TcXaeMgmt-Help.xml
|
<?xml version="1.0" encoding="utf-8"?>
<helpItems schema="maml" xmlns="http://msh"> <!-- Cmdlet: Restart-AdsComputer --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Restart-AdsComputer</command:name> <command:verb>Restart</command:verb> <command:noun>AdsComputer</command:noun> <maml:description> <maml:para>Restarts ("reboots") the operating system on local and remote TwinCAT computers.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The Restart-AdsComputer cmdlet restarts the operating system on the local and remote TwinCAT computers. You can use the parameters of Restart-AdsComputer to specify available ADS target systems to restart. The restart can be done delayed if Users are logged into the target system (existant Session UI) or forced immediatly. You can wait for the restart to complete before you run the next command and specify a waiting time-out. This feature makes it practical to use Restart-AdsComputer in scripts and functions.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: NetIdPort --> <command:syntaxItem> <maml:name>Restart-AdsComputer</maml:name> <!-- Parameter: NetId --> <command:parameter required="false" globbing="false" pipelineInput="false" position="1"> <maml:name>NetId</maml:name> <maml:description> <maml:para>NetId(s) of the target system.</maml:para> </maml:description> <command:parameterValue required="true">AmsNetId[]</command:parameterValue> <dev:type> <maml:name>TwinCAT.Ads.AmsNetId[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Delay --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Delay</maml:name> <maml:description> <maml:para>The delay time for the reboot/shutdown of the target system(s) in seconds. The default is 120 Seconds. If no user is logged in the target system the reboot/shotdown occurs always immediatly without warning. In case of a log in, a Warning message with countdown will be presented to the user.</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <!-- Parameter: Quiet --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="Silent"> <maml:name>Quiet</maml:name> <maml:description> <maml:para>The Quiet parameter suppresses the 'ShouldProcess' messsage and the Cmdlet will be processed without further user confirmation.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Timeout --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Timeout</maml:name> <maml:description> <maml:para>The communication ADS timeout in milliseconds. A value of 0 disables the timeout. A value <= 0 sets the Default (5000 ms).</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>-1</dev:defaultValue> </command:parameter> <!-- Parameter: Wait --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Wait</maml:name> <maml:description> <maml:para>Activates a wait until the rebooted system is available again. The parameter -WaitTimeout specifies how long the script waits for the reboot.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: WaitTimeout --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>WaitTimeout</maml:name> <maml:description> <maml:para>The Wait time for the reboot of the target system (default 120 Seconds). This parameter is used in conjunction with the -Wait parameter.</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>120</dev:defaultValue> </command:parameter> </command:syntaxItem> <!-- Parameter set: Route --> <command:syntaxItem> <maml:name>Restart-AdsComputer</maml:name> <!-- Parameter: InputObject --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="1" aliases="Destination,Route"> <maml:name>InputObject</maml:name> <maml:description> <maml:para>The ADS routes to shutdown/reboot.</maml:para> </maml:description> <command:parameterValue required="true">IRoute[]</command:parameterValue> <dev:type> <maml:name>TwinCAT.IRoute[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Delay --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Delay</maml:name> <maml:description> <maml:para>The delay time for the reboot/shutdown of the target system(s) in seconds. The default is 120 Seconds. If no user is logged in the target system the reboot/shotdown occurs always immediatly without warning. In case of a log in, a Warning message with countdown will be presented to the user.</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <!-- Parameter: Quiet --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="Silent"> <maml:name>Quiet</maml:name> <maml:description> <maml:para>The Quiet parameter suppresses the 'ShouldProcess' messsage and the Cmdlet will be processed without further user confirmation.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Timeout --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Timeout</maml:name> <maml:description> <maml:para>The communication ADS timeout in milliseconds. A value of 0 disables the timeout. A value <= 0 sets the Default (5000 ms).</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>-1</dev:defaultValue> </command:parameter> <!-- Parameter: Wait --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Wait</maml:name> <maml:description> <maml:para>Activates a wait until the rebooted system is available again. The parameter -WaitTimeout specifies how long the script waits for the reboot.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: WaitTimeout --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>WaitTimeout</maml:name> <maml:description> <maml:para>The Wait time for the reboot of the target system (default 120 Seconds). This parameter is used in conjunction with the -Wait parameter.</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>120</dev:defaultValue> </command:parameter> </command:syntaxItem> <!-- Parameter set: AddressStr --> <command:syntaxItem> <maml:name>Restart-AdsComputer</maml:name> <!-- Parameter: Address --> <command:parameter required="true" globbing="true" pipelineInput="false" position="1" aliases="Name"> <maml:name>Address</maml:name> <maml:description> <maml:para>Target names/addresses. These can consist of RouteName, NetID, HostName or IPAddress. This parameter supports wildcards.</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Delay --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Delay</maml:name> <maml:description> <maml:para>The delay time for the reboot/shutdown of the target system(s) in seconds. The default is 120 Seconds. If no user is logged in the target system the reboot/shotdown occurs always immediatly without warning. In case of a log in, a Warning message with countdown will be presented to the user.</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <!-- Parameter: Quiet --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="Silent"> <maml:name>Quiet</maml:name> <maml:description> <maml:para>The Quiet parameter suppresses the 'ShouldProcess' messsage and the Cmdlet will be processed without further user confirmation.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Timeout --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Timeout</maml:name> <maml:description> <maml:para>The communication ADS timeout in milliseconds. A value of 0 disables the timeout. A value <= 0 sets the Default (5000 ms).</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>-1</dev:defaultValue> </command:parameter> <!-- Parameter: Wait --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Wait</maml:name> <maml:description> <maml:para>Activates a wait until the rebooted system is available again. The parameter -WaitTimeout specifies how long the script waits for the reboot.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: WaitTimeout --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>WaitTimeout</maml:name> <maml:description> <maml:para>The Wait time for the reboot of the target system (default 120 Seconds). This parameter is used in conjunction with the -Wait parameter.</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>120</dev:defaultValue> </command:parameter> </command:syntaxItem> <!-- Parameter set: Session --> <command:syntaxItem> <maml:name>Restart-AdsComputer</maml:name> <!-- Parameter: Session --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>Session</maml:name> <maml:description> <maml:para>The Session(s) to use for addressing the target systems.</maml:para> </maml:description> <command:parameterValue required="true">ISession[]</command:parameterValue> <dev:type> <maml:name>TwinCAT.ISession[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Delay --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Delay</maml:name> <maml:description> <maml:para>The delay time for the reboot/shutdown of the target system(s) in seconds. The default is 120 Seconds. If no user is logged in the target system the reboot/shotdown occurs always immediatly without warning. In case of a log in, a Warning message with countdown will be presented to the user.</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <!-- Parameter: Quiet --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="Silent"> <maml:name>Quiet</maml:name> <maml:description> <maml:para>The Quiet parameter suppresses the 'ShouldProcess' messsage and the Cmdlet will be processed without further user confirmation.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Timeout --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Timeout</maml:name> <maml:description> <maml:para>The communication ADS timeout in milliseconds. A value of 0 disables the timeout. A value <= 0 sets the Default (5000 ms).</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>-1</dev:defaultValue> </command:parameter> <!-- Parameter: Wait --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Wait</maml:name> <maml:description> <maml:para>Activates a wait until the rebooted system is available again. The parameter -WaitTimeout specifies how long the script waits for the reboot.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: WaitTimeout --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>WaitTimeout</maml:name> <maml:description> <maml:para>The Wait time for the reboot of the target system (default 120 Seconds). This parameter is used in conjunction with the -Wait parameter.</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>120</dev:defaultValue> </command:parameter> </command:syntaxItem> <!-- Parameter set: SessionId --> <command:syntaxItem> <maml:name>Restart-AdsComputer</maml:name> <!-- Parameter: SessionId --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>SessionId</maml:name> <maml:description> <maml:para>Specifies the Sessions (with unique ID) to use for addressing the target systems.</maml:para> </maml:description> <command:parameterValue required="true">int[]</command:parameterValue> <dev:type> <maml:name>System.Int32[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Delay --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Delay</maml:name> <maml:description> <maml:para>The delay time for the reboot/shutdown of the target system(s) in seconds. The default is 120 Seconds. If no user is logged in the target system the reboot/shotdown occurs always immediatly without warning. In case of a log in, a Warning message with countdown will be presented to the user.</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <!-- Parameter: Quiet --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="Silent"> <maml:name>Quiet</maml:name> <maml:description> <maml:para>The Quiet parameter suppresses the 'ShouldProcess' messsage and the Cmdlet will be processed without further user confirmation.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Timeout --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Timeout</maml:name> <maml:description> <maml:para>The communication ADS timeout in milliseconds. A value of 0 disables the timeout. A value <= 0 sets the Default (5000 ms).</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>-1</dev:defaultValue> </command:parameter> <!-- Parameter: Wait --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Wait</maml:name> <maml:description> <maml:para>Activates a wait until the rebooted system is available again. The parameter -WaitTimeout specifies how long the script waits for the reboot.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: WaitTimeout --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>WaitTimeout</maml:name> <maml:description> <maml:para>The Wait time for the reboot of the target system (default 120 Seconds). This parameter is used in conjunction with the -Wait parameter.</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>120</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Wait --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Wait</maml:name> <maml:description> <maml:para>Activates a wait until the rebooted system is available again. The parameter -WaitTimeout specifies how long the script waits for the reboot.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: WaitTimeout --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>WaitTimeout</maml:name> <maml:description> <maml:para>The Wait time for the reboot of the target system (default 120 Seconds). This parameter is used in conjunction with the -Wait parameter.</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>120</dev:defaultValue> </command:parameter> <!-- Parameter: Delay --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Delay</maml:name> <maml:description> <maml:para>The delay time for the reboot/shutdown of the target system(s) in seconds. The default is 120 Seconds. If no user is logged in the target system the reboot/shotdown occurs always immediatly without warning. In case of a log in, a Warning message with countdown will be presented to the user.</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <!-- Parameter: NetId --> <command:parameter required="false" globbing="false" pipelineInput="false" position="1"> <maml:name>NetId</maml:name> <maml:description> <maml:para>NetId(s) of the target system.</maml:para> </maml:description> <command:parameterValue required="true">AmsNetId[]</command:parameterValue> <dev:type> <maml:name>TwinCAT.Ads.AmsNetId[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: InputObject --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="1" aliases="Destination,Route"> <maml:name>InputObject</maml:name> <maml:description> <maml:para>The ADS routes to shutdown/reboot.</maml:para> </maml:description> <command:parameterValue required="true">IRoute[]</command:parameterValue> <dev:type> <maml:name>TwinCAT.IRoute[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="1" aliases="Destination,Route"> <maml:name>Destination</maml:name> <maml:description> <maml:para>The ADS routes to shutdown/reboot.</maml:para> <maml:para>This is an alias of the InputObject parameter.</maml:para> </maml:description> <command:parameterValue required="true">IRoute[]</command:parameterValue> <dev:type> <maml:name>TwinCAT.IRoute[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="1" aliases="Destination,Route"> <maml:name>Route</maml:name> <maml:description> <maml:para>The ADS routes to shutdown/reboot.</maml:para> <maml:para>This is an alias of the InputObject parameter.</maml:para> </maml:description> <command:parameterValue required="true">IRoute[]</command:parameterValue> <dev:type> <maml:name>TwinCAT.IRoute[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Address --> <command:parameter required="true" globbing="true" pipelineInput="false" position="1" aliases="Name"> <maml:name>Address</maml:name> <maml:description> <maml:para>Target names/addresses. These can consist of RouteName, NetID, HostName or IPAddress. This parameter supports wildcards.</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" globbing="true" pipelineInput="false" position="1" aliases="Name"> <maml:name>Name</maml:name> <maml:description> <maml:para>Target names/addresses. These can consist of RouteName, NetID, HostName or IPAddress. This parameter supports wildcards.</maml:para> <maml:para>This is an alias of the Address parameter.</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Session --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>Session</maml:name> <maml:description> <maml:para>The Session(s) to use for addressing the target systems.</maml:para> </maml:description> <command:parameterValue required="true">ISession[]</command:parameterValue> <dev:type> <maml:name>TwinCAT.ISession[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: SessionId --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>SessionId</maml:name> <maml:description> <maml:para>Specifies the Sessions (with unique ID) to use for addressing the target systems.</maml:para> </maml:description> <command:parameterValue required="true">int[]</command:parameterValue> <dev:type> <maml:name>System.Int32[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Timeout --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Timeout</maml:name> <maml:description> <maml:para>The communication ADS timeout in milliseconds. A value of 0 disables the timeout. A value <= 0 sets the Default (5000 ms).</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>-1</dev:defaultValue> </command:parameter> <!-- Parameter: Quiet --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="Silent"> <maml:name>Quiet</maml:name> <maml:description> <maml:para>The Quiet parameter suppresses the 'ShouldProcess' messsage and the Cmdlet will be processed without further user confirmation.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="Silent"> <maml:name>Silent</maml:name> <maml:description> <maml:para>The Quiet parameter suppresses the 'ShouldProcess' messsage and the Cmdlet will be processed without further user confirmation.</maml:para> <maml:para>This is an alias of the Quiet parameter.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>TwinCAT.IRoute[]</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>The ADS routes to shutdown/reboot.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>TwinCAT.ISession[]</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>The Session(s) to use for addressing the target systems.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>PS> Restart-AdsComputer CX_1111,CX_2222 -force</dev:code> <dev:remarks> <maml:para>Restarts the computers CX_1111 and CX_2222 immediatly without warning logged in users on the target system and returns immediatly without waiting the finished reboot. The Force parameter supresses the ShouldProcess query.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 2 ----------</maml:title> <dev:code>PS> Restart-AdsComputer -netId '1.2.3.4.1.1', '1.2.3.5.1.1' -Delay 30 -Wait -WaitTimeout 240 -force</dev:code> <dev:remarks> <maml:para>Restarts the TwinCAT targets '1.2.3.4.1.1' and 1.2.3.5.1.1' without ShouldProcess query after a delay of 30 Seconds (if a user is logged in) and waits for the reboot before continuing. The Wait timeout is set to 240 Seconds.</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <!-- Cmdlet: Stop-AdsComputer --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Stop-AdsComputer</command:name> <command:verb>Stop</command:verb> <command:noun>AdsComputer</command:noun> <maml:description> <maml:para>Stops (shuts down) local and remote TwinCAT computers.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The Stop-AdsComputer cmdlet shuts the operating system on the local and remote TwinCAT computers down. You can use the parameters of Stop-AdsComputer to specify available ADS target systems to shutdown. The shutdown can be done delayed if Users are logged into the target system (existant Session UI) or forced immediatly.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: NetIdPort --> <command:syntaxItem> <maml:name>Stop-AdsComputer</maml:name> <!-- Parameter: NetId --> <command:parameter required="false" globbing="false" pipelineInput="false" position="1"> <maml:name>NetId</maml:name> <maml:description> <maml:para>NetId(s) of the target system.</maml:para> </maml:description> <command:parameterValue required="true">AmsNetId[]</command:parameterValue> <dev:type> <maml:name>TwinCAT.Ads.AmsNetId[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Delay --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Delay</maml:name> <maml:description> <maml:para>The delay time for the reboot/shutdown of the target system(s) in seconds. The default is 120 Seconds. If no user is logged in the target system the reboot/shotdown occurs always immediatly without warning. In case of a log in, a Warning message with countdown will be presented to the user.</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <!-- Parameter: Quiet --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="Silent"> <maml:name>Quiet</maml:name> <maml:description> <maml:para>The Quiet parameter suppresses the 'ShouldProcess' messsage and the Cmdlet will be processed without further user confirmation.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Timeout --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Timeout</maml:name> <maml:description> <maml:para>The communication ADS timeout in milliseconds. A value of 0 disables the timeout. A value <= 0 sets the Default (5000 ms).</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>-1</dev:defaultValue> </command:parameter> </command:syntaxItem> <!-- Parameter set: Route --> <command:syntaxItem> <maml:name>Stop-AdsComputer</maml:name> <!-- Parameter: InputObject --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="1" aliases="Destination,Route"> <maml:name>InputObject</maml:name> <maml:description> <maml:para>The ADS routes to shutdown/reboot.</maml:para> </maml:description> <command:parameterValue required="true">IRoute[]</command:parameterValue> <dev:type> <maml:name>TwinCAT.IRoute[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Delay --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Delay</maml:name> <maml:description> <maml:para>The delay time for the reboot/shutdown of the target system(s) in seconds. The default is 120 Seconds. If no user is logged in the target system the reboot/shotdown occurs always immediatly without warning. In case of a log in, a Warning message with countdown will be presented to the user.</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <!-- Parameter: Quiet --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="Silent"> <maml:name>Quiet</maml:name> <maml:description> <maml:para>The Quiet parameter suppresses the 'ShouldProcess' messsage and the Cmdlet will be processed without further user confirmation.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Timeout --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Timeout</maml:name> <maml:description> <maml:para>The communication ADS timeout in milliseconds. A value of 0 disables the timeout. A value <= 0 sets the Default (5000 ms).</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>-1</dev:defaultValue> </command:parameter> </command:syntaxItem> <!-- Parameter set: AddressStr --> <command:syntaxItem> <maml:name>Stop-AdsComputer</maml:name> <!-- Parameter: Address --> <command:parameter required="true" globbing="true" pipelineInput="false" position="1" aliases="Name"> <maml:name>Address</maml:name> <maml:description> <maml:para>Target names/addresses. These can consist of RouteName, NetID, HostName or IPAddress. This parameter supports wildcards.</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Delay --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Delay</maml:name> <maml:description> <maml:para>The delay time for the reboot/shutdown of the target system(s) in seconds. The default is 120 Seconds. If no user is logged in the target system the reboot/shotdown occurs always immediatly without warning. In case of a log in, a Warning message with countdown will be presented to the user.</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <!-- Parameter: Quiet --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="Silent"> <maml:name>Quiet</maml:name> <maml:description> <maml:para>The Quiet parameter suppresses the 'ShouldProcess' messsage and the Cmdlet will be processed without further user confirmation.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Timeout --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Timeout</maml:name> <maml:description> <maml:para>The communication ADS timeout in milliseconds. A value of 0 disables the timeout. A value <= 0 sets the Default (5000 ms).</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>-1</dev:defaultValue> </command:parameter> </command:syntaxItem> <!-- Parameter set: Session --> <command:syntaxItem> <maml:name>Stop-AdsComputer</maml:name> <!-- Parameter: Session --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>Session</maml:name> <maml:description> <maml:para>The Session(s) to use for addressing the target systems.</maml:para> </maml:description> <command:parameterValue required="true">ISession[]</command:parameterValue> <dev:type> <maml:name>TwinCAT.ISession[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Delay --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Delay</maml:name> <maml:description> <maml:para>The delay time for the reboot/shutdown of the target system(s) in seconds. The default is 120 Seconds. If no user is logged in the target system the reboot/shotdown occurs always immediatly without warning. In case of a log in, a Warning message with countdown will be presented to the user.</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <!-- Parameter: Quiet --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="Silent"> <maml:name>Quiet</maml:name> <maml:description> <maml:para>The Quiet parameter suppresses the 'ShouldProcess' messsage and the Cmdlet will be processed without further user confirmation.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Timeout --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Timeout</maml:name> <maml:description> <maml:para>The communication ADS timeout in milliseconds. A value of 0 disables the timeout. A value <= 0 sets the Default (5000 ms).</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>-1</dev:defaultValue> </command:parameter> </command:syntaxItem> <!-- Parameter set: SessionId --> <command:syntaxItem> <maml:name>Stop-AdsComputer</maml:name> <!-- Parameter: SessionId --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>SessionId</maml:name> <maml:description> <maml:para>Specifies the Sessions (with unique ID) to use for addressing the target systems.</maml:para> </maml:description> <command:parameterValue required="true">int[]</command:parameterValue> <dev:type> <maml:name>System.Int32[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Delay --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Delay</maml:name> <maml:description> <maml:para>The delay time for the reboot/shutdown of the target system(s) in seconds. The default is 120 Seconds. If no user is logged in the target system the reboot/shotdown occurs always immediatly without warning. In case of a log in, a Warning message with countdown will be presented to the user.</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <!-- Parameter: Quiet --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="Silent"> <maml:name>Quiet</maml:name> <maml:description> <maml:para>The Quiet parameter suppresses the 'ShouldProcess' messsage and the Cmdlet will be processed without further user confirmation.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Timeout --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Timeout</maml:name> <maml:description> <maml:para>The communication ADS timeout in milliseconds. A value of 0 disables the timeout. A value <= 0 sets the Default (5000 ms).</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>-1</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Delay --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Delay</maml:name> <maml:description> <maml:para>The delay time for the reboot/shutdown of the target system(s) in seconds. The default is 120 Seconds. If no user is logged in the target system the reboot/shotdown occurs always immediatly without warning. In case of a log in, a Warning message with countdown will be presented to the user.</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <!-- Parameter: NetId --> <command:parameter required="false" globbing="false" pipelineInput="false" position="1"> <maml:name>NetId</maml:name> <maml:description> <maml:para>NetId(s) of the target system.</maml:para> </maml:description> <command:parameterValue required="true">AmsNetId[]</command:parameterValue> <dev:type> <maml:name>TwinCAT.Ads.AmsNetId[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: InputObject --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="1" aliases="Destination,Route"> <maml:name>InputObject</maml:name> <maml:description> <maml:para>The ADS routes to shutdown/reboot.</maml:para> </maml:description> <command:parameterValue required="true">IRoute[]</command:parameterValue> <dev:type> <maml:name>TwinCAT.IRoute[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="1" aliases="Destination,Route"> <maml:name>Destination</maml:name> <maml:description> <maml:para>The ADS routes to shutdown/reboot.</maml:para> <maml:para>This is an alias of the InputObject parameter.</maml:para> </maml:description> <command:parameterValue required="true">IRoute[]</command:parameterValue> <dev:type> <maml:name>TwinCAT.IRoute[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="1" aliases="Destination,Route"> <maml:name>Route</maml:name> <maml:description> <maml:para>The ADS routes to shutdown/reboot.</maml:para> <maml:para>This is an alias of the InputObject parameter.</maml:para> </maml:description> <command:parameterValue required="true">IRoute[]</command:parameterValue> <dev:type> <maml:name>TwinCAT.IRoute[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Address --> <command:parameter required="true" globbing="true" pipelineInput="false" position="1" aliases="Name"> <maml:name>Address</maml:name> <maml:description> <maml:para>Target names/addresses. These can consist of RouteName, NetID, HostName or IPAddress. This parameter supports wildcards.</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" globbing="true" pipelineInput="false" position="1" aliases="Name"> <maml:name>Name</maml:name> <maml:description> <maml:para>Target names/addresses. These can consist of RouteName, NetID, HostName or IPAddress. This parameter supports wildcards.</maml:para> <maml:para>This is an alias of the Address parameter.</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Session --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>Session</maml:name> <maml:description> <maml:para>The Session(s) to use for addressing the target systems.</maml:para> </maml:description> <command:parameterValue required="true">ISession[]</command:parameterValue> <dev:type> <maml:name>TwinCAT.ISession[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: SessionId --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>SessionId</maml:name> <maml:description> <maml:para>Specifies the Sessions (with unique ID) to use for addressing the target systems.</maml:para> </maml:description> <command:parameterValue required="true">int[]</command:parameterValue> <dev:type> <maml:name>System.Int32[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Timeout --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Timeout</maml:name> <maml:description> <maml:para>The communication ADS timeout in milliseconds. A value of 0 disables the timeout. A value <= 0 sets the Default (5000 ms).</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>-1</dev:defaultValue> </command:parameter> <!-- Parameter: Quiet --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="Silent"> <maml:name>Quiet</maml:name> <maml:description> <maml:para>The Quiet parameter suppresses the 'ShouldProcess' messsage and the Cmdlet will be processed without further user confirmation.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="Silent"> <maml:name>Silent</maml:name> <maml:description> <maml:para>The Quiet parameter suppresses the 'ShouldProcess' messsage and the Cmdlet will be processed without further user confirmation.</maml:para> <maml:para>This is an alias of the Quiet parameter.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>TwinCAT.IRoute[]</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>The ADS routes to shutdown/reboot.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>TwinCAT.ISession[]</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>The Session(s) to use for addressing the target systems.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>PS> Stop-AdsComputer CX_1111,CX_2222 -force</dev:code> <dev:remarks> <maml:para>Immediate shutdown of the computers CX_1111 and CX_2222. The Force parameter supresses the ShouldProcess query.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 2 ----------</maml:title> <dev:code>PS> Stop-AdsComputer -netId '1.2.3.4.1.1', '1.2.3.5.1.1' -Delay 30 -force</dev:code> <dev:remarks> <maml:para>Stops the TwinCAT targets '1.2.3.4.1.1' and 1.2.3.5.1.1' without ShouldProcess query after a delay of 30 Seconds (if a user is logged in).</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <!-- Cmdlet: Copy-AdsFile --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Copy-AdsFile</command:name> <command:verb>Copy</command:verb> <command:noun>AdsFile</command:noun> <maml:description> <maml:para>Uploads / Downloads files from/to TwinCAT target.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>This Cmdlet implements ADS file transfer operations with TwinCAT Systems.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: NetId --> <command:syntaxItem> <maml:name>Copy-AdsFile</maml:name> <!-- Parameter: Path --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>Path</maml:name> <maml:description> <maml:para>The source path specifier, where the file is taken from. If this Cmdlet is in Download mode, this is the specifier or FullPath of the (remote) file, dependant of the StandardFolder Parameter. In case of 'Uploading' this is the FullPath of the file to be transferred.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Destination --> <command:parameter required="false" globbing="false" pipelineInput="false" position="1"> <maml:name>Destination</maml:name> <maml:description> <maml:para>The Destination path/specifier, where the file is stored. If the Cmdlet is in Download mode, this has to be the FullPath of the target location. In case of 'Uploading' this can be the FileName or a FullPath dependent of the StandardDirectory Parameter.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Directory --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Directory</maml:name> <maml:description> <maml:para>The Directory specifier on the remote system. The Default is "Generic".</maml:para> <maml:para>Possible values: Generic, BootDir, TargetDir, ConfigDir, InstallDir, RepositoryDir, UserPath1, UserPath2, UserPath3, UserPath4, UserPath5, UserPath6, UserPath7, UserPath8, UserPath9</maml:para> </maml:description> <command:parameterValue required="true">PathSpecifier</command:parameterValue> <dev:type> <maml:name>TwinCAT.Management.Automation.PathSpecifier</maml:name> <maml:uri /> <maml:description> <maml:para>The PathSpecifier is specifying "Special Folders" on the target system, within the [TwinCAT] Root.</maml:para> </maml:description> </dev:type> <dev:defaultValue>Generic</dev:defaultValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Generic</command:parameterValue> <command:parameterValue required="false" variableLength="false">BootDir</command:parameterValue> <command:parameterValue required="false" variableLength="false">TargetDir</command:parameterValue> <command:parameterValue required="false" variableLength="false">ConfigDir</command:parameterValue> <command:parameterValue required="false" variableLength="false">InstallDir</command:parameterValue> <command:parameterValue required="false" variableLength="false">RepositoryDir</command:parameterValue> <command:parameterValue required="false" variableLength="false">UserPath1</command:parameterValue> <command:parameterValue required="false" variableLength="false">UserPath2</command:parameterValue> <command:parameterValue required="false" variableLength="false">UserPath3</command:parameterValue> <command:parameterValue required="false" variableLength="false">UserPath4</command:parameterValue> <command:parameterValue required="false" variableLength="false">UserPath5</command:parameterValue> <command:parameterValue required="false" variableLength="false">UserPath6</command:parameterValue> <command:parameterValue required="false" variableLength="false">UserPath7</command:parameterValue> <command:parameterValue required="false" variableLength="false">UserPath8</command:parameterValue> <command:parameterValue required="false" variableLength="false">UserPath9</command:parameterValue> </command:parameterValueGroup> </command:parameter> <!-- Parameter: Force --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para>Forces to create the Directory on the target side (and overwrites any preexisting file).</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: NetId --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>NetId</maml:name> <maml:description> <maml:para>The address (AmsNetId) of the system where the file is Downloaded from / Uploaded to (Default: Local)</maml:para> </maml:description> <command:parameterValue required="true">AmsNetId</command:parameterValue> <dev:type> <maml:name>TwinCAT.Ads.AmsNetId</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Upload --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Upload</maml:name> <maml:description> <maml:para>Switches the Cmdlet to Upload mode. If not set, the Cmdlet is in 'Download' mode.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> <!-- Parameter set: Route --> <command:syntaxItem> <maml:name>Copy-AdsFile</maml:name> <!-- Parameter: Path --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>Path</maml:name> <maml:description> <maml:para>The source path specifier, where the file is taken from. If this Cmdlet is in Download mode, this is the specifier or FullPath of the (remote) file, dependant of the StandardFolder Parameter. In case of 'Uploading' this is the FullPath of the file to be transferred.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Destination --> <command:parameter required="false" globbing="false" pipelineInput="false" position="1"> <maml:name>Destination</maml:name> <maml:description> <maml:para>The Destination path/specifier, where the file is stored. If the Cmdlet is in Download mode, this has to be the FullPath of the target location. In case of 'Uploading' this can be the FileName or a FullPath dependent of the StandardDirectory Parameter.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: InputObject --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="named" aliases="Route"> <maml:name>InputObject</maml:name> <maml:description> <maml:para>The address (Route) of the system where the file is Downloaded from / Uploaded to (Default: Local)</maml:para> </maml:description> <command:parameterValue required="true">IRoute</command:parameterValue> <dev:type> <maml:name>TwinCAT.IRoute</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Directory --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Directory</maml:name> <maml:description> <maml:para>The Directory specifier on the remote system. The Default is "Generic".</maml:para> <maml:para>Possible values: Generic, BootDir, TargetDir, ConfigDir, InstallDir, RepositoryDir, UserPath1, UserPath2, UserPath3, UserPath4, UserPath5, UserPath6, UserPath7, UserPath8, UserPath9</maml:para> </maml:description> <command:parameterValue required="true">PathSpecifier</command:parameterValue> <dev:type> <maml:name>TwinCAT.Management.Automation.PathSpecifier</maml:name> <maml:uri /> <maml:description> <maml:para>The PathSpecifier is specifying "Special Folders" on the target system, within the [TwinCAT] Root.</maml:para> </maml:description> </dev:type> <dev:defaultValue>Generic</dev:defaultValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Generic</command:parameterValue> <command:parameterValue required="false" variableLength="false">BootDir</command:parameterValue> <command:parameterValue required="false" variableLength="false">TargetDir</command:parameterValue> <command:parameterValue required="false" variableLength="false">ConfigDir</command:parameterValue> <command:parameterValue required="false" variableLength="false">InstallDir</command:parameterValue> <command:parameterValue required="false" variableLength="false">RepositoryDir</command:parameterValue> <command:parameterValue required="false" variableLength="false">UserPath1</command:parameterValue> <command:parameterValue required="false" variableLength="false">UserPath2</command:parameterValue> <command:parameterValue required="false" variableLength="false">UserPath3</command:parameterValue> <command:parameterValue required="false" variableLength="false">UserPath4</command:parameterValue> <command:parameterValue required="false" variableLength="false">UserPath5</command:parameterValue> <command:parameterValue required="false" variableLength="false">UserPath6</command:parameterValue> <command:parameterValue required="false" variableLength="false">UserPath7</command:parameterValue> <command:parameterValue required="false" variableLength="false">UserPath8</command:parameterValue> <command:parameterValue required="false" variableLength="false">UserPath9</command:parameterValue> </command:parameterValueGroup> </command:parameter> <!-- Parameter: Force --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para>Forces to create the Directory on the target side (and overwrites any preexisting file).</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Upload --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Upload</maml:name> <maml:description> <maml:para>Switches the Cmdlet to Upload mode. If not set, the Cmdlet is in 'Download' mode.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> <!-- Parameter set: AddressStr --> <command:syntaxItem> <maml:name>Copy-AdsFile</maml:name> <!-- Parameter: Path --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>Path</maml:name> <maml:description> <maml:para>The source path specifier, where the file is taken from. If this Cmdlet is in Download mode, this is the specifier or FullPath of the (remote) file, dependant of the StandardFolder Parameter. In case of 'Uploading' this is the FullPath of the file to be transferred.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Destination --> <command:parameter required="false" globbing="false" pipelineInput="false" position="1"> <maml:name>Destination</maml:name> <maml:description> <maml:para>The Destination path/specifier, where the file is stored. If the Cmdlet is in Download mode, this has to be the FullPath of the target location. In case of 'Uploading' this can be the FileName or a FullPath dependent of the StandardDirectory Parameter.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Address --> <command:parameter required="true" globbing="true" pipelineInput="false" position="named"> <maml:name>Address</maml:name> <maml:description> <maml:para>The address of the system where the file is Downloaded from / Uploaded to (Default: Local) This can be the RouteName, NetId, the HostName or the IPAddress.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Directory --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Directory</maml:name> <maml:description> <maml:para>The Directory specifier on the remote system. The Default is "Generic".</maml:para> <maml:para>Possible values: Generic, BootDir, TargetDir, ConfigDir, InstallDir, RepositoryDir, UserPath1, UserPath2, UserPath3, UserPath4, UserPath5, UserPath6, UserPath7, UserPath8, UserPath9</maml:para> </maml:description> <command:parameterValue required="true">PathSpecifier</command:parameterValue> <dev:type> <maml:name>TwinCAT.Management.Automation.PathSpecifier</maml:name> <maml:uri /> <maml:description> <maml:para>The PathSpecifier is specifying "Special Folders" on the target system, within the [TwinCAT] Root.</maml:para> </maml:description> </dev:type> <dev:defaultValue>Generic</dev:defaultValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Generic</command:parameterValue> <command:parameterValue required="false" variableLength="false">BootDir</command:parameterValue> <command:parameterValue required="false" variableLength="false">TargetDir</command:parameterValue> <command:parameterValue required="false" variableLength="false">ConfigDir</command:parameterValue> <command:parameterValue required="false" variableLength="false">InstallDir</command:parameterValue> <command:parameterValue required="false" variableLength="false">RepositoryDir</command:parameterValue> <command:parameterValue required="false" variableLength="false">UserPath1</command:parameterValue> <command:parameterValue required="false" variableLength="false">UserPath2</command:parameterValue> <command:parameterValue required="false" variableLength="false">UserPath3</command:parameterValue> <command:parameterValue required="false" variableLength="false">UserPath4</command:parameterValue> <command:parameterValue required="false" variableLength="false">UserPath5</command:parameterValue> <command:parameterValue required="false" variableLength="false">UserPath6</command:parameterValue> <command:parameterValue required="false" variableLength="false">UserPath7</command:parameterValue> <command:parameterValue required="false" variableLength="false">UserPath8</command:parameterValue> <command:parameterValue required="false" variableLength="false">UserPath9</command:parameterValue> </command:parameterValueGroup> </command:parameter> <!-- Parameter: Force --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para>Forces to create the Directory on the target side (and overwrites any preexisting file).</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Upload --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Upload</maml:name> <maml:description> <maml:para>Switches the Cmdlet to Upload mode. If not set, the Cmdlet is in 'Download' mode.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> <!-- Parameter set: SessionId --> <command:syntaxItem> <maml:name>Copy-AdsFile</maml:name> <!-- Parameter: Path --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>Path</maml:name> <maml:description> <maml:para>The source path specifier, where the file is taken from. If this Cmdlet is in Download mode, this is the specifier or FullPath of the (remote) file, dependant of the StandardFolder Parameter. In case of 'Uploading' this is the FullPath of the file to be transferred.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Destination --> <command:parameter required="false" globbing="false" pipelineInput="false" position="1"> <maml:name>Destination</maml:name> <maml:description> <maml:para>The Destination path/specifier, where the file is stored. If the Cmdlet is in Download mode, this has to be the FullPath of the target location. In case of 'Uploading' this can be the FileName or a FullPath dependent of the StandardDirectory Parameter.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: SessionId --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named" aliases="Id"> <maml:name>SessionId</maml:name> <maml:description> <maml:para>The target system address is derived from the Session Information where the file is Downloaded from / Uploaded to.</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>-1</dev:defaultValue> </command:parameter> <!-- Parameter: Directory --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Directory</maml:name> <maml:description> <maml:para>The Directory specifier on the remote system. The Default is "Generic".</maml:para> <maml:para>Possible values: Generic, BootDir, TargetDir, ConfigDir, InstallDir, RepositoryDir, UserPath1, UserPath2, UserPath3, UserPath4, UserPath5, UserPath6, UserPath7, UserPath8, UserPath9</maml:para> </maml:description> <command:parameterValue required="true">PathSpecifier</command:parameterValue> <dev:type> <maml:name>TwinCAT.Management.Automation.PathSpecifier</maml:name> <maml:uri /> <maml:description> <maml:para>The PathSpecifier is specifying "Special Folders" on the target system, within the [TwinCAT] Root.</maml:para> </maml:description> </dev:type> <dev:defaultValue>Generic</dev:defaultValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Generic</command:parameterValue> <command:parameterValue required="false" variableLength="false">BootDir</command:parameterValue> <command:parameterValue required="false" variableLength="false">TargetDir</command:parameterValue> <command:parameterValue required="false" variableLength="false">ConfigDir</command:parameterValue> <command:parameterValue required="false" variableLength="false">InstallDir</command:parameterValue> <command:parameterValue required="false" variableLength="false">RepositoryDir</command:parameterValue> <command:parameterValue required="false" variableLength="false">UserPath1</command:parameterValue> <command:parameterValue required="false" variableLength="false">UserPath2</command:parameterValue> <command:parameterValue required="false" variableLength="false">UserPath3</command:parameterValue> <command:parameterValue required="false" variableLength="false">UserPath4</command:parameterValue> <command:parameterValue required="false" variableLength="false">UserPath5</command:parameterValue> <command:parameterValue required="false" variableLength="false">UserPath6</command:parameterValue> <command:parameterValue required="false" variableLength="false">UserPath7</command:parameterValue> <command:parameterValue required="false" variableLength="false">UserPath8</command:parameterValue> <command:parameterValue required="false" variableLength="false">UserPath9</command:parameterValue> </command:parameterValueGroup> </command:parameter> <!-- Parameter: Force --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para>Forces to create the Directory on the target side (and overwrites any preexisting file).</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Upload --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Upload</maml:name> <maml:description> <maml:para>Switches the Cmdlet to Upload mode. If not set, the Cmdlet is in 'Download' mode.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Path --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>Path</maml:name> <maml:description> <maml:para>The source path specifier, where the file is taken from. If this Cmdlet is in Download mode, this is the specifier or FullPath of the (remote) file, dependant of the StandardFolder Parameter. In case of 'Uploading' this is the FullPath of the file to be transferred.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Destination --> <command:parameter required="false" globbing="false" pipelineInput="false" position="1"> <maml:name>Destination</maml:name> <maml:description> <maml:para>The Destination path/specifier, where the file is stored. If the Cmdlet is in Download mode, this has to be the FullPath of the target location. In case of 'Uploading' this can be the FileName or a FullPath dependent of the StandardDirectory Parameter.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Directory --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Directory</maml:name> <maml:description> <maml:para>The Directory specifier on the remote system. The Default is "Generic".</maml:para> <maml:para>Possible values: Generic, BootDir, TargetDir, ConfigDir, InstallDir, RepositoryDir, UserPath1, UserPath2, UserPath3, UserPath4, UserPath5, UserPath6, UserPath7, UserPath8, UserPath9</maml:para> </maml:description> <command:parameterValue required="true">PathSpecifier</command:parameterValue> <dev:type> <maml:name>TwinCAT.Management.Automation.PathSpecifier</maml:name> <maml:uri /> <maml:description> <maml:para>The PathSpecifier is specifying "Special Folders" on the target system, within the [TwinCAT] Root.</maml:para> </maml:description> </dev:type> <dev:defaultValue>Generic</dev:defaultValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Generic</command:parameterValue> <command:parameterValue required="false" variableLength="false">BootDir</command:parameterValue> <command:parameterValue required="false" variableLength="false">TargetDir</command:parameterValue> <command:parameterValue required="false" variableLength="false">ConfigDir</command:parameterValue> <command:parameterValue required="false" variableLength="false">InstallDir</command:parameterValue> <command:parameterValue required="false" variableLength="false">RepositoryDir</command:parameterValue> <command:parameterValue required="false" variableLength="false">UserPath1</command:parameterValue> <command:parameterValue required="false" variableLength="false">UserPath2</command:parameterValue> <command:parameterValue required="false" variableLength="false">UserPath3</command:parameterValue> <command:parameterValue required="false" variableLength="false">UserPath4</command:parameterValue> <command:parameterValue required="false" variableLength="false">UserPath5</command:parameterValue> <command:parameterValue required="false" variableLength="false">UserPath6</command:parameterValue> <command:parameterValue required="false" variableLength="false">UserPath7</command:parameterValue> <command:parameterValue required="false" variableLength="false">UserPath8</command:parameterValue> <command:parameterValue required="false" variableLength="false">UserPath9</command:parameterValue> </command:parameterValueGroup> </command:parameter> <!-- Parameter: Upload --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Upload</maml:name> <maml:description> <maml:para>Switches the Cmdlet to Upload mode. If not set, the Cmdlet is in 'Download' mode.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Force --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para>Forces to create the Directory on the target side (and overwrites any preexisting file).</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: NetId --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>NetId</maml:name> <maml:description> <maml:para>The address (AmsNetId) of the system where the file is Downloaded from / Uploaded to (Default: Local)</maml:para> </maml:description> <command:parameterValue required="true">AmsNetId</command:parameterValue> <dev:type> <maml:name>TwinCAT.Ads.AmsNetId</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: InputObject --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="named" aliases="Route"> <maml:name>InputObject</maml:name> <maml:description> <maml:para>The address (Route) of the system where the file is Downloaded from / Uploaded to (Default: Local)</maml:para> </maml:description> <command:parameterValue required="true">IRoute</command:parameterValue> <dev:type> <maml:name>TwinCAT.IRoute</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="named" aliases="Route"> <maml:name>Route</maml:name> <maml:description> <maml:para>The address (Route) of the system where the file is Downloaded from / Uploaded to (Default: Local)</maml:para> <maml:para>This is an alias of the InputObject parameter.</maml:para> </maml:description> <command:parameterValue required="true">IRoute</command:parameterValue> <dev:type> <maml:name>TwinCAT.IRoute</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Address --> <command:parameter required="true" globbing="true" pipelineInput="false" position="named"> <maml:name>Address</maml:name> <maml:description> <maml:para>The address of the system where the file is Downloaded from / Uploaded to (Default: Local) This can be the RouteName, NetId, the HostName or the IPAddress.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: SessionId --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named" aliases="Id"> <maml:name>SessionId</maml:name> <maml:description> <maml:para>The target system address is derived from the Session Information where the file is Downloaded from / Uploaded to.</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>-1</dev:defaultValue> </command:parameter> <command:parameter required="true" globbing="false" pipelineInput="false" position="named" aliases="Id"> <maml:name>Id</maml:name> <maml:description> <maml:para>The target system address is derived from the Session Information where the file is Downloaded from / Uploaded to.</maml:para> <maml:para>This is an alias of the SessionId parameter.</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>-1</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>TwinCAT.IRoute</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>The address (Route) of the system where the file is Downloaded from / Uploaded to (Default: Local)</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>PS > Copy-AdsFile -address CX_00001 -path CurrentConfig.xml -Destination c:\tmp\Config1.xml -Directory BootDir</dev:code> <dev:remarks> <maml:para>Downloads the the CurrentConfig.xml from the BootDir of the target system to 'c:\tmp\Config1.xml'</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 2 ----------</maml:title> <dev:code>PS > Copy-AdsFile -address CX_00001 -upload -path c:\tmp\Config1.xml -destination CurrentConfig.xml -Directory BootDir</dev:code> <dev:remarks> <maml:para>Uploads the file "c:\tmp\Config1.xml" on local system to the Target BootFolder of system CX_00001</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 3 ----------</maml:title> <dev:code>PS > Copy-AdsFile -address CX_0001 -path c:\ReadMe.txt -destination d:\tmp\</dev:code> <dev:remarks> <maml:para>Downloads the File "C:\ReadMe.txt" form System CX_0001 to the local system and store it under d:\tmp\ReadMe.txt</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <!-- Cmdlet: Register-AdsHandle --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Register-AdsHandle</command:name> <command:verb>Register</command:verb> <command:noun>AdsHandle</command:noun> <maml:description> <maml:para>Registers and returns a symbol handle.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>This Cmdlet registers a symbol handle at the connected system. The handle is returned as AdsHandleInfo.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: NetIdPortSymbol --> <command:syntaxItem> <maml:name>Register-AdsHandle</maml:name> <!-- Parameter: Path --> <command:parameter required="true" globbing="true" pipelineInput="false" position="1"> <maml:name>Path</maml:name> <maml:description> <maml:para>The instance path to the symbol.</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Port --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Port</maml:name> <maml:description> <maml:para>The address Port to use (always in combination with the NetId). ArgumentCompleter is supported.</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>10000</dev:defaultValue> </command:parameter> <!-- Parameter: NetId --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>NetId</maml:name> <maml:description> <maml:para>The NetId address of the Target system</maml:para> </maml:description> <command:parameterValue required="true">AmsNetId</command:parameterValue> <dev:type> <maml:name>TwinCAT.Ads.AmsNetId</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> <!-- Parameter set: RouteSymbol --> <command:syntaxItem> <maml:name>Register-AdsHandle</maml:name> <!-- Parameter: Path --> <command:parameter required="true" globbing="true" pipelineInput="false" position="1"> <maml:name>Path</maml:name> <maml:description> <maml:para>The instance path to the symbol.</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Port --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Port</maml:name> <maml:description> <maml:para>The address Port to use (always in combination with the NetId). ArgumentCompleter is supported.</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>10000</dev:defaultValue> </command:parameter> <!-- Parameter: Route --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named" aliases="Destination"> <maml:name>Route</maml:name> <maml:description> <maml:para>Specifies the route of the target system.</maml:para> </maml:description> <command:parameterValue required="true">IRoute</command:parameterValue> <dev:type> <maml:name>TwinCAT.IRoute</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> <!-- Parameter set: AddressSymbol --> <command:syntaxItem> <maml:name>Register-AdsHandle</maml:name> <!-- Parameter: Path --> <command:parameter required="true" globbing="true" pipelineInput="false" position="1"> <maml:name>Path</maml:name> <maml:description> <maml:para>The instance path to the symbol.</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Address --> <command:parameter required="true" globbing="true" pipelineInput="false" position="named"> <maml:name>Address</maml:name> <maml:description> <maml:para>The Address of the target system where to register the symbol handle. The Address can consist of RouteName, NetId, IPAddress or HostName. Wildcards are permitted.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Port --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Port</maml:name> <maml:description> <maml:para>The address Port to use (always in combination with the NetId). ArgumentCompleter is supported.</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>10000</dev:defaultValue> </command:parameter> </command:syntaxItem> <!-- Parameter set: SessionSymbol --> <command:syntaxItem> <maml:name>Register-AdsHandle</maml:name> <!-- Parameter: Path --> <command:parameter required="true" globbing="true" pipelineInput="false" position="1"> <maml:name>Path</maml:name> <maml:description> <maml:para>The instance path to the symbol.</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Session --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="named"> <maml:name>Session</maml:name> <maml:description> <maml:para>The Session to use (instead of addressing the target system).</maml:para> </maml:description> <command:parameterValue required="true">ISession</command:parameterValue> <dev:type> <maml:name>TwinCAT.ISession</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> <!-- Parameter set: SessionIdSymbol --> <command:syntaxItem> <maml:name>Register-AdsHandle</maml:name> <!-- Parameter: Path --> <command:parameter required="true" globbing="true" pipelineInput="false" position="1"> <maml:name>Path</maml:name> <maml:description> <maml:para>The instance path to the symbol.</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: SessionId --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>SessionId</maml:name> <maml:description> <maml:para>Specifies the Session (with unique ID) to use instead of specifying the target address.</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>-1</dev:defaultValue> </command:parameter> </command:syntaxItem> <!-- Parameter set: InputObject --> <command:syntaxItem> <maml:name>Register-AdsHandle</maml:name> <!-- Parameter: InputObject --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="1" aliases="Symbol"> <maml:name>InputObject</maml:name> <maml:description> <maml:para>The symbol object.</maml:para> </maml:description> <command:parameterValue required="true">ISymbol[]</command:parameterValue> <dev:type> <maml:name>TwinCAT.TypeSystem.ISymbol[]</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: NetId --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>NetId</maml:name> <maml:description> <maml:para>The NetId address of the Target system</maml:para> </maml:description> <command:parameterValue required="true">AmsNetId</command:parameterValue> <dev:type> <maml:name>TwinCAT.Ads.AmsNetId</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Route --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named" aliases="Destination"> <maml:name>Route</maml:name> <maml:description> <maml:para>Specifies the route of the target system.</maml:para> </maml:description> <command:parameterValue required="true">IRoute</command:parameterValue> <dev:type> <maml:name>TwinCAT.IRoute</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" globbing="false" pipelineInput="false" position="named" aliases="Destination"> <maml:name>Destination</maml:name> <maml:description> <maml:para>Specifies the route of the target system.</maml:para> <maml:para>This is an alias of the Route parameter.</maml:para> </maml:description> <command:parameterValue required="true">IRoute</command:parameterValue> <dev:type> <maml:name>TwinCAT.IRoute</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Address --> <command:parameter required="true" globbing="true" pipelineInput="false" position="named"> <maml:name>Address</maml:name> <maml:description> <maml:para>The Address of the target system where to register the symbol handle. The Address can consist of RouteName, NetId, IPAddress or HostName. Wildcards are permitted.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Session --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="named"> <maml:name>Session</maml:name> <maml:description> <maml:para>The Session to use (instead of addressing the target system).</maml:para> </maml:description> <command:parameterValue required="true">ISession</command:parameterValue> <dev:type> <maml:name>TwinCAT.ISession</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: SessionId --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>SessionId</maml:name> <maml:description> <maml:para>Specifies the Session (with unique ID) to use instead of specifying the target address.</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>-1</dev:defaultValue> </command:parameter> <!-- Parameter: Port --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Port</maml:name> <maml:description> <maml:para>The address Port to use (always in combination with the NetId). ArgumentCompleter is supported.</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>10000</dev:defaultValue> </command:parameter> <!-- Parameter: Path --> <command:parameter required="true" globbing="true" pipelineInput="false" position="1"> <maml:name>Path</maml:name> <maml:description> <maml:para>The instance path to the symbol.</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: InputObject --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="1" aliases="Symbol"> <maml:name>InputObject</maml:name> <maml:description> <maml:para>The symbol object.</maml:para> </maml:description> <command:parameterValue required="true">ISymbol[]</command:parameterValue> <dev:type> <maml:name>TwinCAT.TypeSystem.ISymbol[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="1" aliases="Symbol"> <maml:name>Symbol</maml:name> <maml:description> <maml:para>The symbol object.</maml:para> <maml:para>This is an alias of the InputObject parameter.</maml:para> </maml:description> <command:parameterValue required="true">ISymbol[]</command:parameterValue> <dev:type> <maml:name>TwinCAT.TypeSystem.ISymbol[]</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>TwinCAT.ISession</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>The Session to use (instead of addressing the target system).</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>TwinCAT.TypeSystem.ISymbol[]</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>The symbol object.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>PS> $session = New-TcSession -NetId '1.2.3.4.5.6' -Port 851 PS> $handleInfo = $session | Register-AdsHandle -Path 'TwinCAT_SystemInfoVarList._AppInfo.ProjectName' PS> $handleInfo = Register-AdsHandle -Path 'TwinCAT_SystemInfoVarList._AppInfo.ProjectName' -Session $s PS> $handleInfo InstancePath Result Handle ------------ ------ ------ TwinCAT_SystemInfoVarList._AppInfo.ProjectName NoError 0x428000FC (1115685116) PS> Read-TcValue -Session $session -IndexGroup SymbolValueByHandle -IndexOffset $handleInfo.Handle -Type String MyProject PS> $handle | Unregister-AdsHandle -Session $session PS> $session | Close-tcsession</dev:code> <dev:remarks> <maml:para>Opens a new device session, registers a Symbol Handle to the ProjectName of the running PLC Project, Reads the value by handle unregisters the handle and closes the session again.</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <!-- Cmdlet: Unregister-AdsHandle --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Unregister-AdsHandle</command:name> <command:verb>Unregister</command:verb> <command:noun>AdsHandle</command:noun> <maml:description> <maml:para>Unregisters a symbol handle.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>This Cmdlet unregisters an already registered symbol handle from the target system. The Cmdlet supports raw [uint] handles or AdsHandleInfo objects.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: NetIdPortHandle --> <command:syntaxItem> <maml:name>Unregister-AdsHandle</maml:name> <!-- Parameter: Handle --> <command:parameter required="true" globbing="true" pipelineInput="false" position="1"> <maml:name>Handle</maml:name> <maml:description> <maml:para>The instance path of the symbol to read (symbolic access). This parameter supports wildcards.</maml:para> </maml:description> <command:parameterValue required="true">uint[]</command:parameterValue> <dev:type> <maml:name>System.UInt32[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Port --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Port</maml:name> <maml:description> <maml:para>The address Port to use. ClearText names for the Port and ArgumentCompleter are supported.</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>10000</dev:defaultValue> </command:parameter> <!-- Parameter: NetId --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>NetId</maml:name> <maml:description> <maml:para>The NetId part of the device target address.</maml:para> </maml:description> <command:parameterValue required="true">AmsNetId</command:parameterValue> <dev:type> <maml:name>TwinCAT.Ads.AmsNetId</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> <!-- Parameter set: NetIdPortInfo --> <command:syntaxItem> <maml:name>Unregister-AdsHandle</maml:name> <!-- Parameter: InputObject --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="1" aliases="HandleInfo"> <maml:name>InputObject</maml:name> <maml:description> <maml:para>The AdsHandleInfo object (produced by Register-AdsHandle Cmdlet)</maml:para> </maml:description> <command:parameterValue required="true">AdsHandleInfo[]</command:parameterValue> <dev:type> <maml:name>TwinCAT.Management.Automation.AdsHandleInfo[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Port --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Port</maml:name> <maml:description> <maml:para>The address Port to use. ClearText names for the Port and ArgumentCompleter are supported.</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>10000</dev:defaultValue> </command:parameter> <!-- Parameter: NetId --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>NetId</maml:name> <maml:description> <maml:para>The NetId part of the device target address.</maml:para> </maml:description> <command:parameterValue required="true">AmsNetId</command:parameterValue> <dev:type> <maml:name>TwinCAT.Ads.AmsNetId</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> <!-- Parameter set: RouteHandle --> <command:syntaxItem> <maml:name>Unregister-AdsHandle</maml:name> <!-- Parameter: Handle --> <command:parameter required="true" globbing="true" pipelineInput="false" position="1"> <maml:name>Handle</maml:name> <maml:description> <maml:para>The instance path of the symbol to read (symbolic access). This parameter supports wildcards.</maml:para> </maml:description> <command:parameterValue required="true">uint[]</command:parameterValue> <dev:type> <maml:name>System.UInt32[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Port --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Port</maml:name> <maml:description> <maml:para>The address Port to use. ClearText names for the Port and ArgumentCompleter are supported.</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>10000</dev:defaultValue> </command:parameter> <!-- Parameter: Route --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named" aliases="Destination"> <maml:name>Route</maml:name> <maml:description> <maml:para>Specifies the target system.</maml:para> </maml:description> <command:parameterValue required="true">IRoute</command:parameterValue> <dev:type> <maml:name>TwinCAT.IRoute</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> <!-- Parameter set: RouteInfo --> <command:syntaxItem> <maml:name>Unregister-AdsHandle</maml:name> <!-- Parameter: InputObject --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="1" aliases="HandleInfo"> <maml:name>InputObject</maml:name> <maml:description> <maml:para>The AdsHandleInfo object (produced by Register-AdsHandle Cmdlet)</maml:para> </maml:description> <command:parameterValue required="true">AdsHandleInfo[]</command:parameterValue> <dev:type> <maml:name>TwinCAT.Management.Automation.AdsHandleInfo[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Port --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Port</maml:name> <maml:description> <maml:para>The address Port to use. ClearText names for the Port and ArgumentCompleter are supported.</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>10000</dev:defaultValue> </command:parameter> <!-- Parameter: Route --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named" aliases="Destination"> <maml:name>Route</maml:name> <maml:description> <maml:para>Specifies the target system.</maml:para> </maml:description> <command:parameterValue required="true">IRoute</command:parameterValue> <dev:type> <maml:name>TwinCAT.IRoute</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> <!-- Parameter set: AddressHandle --> <command:syntaxItem> <maml:name>Unregister-AdsHandle</maml:name> <!-- Parameter: Handle --> <command:parameter required="true" globbing="true" pipelineInput="false" position="1"> <maml:name>Handle</maml:name> <maml:description> <maml:para>The instance path of the symbol to read (symbolic access). This parameter supports wildcards.</maml:para> </maml:description> <command:parameterValue required="true">uint[]</command:parameterValue> <dev:type> <maml:name>System.UInt32[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Address --> <command:parameter required="true" globbing="true" pipelineInput="false" position="named"> <maml:name>Address</maml:name> <maml:description> <maml:para>The target address of the system. The Address can consist of RouteName, NetId, IPAddress or HostName. Wildcards are permitted and ArgumentCompleter is supported.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Port --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Port</maml:name> <maml:description> <maml:para>The address Port to use. ClearText names for the Port and ArgumentCompleter are supported.</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>10000</dev:defaultValue> </command:parameter> </command:syntaxItem> <!-- Parameter set: AddressInfo --> <command:syntaxItem> <maml:name>Unregister-AdsHandle</maml:name> <!-- Parameter: InputObject --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="1" aliases="HandleInfo"> <maml:name>InputObject</maml:name> <maml:description> <maml:para>The AdsHandleInfo object (produced by Register-AdsHandle Cmdlet)</maml:para> </maml:description> <command:parameterValue required="true">AdsHandleInfo[]</command:parameterValue> <dev:type> <maml:name>TwinCAT.Management.Automation.AdsHandleInfo[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Address --> <command:parameter required="true" globbing="true" pipelineInput="false" position="named"> <maml:name>Address</maml:name> <maml:description> <maml:para>The target address of the system. The Address can consist of RouteName, NetId, IPAddress or HostName. Wildcards are permitted and ArgumentCompleter is supported.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Port --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Port</maml:name> <maml:description> <maml:para>The address Port to use. ClearText names for the Port and ArgumentCompleter are supported.</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>10000</dev:defaultValue> </command:parameter> </command:syntaxItem> <!-- Parameter set: SessionHandle --> <command:syntaxItem> <maml:name>Unregister-AdsHandle</maml:name> <!-- Parameter: Handle --> <command:parameter required="true" globbing="true" pipelineInput="false" position="1"> <maml:name>Handle</maml:name> <maml:description> <maml:para>The instance path of the symbol to read (symbolic access). This parameter supports wildcards.</maml:para> </maml:description> <command:parameterValue required="true">uint[]</command:parameterValue> <dev:type> <maml:name>System.UInt32[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Session --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="named"> <maml:name>Session</maml:name> <maml:description> <maml:para>The Session object (instead of specifieng the target system address).</maml:para> </maml:description> <command:parameterValue required="true">ISession</command:parameterValue> <dev:type> <maml:name>TwinCAT.ISession</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> <!-- Parameter set: SessionInfo --> <command:syntaxItem> <maml:name>Unregister-AdsHandle</maml:name> <!-- Parameter: InputObject --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="1" aliases="HandleInfo"> <maml:name>InputObject</maml:name> <maml:description> <maml:para>The AdsHandleInfo object (produced by Register-AdsHandle Cmdlet)</maml:para> </maml:description> <command:parameterValue required="true">AdsHandleInfo[]</command:parameterValue> <dev:type> <maml:name>TwinCAT.Management.Automation.AdsHandleInfo[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Session --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="named"> <maml:name>Session</maml:name> <maml:description> <maml:para>The Session object (instead of specifieng the target system address).</maml:para> </maml:description> <command:parameterValue required="true">ISession</command:parameterValue> <dev:type> <maml:name>TwinCAT.ISession</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> <!-- Parameter set: SessionIdHandle --> <command:syntaxItem> <maml:name>Unregister-AdsHandle</maml:name> <!-- Parameter: Handle --> <command:parameter required="true" globbing="true" pipelineInput="false" position="1"> <maml:name>Handle</maml:name> <maml:description> <maml:para>The instance path of the symbol to read (symbolic access). This parameter supports wildcards.</maml:para> </maml:description> <command:parameterValue required="true">uint[]</command:parameterValue> <dev:type> <maml:name>System.UInt32[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: SessionId --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>SessionId</maml:name> <maml:description> <maml:para>Specifies the Session (with unique ID) to use (instead of specifying the address).</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>-1</dev:defaultValue> </command:parameter> </command:syntaxItem> <!-- Parameter set: SessionIdInfo --> <command:syntaxItem> <maml:name>Unregister-AdsHandle</maml:name> <!-- Parameter: InputObject --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="1" aliases="HandleInfo"> <maml:name>InputObject</maml:name> <maml:description> <maml:para>The AdsHandleInfo object (produced by Register-AdsHandle Cmdlet)</maml:para> </maml:description> <command:parameterValue required="true">AdsHandleInfo[]</command:parameterValue> <dev:type> <maml:name>TwinCAT.Management.Automation.AdsHandleInfo[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: SessionId --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>SessionId</maml:name> <maml:description> <maml:para>Specifies the Session (with unique ID) to use (instead of specifying the address).</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>-1</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: NetId --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>NetId</maml:name> <maml:description> <maml:para>The NetId part of the device target address.</maml:para> </maml:description> <command:parameterValue required="true">AmsNetId</command:parameterValue> <dev:type> <maml:name>TwinCAT.Ads.AmsNetId</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Route --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named" aliases="Destination"> <maml:name>Route</maml:name> <maml:description> <maml:para>Specifies the target system.</maml:para> </maml:description> <command:parameterValue required="true">IRoute</command:parameterValue> <dev:type> <maml:name>TwinCAT.IRoute</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" globbing="false" pipelineInput="false" position="named" aliases="Destination"> <maml:name>Destination</maml:name> <maml:description> <maml:para>Specifies the target system.</maml:para> <maml:para>This is an alias of the Route parameter.</maml:para> </maml:description> <command:parameterValue required="true">IRoute</command:parameterValue> <dev:type> <maml:name>TwinCAT.IRoute</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Address --> <command:parameter required="true" globbing="true" pipelineInput="false" position="named"> <maml:name>Address</maml:name> <maml:description> <maml:para>The target address of the system. The Address can consist of RouteName, NetId, IPAddress or HostName. Wildcards are permitted and ArgumentCompleter is supported.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Session --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="named"> <maml:name>Session</maml:name> <maml:description> <maml:para>The Session object (instead of specifieng the target system address).</maml:para> </maml:description> <command:parameterValue required="true">ISession</command:parameterValue> <dev:type> <maml:name>TwinCAT.ISession</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: SessionId --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>SessionId</maml:name> <maml:description> <maml:para>Specifies the Session (with unique ID) to use (instead of specifying the address).</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>-1</dev:defaultValue> </command:parameter> <!-- Parameter: Port --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Port</maml:name> <maml:description> <maml:para>The address Port to use. ClearText names for the Port and ArgumentCompleter are supported.</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>10000</dev:defaultValue> </command:parameter> <!-- Parameter: Handle --> <command:parameter required="true" globbing="true" pipelineInput="false" position="1"> <maml:name>Handle</maml:name> <maml:description> <maml:para>The instance path of the symbol to read (symbolic access). This parameter supports wildcards.</maml:para> </maml:description> <command:parameterValue required="true">uint[]</command:parameterValue> <dev:type> <maml:name>System.UInt32[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: InputObject --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="1" aliases="HandleInfo"> <maml:name>InputObject</maml:name> <maml:description> <maml:para>The AdsHandleInfo object (produced by Register-AdsHandle Cmdlet)</maml:para> </maml:description> <command:parameterValue required="true">AdsHandleInfo[]</command:parameterValue> <dev:type> <maml:name>TwinCAT.Management.Automation.AdsHandleInfo[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="1" aliases="HandleInfo"> <maml:name>HandleInfo</maml:name> <maml:description> <maml:para>The AdsHandleInfo object (produced by Register-AdsHandle Cmdlet)</maml:para> <maml:para>This is an alias of the InputObject parameter.</maml:para> </maml:description> <command:parameterValue required="true">AdsHandleInfo[]</command:parameterValue> <dev:type> <maml:name>TwinCAT.Management.Automation.AdsHandleInfo[]</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>TwinCAT.ISession</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>The Session object (instead of specifieng the target system address).</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>TwinCAT.Management.Automation.AdsHandleInfo[]</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>The AdsHandleInfo object (produced by Register-AdsHandle Cmdlet)</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>PS> $session = New-TcSession -NetId '1.2.3.4.5.6' -Port 851 PS> $handleInfo = $session | Register-AdsHandle -Path 'TwinCAT_SystemInfoVarList._AppInfo.ProjectName' PS> $handleInfo = Register-AdsHandle -Path 'TwinCAT_SystemInfoVarList._AppInfo.ProjectName' -Session $s PS> $handleInfo InstancePath Result Handle ------------ ------ ------ TwinCAT_SystemInfoVarList._AppInfo.ProjectName NoError 0x428000FC (1115685116) PS> Read-TcValue -Session $session -IndexGroup SymbolValueByHandle -IndexOffset $handleInfo.Handle -Type String MyProject PS> $handle | Unregister-AdsHandle -Session $session PS> $session | Close-tcsession</dev:code> <dev:remarks> <maml:para>Opens a new device session, registers a Symbol Handle to the ProjectName of the running PLC Project, Reads the value by handle unregisters the handle and closes the session again.</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <!-- Cmdlet: Add-AdsNatRoute --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Add-AdsNatRoute</command:name> <command:verb>Add</command:verb> <command:noun>AdsNatRoute</command:noun> <maml:description> <maml:para>Adds an AmsNAT Route to the destination system (obsolete).</maml:para> </maml:description> </command:details> <maml:description> <maml:para>This Cmdlet adds an AmsNAT Route to the destination system. It writes just the specified content to the StaticRoutes.xml and needs a TwinCAT Restart afterwards. Please be aware that the Route is not added bidirectionally. For TwinCAT Versions >= 3.1.4024.11 (or newer), the Add-AdsRoute Cmdlet should be used with the -NAT Parameter as Replacement. Therefore, this 'Add-AdsNatRoute' Cmdlet is classified as 'obsolete' and of limitied use and could be removed in future.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Add-AdsNatRoute</maml:name> <!-- Parameter: Name --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>Name</maml:name> <maml:description> <maml:para>The Name of the AmsNAT Route to add.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Address --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Address</maml:name> <maml:description> <maml:para>The Address of the system to be added as route. This can be an IPAddress or HostName.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: NATNetId --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>NATNetId</maml:name> <maml:description> <maml:para>The NATNetId. This is the NetID that is used as NetId Translation on the local/destination system.</maml:para> </maml:description> <command:parameterValue required="true">AmsNetId</command:parameterValue> <dev:type> <maml:name>TwinCAT.Ads.AmsNetId</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: NetId --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>NetId</maml:name> <maml:description> <maml:para>The NetId of the system to be added as Route. This will be the RemoteNetId.</maml:para> </maml:description> <command:parameterValue required="true">AmsNetId</command:parameterValue> <dev:type> <maml:name>TwinCAT.Ads.AmsNetId</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Destination --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Destination</maml:name> <maml:description> <maml:para>The Destination Address, where the AmsNAT Route is added. This Parameter allows RouteName, AmsNetId, IPAddress or HostName</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <!-- Parameter: Force --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para>Forces the command (no confirmation, Resets the FailFastHandler)</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Quiet --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="Silent"> <maml:name>Quiet</maml:name> <maml:description> <maml:para>The Quiet parameter suppresses the 'ShouldProcess' message and the Cmdlet will be processed without further user confirmation.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Name --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>Name</maml:name> <maml:description> <maml:para>The Name of the AmsNAT Route to add.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Address --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Address</maml:name> <maml:description> <maml:para>The Address of the system to be added as route. This can be an IPAddress or HostName.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: NetId --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>NetId</maml:name> <maml:description> <maml:para>The NetId of the system to be added as Route. This will be the RemoteNetId.</maml:para> </maml:description> <command:parameterValue required="true">AmsNetId</command:parameterValue> <dev:type> <maml:name>TwinCAT.Ads.AmsNetId</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: NATNetId --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>NATNetId</maml:name> <maml:description> <maml:para>The NATNetId. This is the NetID that is used as NetId Translation on the local/destination system.</maml:para> </maml:description> <command:parameterValue required="true">AmsNetId</command:parameterValue> <dev:type> <maml:name>TwinCAT.Ads.AmsNetId</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Destination --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Destination</maml:name> <maml:description> <maml:para>The Destination Address, where the AmsNAT Route is added. This Parameter allows RouteName, AmsNetId, IPAddress or HostName</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <!-- Parameter: Quiet --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="Silent"> <maml:name>Quiet</maml:name> <maml:description> <maml:para>The Quiet parameter suppresses the 'ShouldProcess' message and the Cmdlet will be processed without further user confirmation.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="Silent"> <maml:name>Silent</maml:name> <maml:description> <maml:para>The Quiet parameter suppresses the 'ShouldProcess' message and the Cmdlet will be processed without further user confirmation.</maml:para> <maml:para>This is an alias of the Quiet parameter.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Force --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para>Forces the command (no confirmation, Resets the FailFastHandler)</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>PS> Add-AdsNatRoute -Name MyRoute -NetId 1.2.3.4.1.1 -Address 1.2.3.4 -NATNetId 1.2.3.4.2.2 </dev:code> <dev:remarks> <maml:para>Adds a Route 'MyRoute' with RemoteNetId '1.2.3.4.1.1' and IPAddress '1.2.3.4' with AmsNAT translation '1.2.3.4.2.2' to the local system.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 2 ----------</maml:title> <dev:code>PS> Add-AdsNatRoute -Name Client01 -NetId 1.2.3.4.1.1 -Address Client01 -NATNetId 1.2.3.4.2.2 -Destination CX_1234</dev:code> <dev:remarks> <maml:para>Adds a Route 'Client01' with RemoteNetId '1.2.3.4.1.1' and DnsName 'Client01' to 'CX_1234' with AmsNAT translation '1.2.3.4.2.2'.</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <!-- Cmdlet: Register-AdsNatRoute --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Register-AdsNatRoute</command:name> <command:verb>Register</command:verb> <command:noun>AdsNatRoute</command:noun> <maml:description> <maml:para>Changes an standard Route to an AmsNAT route on the target system (obsolete).</maml:para> </maml:description> </command:details> <maml:description> <maml:para>This Cmdlet Changes an standard Route to an AmsNAT route on the target system. The route must be preexisting and the cmdlet adds the RemoteNetId/AmsNAT information to the StaticRoutes.xml of the destination system. Afterwards the destination system needs a TwinCAT Restart. For TwinCAT Versions >= 3.1.4024.11 (or newer), the Add-AdsRoute Cmdlet should be used with the -NAT Parameter as Replacement. Therefore, this 'Register-AdsNatRoute' Cmdlet is classified as 'obsolete' and of limitied use and could be removed in future.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: Name --> <command:syntaxItem> <maml:name>Register-AdsNatRoute</maml:name> <!-- Parameter: Name --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>Name</maml:name> <maml:description> <maml:para>The Name of the Route where to add an AmsNAT entry.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: NATNetId --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>NATNetId</maml:name> <maml:description> <maml:para>The NATNetId (the local representation of the remote system).</maml:para> </maml:description> <command:parameterValue required="true">AmsNetId</command:parameterValue> <dev:type> <maml:name>TwinCAT.Ads.AmsNetId</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Destination --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Destination</maml:name> <maml:description> <maml:para>The Destination system, where the AmsNAT translation is added. This Parameter allows RouteName, AmsNetId, IPAddress or HostName</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <!-- Parameter: Force --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para>Forces the command (no confirmation, Resets the FailFastHandler)</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Quiet --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="Silent"> <maml:name>Quiet</maml:name> <maml:description> <maml:para>The Quiet parameter suppresses the 'ShouldProcess' messsage and the Cmdlet will be processed without further user confirmation.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> <!-- Parameter set: NetId --> <command:syntaxItem> <maml:name>Register-AdsNatRoute</maml:name> <!-- Parameter: NetId --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>NetId</maml:name> <maml:description> <maml:para>The NetID which specifies the existing route where to add an AmsNAT entry. This NetId becomes the 'RemoteNetId' afterwards.</maml:para> </maml:description> <command:parameterValue required="true">AmsNetId</command:parameterValue> <dev:type> <maml:name>TwinCAT.Ads.AmsNetId</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: NATNetId --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>NATNetId</maml:name> <maml:description> <maml:para>The NATNetId (the local representation of the remote system).</maml:para> </maml:description> <command:parameterValue required="true">AmsNetId</command:parameterValue> <dev:type> <maml:name>TwinCAT.Ads.AmsNetId</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Destination --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Destination</maml:name> <maml:description> <maml:para>The Destination system, where the AmsNAT translation is added. This Parameter allows RouteName, AmsNetId, IPAddress or HostName</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <!-- Parameter: Force --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para>Forces the command (no confirmation, Resets the FailFastHandler)</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Quiet --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="Silent"> <maml:name>Quiet</maml:name> <maml:description> <maml:para>The Quiet parameter suppresses the 'ShouldProcess' messsage and the Cmdlet will be processed without further user confirmation.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Name --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>Name</maml:name> <maml:description> <maml:para>The Name of the Route where to add an AmsNAT entry.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: NetId --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>NetId</maml:name> <maml:description> <maml:para>The NetID which specifies the existing route where to add an AmsNAT entry. This NetId becomes the 'RemoteNetId' afterwards.</maml:para> </maml:description> <command:parameterValue required="true">AmsNetId</command:parameterValue> <dev:type> <maml:name>TwinCAT.Ads.AmsNetId</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: NATNetId --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>NATNetId</maml:name> <maml:description> <maml:para>The NATNetId (the local representation of the remote system).</maml:para> </maml:description> <command:parameterValue required="true">AmsNetId</command:parameterValue> <dev:type> <maml:name>TwinCAT.Ads.AmsNetId</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Destination --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Destination</maml:name> <maml:description> <maml:para>The Destination system, where the AmsNAT translation is added. This Parameter allows RouteName, AmsNetId, IPAddress or HostName</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <!-- Parameter: Quiet --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="Silent"> <maml:name>Quiet</maml:name> <maml:description> <maml:para>The Quiet parameter suppresses the 'ShouldProcess' messsage and the Cmdlet will be processed without further user confirmation.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="Silent"> <maml:name>Silent</maml:name> <maml:description> <maml:para>The Quiet parameter suppresses the 'ShouldProcess' messsage and the Cmdlet will be processed without further user confirmation.</maml:para> <maml:para>This is an alias of the Quiet parameter.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Force --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para>Forces the command (no confirmation, Resets the FailFastHandler)</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>PS> Register-AdsNatRoute -Name MyRoute -NATNetId 1.2.3.4.2.2 </dev:code> <dev:remarks> <maml:para>Adds an AmsNAT address translation to the existing route 'MyRoute' on the local system (e.g. from '1.2.3.4.1.1' to '1.2.3.4.2.2').</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 2 ----------</maml:title> <dev:code>PS> Register-AdsNatRoute -NetId 1.2.3.4.1.1 -NATNetId 1.2.3.4.2.2 -Destination CX_1234</dev:code> <dev:remarks> <maml:para>Adds an AmsNAT address translation to the existing route with NetId '1.2.3.4.1.1' to NATNetId '1.2.3.4.2.2' on System 'CX_1234'.</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <!-- Cmdlet: Remove-AdsNatRoute --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Remove-AdsNatRoute</command:name> <command:verb>Remove</command:verb> <command:noun>AdsNatRoute</command:noun> <maml:description> <maml:para>Removes an AmsNAT Route from the destination system (obsolete).</maml:para> </maml:description> </command:details> <maml:description> <maml:para>This Cmdlet removes an AmsNAT Route from the destination system. It edits just the specified content of the destination system StaticRoutes.xml and needs a TwinCAT Restart. afterwards. Please be aware that the Route is not removed bidirectionally. This 'Remove-AdsNatRoute' Cmdlet is classified as 'obsolete' and of limitied use and could be removed in future. Please use the Remove-AdsRoute Cmdlet instead.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: Name --> <command:syntaxItem> <maml:name>Remove-AdsNatRoute</maml:name> <!-- Parameter: Name --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>Name</maml:name> <maml:description> <maml:para>The Name of the AmsNAT route to remove.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Destination --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Destination</maml:name> <maml:description> <maml:para>The destination address, where to Remove the specified MQTT route. This can be the NetId, the HostName or the IPAddress.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <!-- Parameter: Force --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para>Forces the command (no confirmation, Resets the FailFastHandler)</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Quiet --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="Silent"> <maml:name>Quiet</maml:name> <maml:description> <maml:para>The Quiet parameter suppresses the 'ShouldProcess' messsage and the Cmdlet will be processed without further user confirmation.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> <!-- Parameter set: Address --> <command:syntaxItem> <maml:name>Remove-AdsNatRoute</maml:name> <!-- Parameter: Address --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>Address</maml:name> <maml:description> <maml:para>The Address of the AmsNAT route to delete. This can be the IPAddress or the Dns HostName of the route system.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Destination --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Destination</maml:name> <maml:description> <maml:para>The destination address, where to Remove the specified MQTT route. This can be the NetId, the HostName or the IPAddress.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <!-- Parameter: Force --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para>Forces the command (no confirmation, Resets the FailFastHandler)</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Quiet --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="Silent"> <maml:name>Quiet</maml:name> <maml:description> <maml:para>The Quiet parameter suppresses the 'ShouldProcess' messsage and the Cmdlet will be processed without further user confirmation.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> <!-- Parameter set: NetId --> <command:syntaxItem> <maml:name>Remove-AdsNatRoute</maml:name> <!-- Parameter: NATNetId --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>NATNetId</maml:name> <maml:description> <maml:para>The AmsNAT NetId (translation NetID) of the route to remove.</maml:para> </maml:description> <command:parameterValue required="true">AmsNetId</command:parameterValue> <dev:type> <maml:name>TwinCAT.Ads.AmsNetId</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Destination --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Destination</maml:name> <maml:description> <maml:para>The destination address, where to Remove the specified MQTT route. This can be the NetId, the HostName or the IPAddress.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <!-- Parameter: Force --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para>Forces the command (no confirmation, Resets the FailFastHandler)</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Quiet --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="Silent"> <maml:name>Quiet</maml:name> <maml:description> <maml:para>The Quiet parameter suppresses the 'ShouldProcess' messsage and the Cmdlet will be processed without further user confirmation.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Name --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>Name</maml:name> <maml:description> <maml:para>The Name of the AmsNAT route to remove.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Address --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>Address</maml:name> <maml:description> <maml:para>The Address of the AmsNAT route to delete. This can be the IPAddress or the Dns HostName of the route system.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: NATNetId --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>NATNetId</maml:name> <maml:description> <maml:para>The AmsNAT NetId (translation NetID) of the route to remove.</maml:para> </maml:description> <command:parameterValue required="true">AmsNetId</command:parameterValue> <dev:type> <maml:name>TwinCAT.Ads.AmsNetId</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Destination --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Destination</maml:name> <maml:description> <maml:para>The destination address, where to Remove the specified MQTT route. This can be the NetId, the HostName or the IPAddress.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <!-- Parameter: Quiet --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="Silent"> <maml:name>Quiet</maml:name> <maml:description> <maml:para>The Quiet parameter suppresses the 'ShouldProcess' messsage and the Cmdlet will be processed without further user confirmation.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="Silent"> <maml:name>Silent</maml:name> <maml:description> <maml:para>The Quiet parameter suppresses the 'ShouldProcess' messsage and the Cmdlet will be processed without further user confirmation.</maml:para> <maml:para>This is an alias of the Quiet parameter.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Force --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para>Forces the command (no confirmation, Resets the FailFastHandler)</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>PS> Remove-AdsNatRoute -Name MyRoute </dev:code> <dev:remarks> <maml:para>Removes the AmsNAT route 'MyRoute' from the local system.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 2 ----------</maml:title> <dev:code>PS> Remove-AdsNatRoute -NATNetId 1.2.3.4.2.2 -Destination CX_1234</dev:code> <dev:remarks> <maml:para>Removes the AmsNAT Route with Translation NetId '1.2.3.4.2.2' from the system 'CX_1234'</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <!-- Cmdlet: Start-AdsProcess --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Start-AdsProcess</command:name> <command:verb>Start</command:verb> <command:noun>AdsProcess</command:noun> <maml:description> <maml:para>Start a process via ADS on the target system.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>This Cmdlet starts a processs on the Target system.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: NetIdPort --> <command:syntaxItem> <maml:name>Start-AdsProcess</maml:name> <!-- Parameter: NetId --> <command:parameter required="false" globbing="false" pipelineInput="false" position="1"> <maml:name>NetId</maml:name> <maml:description> <maml:para>NetId(s) of the target system.</maml:para> </maml:description> <command:parameterValue required="true">AmsNetId[]</command:parameterValue> <dev:type> <maml:name>TwinCAT.Ads.AmsNetId[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: FilePath --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>FilePath</maml:name> <maml:description> <maml:para>Path to the executable of the target system.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <!-- Parameter: ArgumentList --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ArgumentList</maml:name> <maml:description> <maml:para>Specifies parameters or parameter values to use when this cmdlet starts the process. Arguments can be accepted as a single string with the arguments separated by spaces, or as an array of strings separated by commas. The cmdlet joins the array into a single string with each element of the array separated by a single space.</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Force --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para>Force reading value. This flag bypasses the FailFastInterceptor to retry communication in every case.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Timeout --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Timeout</maml:name> <maml:description> <maml:para>The communication ADS timeout in milliseconds. A value of 0 disables the timeout. A value <= 0 sets the Default (5000 ms).</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>-1</dev:defaultValue> </command:parameter> <!-- Parameter: WorkingDir --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>WorkingDir</maml:name> <maml:description> <maml:para>The working directory on the target system</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:syntaxItem> <!-- Parameter set: Route --> <command:syntaxItem> <maml:name>Start-AdsProcess</maml:name> <!-- Parameter: InputObject --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="1" aliases="Destination,Route"> <maml:name>InputObject</maml:name> <maml:description> <maml:para>The route object where to get the Target information from..</maml:para> </maml:description> <command:parameterValue required="true">IRoute[]</command:parameterValue> <dev:type> <maml:name>TwinCAT.IRoute[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: FilePath --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>FilePath</maml:name> <maml:description> <maml:para>Path to the executable of the target system.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <!-- Parameter: ArgumentList --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ArgumentList</maml:name> <maml:description> <maml:para>Specifies parameters or parameter values to use when this cmdlet starts the process. Arguments can be accepted as a single string with the arguments separated by spaces, or as an array of strings separated by commas. The cmdlet joins the array into a single string with each element of the array separated by a single space.</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Force --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para>Force reading value. This flag bypasses the FailFastInterceptor to retry communication in every case.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Timeout --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Timeout</maml:name> <maml:description> <maml:para>The communication ADS timeout in milliseconds. A value of 0 disables the timeout. A value <= 0 sets the Default (5000 ms).</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>-1</dev:defaultValue> </command:parameter> <!-- Parameter: WorkingDir --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>WorkingDir</maml:name> <maml:description> <maml:para>The working directory on the target system</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:syntaxItem> <!-- Parameter set: AddressStr --> <command:syntaxItem> <maml:name>Start-AdsProcess</maml:name> <!-- Parameter: Address --> <command:parameter required="true" globbing="true" pipelineInput="false" position="1" aliases="Name"> <maml:name>Address</maml:name> <maml:description> <maml:para>Target names/addresses. These can consist of RouteName, NetID, HostName or IPAddress. Wildcards are permitted.</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: FilePath --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>FilePath</maml:name> <maml:description> <maml:para>Path to the executable of the target system.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <!-- Parameter: ArgumentList --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ArgumentList</maml:name> <maml:description> <maml:para>Specifies parameters or parameter values to use when this cmdlet starts the process. Arguments can be accepted as a single string with the arguments separated by spaces, or as an array of strings separated by commas. The cmdlet joins the array into a single string with each element of the array separated by a single space.</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Force --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para>Force reading value. This flag bypasses the FailFastInterceptor to retry communication in every case.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Timeout --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Timeout</maml:name> <maml:description> <maml:para>The communication ADS timeout in milliseconds. A value of 0 disables the timeout. A value <= 0 sets the Default (5000 ms).</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>-1</dev:defaultValue> </command:parameter> <!-- Parameter: WorkingDir --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>WorkingDir</maml:name> <maml:description> <maml:para>The working directory on the target system</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:syntaxItem> <!-- Parameter set: Session --> <command:syntaxItem> <maml:name>Start-AdsProcess</maml:name> <!-- Parameter: FilePath --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>FilePath</maml:name> <maml:description> <maml:para>Path to the executable of the target system.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <!-- Parameter: Session --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>Session</maml:name> <maml:description> <maml:para>The Session to use for the value read.</maml:para> </maml:description> <command:parameterValue required="true">ISession[]</command:parameterValue> <dev:type> <maml:name>TwinCAT.ISession[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ArgumentList --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ArgumentList</maml:name> <maml:description> <maml:para>Specifies parameters or parameter values to use when this cmdlet starts the process. Arguments can be accepted as a single string with the arguments separated by spaces, or as an array of strings separated by commas. The cmdlet joins the array into a single string with each element of the array separated by a single space.</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Force --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para>Force reading value. This flag bypasses the FailFastInterceptor to retry communication in every case.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Timeout --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Timeout</maml:name> <maml:description> <maml:para>The communication ADS timeout in milliseconds. A value of 0 disables the timeout. A value <= 0 sets the Default (5000 ms).</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>-1</dev:defaultValue> </command:parameter> <!-- Parameter: WorkingDir --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>WorkingDir</maml:name> <maml:description> <maml:para>The working directory on the target system</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:syntaxItem> <!-- Parameter set: SessionId --> <command:syntaxItem> <maml:name>Start-AdsProcess</maml:name> <!-- Parameter: FilePath --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>FilePath</maml:name> <maml:description> <maml:para>Path to the executable of the target system.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <!-- Parameter: SessionId --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>SessionId</maml:name> <maml:description> <maml:para>Specifies the Session (with unique ID) to use for the value read.</maml:para> </maml:description> <command:parameterValue required="true">int[]</command:parameterValue> <dev:type> <maml:name>System.Int32[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ArgumentList --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ArgumentList</maml:name> <maml:description> <maml:para>Specifies parameters or parameter values to use when this cmdlet starts the process. Arguments can be accepted as a single string with the arguments separated by spaces, or as an array of strings separated by commas. The cmdlet joins the array into a single string with each element of the array separated by a single space.</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Force --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para>Force reading value. This flag bypasses the FailFastInterceptor to retry communication in every case.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Timeout --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Timeout</maml:name> <maml:description> <maml:para>The communication ADS timeout in milliseconds. A value of 0 disables the timeout. A value <= 0 sets the Default (5000 ms).</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>-1</dev:defaultValue> </command:parameter> <!-- Parameter: WorkingDir --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>WorkingDir</maml:name> <maml:description> <maml:para>The working directory on the target system</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: NetId --> <command:parameter required="false" globbing="false" pipelineInput="false" position="1"> <maml:name>NetId</maml:name> <maml:description> <maml:para>NetId(s) of the target system.</maml:para> </maml:description> <command:parameterValue required="true">AmsNetId[]</command:parameterValue> <dev:type> <maml:name>TwinCAT.Ads.AmsNetId[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: InputObject --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="1" aliases="Destination,Route"> <maml:name>InputObject</maml:name> <maml:description> <maml:para>The route object where to get the Target information from..</maml:para> </maml:description> <command:parameterValue required="true">IRoute[]</command:parameterValue> <dev:type> <maml:name>TwinCAT.IRoute[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="1" aliases="Destination,Route"> <maml:name>Destination</maml:name> <maml:description> <maml:para>The route object where to get the Target information from..</maml:para> <maml:para>This is an alias of the InputObject parameter.</maml:para> </maml:description> <command:parameterValue required="true">IRoute[]</command:parameterValue> <dev:type> <maml:name>TwinCAT.IRoute[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="1" aliases="Destination,Route"> <maml:name>Route</maml:name> <maml:description> <maml:para>The route object where to get the Target information from..</maml:para> <maml:para>This is an alias of the InputObject parameter.</maml:para> </maml:description> <command:parameterValue required="true">IRoute[]</command:parameterValue> <dev:type> <maml:name>TwinCAT.IRoute[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Address --> <command:parameter required="true" globbing="true" pipelineInput="false" position="1" aliases="Name"> <maml:name>Address</maml:name> <maml:description> <maml:para>Target names/addresses. These can consist of RouteName, NetID, HostName or IPAddress. Wildcards are permitted.</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" globbing="true" pipelineInput="false" position="1" aliases="Name"> <maml:name>Name</maml:name> <maml:description> <maml:para>Target names/addresses. These can consist of RouteName, NetID, HostName or IPAddress. Wildcards are permitted.</maml:para> <maml:para>This is an alias of the Address parameter.</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Session --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>Session</maml:name> <maml:description> <maml:para>The Session to use for the value read.</maml:para> </maml:description> <command:parameterValue required="true">ISession[]</command:parameterValue> <dev:type> <maml:name>TwinCAT.ISession[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: SessionId --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>SessionId</maml:name> <maml:description> <maml:para>Specifies the Session (with unique ID) to use for the value read.</maml:para> </maml:description> <command:parameterValue required="true">int[]</command:parameterValue> <dev:type> <maml:name>System.Int32[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: FilePath --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>FilePath</maml:name> <maml:description> <maml:para>Path to the executable of the target system.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <!-- Parameter: ArgumentList --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ArgumentList</maml:name> <maml:description> <maml:para>Specifies parameters or parameter values to use when this cmdlet starts the process. Arguments can be accepted as a single string with the arguments separated by spaces, or as an array of strings separated by commas. The cmdlet joins the array into a single string with each element of the array separated by a single space.</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: WorkingDir --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>WorkingDir</maml:name> <maml:description> <maml:para>The working directory on the target system</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <!-- Parameter: Timeout --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Timeout</maml:name> <maml:description> <maml:para>The communication ADS timeout in milliseconds. A value of 0 disables the timeout. A value <= 0 sets the Default (5000 ms).</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>-1</dev:defaultValue> </command:parameter> <!-- Parameter: Force --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para>Force reading value. This flag bypasses the FailFastInterceptor to retry communication in every case.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>TwinCAT.IRoute[]</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>The route object where to get the Target information from..</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>TwinCAT.ISession[]</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>The Session to use for the value read.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>PS> Start-AdsProcess -Address CX_1234 -path "notepad.exe"</dev:code> <dev:remarks> <maml:para>Starts the notepad.exe on the target system.</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <!-- Cmdlet: Add-AdsRoute --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Add-AdsRoute</command:name> <command:verb>Add</command:verb> <command:noun>AdsRoute</command:noun> <maml:description> <maml:para>Cmdlet for adding TwinCAT Routes.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Adds a Route to the destination target System (Temporary or statically). Dependant on the used parameters, this Cmdlet uses an internal broadcast search to determine the target system Addresses (NetId, HostName or IPAddress) to establish a full defined route. To find the specified target it is necessary that the target system is running/online and reachable from the local system. Another use case is to establish a route on the local system for preparation before the targeting system is available. In that case the full target address represented by the -NetID and -IPOrHostName parameter must be given, while leaving out the -Credential parameter.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: Address --> <command:syntaxItem> <maml:name>Add-AdsRoute</maml:name> <!-- Parameter: Address --> <command:parameter required="true" globbing="true" pipelineInput="false" position="0" aliases="TargetAddress"> <maml:name>Address</maml:name> <maml:description> <maml:para>The address for the ADS route. This can be the RouteName, NetId, the HostName or the IPAddress.</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: BroadcastTimeout --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>BroadcastTimeout</maml:name> <maml:description> <maml:para>(Broadcast) Search Timeout for searching the unregistered target in seconds (Default 0, Dynamic detection).</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <!-- Parameter: Credential --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="TargetCredential"> <maml:name>Credential</maml:name> <maml:description> <maml:para>Credentials of the route to be added to the destination system. This parameter is only necessary, when a bidirectional route will be added. When specifying</maml:para> <maml:para>IMPORTANT: Please be aware, that in the current version, tha password is transferred as clear text through the network. Use this only in safe subnetworks.</maml:para> </maml:description> <command:parameterValue required="true">PSCredential</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.PSCredential</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Destination --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Destination</maml:name> <maml:description> <maml:para>The Destination Address, where the route is added.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <!-- Parameter: DestinationCredential --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>DestinationCredential</maml:name> <maml:description> <maml:para>The credentials of the destination system, where to add the route. Local system by default.</maml:para> </maml:description> <command:parameterValue required="true">PSCredential</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.PSCredential</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Force --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para>Forces the command (no confirmation, Resets the FailFastHandler)</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: HostName --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>HostName</maml:name> <maml:description> <maml:para>If set, the route will be registered as HostName</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Name --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of the route(s) to add. If the Routes address is ambiguous and more than one route will be found online for adding then the route names will be numbered to be distinct. Without setting this parameter, the default route name will be its Computername / Hostname.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Nat --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Nat</maml:name> <maml:description> <maml:para>The 'Nat' parameter sets the local representation of the routes AmsNetId. All (local) addressing to this netId will be translated to the remote/network AmsAddress of the route. If using the '-Nat' parameter, the 'Add-AdsRoute' Cmdlet is limited to single route additions. Multi-adding is not supported. This Parameter can be used with TwinCAT Versions >= 3.1.4024.11.</maml:para> </maml:description> <command:parameterValue required="true">AmsNetId</command:parameterValue> <dev:type> <maml:name>TwinCAT.Ads.AmsNetId</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: PassThru --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>PassThru</maml:name> <maml:description> <maml:para>If the passthrough parameter is set, the successfully created route will be returned as object. By default, this Cmdlet will not create any output.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Quiet --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="Silent"> <maml:name>Quiet</maml:name> <maml:description> <maml:para>The Quiet parameter suppresses the 'ShouldProcess' messsage and the Cmdlet will be processed without further user confirmation.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: RemotePersistance --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>RemotePersistance</maml:name> <maml:description> <maml:para>The persistance type of the remmote route. None/Server means no remote route will be created. Other valid values are 'Static' or 'Temporary'</maml:para> <maml:para>Possible values: None, Server, Temporary, Static</maml:para> </maml:description> <command:parameterValue required="true">RoutePersistanceType</command:parameterValue> <dev:type> <maml:name>TwinCAT.RoutePersistanceType</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Static</dev:defaultValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">None</command:parameterValue> <command:parameterValue required="false" variableLength="false">Server</command:parameterValue> <command:parameterValue required="false" variableLength="false">Temporary</command:parameterValue> <command:parameterValue required="false" variableLength="false">Static</command:parameterValue> </command:parameterValueGroup> </command:parameter> <!-- Parameter: Temporary --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Temporary</maml:name> <maml:description> <maml:para>If set, the Route will be registered as temporary route.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Unidirectional --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Unidirectional</maml:name> <maml:description> <maml:para>Gets or sets the unidirectional setting. The Unidirectional setting registers the ADS Route as 'one-way' channel. That means that the engineering/source system (thats where the route request is initiated) can send requests to the remote target, but not in the opposite direction.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> <!-- Parameter set: AddressPSK --> <command:syntaxItem> <maml:name>Add-AdsRoute</maml:name> <!-- Parameter: Address --> <command:parameter required="true" globbing="true" pipelineInput="false" position="0" aliases="TargetAddress"> <maml:name>Address</maml:name> <maml:description> <maml:para>The address for the ADS route. This can be the RouteName, NetId, the HostName or the IPAddress.</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Credential --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named" aliases="TargetCredential"> <maml:name>Credential</maml:name> <maml:description> <maml:para>Credentials of the route to be added to the destination system. This parameter is only necessary, when a bidirectional route will be added. When specifying</maml:para> <maml:para>IMPORTANT: Please be aware, that in the current version, tha password is transferred as clear text through the network. Use this only in safe subnetworks.</maml:para> </maml:description> <command:parameterValue required="true">PSCredential</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.PSCredential</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: PreSharedKey --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named" aliases="PSK"> <maml:name>PreSharedKey</maml:name> <maml:description> <maml:para>Gets or sets the PreSharedKey (PSK) mode for adding the route. Because a valid certificate is expected at the target, it is not necessary to enter credentials.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: BroadcastTimeout --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>BroadcastTimeout</maml:name> <maml:description> <maml:para>(Broadcast) Search Timeout for searching the unregistered target in seconds (Default 0, Dynamic detection).</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <!-- Parameter: Destination --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Destination</maml:name> <maml:description> <maml:para>The Destination Address, where the route is added.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <!-- Parameter: DestinationCredential --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>DestinationCredential</maml:name> <maml:description> <maml:para>The credentials of the destination system, where to add the route. Local system by default.</maml:para> </maml:description> <command:parameterValue required="true">PSCredential</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.PSCredential</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Force --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para>Forces the command (no confirmation, Resets the FailFastHandler)</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: HostName --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>HostName</maml:name> <maml:description> <maml:para>If set, the route will be registered as HostName</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Name --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of the route(s) to add. If the Routes address is ambiguous and more than one route will be found online for adding then the route names will be numbered to be distinct. Without setting this parameter, the default route name will be its Computername / Hostname.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Nat --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Nat</maml:name> <maml:description> <maml:para>The 'Nat' parameter sets the local representation of the routes AmsNetId. All (local) addressing to this netId will be translated to the remote/network AmsAddress of the route. If using the '-Nat' parameter, the 'Add-AdsRoute' Cmdlet is limited to single route additions. Multi-adding is not supported. This Parameter can be used with TwinCAT Versions >= 3.1.4024.11.</maml:para> </maml:description> <command:parameterValue required="true">AmsNetId</command:parameterValue> <dev:type> <maml:name>TwinCAT.Ads.AmsNetId</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: PassThru --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>PassThru</maml:name> <maml:description> <maml:para>If the passthrough parameter is set, the successfully created route will be returned as object. By default, this Cmdlet will not create any output.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Quiet --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="Silent"> <maml:name>Quiet</maml:name> <maml:description> <maml:para>The Quiet parameter suppresses the 'ShouldProcess' messsage and the Cmdlet will be processed without further user confirmation.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Temporary --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Temporary</maml:name> <maml:description> <maml:para>If set, the Route will be registered as temporary route.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Unidirectional --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Unidirectional</maml:name> <maml:description> <maml:para>Gets or sets the unidirectional setting. The Unidirectional setting registers the ADS Route as 'one-way' channel. That means that the engineering/source system (thats where the route request is initiated) can send requests to the remote target, but not in the opposite direction.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> <!-- Parameter set: AddressPSKKey --> <command:syntaxItem> <maml:name>Add-AdsRoute</maml:name> <!-- Parameter: Address --> <command:parameter required="true" globbing="true" pipelineInput="false" position="0" aliases="TargetAddress"> <maml:name>Address</maml:name> <maml:description> <maml:para>The address for the ADS route. This can be the RouteName, NetId, the HostName or the IPAddress.</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: BinaryKey --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>BinaryKey</maml:name> <maml:description> <maml:para>The BinaryKey can be used instead of the credential Password on SecureSettings.PreSharedKeys (PSK). There is no function for this parameter on other security settings.</maml:para> </maml:description> <command:parameterValue required="true">byte[]</command:parameterValue> <dev:type> <maml:name>System.Byte[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Identity --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Identity</maml:name> <maml:description> <maml:para>The BinaryKey can be used instead of the credential Password on SecureSettings.PreSharedKeys (PSK). There is no function for this parameter on other security settings.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: PreSharedKey --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named" aliases="PSK"> <maml:name>PreSharedKey</maml:name> <maml:description> <maml:para>Gets or sets the PreSharedKey (PSK) mode for adding the route. Because a valid certificate is expected at the target, it is not necessary to enter credentials.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: BroadcastTimeout --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>BroadcastTimeout</maml:name> <maml:description> <maml:para>(Broadcast) Search Timeout for searching the unregistered target in seconds (Default 0, Dynamic detection).</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <!-- Parameter: Destination --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Destination</maml:name> <maml:description> <maml:para>The Destination Address, where the route is added.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <!-- Parameter: DestinationCredential --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>DestinationCredential</maml:name> <maml:description> <maml:para>The credentials of the destination system, where to add the route. Local system by default.</maml:para> </maml:description> <command:parameterValue required="true">PSCredential</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.PSCredential</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Force --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para>Forces the command (no confirmation, Resets the FailFastHandler)</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: HostName --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>HostName</maml:name> <maml:description> <maml:para>If set, the route will be registered as HostName</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Name --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of the route(s) to add. If the Routes address is ambiguous and more than one route will be found online for adding then the route names will be numbered to be distinct. Without setting this parameter, the default route name will be its Computername / Hostname.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Nat --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Nat</maml:name> <maml:description> <maml:para>The 'Nat' parameter sets the local representation of the routes AmsNetId. All (local) addressing to this netId will be translated to the remote/network AmsAddress of the route. If using the '-Nat' parameter, the 'Add-AdsRoute' Cmdlet is limited to single route additions. Multi-adding is not supported. This Parameter can be used with TwinCAT Versions >= 3.1.4024.11.</maml:para> </maml:description> <command:parameterValue required="true">AmsNetId</command:parameterValue> <dev:type> <maml:name>TwinCAT.Ads.AmsNetId</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: PassThru --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>PassThru</maml:name> <maml:description> <maml:para>If the passthrough parameter is set, the successfully created route will be returned as object. By default, this Cmdlet will not create any output.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Quiet --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="Silent"> <maml:name>Quiet</maml:name> <maml:description> <maml:para>The Quiet parameter suppresses the 'ShouldProcess' messsage and the Cmdlet will be processed without further user confirmation.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Temporary --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Temporary</maml:name> <maml:description> <maml:para>If set, the Route will be registered as temporary route.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Unidirectional --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Unidirectional</maml:name> <maml:description> <maml:para>Gets or sets the unidirectional setting. The Unidirectional setting registers the ADS Route as 'one-way' channel. That means that the engineering/source system (thats where the route request is initiated) can send requests to the remote target, but not in the opposite direction.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> <!-- Parameter set: AddressSCA --> <command:syntaxItem> <maml:name>Add-AdsRoute</maml:name> <!-- Parameter: Address --> <command:parameter required="true" globbing="true" pipelineInput="false" position="0" aliases="TargetAddress"> <maml:name>Address</maml:name> <maml:description> <maml:para>The address for the ADS route. This can be the RouteName, NetId, the HostName or the IPAddress.</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: SharedCertAuth --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named" aliases="SCA"> <maml:name>SharedCertAuth</maml:name> <maml:description> <maml:para>Gets or sets the SharedCertificateAuthority (SCA) mode for adding the route. Because a valid certificate is expected at the target, it is not necessary to enter credentials.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: BroadcastTimeout --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>BroadcastTimeout</maml:name> <maml:description> <maml:para>(Broadcast) Search Timeout for searching the unregistered target in seconds (Default 0, Dynamic detection).</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <!-- Parameter: Destination --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Destination</maml:name> <maml:description> <maml:para>The Destination Address, where the route is added.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <!-- Parameter: DestinationCredential --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>DestinationCredential</maml:name> <maml:description> <maml:para>The credentials of the destination system, where to add the route. Local system by default.</maml:para> </maml:description> <command:parameterValue required="true">PSCredential</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.PSCredential</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Force --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para>Forces the command (no confirmation, Resets the FailFastHandler)</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: HostName --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>HostName</maml:name> <maml:description> <maml:para>If set, the route will be registered as HostName</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: IgnoreCN --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>IgnoreCN</maml:name> <maml:description> <maml:para>Gets or sets the 'Ignore Common Name' mode for SharedCertificateAuthority (SCA) while adding the route.</maml:para> <maml:para>The "CommonName" of the certificate must correspond to the name used when establishing the connection in the certificate. This behavior can be deactivated by this option.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Name --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of the route(s) to add. If the Routes address is ambiguous and more than one route will be found online for adding then the route names will be numbered to be distinct. Without setting this parameter, the default route name will be its Computername / Hostname.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Nat --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Nat</maml:name> <maml:description> <maml:para>The 'Nat' parameter sets the local representation of the routes AmsNetId. All (local) addressing to this netId will be translated to the remote/network AmsAddress of the route. If using the '-Nat' parameter, the 'Add-AdsRoute' Cmdlet is limited to single route additions. Multi-adding is not supported. This Parameter can be used with TwinCAT Versions >= 3.1.4024.11.</maml:para> </maml:description> <command:parameterValue required="true">AmsNetId</command:parameterValue> <dev:type> <maml:name>TwinCAT.Ads.AmsNetId</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: PassThru --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>PassThru</maml:name> <maml:description> <maml:para>If the passthrough parameter is set, the successfully created route will be returned as object. By default, this Cmdlet will not create any output.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Quiet --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="Silent"> <maml:name>Quiet</maml:name> <maml:description> <maml:para>The Quiet parameter suppresses the 'ShouldProcess' messsage and the Cmdlet will be processed without further user confirmation.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Temporary --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Temporary</maml:name> <maml:description> <maml:para>If set, the Route will be registered as temporary route.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Unidirectional --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Unidirectional</maml:name> <maml:description> <maml:para>Gets or sets the unidirectional setting. The Unidirectional setting registers the ADS Route as 'one-way' channel. That means that the engineering/source system (thats where the route request is initiated) can send requests to the remote target, but not in the opposite direction.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> <!-- Parameter set: AddressSSC --> <command:syntaxItem> <maml:name>Add-AdsRoute</maml:name> <!-- Parameter: Address --> <command:parameter required="true" globbing="true" pipelineInput="false" position="0" aliases="TargetAddress"> <maml:name>Address</maml:name> <maml:description> <maml:para>The address for the ADS route. This can be the RouteName, NetId, the HostName or the IPAddress.</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Credential --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named" aliases="TargetCredential"> <maml:name>Credential</maml:name> <maml:description> <maml:para>Credentials of the route to be added to the destination system. This parameter is only necessary, when a bidirectional route will be added. When specifying</maml:para> <maml:para>IMPORTANT: Please be aware, that in the current version, tha password is transferred as clear text through the network. Use this only in safe subnetworks.</maml:para> </maml:description> <command:parameterValue required="true">PSCredential</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.PSCredential</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: SelfSigned --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named" aliases="SSC"> <maml:name>SelfSigned</maml:name> <maml:description> <maml:para>Gets or sets the SelfSigned (SSC) mode for adding the route.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: BroadcastTimeout --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>BroadcastTimeout</maml:name> <maml:description> <maml:para>(Broadcast) Search Timeout for searching the unregistered target in seconds (Default 0, Dynamic detection).</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <!-- Parameter: Destination --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Destination</maml:name> <maml:description> <maml:para>The Destination Address, where the route is added.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <!-- Parameter: DestinationCredential --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>DestinationCredential</maml:name> <maml:description> <maml:para>The credentials of the destination system, where to add the route. Local system by default.</maml:para> </maml:description> <command:parameterValue required="true">PSCredential</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.PSCredential</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: FingerPrint --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>FingerPrint</maml:name> <maml:description> <maml:para>The Fingerprint used for adding the route. This parameter can be used when the parameter '-SelfSigned' is set. If specified, the found OnlineTarget will be checked against this fingerprint. If not specified, the 'Add-AdsRoute' Cmdlet doesn't check the fingerprint, always adding the route. Using the fingerprint means that only single routes can be added, multi-adding routes with fingerprint is not supported.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <!-- Parameter: Force --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para>Forces the command (no confirmation, Resets the FailFastHandler)</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: HostName --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>HostName</maml:name> <maml:description> <maml:para>If set, the route will be registered as HostName</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Name --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of the route(s) to add. If the Routes address is ambiguous and more than one route will be found online for adding then the route names will be numbered to be distinct. Without setting this parameter, the default route name will be its Computername / Hostname.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Nat --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Nat</maml:name> <maml:description> <maml:para>The 'Nat' parameter sets the local representation of the routes AmsNetId. All (local) addressing to this netId will be translated to the remote/network AmsAddress of the route. If using the '-Nat' parameter, the 'Add-AdsRoute' Cmdlet is limited to single route additions. Multi-adding is not supported. This Parameter can be used with TwinCAT Versions >= 3.1.4024.11.</maml:para> </maml:description> <command:parameterValue required="true">AmsNetId</command:parameterValue> <dev:type> <maml:name>TwinCAT.Ads.AmsNetId</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: PassThru --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>PassThru</maml:name> <maml:description> <maml:para>If the passthrough parameter is set, the successfully created route will be returned as object. By default, this Cmdlet will not create any output.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Quiet --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="Silent"> <maml:name>Quiet</maml:name> <maml:description> <maml:para>The Quiet parameter suppresses the 'ShouldProcess' messsage and the Cmdlet will be processed without further user confirmation.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Temporary --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Temporary</maml:name> <maml:description> <maml:para>If set, the Route will be registered as temporary route.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Unidirectional --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Unidirectional</maml:name> <maml:description> <maml:para>Gets or sets the unidirectional setting. The Unidirectional setting registers the ADS Route as 'one-way' channel. That means that the engineering/source system (thats where the route request is initiated) can send requests to the remote target, but not in the opposite direction.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> <!-- Parameter set: NetId --> <command:syntaxItem> <maml:name>Add-AdsRoute</maml:name> <!-- Parameter: NetId --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0" aliases="TargetNetId"> <maml:name>NetId</maml:name> <maml:description> <maml:para>The AmsNetID for the ADS route to add. If no further IPAddress or HostName is specified with the -IPOrHostName parameter, a broadcast search is triggered to find an online device. If a single sided route should be added, specify the IPAddress or HostName Parameter in combination with -RemotePersistance:None and without -Credential.</maml:para> </maml:description> <command:parameterValue required="true">AmsNetId</command:parameterValue> <dev:type> <maml:name>TwinCAT.Ads.AmsNetId</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Credential --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="TargetCredential"> <maml:name>Credential</maml:name> <maml:description> <maml:para>Credentials of the route to be added to the destination system. This parameter is only necessary, when a bidirectional route will be added. When specifying</maml:para> <maml:para>IMPORTANT: Please be aware, that in the current version, tha password is transferred as clear text through the network. Use this only in safe subnetworks.</maml:para> </maml:description> <command:parameterValue required="true">PSCredential</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.PSCredential</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Destination --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Destination</maml:name> <maml:description> <maml:para>The Destination Address, where the route is added.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <!-- Parameter: DestinationCredential --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>DestinationCredential</maml:name> <maml:description> <maml:para>The credentials of the destination system, where to add the route. Local system by default.</maml:para> </maml:description> <command:parameterValue required="true">PSCredential</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.PSCredential</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Force --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para>Forces the command (no confirmation, Resets the FailFastHandler)</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: HostName --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>HostName</maml:name> <maml:description> <maml:para>If set, the route will be registered as HostName</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: IPOrHostName --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>IPOrHostName</maml:name> <maml:description> <maml:para>The HostName Address of the target route or the IPAddress. Because the HostName or IPAddress is necessary in addition to the NetId for a functional route, the Add-AdsRoute Cmdlet tries to detect the HostName/IPAddress via a Broadcast search in the Network when it is not specified. That means the target must be available and reachable within the network in that case. If not the Add-AdsRoute Cmdlet will fail. If the IP or HostName in combination with the -NetId is specified, the target availability is not necessary and Add-Route will register the Route whatever is specified as address.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Name --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of the route(s) to add. If the Routes address is ambiguous and more than one route will be found online for adding then the route names will be numbered to be distinct. Without setting this parameter, the default route name will be its Computername / Hostname.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Nat --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Nat</maml:name> <maml:description> <maml:para>The 'Nat' parameter sets the local representation of the routes AmsNetId. All (local) addressing to this netId will be translated to the remote/network AmsAddress of the route. If using the '-Nat' parameter, the 'Add-AdsRoute' Cmdlet is limited to single route additions. Multi-adding is not supported. This Parameter can be used with TwinCAT Versions >= 3.1.4024.11.</maml:para> </maml:description> <command:parameterValue required="true">AmsNetId</command:parameterValue> <dev:type> <maml:name>TwinCAT.Ads.AmsNetId</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: PassThru --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>PassThru</maml:name> <maml:description> <maml:para>If the passthrough parameter is set, the successfully created route will be returned as object. By default, this Cmdlet will not create any output.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Quiet --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="Silent"> <maml:name>Quiet</maml:name> <maml:description> <maml:para>The Quiet parameter suppresses the 'ShouldProcess' messsage and the Cmdlet will be processed without further user confirmation.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: RemotePersistance --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>RemotePersistance</maml:name> <maml:description> <maml:para>The persistance type of the remmote route. None/Server means no remote route will be created. Other valid values are 'Static' or 'Temporary'</maml:para> <maml:para>Possible values: None, Server, Temporary, Static</maml:para> </maml:description> <command:parameterValue required="true">RoutePersistanceType</command:parameterValue> <dev:type> <maml:name>TwinCAT.RoutePersistanceType</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Static</dev:defaultValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">None</command:parameterValue> <command:parameterValue required="false" variableLength="false">Server</command:parameterValue> <command:parameterValue required="false" variableLength="false">Temporary</command:parameterValue> <command:parameterValue required="false" variableLength="false">Static</command:parameterValue> </command:parameterValueGroup> </command:parameter> <!-- Parameter: Temporary --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Temporary</maml:name> <maml:description> <maml:para>If set, the Route will be registered as temporary route.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Unidirectional --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Unidirectional</maml:name> <maml:description> <maml:para>Gets or sets the unidirectional setting. The Unidirectional setting registers the ADS Route as 'one-way' channel. That means that the engineering/source system (thats where the route request is initiated) can send requests to the remote target, but not in the opposite direction.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> <!-- Parameter set: NetIdPSK --> <command:syntaxItem> <maml:name>Add-AdsRoute</maml:name> <!-- Parameter: NetId --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0" aliases="TargetNetId"> <maml:name>NetId</maml:name> <maml:description> <maml:para>The AmsNetID for the ADS route to add. If no further IPAddress or HostName is specified with the -IPOrHostName parameter, a broadcast search is triggered to find an online device. If a single sided route should be added, specify the IPAddress or HostName Parameter in combination with -RemotePersistance:None and without -Credential.</maml:para> </maml:description> <command:parameterValue required="true">AmsNetId</command:parameterValue> <dev:type> <maml:name>TwinCAT.Ads.AmsNetId</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Credential --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named" aliases="TargetCredential"> <maml:name>Credential</maml:name> <maml:description> <maml:para>Credentials of the route to be added to the destination system. This parameter is only necessary, when a bidirectional route will be added. When specifying</maml:para> <maml:para>IMPORTANT: Please be aware, that in the current version, tha password is transferred as clear text through the network. Use this only in safe subnetworks.</maml:para> </maml:description> <command:parameterValue required="true">PSCredential</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.PSCredential</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: PreSharedKey --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named" aliases="PSK"> <maml:name>PreSharedKey</maml:name> <maml:description> <maml:para>Gets or sets the PreSharedKey (PSK) mode for adding the route. Because a valid certificate is expected at the target, it is not necessary to enter credentials.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Destination --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Destination</maml:name> <maml:description> <maml:para>The Destination Address, where the route is added.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <!-- Parameter: DestinationCredential --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>DestinationCredential</maml:name> <maml:description> <maml:para>The credentials of the destination system, where to add the route. Local system by default.</maml:para> </maml:description> <command:parameterValue required="true">PSCredential</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.PSCredential</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Force --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para>Forces the command (no confirmation, Resets the FailFastHandler)</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: HostName --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>HostName</maml:name> <maml:description> <maml:para>If set, the route will be registered as HostName</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: IPOrHostName --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>IPOrHostName</maml:name> <maml:description> <maml:para>The HostName Address of the target route or the IPAddress. Because the HostName or IPAddress is necessary in addition to the NetId for a functional route, the Add-AdsRoute Cmdlet tries to detect the HostName/IPAddress via a Broadcast search in the Network when it is not specified. That means the target must be available and reachable within the network in that case. If not the Add-AdsRoute Cmdlet will fail. If the IP or HostName in combination with the -NetId is specified, the target availability is not necessary and Add-Route will register the Route whatever is specified as address.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Name --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of the route(s) to add. If the Routes address is ambiguous and more than one route will be found online for adding then the route names will be numbered to be distinct. Without setting this parameter, the default route name will be its Computername / Hostname.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Nat --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Nat</maml:name> <maml:description> <maml:para>The 'Nat' parameter sets the local representation of the routes AmsNetId. All (local) addressing to this netId will be translated to the remote/network AmsAddress of the route. If using the '-Nat' parameter, the 'Add-AdsRoute' Cmdlet is limited to single route additions. Multi-adding is not supported. This Parameter can be used with TwinCAT Versions >= 3.1.4024.11.</maml:para> </maml:description> <command:parameterValue required="true">AmsNetId</command:parameterValue> <dev:type> <maml:name>TwinCAT.Ads.AmsNetId</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: PassThru --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>PassThru</maml:name> <maml:description> <maml:para>If the passthrough parameter is set, the successfully created route will be returned as object. By default, this Cmdlet will not create any output.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Quiet --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="Silent"> <maml:name>Quiet</maml:name> <maml:description> <maml:para>The Quiet parameter suppresses the 'ShouldProcess' messsage and the Cmdlet will be processed without further user confirmation.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Temporary --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Temporary</maml:name> <maml:description> <maml:para>If set, the Route will be registered as temporary route.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Unidirectional --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Unidirectional</maml:name> <maml:description> <maml:para>Gets or sets the unidirectional setting. The Unidirectional setting registers the ADS Route as 'one-way' channel. That means that the engineering/source system (thats where the route request is initiated) can send requests to the remote target, but not in the opposite direction.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> <!-- Parameter set: NetIdPSKKey --> <command:syntaxItem> <maml:name>Add-AdsRoute</maml:name> <!-- Parameter: NetId --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0" aliases="TargetNetId"> <maml:name>NetId</maml:name> <maml:description> <maml:para>The AmsNetID for the ADS route to add. If no further IPAddress or HostName is specified with the -IPOrHostName parameter, a broadcast search is triggered to find an online device. If a single sided route should be added, specify the IPAddress or HostName Parameter in combination with -RemotePersistance:None and without -Credential.</maml:para> </maml:description> <command:parameterValue required="true">AmsNetId</command:parameterValue> <dev:type> <maml:name>TwinCAT.Ads.AmsNetId</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: BinaryKey --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>BinaryKey</maml:name> <maml:description> <maml:para>The BinaryKey can be used instead of the credential Password on SecureSettings.PreSharedKeys (PSK). There is no function for this parameter on other security settings.</maml:para> </maml:description> <command:parameterValue required="true">byte[]</command:parameterValue> <dev:type> <maml:name>System.Byte[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Identity --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Identity</maml:name> <maml:description> <maml:para>The BinaryKey can be used instead of the credential Password on SecureSettings.PreSharedKeys (PSK). There is no function for this parameter on other security settings.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: PreSharedKey --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named" aliases="PSK"> <maml:name>PreSharedKey</maml:name> <maml:description> <maml:para>Gets or sets the PreSharedKey (PSK) mode for adding the route. Because a valid certificate is expected at the target, it is not necessary to enter credentials.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Destination --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Destination</maml:name> <maml:description> <maml:para>The Destination Address, where the route is added.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <!-- Parameter: DestinationCredential --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>DestinationCredential</maml:name> <maml:description> <maml:para>The credentials of the destination system, where to add the route. Local system by default.</maml:para> </maml:description> <command:parameterValue required="true">PSCredential</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.PSCredential</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Force --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para>Forces the command (no confirmation, Resets the FailFastHandler)</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: HostName --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>HostName</maml:name> <maml:description> <maml:para>If set, the route will be registered as HostName</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: IPOrHostName --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>IPOrHostName</maml:name> <maml:description> <maml:para>The HostName Address of the target route or the IPAddress. Because the HostName or IPAddress is necessary in addition to the NetId for a functional route, the Add-AdsRoute Cmdlet tries to detect the HostName/IPAddress via a Broadcast search in the Network when it is not specified. That means the target must be available and reachable within the network in that case. If not the Add-AdsRoute Cmdlet will fail. If the IP or HostName in combination with the -NetId is specified, the target availability is not necessary and Add-Route will register the Route whatever is specified as address.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Name --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of the route(s) to add. If the Routes address is ambiguous and more than one route will be found online for adding then the route names will be numbered to be distinct. Without setting this parameter, the default route name will be its Computername / Hostname.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Nat --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Nat</maml:name> <maml:description> <maml:para>The 'Nat' parameter sets the local representation of the routes AmsNetId. All (local) addressing to this netId will be translated to the remote/network AmsAddress of the route. If using the '-Nat' parameter, the 'Add-AdsRoute' Cmdlet is limited to single route additions. Multi-adding is not supported. This Parameter can be used with TwinCAT Versions >= 3.1.4024.11.</maml:para> </maml:description> <command:parameterValue required="true">AmsNetId</command:parameterValue> <dev:type> <maml:name>TwinCAT.Ads.AmsNetId</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: PassThru --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>PassThru</maml:name> <maml:description> <maml:para>If the passthrough parameter is set, the successfully created route will be returned as object. By default, this Cmdlet will not create any output.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Quiet --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="Silent"> <maml:name>Quiet</maml:name> <maml:description> <maml:para>The Quiet parameter suppresses the 'ShouldProcess' messsage and the Cmdlet will be processed without further user confirmation.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Temporary --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Temporary</maml:name> <maml:description> <maml:para>If set, the Route will be registered as temporary route.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Unidirectional --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Unidirectional</maml:name> <maml:description> <maml:para>Gets or sets the unidirectional setting. The Unidirectional setting registers the ADS Route as 'one-way' channel. That means that the engineering/source system (thats where the route request is initiated) can send requests to the remote target, but not in the opposite direction.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> <!-- Parameter set: NetIdSCA --> <command:syntaxItem> <maml:name>Add-AdsRoute</maml:name> <!-- Parameter: NetId --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0" aliases="TargetNetId"> <maml:name>NetId</maml:name> <maml:description> <maml:para>The AmsNetID for the ADS route to add. If no further IPAddress or HostName is specified with the -IPOrHostName parameter, a broadcast search is triggered to find an online device. If a single sided route should be added, specify the IPAddress or HostName Parameter in combination with -RemotePersistance:None and without -Credential.</maml:para> </maml:description> <command:parameterValue required="true">AmsNetId</command:parameterValue> <dev:type> <maml:name>TwinCAT.Ads.AmsNetId</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: SharedCertAuth --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named" aliases="SCA"> <maml:name>SharedCertAuth</maml:name> <maml:description> <maml:para>Gets or sets the SharedCertificateAuthority (SCA) mode for adding the route. Because a valid certificate is expected at the target, it is not necessary to enter credentials.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Destination --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Destination</maml:name> <maml:description> <maml:para>The Destination Address, where the route is added.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <!-- Parameter: DestinationCredential --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>DestinationCredential</maml:name> <maml:description> <maml:para>The credentials of the destination system, where to add the route. Local system by default.</maml:para> </maml:description> <command:parameterValue required="true">PSCredential</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.PSCredential</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Force --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para>Forces the command (no confirmation, Resets the FailFastHandler)</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: HostName --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>HostName</maml:name> <maml:description> <maml:para>If set, the route will be registered as HostName</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: IgnoreCN --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>IgnoreCN</maml:name> <maml:description> <maml:para>Gets or sets the 'Ignore Common Name' mode for SharedCertificateAuthority (SCA) while adding the route.</maml:para> <maml:para>The "CommonName" of the certificate must correspond to the name used when establishing the connection in the certificate. This behavior can be deactivated by this option.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: IPOrHostName --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>IPOrHostName</maml:name> <maml:description> <maml:para>The HostName Address of the target route or the IPAddress. Because the HostName or IPAddress is necessary in addition to the NetId for a functional route, the Add-AdsRoute Cmdlet tries to detect the HostName/IPAddress via a Broadcast search in the Network when it is not specified. That means the target must be available and reachable within the network in that case. If not the Add-AdsRoute Cmdlet will fail. If the IP or HostName in combination with the -NetId is specified, the target availability is not necessary and Add-Route will register the Route whatever is specified as address.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Name --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of the route(s) to add. If the Routes address is ambiguous and more than one route will be found online for adding then the route names will be numbered to be distinct. Without setting this parameter, the default route name will be its Computername / Hostname.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Nat --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Nat</maml:name> <maml:description> <maml:para>The 'Nat' parameter sets the local representation of the routes AmsNetId. All (local) addressing to this netId will be translated to the remote/network AmsAddress of the route. If using the '-Nat' parameter, the 'Add-AdsRoute' Cmdlet is limited to single route additions. Multi-adding is not supported. This Parameter can be used with TwinCAT Versions >= 3.1.4024.11.</maml:para> </maml:description> <command:parameterValue required="true">AmsNetId</command:parameterValue> <dev:type> <maml:name>TwinCAT.Ads.AmsNetId</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: PassThru --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>PassThru</maml:name> <maml:description> <maml:para>If the passthrough parameter is set, the successfully created route will be returned as object. By default, this Cmdlet will not create any output.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Quiet --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="Silent"> <maml:name>Quiet</maml:name> <maml:description> <maml:para>The Quiet parameter suppresses the 'ShouldProcess' messsage and the Cmdlet will be processed without further user confirmation.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Temporary --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Temporary</maml:name> <maml:description> <maml:para>If set, the Route will be registered as temporary route.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Unidirectional --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Unidirectional</maml:name> <maml:description> <maml:para>Gets or sets the unidirectional setting. The Unidirectional setting registers the ADS Route as 'one-way' channel. That means that the engineering/source system (thats where the route request is initiated) can send requests to the remote target, but not in the opposite direction.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> <!-- Parameter set: NetIdSSC --> <command:syntaxItem> <maml:name>Add-AdsRoute</maml:name> <!-- Parameter: NetId --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0" aliases="TargetNetId"> <maml:name>NetId</maml:name> <maml:description> <maml:para>The AmsNetID for the ADS route to add. If no further IPAddress or HostName is specified with the -IPOrHostName parameter, a broadcast search is triggered to find an online device. If a single sided route should be added, specify the IPAddress or HostName Parameter in combination with -RemotePersistance:None and without -Credential.</maml:para> </maml:description> <command:parameterValue required="true">AmsNetId</command:parameterValue> <dev:type> <maml:name>TwinCAT.Ads.AmsNetId</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Credential --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named" aliases="TargetCredential"> <maml:name>Credential</maml:name> <maml:description> <maml:para>Credentials of the route to be added to the destination system. This parameter is only necessary, when a bidirectional route will be added. When specifying</maml:para> <maml:para>IMPORTANT: Please be aware, that in the current version, tha password is transferred as clear text through the network. Use this only in safe subnetworks.</maml:para> </maml:description> <command:parameterValue required="true">PSCredential</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.PSCredential</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: SelfSigned --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named" aliases="SSC"> <maml:name>SelfSigned</maml:name> <maml:description> <maml:para>Gets or sets the SelfSigned (SSC) mode for adding the route.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Destination --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Destination</maml:name> <maml:description> <maml:para>The Destination Address, where the route is added.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <!-- Parameter: DestinationCredential --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>DestinationCredential</maml:name> <maml:description> <maml:para>The credentials of the destination system, where to add the route. Local system by default.</maml:para> </maml:description> <command:parameterValue required="true">PSCredential</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.PSCredential</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: FingerPrint --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>FingerPrint</maml:name> <maml:description> <maml:para>The Fingerprint used for adding the route. This parameter can be used when the parameter '-SelfSigned' is set. If specified, the found OnlineTarget will be checked against this fingerprint. If not specified, the 'Add-AdsRoute' Cmdlet doesn't check the fingerprint, always adding the route. Using the fingerprint means that only single routes can be added, multi-adding routes with fingerprint is not supported.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <!-- Parameter: Force --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para>Forces the command (no confirmation, Resets the FailFastHandler)</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: HostName --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>HostName</maml:name> <maml:description> <maml:para>If set, the route will be registered as HostName</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: IPOrHostName --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>IPOrHostName</maml:name> <maml:description> <maml:para>The HostName Address of the target route or the IPAddress. Because the HostName or IPAddress is necessary in addition to the NetId for a functional route, the Add-AdsRoute Cmdlet tries to detect the HostName/IPAddress via a Broadcast search in the Network when it is not specified. That means the target must be available and reachable within the network in that case. If not the Add-AdsRoute Cmdlet will fail. If the IP or HostName in combination with the -NetId is specified, the target availability is not necessary and Add-Route will register the Route whatever is specified as address.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Name --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of the route(s) to add. If the Routes address is ambiguous and more than one route will be found online for adding then the route names will be numbered to be distinct. Without setting this parameter, the default route name will be its Computername / Hostname.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Nat --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Nat</maml:name> <maml:description> <maml:para>The 'Nat' parameter sets the local representation of the routes AmsNetId. All (local) addressing to this netId will be translated to the remote/network AmsAddress of the route. If using the '-Nat' parameter, the 'Add-AdsRoute' Cmdlet is limited to single route additions. Multi-adding is not supported. This Parameter can be used with TwinCAT Versions >= 3.1.4024.11.</maml:para> </maml:description> <command:parameterValue required="true">AmsNetId</command:parameterValue> <dev:type> <maml:name>TwinCAT.Ads.AmsNetId</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: PassThru --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>PassThru</maml:name> <maml:description> <maml:para>If the passthrough parameter is set, the successfully created route will be returned as object. By default, this Cmdlet will not create any output.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Quiet --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="Silent"> <maml:name>Quiet</maml:name> <maml:description> <maml:para>The Quiet parameter suppresses the 'ShouldProcess' messsage and the Cmdlet will be processed without further user confirmation.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Temporary --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Temporary</maml:name> <maml:description> <maml:para>If set, the Route will be registered as temporary route.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Unidirectional --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Unidirectional</maml:name> <maml:description> <maml:para>Gets or sets the unidirectional setting. The Unidirectional setting registers the ADS Route as 'one-way' channel. That means that the engineering/source system (thats where the route request is initiated) can send requests to the remote target, but not in the opposite direction.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> <!-- Parameter set: Routes --> <command:syntaxItem> <maml:name>Add-AdsRoute</maml:name> <!-- Parameter: Credential --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named" aliases="TargetCredential"> <maml:name>Credential</maml:name> <maml:description> <maml:para>Credentials of the route to be added to the destination system. This parameter is only necessary, when a bidirectional route will be added. When specifying</maml:para> <maml:para>IMPORTANT: Please be aware, that in the current version, tha password is transferred as clear text through the network. Use this only in safe subnetworks.</maml:para> </maml:description> <command:parameterValue required="true">PSCredential</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.PSCredential</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: InputObject --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="named" aliases="Route,TargetRoute"> <maml:name>InputObject</maml:name> <maml:description> <maml:para>The input Ads Routes.</maml:para> </maml:description> <command:parameterValue required="true">IRoute[]</command:parameterValue> <dev:type> <maml:name>TwinCAT.IRoute[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Destination --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Destination</maml:name> <maml:description> <maml:para>The Destination Address, where the route is added.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <!-- Parameter: DestinationCredential --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>DestinationCredential</maml:name> <maml:description> <maml:para>The credentials of the destination system, where to add the route. Local system by default.</maml:para> </maml:description> <command:parameterValue required="true">PSCredential</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.PSCredential</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Force --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para>Forces the command (no confirmation, Resets the FailFastHandler)</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: HostName --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>HostName</maml:name> <maml:description> <maml:para>If set, the route will be registered as HostName</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Nat --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Nat</maml:name> <maml:description> <maml:para>The 'Nat' parameter sets the local representation of the routes AmsNetId. All (local) addressing to this netId will be translated to the remote/network AmsAddress of the route. If using the '-Nat' parameter, the 'Add-AdsRoute' Cmdlet is limited to single route additions. Multi-adding is not supported. This Parameter can be used with TwinCAT Versions >= 3.1.4024.11.</maml:para> </maml:description> <command:parameterValue required="true">AmsNetId</command:parameterValue> <dev:type> <maml:name>TwinCAT.Ads.AmsNetId</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: PassThru --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>PassThru</maml:name> <maml:description> <maml:para>If the passthrough parameter is set, the successfully created route will be returned as object. By default, this Cmdlet will not create any output.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Quiet --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="Silent"> <maml:name>Quiet</maml:name> <maml:description> <maml:para>The Quiet parameter suppresses the 'ShouldProcess' messsage and the Cmdlet will be processed without further user confirmation.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: RemotePersistance --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>RemotePersistance</maml:name> <maml:description> <maml:para>The persistance type of the remmote route. None/Server means no remote route will be created. Other valid values are 'Static' or 'Temporary'</maml:para> <maml:para>Possible values: None, Server, Temporary, Static</maml:para> </maml:description> <command:parameterValue required="true">RoutePersistanceType</command:parameterValue> <dev:type> <maml:name>TwinCAT.RoutePersistanceType</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Static</dev:defaultValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">None</command:parameterValue> <command:parameterValue required="false" variableLength="false">Server</command:parameterValue> <command:parameterValue required="false" variableLength="false">Temporary</command:parameterValue> <command:parameterValue required="false" variableLength="false">Static</command:parameterValue> </command:parameterValueGroup> </command:parameter> <!-- Parameter: Temporary --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Temporary</maml:name> <maml:description> <maml:para>If set, the Route will be registered as temporary route.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Unidirectional --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Unidirectional</maml:name> <maml:description> <maml:para>Gets or sets the unidirectional setting. The Unidirectional setting registers the ADS Route as 'one-way' channel. That means that the engineering/source system (thats where the route request is initiated) can send requests to the remote target, but not in the opposite direction.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> <!-- Parameter set: RoutesPSK --> <command:syntaxItem> <maml:name>Add-AdsRoute</maml:name> <!-- Parameter: Credential --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named" aliases="TargetCredential"> <maml:name>Credential</maml:name> <maml:description> <maml:para>Credentials of the route to be added to the destination system. This parameter is only necessary, when a bidirectional route will be added. When specifying</maml:para> <maml:para>IMPORTANT: Please be aware, that in the current version, tha password is transferred as clear text through the network. Use this only in safe subnetworks.</maml:para> </maml:description> <command:parameterValue required="true">PSCredential</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.PSCredential</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: InputObject --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="named" aliases="Route,TargetRoute"> <maml:name>InputObject</maml:name> <maml:description> <maml:para>The input Ads Routes.</maml:para> </maml:description> <command:parameterValue required="true">IRoute[]</command:parameterValue> <dev:type> <maml:name>TwinCAT.IRoute[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: PreSharedKey --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named" aliases="PSK"> <maml:name>PreSharedKey</maml:name> <maml:description> <maml:para>Gets or sets the PreSharedKey (PSK) mode for adding the route. Because a valid certificate is expected at the target, it is not necessary to enter credentials.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Destination --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Destination</maml:name> <maml:description> <maml:para>The Destination Address, where the route is added.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <!-- Parameter: DestinationCredential --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>DestinationCredential</maml:name> <maml:description> <maml:para>The credentials of the destination system, where to add the route. Local system by default.</maml:para> </maml:description> <command:parameterValue required="true">PSCredential</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.PSCredential</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Force --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para>Forces the command (no confirmation, Resets the FailFastHandler)</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: HostName --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>HostName</maml:name> <maml:description> <maml:para>If set, the route will be registered as HostName</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Nat --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Nat</maml:name> <maml:description> <maml:para>The 'Nat' parameter sets the local representation of the routes AmsNetId. All (local) addressing to this netId will be translated to the remote/network AmsAddress of the route. If using the '-Nat' parameter, the 'Add-AdsRoute' Cmdlet is limited to single route additions. Multi-adding is not supported. This Parameter can be used with TwinCAT Versions >= 3.1.4024.11.</maml:para> </maml:description> <command:parameterValue required="true">AmsNetId</command:parameterValue> <dev:type> <maml:name>TwinCAT.Ads.AmsNetId</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: PassThru --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>PassThru</maml:name> <maml:description> <maml:para>If the passthrough parameter is set, the successfully created route will be returned as object. By default, this Cmdlet will not create any output.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Quiet --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="Silent"> <maml:name>Quiet</maml:name> <maml:description> <maml:para>The Quiet parameter suppresses the 'ShouldProcess' messsage and the Cmdlet will be processed without further user confirmation.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Temporary --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Temporary</maml:name> <maml:description> <maml:para>If set, the Route will be registered as temporary route.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Unidirectional --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Unidirectional</maml:name> <maml:description> <maml:para>Gets or sets the unidirectional setting. The Unidirectional setting registers the ADS Route as 'one-way' channel. That means that the engineering/source system (thats where the route request is initiated) can send requests to the remote target, but not in the opposite direction.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> <!-- Parameter set: RoutesPSKKey --> <command:syntaxItem> <maml:name>Add-AdsRoute</maml:name> <!-- Parameter: BinaryKey --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>BinaryKey</maml:name> <maml:description> <maml:para>The BinaryKey can be used instead of the credential Password on SecureSettings.PreSharedKeys (PSK). There is no function for this parameter on other security settings.</maml:para> </maml:description> <command:parameterValue required="true">byte[]</command:parameterValue> <dev:type> <maml:name>System.Byte[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Identity --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Identity</maml:name> <maml:description> <maml:para>The BinaryKey can be used instead of the credential Password on SecureSettings.PreSharedKeys (PSK). There is no function for this parameter on other security settings.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: InputObject --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="named" aliases="Route,TargetRoute"> <maml:name>InputObject</maml:name> <maml:description> <maml:para>The input Ads Routes.</maml:para> </maml:description> <command:parameterValue required="true">IRoute[]</command:parameterValue> <dev:type> <maml:name>TwinCAT.IRoute[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: PreSharedKey --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named" aliases="PSK"> <maml:name>PreSharedKey</maml:name> <maml:description> <maml:para>Gets or sets the PreSharedKey (PSK) mode for adding the route. Because a valid certificate is expected at the target, it is not necessary to enter credentials.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Destination --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Destination</maml:name> <maml:description> <maml:para>The Destination Address, where the route is added.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <!-- Parameter: DestinationCredential --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>DestinationCredential</maml:name> <maml:description> <maml:para>The credentials of the destination system, where to add the route. Local system by default.</maml:para> </maml:description> <command:parameterValue required="true">PSCredential</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.PSCredential</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Force --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para>Forces the command (no confirmation, Resets the FailFastHandler)</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: HostName --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>HostName</maml:name> <maml:description> <maml:para>If set, the route will be registered as HostName</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Nat --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Nat</maml:name> <maml:description> <maml:para>The 'Nat' parameter sets the local representation of the routes AmsNetId. All (local) addressing to this netId will be translated to the remote/network AmsAddress of the route. If using the '-Nat' parameter, the 'Add-AdsRoute' Cmdlet is limited to single route additions. Multi-adding is not supported. This Parameter can be used with TwinCAT Versions >= 3.1.4024.11.</maml:para> </maml:description> <command:parameterValue required="true">AmsNetId</command:parameterValue> <dev:type> <maml:name>TwinCAT.Ads.AmsNetId</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: PassThru --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>PassThru</maml:name> <maml:description> <maml:para>If the passthrough parameter is set, the successfully created route will be returned as object. By default, this Cmdlet will not create any output.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Quiet --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="Silent"> <maml:name>Quiet</maml:name> <maml:description> <maml:para>The Quiet parameter suppresses the 'ShouldProcess' messsage and the Cmdlet will be processed without further user confirmation.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Temporary --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Temporary</maml:name> <maml:description> <maml:para>If set, the Route will be registered as temporary route.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Unidirectional --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Unidirectional</maml:name> <maml:description> <maml:para>Gets or sets the unidirectional setting. The Unidirectional setting registers the ADS Route as 'one-way' channel. That means that the engineering/source system (thats where the route request is initiated) can send requests to the remote target, but not in the opposite direction.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> <!-- Parameter set: RoutesSCA --> <command:syntaxItem> <maml:name>Add-AdsRoute</maml:name> <!-- Parameter: InputObject --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="named" aliases="Route,TargetRoute"> <maml:name>InputObject</maml:name> <maml:description> <maml:para>The input Ads Routes.</maml:para> </maml:description> <command:parameterValue required="true">IRoute[]</command:parameterValue> <dev:type> <maml:name>TwinCAT.IRoute[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: SharedCertAuth --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named" aliases="SCA"> <maml:name>SharedCertAuth</maml:name> <maml:description> <maml:para>Gets or sets the SharedCertificateAuthority (SCA) mode for adding the route. Because a valid certificate is expected at the target, it is not necessary to enter credentials.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Destination --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Destination</maml:name> <maml:description> <maml:para>The Destination Address, where the route is added.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <!-- Parameter: DestinationCredential --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>DestinationCredential</maml:name> <maml:description> <maml:para>The credentials of the destination system, where to add the route. Local system by default.</maml:para> </maml:description> <command:parameterValue required="true">PSCredential</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.PSCredential</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Force --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para>Forces the command (no confirmation, Resets the FailFastHandler)</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: HostName --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>HostName</maml:name> <maml:description> <maml:para>If set, the route will be registered as HostName</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: IgnoreCN --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>IgnoreCN</maml:name> <maml:description> <maml:para>Gets or sets the 'Ignore Common Name' mode for SharedCertificateAuthority (SCA) while adding the route.</maml:para> <maml:para>The "CommonName" of the certificate must correspond to the name used when establishing the connection in the certificate. This behavior can be deactivated by this option.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Nat --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Nat</maml:name> <maml:description> <maml:para>The 'Nat' parameter sets the local representation of the routes AmsNetId. All (local) addressing to this netId will be translated to the remote/network AmsAddress of the route. If using the '-Nat' parameter, the 'Add-AdsRoute' Cmdlet is limited to single route additions. Multi-adding is not supported. This Parameter can be used with TwinCAT Versions >= 3.1.4024.11.</maml:para> </maml:description> <command:parameterValue required="true">AmsNetId</command:parameterValue> <dev:type> <maml:name>TwinCAT.Ads.AmsNetId</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: PassThru --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>PassThru</maml:name> <maml:description> <maml:para>If the passthrough parameter is set, the successfully created route will be returned as object. By default, this Cmdlet will not create any output.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Quiet --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="Silent"> <maml:name>Quiet</maml:name> <maml:description> <maml:para>The Quiet parameter suppresses the 'ShouldProcess' messsage and the Cmdlet will be processed without further user confirmation.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Temporary --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Temporary</maml:name> <maml:description> <maml:para>If set, the Route will be registered as temporary route.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Unidirectional --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Unidirectional</maml:name> <maml:description> <maml:para>Gets or sets the unidirectional setting. The Unidirectional setting registers the ADS Route as 'one-way' channel. That means that the engineering/source system (thats where the route request is initiated) can send requests to the remote target, but not in the opposite direction.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> <!-- Parameter set: RoutesSSC --> <command:syntaxItem> <maml:name>Add-AdsRoute</maml:name> <!-- Parameter: Credential --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named" aliases="TargetCredential"> <maml:name>Credential</maml:name> <maml:description> <maml:para>Credentials of the route to be added to the destination system. This parameter is only necessary, when a bidirectional route will be added. When specifying</maml:para> <maml:para>IMPORTANT: Please be aware, that in the current version, tha password is transferred as clear text through the network. Use this only in safe subnetworks.</maml:para> </maml:description> <command:parameterValue required="true">PSCredential</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.PSCredential</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: InputObject --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="named" aliases="Route,TargetRoute"> <maml:name>InputObject</maml:name> <maml:description> <maml:para>The input Ads Routes.</maml:para> </maml:description> <command:parameterValue required="true">IRoute[]</command:parameterValue> <dev:type> <maml:name>TwinCAT.IRoute[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: SelfSigned --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named" aliases="SSC"> <maml:name>SelfSigned</maml:name> <maml:description> <maml:para>Gets or sets the SelfSigned (SSC) mode for adding the route.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Destination --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Destination</maml:name> <maml:description> <maml:para>The Destination Address, where the route is added.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <!-- Parameter: DestinationCredential --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>DestinationCredential</maml:name> <maml:description> <maml:para>The credentials of the destination system, where to add the route. Local system by default.</maml:para> </maml:description> <command:parameterValue required="true">PSCredential</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.PSCredential</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: FingerPrint --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>FingerPrint</maml:name> <maml:description> <maml:para>The Fingerprint used for adding the route. This parameter can be used when the parameter '-SelfSigned' is set. If specified, the found OnlineTarget will be checked against this fingerprint. If not specified, the 'Add-AdsRoute' Cmdlet doesn't check the fingerprint, always adding the route. Using the fingerprint means that only single routes can be added, multi-adding routes with fingerprint is not supported.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <!-- Parameter: Force --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para>Forces the command (no confirmation, Resets the FailFastHandler)</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: HostName --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>HostName</maml:name> <maml:description> <maml:para>If set, the route will be registered as HostName</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Nat --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Nat</maml:name> <maml:description> <maml:para>The 'Nat' parameter sets the local representation of the routes AmsNetId. All (local) addressing to this netId will be translated to the remote/network AmsAddress of the route. If using the '-Nat' parameter, the 'Add-AdsRoute' Cmdlet is limited to single route additions. Multi-adding is not supported. This Parameter can be used with TwinCAT Versions >= 3.1.4024.11.</maml:para> </maml:description> <command:parameterValue required="true">AmsNetId</command:parameterValue> <dev:type> <maml:name>TwinCAT.Ads.AmsNetId</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: PassThru --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>PassThru</maml:name> <maml:description> <maml:para>If the passthrough parameter is set, the successfully created route will be returned as object. By default, this Cmdlet will not create any output.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Quiet --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="Silent"> <maml:name>Quiet</maml:name> <maml:description> <maml:para>The Quiet parameter suppresses the 'ShouldProcess' messsage and the Cmdlet will be processed without further user confirmation.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Temporary --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Temporary</maml:name> <maml:description> <maml:para>If set, the Route will be registered as temporary route.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Unidirectional --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Unidirectional</maml:name> <maml:description> <maml:para>Gets or sets the unidirectional setting. The Unidirectional setting registers the ADS Route as 'one-way' channel. That means that the engineering/source system (thats where the route request is initiated) can send requests to the remote target, but not in the opposite direction.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Name --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of the route(s) to add. If the Routes address is ambiguous and more than one route will be found online for adding then the route names will be numbered to be distinct. Without setting this parameter, the default route name will be its Computername / Hostname.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Address --> <command:parameter required="true" globbing="true" pipelineInput="false" position="0" aliases="TargetAddress"> <maml:name>Address</maml:name> <maml:description> <maml:para>The address for the ADS route. This can be the RouteName, NetId, the HostName or the IPAddress.</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" globbing="true" pipelineInput="false" position="0" aliases="TargetAddress"> <maml:name>TargetAddress</maml:name> <maml:description> <maml:para>The address for the ADS route. This can be the RouteName, NetId, the HostName or the IPAddress.</maml:para> <maml:para>This is an alias of the Address parameter.</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: NetId --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0" aliases="TargetNetId"> <maml:name>NetId</maml:name> <maml:description> <maml:para>The AmsNetID for the ADS route to add. If no further IPAddress or HostName is specified with the -IPOrHostName parameter, a broadcast search is triggered to find an online device. If a single sided route should be added, specify the IPAddress or HostName Parameter in combination with -RemotePersistance:None and without -Credential.</maml:para> </maml:description> <command:parameterValue required="true">AmsNetId</command:parameterValue> <dev:type> <maml:name>TwinCAT.Ads.AmsNetId</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" globbing="false" pipelineInput="false" position="0" aliases="TargetNetId"> <maml:name>TargetNetId</maml:name> <maml:description> <maml:para>The AmsNetID for the ADS route to add. If no further IPAddress or HostName is specified with the -IPOrHostName parameter, a broadcast search is triggered to find an online device. If a single sided route should be added, specify the IPAddress or HostName Parameter in combination with -RemotePersistance:None and without -Credential.</maml:para> <maml:para>This is an alias of the NetId parameter.</maml:para> </maml:description> <command:parameterValue required="true">AmsNetId</command:parameterValue> <dev:type> <maml:name>TwinCAT.Ads.AmsNetId</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: IPOrHostName --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>IPOrHostName</maml:name> <maml:description> <maml:para>The HostName Address of the target route or the IPAddress. Because the HostName or IPAddress is necessary in addition to the NetId for a functional route, the Add-AdsRoute Cmdlet tries to detect the HostName/IPAddress via a Broadcast search in the Network when it is not specified. That means the target must be available and reachable within the network in that case. If not the Add-AdsRoute Cmdlet will fail. If the IP or HostName in combination with the -NetId is specified, the target availability is not necessary and Add-Route will register the Route whatever is specified as address.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: RemotePersistance --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>RemotePersistance</maml:name> <maml:description> <maml:para>The persistance type of the remmote route. None/Server means no remote route will be created. Other valid values are 'Static' or 'Temporary'</maml:para> <maml:para>Possible values: None, Server, Temporary, Static</maml:para> </maml:description> <command:parameterValue required="true">RoutePersistanceType</command:parameterValue> <dev:type> <maml:name>TwinCAT.RoutePersistanceType</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Static</dev:defaultValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">None</command:parameterValue> <command:parameterValue required="false" variableLength="false">Server</command:parameterValue> <command:parameterValue required="false" variableLength="false">Temporary</command:parameterValue> <command:parameterValue required="false" variableLength="false">Static</command:parameterValue> </command:parameterValueGroup> </command:parameter> <!-- Parameter: BroadcastTimeout --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>BroadcastTimeout</maml:name> <maml:description> <maml:para>(Broadcast) Search Timeout for searching the unregistered target in seconds (Default 0, Dynamic detection).</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <!-- Parameter: InputObject --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="named" aliases="Route,TargetRoute"> <maml:name>InputObject</maml:name> <maml:description> <maml:para>The input Ads Routes.</maml:para> </maml:description> <command:parameterValue required="true">IRoute[]</command:parameterValue> <dev:type> <maml:name>TwinCAT.IRoute[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="named" aliases="Route,TargetRoute"> <maml:name>Route</maml:name> <maml:description> <maml:para>The input Ads Routes.</maml:para> <maml:para>This is an alias of the InputObject parameter.</maml:para> </maml:description> <command:parameterValue required="true">IRoute[]</command:parameterValue> <dev:type> <maml:name>TwinCAT.IRoute[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="named" aliases="Route,TargetRoute"> <maml:name>TargetRoute</maml:name> <maml:description> <maml:para>The input Ads Routes.</maml:para> <maml:para>This is an alias of the InputObject parameter.</maml:para> </maml:description> <command:parameterValue required="true">IRoute[]</command:parameterValue> <dev:type> <maml:name>TwinCAT.IRoute[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Destination --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Destination</maml:name> <maml:description> <maml:para>The Destination Address, where the route is added.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <!-- Parameter: DestinationCredential --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>DestinationCredential</maml:name> <maml:description> <maml:para>The credentials of the destination system, where to add the route. Local system by default.</maml:para> </maml:description> <command:parameterValue required="true">PSCredential</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.PSCredential</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Credential --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named" aliases="TargetCredential"> <maml:name>Credential</maml:name> <maml:description> <maml:para>Credentials of the route to be added to the destination system. This parameter is only necessary, when a bidirectional route will be added. When specifying</maml:para> <maml:para>IMPORTANT: Please be aware, that in the current version, tha password is transferred as clear text through the network. Use this only in safe subnetworks.</maml:para> </maml:description> <command:parameterValue required="true">PSCredential</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.PSCredential</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" globbing="false" pipelineInput="false" position="named" aliases="TargetCredential"> <maml:name>TargetCredential</maml:name> <maml:description> <maml:para>Credentials of the route to be added to the destination system. This parameter is only necessary, when a bidirectional route will be added. When specifying</maml:para> <maml:para>IMPORTANT: Please be aware, that in the current version, tha password is transferred as clear text through the network. Use this only in safe subnetworks.</maml:para> <maml:para>This is an alias of the Credential parameter.</maml:para> </maml:description> <command:parameterValue required="true">PSCredential</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.PSCredential</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Identity --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Identity</maml:name> <maml:description> <maml:para>The BinaryKey can be used instead of the credential Password on SecureSettings.PreSharedKeys (PSK). There is no function for this parameter on other security settings.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: BinaryKey --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>BinaryKey</maml:name> <maml:description> <maml:para>The BinaryKey can be used instead of the credential Password on SecureSettings.PreSharedKeys (PSK). There is no function for this parameter on other security settings.</maml:para> </maml:description> <command:parameterValue required="true">byte[]</command:parameterValue> <dev:type> <maml:name>System.Byte[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: HostName --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>HostName</maml:name> <maml:description> <maml:para>If set, the route will be registered as HostName</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Temporary --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Temporary</maml:name> <maml:description> <maml:para>If set, the Route will be registered as temporary route.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: SelfSigned --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named" aliases="SSC"> <maml:name>SelfSigned</maml:name> <maml:description> <maml:para>Gets or sets the SelfSigned (SSC) mode for adding the route.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="true" globbing="false" pipelineInput="false" position="named" aliases="SSC"> <maml:name>SSC</maml:name> <maml:description> <maml:para>Gets or sets the SelfSigned (SSC) mode for adding the route.</maml:para> <maml:para>This is an alias of the SelfSigned parameter.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: FingerPrint --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>FingerPrint</maml:name> <maml:description> <maml:para>The Fingerprint used for adding the route. This parameter can be used when the parameter '-SelfSigned' is set. If specified, the found OnlineTarget will be checked against this fingerprint. If not specified, the 'Add-AdsRoute' Cmdlet doesn't check the fingerprint, always adding the route. Using the fingerprint means that only single routes can be added, multi-adding routes with fingerprint is not supported.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <!-- Parameter: PreSharedKey --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named" aliases="PSK"> <maml:name>PreSharedKey</maml:name> <maml:description> <maml:para>Gets or sets the PreSharedKey (PSK) mode for adding the route. Because a valid certificate is expected at the target, it is not necessary to enter credentials.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="true" globbing="false" pipelineInput="false" position="named" aliases="PSK"> <maml:name>PSK</maml:name> <maml:description> <maml:para>Gets or sets the PreSharedKey (PSK) mode for adding the route. Because a valid certificate is expected at the target, it is not necessary to enter credentials.</maml:para> <maml:para>This is an alias of the PreSharedKey parameter.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: SharedCertAuth --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named" aliases="SCA"> <maml:name>SharedCertAuth</maml:name> <maml:description> <maml:para>Gets or sets the SharedCertificateAuthority (SCA) mode for adding the route. Because a valid certificate is expected at the target, it is not necessary to enter credentials.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="true" globbing="false" pipelineInput="false" position="named" aliases="SCA"> <maml:name>SCA</maml:name> <maml:description> <maml:para>Gets or sets the SharedCertificateAuthority (SCA) mode for adding the route. Because a valid certificate is expected at the target, it is not necessary to enter credentials.</maml:para> <maml:para>This is an alias of the SharedCertAuth parameter.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: IgnoreCN --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>IgnoreCN</maml:name> <maml:description> <maml:para>Gets or sets the 'Ignore Common Name' mode for SharedCertificateAuthority (SCA) while adding the route.</maml:para> <maml:para>The "CommonName" of the certificate must correspond to the name used when establishing the connection in the certificate. This behavior can be deactivated by this option.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Unidirectional --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Unidirectional</maml:name> <maml:description> <maml:para>Gets or sets the unidirectional setting. The Unidirectional setting registers the ADS Route as 'one-way' channel. That means that the engineering/source system (thats where the route request is initiated) can send requests to the remote target, but not in the opposite direction.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Quiet --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="Silent"> <maml:name>Quiet</maml:name> <maml:description> <maml:para>The Quiet parameter suppresses the 'ShouldProcess' messsage and the Cmdlet will be processed without further user confirmation.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="Silent"> <maml:name>Silent</maml:name> <maml:description> <maml:para>The Quiet parameter suppresses the 'ShouldProcess' messsage and the Cmdlet will be processed without further user confirmation.</maml:para> <maml:para>This is an alias of the Quiet parameter.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Force --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para>Forces the command (no confirmation, Resets the FailFastHandler)</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Nat --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Nat</maml:name> <maml:description> <maml:para>The 'Nat' parameter sets the local representation of the routes AmsNetId. All (local) addressing to this netId will be translated to the remote/network AmsAddress of the route. If using the '-Nat' parameter, the 'Add-AdsRoute' Cmdlet is limited to single route additions. Multi-adding is not supported. This Parameter can be used with TwinCAT Versions >= 3.1.4024.11.</maml:para> </maml:description> <command:parameterValue required="true">AmsNetId</command:parameterValue> <dev:type> <maml:name>TwinCAT.Ads.AmsNetId</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: PassThru --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>PassThru</maml:name> <maml:description> <maml:para>If the passthrough parameter is set, the successfully created route will be returned as object. By default, this Cmdlet will not create any output.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>TwinCAT.IRoute[]</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>The input Ads Routes.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>> Get-AdsRoute -All -name "Tc3*" Name NetId Address Sub TcVersion RTSystem ---- ----- ------- --- --------- -------- TC3TestA1-CP67x 172.17.62.105.1.1 172.17.62.105 3.1.4021 Win7 TC3Test13-C6650 192.168.0.239.1.1 172.17.62.156 2.11.2246 Win7 PS> $cred = Get-Credential -Message "Get Credentials" -UserName "UserName" PS> Add-AdsRoute -Credential $cred -Address "TC3TestA1-CP67x" -temporary -passthru Name NetId Address Sub TcVersion RTSystem ---- ----- ------- --- --------- -------- TC3TestA1-CP67x 172.17.62.105.1.1 172.17.62.105 3.1.4021 Win7 PS> Get-AdsRoute -name "TC3TestA1-CP67x" | Test-AdsRoute</dev:code> <dev:remarks> <maml:para>Search for Systems that start with the name "TC3*", then asks the user for Credentials and adds the Route as 'temporary' (with TC2 compatible security, clear text password). Afterwards, the connection is checked via 'Test-AdsRoute'.</maml:para> <maml:para>The route is specified by its name (ComputerName). To find out the address of the route an under the hood broadcast search is necessary what means that the target system must be online available in the network.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 2 ----------</maml:title> <dev:code>> Add-AdsRoute -name Test -NetId 1.2.3.4.1.1 -IPOrHostName 1.2.3.4</dev:code> <dev:remarks> <maml:para>Adds a Route named 'Test' to the local routes with the specified NetId and IPAddress. Because NetId and IPOrHostName are defined AND no credentials are set, this route is added locally only.</maml:para> <maml:para>Be aware that to get the route functional, the target system must define the backroute.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 3 ----------</maml:title> <dev:code>> Get-AdsRoute -All -name "Tc3*" Name NetId Address Sub TcVersion RTSystem ---- ----- ------- --- --------- -------- TC3TestA1-CP67x 172.17.62.105.1.1 172.17.62.105 3.1.4021 Win7 TC3Test13-C6650 192.168.0.239.1.1 172.17.62.156 2.11.2246 Win7 PS> $cred = Get-Credential -Message "Get Credentials" -UserName "UserName" PS> Add-AdsRoute -Credential $cred -Address "TC3TestA1-CP67x" -selfSigned -passthru Name NetId Address Sub TcVersion RTSystem ---- ----- ------- --- --------- -------- TC3TestA1-CP67x 172.17.62.105.1.1 172.17.62.105 3.1.4021 Win7 PS> Get-AdsRoute -name "TC3TestA1-CP67x" | Test-AdsRoute</dev:code> <dev:remarks> <maml:para>Search for Systems that start with the name "TC3*", then asks the user for Credentials and adds the Route with 'SelfSigned' AdsSecure settings. Afterwards, the connection is checked via 'Test-AdsRoute'.</maml:para> <maml:para>The route is specified by its name (ComputerName). To find out the address of the route an under the hood broadcast search is necessary what means that the target system must be online available in the network.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 4 ----------</maml:title> <dev:code>PS> Add-AdsRoute -Address 172.17.62.105 -sca -passthru Name NetId Address Sub TcVersion RTSystem ---- ----- ------- --- --------- -------- TC3TestA1-CP67x 172.17.62.105.1.1 172.17.62.105 3.1.4021 Win7</dev:code> <dev:remarks> <maml:para>Searches for the system with the specified IPAddress, and add the Route with Shared Certification Authority settings without password. The precondition is, that valid certificates are already established on both (engineering and remote) systems, within their StaticRoutes.xml files.</maml:para> <maml:para>The route is specified by its Address only. Because the NetId is missing a broadcast search is necessary what means that the target system must be online available in the network.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 5 ----------</maml:title> <dev:code>PS> $cred = Get-Credential -Message "Get Credentials" -UserName "UserName" PS> Add-AdsRoute -Credential $cred -NetId 172.17.62.105 -Nat 1.2.3.4.1.1 Name NetId Address Sub TcVersion RTSystem --------------- ----------- ------------- --- --------- ------------ TC3TestA1-CP67x 1.2.3.4.1.1 172.17.62.105 3.1.4024 Win10 (2004)</dev:code> <dev:remarks> <maml:para>Add a route with a local network address translation (NAT AmsNetId) to project a remote AmsNetId (RemoteNetId) locally to a different address.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 6 ----------</maml:title> <dev:code>Add-AdsRoute -name "TestRoute" -NetId 1.2.3.4.1.1 -IPOrHostName 1.2.3.4 -Temporary -RemotePersistance None</dev:code> <dev:remarks> <maml:para>Adding a route 'TestRoute' single sided and temporary only to the local system. The remote device doesn't need to be online.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 7 ----------</maml:title> <dev:code>PS> $route = get-adsroute CX_01234 -all PS> $route Name NetId TLS Address FingerPrint ---- ----- --- ------- ----------- CX_01234 192.168.0.197.1.1 X 192.168.0.197 7835dae7a079c4f296c84109b2e6d7156b66e6bcc39e386c3576d7535… PS> $route | add-adsroute -SharedCertAuth -IgnoreCN -passthru Name NetId TLS Address FingerPrint ---- ----- --- ------- ----------- CX_01234 192.168.0.197.1.1 X 192.168.0.197 7835dae7a079c4f296c84109b2e6d7156b66e6bcc39e386c3576d7535…</dev:code> <dev:remarks> <maml:para>Broadcast search for a Device with Hostname CX_01234 and adding of a ADSSecure route via 'Shared Certificate Authority' (SCA) to the local system. Both systems must contain certificates derived from the same root CA certificate.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 8 ----------</maml:title> <dev:code>PS> $cred = get-credential UserName: MyUser Password: ******** PS> $route = get-adsroute CX_01234 -all PS> $route Name NetId TLS Address FingerPrint ---- ----- --- ------- ----------- CX_01234 192.168.0.197.1.1 X 192.168.0.197 7835dae7a079c4f296c84109b2e6d7156b66e6bcc39e386c3576d7535… PS> $route | add-adsroute -PreSharedKey -Credential $cred Name NetId TLS Address FingerPrint ---- ----- --- ------- ----------- CX_01234 192.168.0.197.1.1 X 192.168.0.197 7835dae7a079c4f296c84109b2e6d7156b66e6bcc39e386c3576d7535…</dev:code> <dev:remarks> <maml:para>Broadcast search for a Device with Hostname CX_01234 and adding of a ADSSecure route via 'Preshared key' (UserName, Password) to the local system. The target system must already contain the preshared key configuration (as Psk Identity/Password) in its StaticRoutes.xml configuration file.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 9 ----------</maml:title> <dev:code>PS> $route = get-adsroute CX_01234 -all PS> $route Name NetId TLS Address FingerPrint ---- ----- --- ------- ----------- CX_01234 192.168.0.197.1.1 X 192.168.0.197 7835dae7a079c4f296c84109b2e6d7156b66e6bcc39e386c3576d7535… PS> $route | add-adsroute -PreSharedKey -Identity MyUser -BinaryKey 1,2,3,4,5,6,7,8,9,0xa,0xb,0xc,0xd,0xe,0xf Name NetId TLS Address FingerPrint ---- ----- --- ------- ----------- CX_01234 192.168.0.197.1.1 X 192.168.0.197 7835dae7a079c4f296c84109b2e6d7156b66e6bcc39e386c3576d7535…</dev:code> <dev:remarks> <maml:para>Broadcast search for a Device with Hostname CX_01234 and adding of a ADSSecure route via 'Preshared key' (Identity, BinaryKey) to the local system. The target system must already contain the preshared key configuration (as Psk Identity/BinaryKey) in its StaticRoutes.xml configuration file.</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <!-- Cmdlet: Get-AdsRoute --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Get-AdsRoute</command:name> <command:verb>Get</command:verb> <command:noun>AdsRoute</command:noun> <maml:description> <maml:para>List routes on a TwinCAT System / Broadcast search.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>This Cmdlet can list the routes configured on a TwinCAT local/remote system, or start determining all TwinCAT Systems within the current subnet.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: Broadcast --> <command:syntaxItem> <maml:name>Get-AdsRoute</maml:name> <!-- Parameter: Address --> <command:parameter required="false" globbing="true" pipelineInput="false" position="0" aliases="Name"> <maml:name>Address</maml:name> <maml:description> <maml:para>The Name / Address of the route to get. The address of the route can be coded as NetId, the HostName or the IPAddress in string representation. Wildcards are permitted.</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: All --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named" aliases="Broadcast"> <maml:name>All</maml:name> <maml:description> <maml:para>Broadcast switch. If activated a broadcast search is triggered within the local network. The search can be constrained additionally by the -Address/-Name parameter. Searching by Address (direct access of targets if no wildcards, otherwise using Broadcast search): - HostName: Searching the target by dns resolution and then via IP (fallback broadcast search filtering DeviceName/Hostname, not working over subnets!) - IPAddress: Directly accessing via IP (works also over subnets) - AmsNetId: Working via Broadcast search (not working over subnet segments!) Searching by Name: Works always via Broadcast search, wildcards permitted</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: BroadcastTimeout --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>BroadcastTimeout</maml:name> <maml:description> <maml:para>(Broadcast) Search Timeout in Seconds (Default 0 Seconds) 0 Seconds means that the Length of the search operation will be determined dynamically. If for a longer period no targets are arriving.</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <!-- Parameter: Force --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para>If set, the broadcast search won't use cached routes. The Route will be determined by broadcast always. Only available with the -All parameter.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: InputObject --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="Destination"> <maml:name>InputObject</maml:name> <maml:description> <maml:para>The Destination address specifies the target, where the the routes are determined. Use this to get the registered routes of a remote system. The Destination system can be specified by RouteName (route name on local system), AmsNetId, IPAddress or HostName</maml:para> </maml:description> <command:parameterValue required="true">IRoute</command:parameterValue> <dev:type> <maml:name>TwinCAT.IRoute</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: NetAdapter --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>NetAdapter</maml:name> <maml:description> <maml:para>The Network adapter name of the NetworkAdapter to use. By default e.g. Broadcast searches go out via all active Network adapters. This parameter can be use to restrict this.</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> <!-- Parameter set: GetRoutes --> <command:syntaxItem> <maml:name>Get-AdsRoute</maml:name> <!-- Parameter: Address --> <command:parameter required="false" globbing="true" pipelineInput="false" position="0" aliases="Name"> <maml:name>Address</maml:name> <maml:description> <maml:para>The Name / Address of the route to get. The address of the route can be coded as NetId, the HostName or the IPAddress in string representation. Wildcards are permitted.</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Access --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Access</maml:name> <maml:description> <maml:para>Defines the strategy how to get the remote routes. Valid methods are 'Merged', 'Actual', 'Configuration', 'Registry'. The default value is 'Default' / 'Merged'</maml:para> <maml:para>Possible values: None, Actual, Registry, Configured, Merged, Default</maml:para> </maml:description> <command:parameterValue required="true">RouteAccessType</command:parameterValue> <dev:type> <maml:name>TwinCAT.RouteAccessType</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Merged</dev:defaultValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">None</command:parameterValue> <command:parameterValue required="false" variableLength="false">Actual</command:parameterValue> <command:parameterValue required="false" variableLength="false">Registry</command:parameterValue> <command:parameterValue required="false" variableLength="false">Configured</command:parameterValue> <command:parameterValue required="false" variableLength="false">Merged</command:parameterValue> <command:parameterValue required="false" variableLength="false">Default</command:parameterValue> </command:parameterValueGroup> </command:parameter> <!-- Parameter: BroadcastTimeout --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>BroadcastTimeout</maml:name> <maml:description> <maml:para>(Broadcast) Search Timeout in Seconds (Default 0 Seconds) 0 Seconds means that the Length of the search operation will be determined dynamically. If for a longer period no targets are arriving.</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <!-- Parameter: Force --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para>If set, the broadcast search won't use cached routes. The Route will be determined by broadcast always. Only available with the -All parameter.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: InputObject --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="Destination"> <maml:name>InputObject</maml:name> <maml:description> <maml:para>The Destination address specifies the target, where the the routes are determined. Use this to get the registered routes of a remote system. The Destination system can be specified by RouteName (route name on local system), AmsNetId, IPAddress or HostName</maml:para> </maml:description> <command:parameterValue required="true">IRoute</command:parameterValue> <dev:type> <maml:name>TwinCAT.IRoute</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> <!-- Parameter set: LocalSystem --> <command:syntaxItem> <maml:name>Get-AdsRoute</maml:name> <!-- Parameter: Local --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named" aliases="Self"> <maml:name>Local</maml:name> <maml:description> <maml:para>If set, the local system route will be returned. By default a list of the actual registered routes will be returned.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: InputObject --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="Destination"> <maml:name>InputObject</maml:name> <maml:description> <maml:para>The Destination address specifies the target, where the the routes are determined. Use this to get the registered routes of a remote system. The Destination system can be specified by RouteName (route name on local system), AmsNetId, IPAddress or HostName</maml:para> </maml:description> <command:parameterValue required="true">IRoute</command:parameterValue> <dev:type> <maml:name>TwinCAT.IRoute</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: All --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named" aliases="Broadcast"> <maml:name>All</maml:name> <maml:description> <maml:para>Broadcast switch. If activated a broadcast search is triggered within the local network. The search can be constrained additionally by the -Address/-Name parameter. Searching by Address (direct access of targets if no wildcards, otherwise using Broadcast search): - HostName: Searching the target by dns resolution and then via IP (fallback broadcast search filtering DeviceName/Hostname, not working over subnets!) - IPAddress: Directly accessing via IP (works also over subnets) - AmsNetId: Working via Broadcast search (not working over subnet segments!) Searching by Name: Works always via Broadcast search, wildcards permitted</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="true" globbing="false" pipelineInput="false" position="named" aliases="Broadcast"> <maml:name>Broadcast</maml:name> <maml:description> <maml:para>Broadcast switch. If activated a broadcast search is triggered within the local network. The search can be constrained additionally by the -Address/-Name parameter. Searching by Address (direct access of targets if no wildcards, otherwise using Broadcast search): - HostName: Searching the target by dns resolution and then via IP (fallback broadcast search filtering DeviceName/Hostname, not working over subnets!) - IPAddress: Directly accessing via IP (works also over subnets) - AmsNetId: Working via Broadcast search (not working over subnet segments!) Searching by Name: Works always via Broadcast search, wildcards permitted</maml:para> <maml:para>This is an alias of the All parameter.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: BroadcastTimeout --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>BroadcastTimeout</maml:name> <maml:description> <maml:para>(Broadcast) Search Timeout in Seconds (Default 0 Seconds) 0 Seconds means that the Length of the search operation will be determined dynamically. If for a longer period no targets are arriving.</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <!-- Parameter: NetAdapter --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>NetAdapter</maml:name> <maml:description> <maml:para>The Network adapter name of the NetworkAdapter to use. By default e.g. Broadcast searches go out via all active Network adapters. This parameter can be use to restrict this.</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Address --> <command:parameter required="false" globbing="true" pipelineInput="false" position="0" aliases="Name"> <maml:name>Address</maml:name> <maml:description> <maml:para>The Name / Address of the route to get. The address of the route can be coded as NetId, the HostName or the IPAddress in string representation. Wildcards are permitted.</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" globbing="true" pipelineInput="false" position="0" aliases="Name"> <maml:name>Name</maml:name> <maml:description> <maml:para>The Name / Address of the route to get. The address of the route can be coded as NetId, the HostName or the IPAddress in string representation. Wildcards are permitted.</maml:para> <maml:para>This is an alias of the Address parameter.</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: InputObject --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="Destination"> <maml:name>InputObject</maml:name> <maml:description> <maml:para>The Destination address specifies the target, where the the routes are determined. Use this to get the registered routes of a remote system. The Destination system can be specified by RouteName (route name on local system), AmsNetId, IPAddress or HostName</maml:para> </maml:description> <command:parameterValue required="true">IRoute</command:parameterValue> <dev:type> <maml:name>TwinCAT.IRoute</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="Destination"> <maml:name>Destination</maml:name> <maml:description> <maml:para>The Destination address specifies the target, where the the routes are determined. Use this to get the registered routes of a remote system. The Destination system can be specified by RouteName (route name on local system), AmsNetId, IPAddress or HostName</maml:para> <maml:para>This is an alias of the InputObject parameter.</maml:para> </maml:description> <command:parameterValue required="true">IRoute</command:parameterValue> <dev:type> <maml:name>TwinCAT.IRoute</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Access --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Access</maml:name> <maml:description> <maml:para>Defines the strategy how to get the remote routes. Valid methods are 'Merged', 'Actual', 'Configuration', 'Registry'. The default value is 'Default' / 'Merged'</maml:para> <maml:para>Possible values: None, Actual, Registry, Configured, Merged, Default</maml:para> </maml:description> <command:parameterValue required="true">RouteAccessType</command:parameterValue> <dev:type> <maml:name>TwinCAT.RouteAccessType</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Merged</dev:defaultValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">None</command:parameterValue> <command:parameterValue required="false" variableLength="false">Actual</command:parameterValue> <command:parameterValue required="false" variableLength="false">Registry</command:parameterValue> <command:parameterValue required="false" variableLength="false">Configured</command:parameterValue> <command:parameterValue required="false" variableLength="false">Merged</command:parameterValue> <command:parameterValue required="false" variableLength="false">Default</command:parameterValue> </command:parameterValueGroup> </command:parameter> <!-- Parameter: Local --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named" aliases="Self"> <maml:name>Local</maml:name> <maml:description> <maml:para>If set, the local system route will be returned. By default a list of the actual registered routes will be returned.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="true" globbing="false" pipelineInput="false" position="named" aliases="Self"> <maml:name>Self</maml:name> <maml:description> <maml:para>If set, the local system route will be returned. By default a list of the actual registered routes will be returned.</maml:para> <maml:para>This is an alias of the Local parameter.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Force --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para>If set, the broadcast search won't use cached routes. The Route will be determined by broadcast always. Only available with the -All parameter.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>PS> Get-AdsRoute Name NetId Address Sub TcVersion RTSystem ---- ----- ------- --- --------- --------- CP-15ECA0 172.17.62.128.1.1 172.17.62.178 [UNKNOWN] [UNKNOWN] CP-15ECA1 172.17.62.105.1.1 172.17.62.105 [UNKNOWN] [UNKNOWN]</dev:code> <dev:remarks> <maml:para>Lists all registered local routes. Because only the local port 10000 is addressed, the TcVersion and RTSystem is unknown (the Cmdlet doesn't contact the targets and doesn't produce additional roundtrips.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 2 ----------</maml:title> <dev:code> PS> get-AdsRoute -All Name NetId Address Sub Version RTSystem ---- ----- ------- --- ------- -------- CX-1CEEDA 5.16.136.222.1.1 172.17.62.139 3.1.4020 Win7 CX-20BC62 5.32.188.98.1.1 172.17.62.90 3.1.4020 CE6.0 CX-10A87B 5.16.168.123.1.1 172.17.62.140 2.11.2254 CE7.0 CP-15ECA0 172.17.62.128.1.1 172.17.62.178 3.1.4021 Win7 CX-0A7F60 5.10.127.96.1.1 172.17.62.148 3.1.4020 XP CX2030-B4018 172.17.60.157.1.1 172.17.60.159 2.11.2256 Win7 CP_11BB16 5.17.187.22.1.1 172.17.60.180 2.11.2038 CE6.0 CX-128CE5 172.17.60.165.1.1 172.17.62.191 2.11.2237 CE7.0 CX-124218 5.18.66.24.1.1 172.17.60.192 3.1.4021 Win7 CX-1D82AA 172.17.62.180.1.1 172.17.62.180 3.1.4021 Win8 CX_0AB4F0 5.10.180.240.1.1 172.17.60.195 2.11.2243 XP CP-1DFA0A 172.17.62.118.1.1 172.17.62.118 3.1.4021 Win7 CX-AF0001 172.17.62.75.1.1 172.17.62.70 3.1.4020 Win10</dev:code> <dev:remarks> <maml:para>Start a Broadcast search from the local system and lists the devices within the connected network.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 3 ----------</maml:title> <dev:code> PS> Get-AdsRoute -Name "Tc3*" Name NetId Address Sub Version RTSystem ---- ----- ------- --- ------- -------- TC3TESTA1-CP67X 172.17.62.105.1.1 172.17.62.105 0.0 Unknown</dev:code> <dev:remarks> <maml:para>Get the (actual) route assigned to the local system that has the name pattern "Tc3*"</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 4 ----------</maml:title> <dev:code> PS> Get-AdsRoute -All | where TcVersion -lt "3.1.0.0" Name NetId Address Sub Version RTSystem ---- ----- ------- --- ------- -------- TC3Test17-C6930 172.17.62.98.1.1 172.17.62.98 2.11.2234 Win7 CX2030-B4018 172.17.60.157.1.1 172.17.60.159 2.11.2256 Win7 CX-10A87B 5.16.168.123.1.1 172.17.62.140 2.11.2254 CE7.0 TC3Test13-C6650 172.17.60.239.1.1 172.17.62.156 2.11.2246 Win7 ECATTest01 172.17.61.6.1.1 172.17.61.31 2.11.2239 Win7 CX-128CE5 172.17.60.165.1.1 172.17.62.191 2.11.2237 CE7.0 CX_0AB4F0 5.10.180.240.1.1 172.17.60.195 2.11.2243 XP CP_11BB16 5.17.187.22.1.1 172.17.60.180 2.11.2038 CE6.0</dev:code> <dev:remarks> <maml:para>Find out all TwinCAT Systems within the network with Version numbers lower than '3.1.0.0'</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 5 ----------</maml:title> <dev:code>PS> $runningAdaptors = @(get-netadapter | Where-Object -Property Status -eq Up) PS> get-AdsRoute -all -NetAdapterName $runningAdaptors[0].Name -verbose VERBOSE: Broadcast search from system 'CX_11111' ... VERBOSE: Broadcasting over the Network Adapter(s) 'Ethernet 1' Name NetId Protocol TLS Address FingerPrint ---- ----- -------- --- ------- ----------- CX_22222 192.168.0.2.1.1 TcpIP X 192.168.0.2 xxxxxxxxxxx VERBOSE: Broadcast search finished. Found '1' route(s)</dev:code> <dev:remarks> <maml:para>Determines the first active Network adapter for broadcasting and returns the found targets.</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <!-- Cmdlet: Remove-AdsRoute --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Remove-AdsRoute</command:name> <command:verb>Remove</command:verb> <command:noun>AdsRoute</command:noun> <maml:description> <maml:para>Remove an ADS Route.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: Address --> <command:syntaxItem> <maml:name>Remove-AdsRoute</maml:name> <!-- Parameter: Address --> <command:parameter required="true" globbing="true" pipelineInput="false" position="0" aliases="Name"> <maml:name>Address</maml:name> <maml:description> <maml:para>The address for the ADS route to remove. This can be the NetId, the HostName or the IPAddress. Wildcards are permitted.</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Credentials --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Credentials</maml:name> <maml:description> <maml:para>Destination system route credentials (only if removing remotely).</maml:para> </maml:description> <command:parameterValue required="true">PSCredential</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.PSCredential</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>System.Management.Automation.PSCredential</dev:defaultValue> </command:parameter> <!-- Parameter: Destination --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Destination</maml:name> <maml:description> <maml:para>The destination address, where to Remove the specified route. This can be the NetId, the HostName or the IPAddress</maml:para> </maml:description> <command:parameterValue required="true">IRoute</command:parameterValue> <dev:type> <maml:name>TwinCAT.IRoute</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Force --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para>Forces the command (no confirmation, Resets the FailFastHandler)</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Mode --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Mode</maml:name> <maml:description> <maml:para>The Mode parameter indicates if the Router should be deleted on on side or on both sides (default).</maml:para> <maml:para>Possible values: Single, Both</maml:para> </maml:description> <command:parameterValue required="true">RouteChangeMode</command:parameterValue> <dev:type> <maml:name>TwinCAT.Management.RouteChangeMode</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Both</dev:defaultValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Single</command:parameterValue> <command:parameterValue required="false" variableLength="false">Both</command:parameterValue> </command:parameterValueGroup> </command:parameter> <!-- Parameter: Quiet --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="Silent"> <maml:name>Quiet</maml:name> <maml:description> <maml:para>The Quiet parameter suppresses the 'ShouldProcess' messsage and the Cmdlet will be processed without further user confirmation.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> <!-- Parameter set: NetId --> <command:syntaxItem> <maml:name>Remove-AdsRoute</maml:name> <!-- Parameter: NetId --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>NetId</maml:name> <maml:description> <maml:para>The NetID of the route to remove.</maml:para> </maml:description> <command:parameterValue required="true">AmsNetId</command:parameterValue> <dev:type> <maml:name>TwinCAT.Ads.AmsNetId</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Credentials --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Credentials</maml:name> <maml:description> <maml:para>Destination system route credentials (only if removing remotely).</maml:para> </maml:description> <command:parameterValue required="true">PSCredential</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.PSCredential</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>System.Management.Automation.PSCredential</dev:defaultValue> </command:parameter> <!-- Parameter: Destination --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Destination</maml:name> <maml:description> <maml:para>The destination address, where to Remove the specified route. This can be the NetId, the HostName or the IPAddress</maml:para> </maml:description> <command:parameterValue required="true">IRoute</command:parameterValue> <dev:type> <maml:name>TwinCAT.IRoute</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Force --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para>Forces the command (no confirmation, Resets the FailFastHandler)</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Mode --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Mode</maml:name> <maml:description> <maml:para>The Mode parameter indicates if the Router should be deleted on on side or on both sides (default).</maml:para> <maml:para>Possible values: Single, Both</maml:para> </maml:description> <command:parameterValue required="true">RouteChangeMode</command:parameterValue> <dev:type> <maml:name>TwinCAT.Management.RouteChangeMode</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Both</dev:defaultValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Single</command:parameterValue> <command:parameterValue required="false" variableLength="false">Both</command:parameterValue> </command:parameterValueGroup> </command:parameter> <!-- Parameter: Quiet --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="Silent"> <maml:name>Quiet</maml:name> <maml:description> <maml:para>The Quiet parameter suppresses the 'ShouldProcess' messsage and the Cmdlet will be processed without further user confirmation.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> <!-- Parameter set: Route --> <command:syntaxItem> <maml:name>Remove-AdsRoute</maml:name> <!-- Parameter: InputObject --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>InputObject</maml:name> <maml:description> <maml:para>A collection of routes to remove (Pipeline support).</maml:para> </maml:description> <command:parameterValue required="true">RouteTargetCollection</command:parameterValue> <dev:type> <maml:name>TwinCAT.RouteTargetCollection</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Credentials --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Credentials</maml:name> <maml:description> <maml:para>Destination system route credentials (only if removing remotely).</maml:para> </maml:description> <command:parameterValue required="true">PSCredential</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.PSCredential</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>System.Management.Automation.PSCredential</dev:defaultValue> </command:parameter> <!-- Parameter: Destination --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Destination</maml:name> <maml:description> <maml:para>The destination address, where to Remove the specified route. This can be the NetId, the HostName or the IPAddress</maml:para> </maml:description> <command:parameterValue required="true">IRoute</command:parameterValue> <dev:type> <maml:name>TwinCAT.IRoute</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Force --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para>Forces the command (no confirmation, Resets the FailFastHandler)</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Mode --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Mode</maml:name> <maml:description> <maml:para>The Mode parameter indicates if the Router should be deleted on on side or on both sides (default).</maml:para> <maml:para>Possible values: Single, Both</maml:para> </maml:description> <command:parameterValue required="true">RouteChangeMode</command:parameterValue> <dev:type> <maml:name>TwinCAT.Management.RouteChangeMode</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Both</dev:defaultValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Single</command:parameterValue> <command:parameterValue required="false" variableLength="false">Both</command:parameterValue> </command:parameterValueGroup> </command:parameter> <!-- Parameter: Quiet --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="Silent"> <maml:name>Quiet</maml:name> <maml:description> <maml:para>The Quiet parameter suppresses the 'ShouldProcess' messsage and the Cmdlet will be processed without further user confirmation.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Destination --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Destination</maml:name> <maml:description> <maml:para>The destination address, where to Remove the specified route. This can be the NetId, the HostName or the IPAddress</maml:para> </maml:description> <command:parameterValue required="true">IRoute</command:parameterValue> <dev:type> <maml:name>TwinCAT.IRoute</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Address --> <command:parameter required="true" globbing="true" pipelineInput="false" position="0" aliases="Name"> <maml:name>Address</maml:name> <maml:description> <maml:para>The address for the ADS route to remove. This can be the NetId, the HostName or the IPAddress. Wildcards are permitted.</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" globbing="true" pipelineInput="false" position="0" aliases="Name"> <maml:name>Name</maml:name> <maml:description> <maml:para>The address for the ADS route to remove. This can be the NetId, the HostName or the IPAddress. Wildcards are permitted.</maml:para> <maml:para>This is an alias of the Address parameter.</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: NetId --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>NetId</maml:name> <maml:description> <maml:para>The NetID of the route to remove.</maml:para> </maml:description> <command:parameterValue required="true">AmsNetId</command:parameterValue> <dev:type> <maml:name>TwinCAT.Ads.AmsNetId</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: InputObject --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>InputObject</maml:name> <maml:description> <maml:para>A collection of routes to remove (Pipeline support).</maml:para> </maml:description> <command:parameterValue required="true">RouteTargetCollection</command:parameterValue> <dev:type> <maml:name>TwinCAT.RouteTargetCollection</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Quiet --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="Silent"> <maml:name>Quiet</maml:name> <maml:description> <maml:para>The Quiet parameter suppresses the 'ShouldProcess' messsage and the Cmdlet will be processed without further user confirmation.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="Silent"> <maml:name>Silent</maml:name> <maml:description> <maml:para>The Quiet parameter suppresses the 'ShouldProcess' messsage and the Cmdlet will be processed without further user confirmation.</maml:para> <maml:para>This is an alias of the Quiet parameter.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Force --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para>Forces the command (no confirmation, Resets the FailFastHandler)</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Credentials --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Credentials</maml:name> <maml:description> <maml:para>Destination system route credentials (only if removing remotely).</maml:para> </maml:description> <command:parameterValue required="true">PSCredential</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.PSCredential</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>System.Management.Automation.PSCredential</dev:defaultValue> </command:parameter> <!-- Parameter: Mode --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Mode</maml:name> <maml:description> <maml:para>The Mode parameter indicates if the Router should be deleted on on side or on both sides (default).</maml:para> <maml:para>Possible values: Single, Both</maml:para> </maml:description> <command:parameterValue required="true">RouteChangeMode</command:parameterValue> <dev:type> <maml:name>TwinCAT.Management.RouteChangeMode</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Both</dev:defaultValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Single</command:parameterValue> <command:parameterValue required="false" variableLength="false">Both</command:parameterValue> </command:parameterValueGroup> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>TwinCAT.RouteTargetCollection</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>A collection of routes to remove (Pipeline support).</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>PS> Get-AdsRoute Name NetId Address Sub TcVersion RTSystem ---- ----- ------- --- --------- -------- CP-15ECA0 172.17.62.128.1.1 172.17.62.178 0.0 Unknown TC3TESTA1-CP67X 172.17.62.105.1.1 172.17.62.105 0.0 Unknown PS> Remove-AdsRoute -Name "CP-15ECA0","TC3TESTA1*"</dev:code> <dev:remarks> <maml:para>Removes the Routes "CP-15ECA0" and "TC3TESTA1-CP67X" from the local system.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 2 ----------</maml:title> <dev:code>PS> Get-AdsRoute | Remove-AdsRoute -silent</dev:code> <dev:remarks> <maml:para>Removes all registered routes from the local system.</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <!-- Cmdlet: Test-AdsRoute --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Test-AdsRoute</command:name> <command:verb>Test</command:verb> <command:noun>AdsRoute</command:noun> <maml:description> <maml:para>Test the specified route connection.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>This Cmdlet establishes a connection to the specified target system and tests if the connection is working. A Port scan can be executed.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: AddressStr --> <command:syntaxItem> <maml:name>Test-AdsRoute</maml:name> <!-- Parameter: Name --> <command:parameter required="false" globbing="false" pipelineInput="false" position="0" aliases="Address"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name(s) or address(es) of the systems to test. These can consist of RouteName, NetID, HostName or IPAddress. Wildcards are permitted.</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Port --> <command:parameter required="false" globbing="false" pipelineInput="false" position="1"> <maml:name>Port</maml:name> <maml:description> <maml:para>The Port(s) of the target system to test.</maml:para> </maml:description> <command:parameterValue required="true">int[]</command:parameterValue> <dev:type> <maml:name>System.Int32[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Count --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Count</maml:name> <maml:description> <maml:para>Specifies the number of echo/ping requests to send. The default value is 1.</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>1</dev:defaultValue> </command:parameter> <!-- Parameter: DefaultPorts --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>DefaultPorts</maml:name> <maml:description> <maml:para>Tests all default ports. The following ports will be tested: 10000, 300, 301, 302, 303, 501, 801, 811, 821, 831, 850, 851, 852, 853, 854, 855, 19200 The 'DefaultPorts' switch overrides the 'Port' parameter.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Delay --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Delay</maml:name> <maml:description> <maml:para>Specifies the interval between pings/tests, in seconds. The default value is 1 Second.</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>1</dev:defaultValue> </command:parameter> <!-- Parameter: Mode --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Mode</maml:name> <maml:description> <maml:para>The Ping Strategy (PingStrategy.Ads by default)</maml:para> <maml:para>Possible values: None, IP, HostName, IPOrHostName, Ads, AdsGetState, AdsTestConnection, Default</maml:para> </maml:description> <command:parameterValue required="true">PingStrategy</command:parameterValue> <dev:type> <maml:name>TwinCAT.PingStrategy</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Default</dev:defaultValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">None</command:parameterValue> <command:parameterValue required="false" variableLength="false">IP</command:parameterValue> <command:parameterValue required="false" variableLength="false">HostName</command:parameterValue> <command:parameterValue required="false" variableLength="false">IPOrHostName</command:parameterValue> <command:parameterValue required="false" variableLength="false">Ads</command:parameterValue> <command:parameterValue required="false" variableLength="false">AdsGetState</command:parameterValue> <command:parameterValue required="false" variableLength="false">AdsTestConnection</command:parameterValue> <command:parameterValue required="false" variableLength="false">Default</command:parameterValue> </command:parameterValueGroup> </command:parameter> <!-- Parameter: OnlinePorts --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OnlinePorts</maml:name> <maml:description> <maml:para>Determines all active/online ports from the target and tests them. The 'OnlinePorts' switch overrides the 'DefaultPorts' and 'Port' parameters.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Quiet --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Quiet</maml:name> <maml:description> <maml:para>The Quiet mode. Returns a boolean only ($true, if one ping succeeded and $false if all failed)</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: ScanSeconds --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="TTL,TimeToLive,TimeoutSeconds"> <maml:name>ScanSeconds</maml:name> <maml:description> <maml:para>Sets timeout for each single test request. The test fails if a (single) response isn't received before the timeout expires. The default timeout is 2 seconds.</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>2</dev:defaultValue> </command:parameter> <!-- Parameter: SourceRoute --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="Source"> <maml:name>SourceRoute</maml:name> <maml:description> <maml:para>The source system where to test the Route.</maml:para> </maml:description> <command:parameterValue required="true">RouteTarget</command:parameterValue> <dev:type> <maml:name>TwinCAT.RouteTarget</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> <!-- Parameter set: NetId --> <command:syntaxItem> <maml:name>Test-AdsRoute</maml:name> <!-- Parameter: Port --> <command:parameter required="false" globbing="false" pipelineInput="false" position="1"> <maml:name>Port</maml:name> <maml:description> <maml:para>The Port(s) of the target system to test.</maml:para> </maml:description> <command:parameterValue required="true">int[]</command:parameterValue> <dev:type> <maml:name>System.Int32[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: NetId --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="named"> <maml:name>NetId</maml:name> <maml:description> <maml:para>The NetId(s) of the target system to test (AmsNetId.Local by default)</maml:para> </maml:description> <command:parameterValue required="true">AmsNetId[]</command:parameterValue> <dev:type> <maml:name>TwinCAT.Ads.AmsNetId[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Count --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Count</maml:name> <maml:description> <maml:para>Specifies the number of echo/ping requests to send. The default value is 1.</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>1</dev:defaultValue> </command:parameter> <!-- Parameter: DefaultPorts --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>DefaultPorts</maml:name> <maml:description> <maml:para>Tests all default ports. The following ports will be tested: 10000, 300, 301, 302, 303, 501, 801, 811, 821, 831, 850, 851, 852, 853, 854, 855, 19200 The 'DefaultPorts' switch overrides the 'Port' parameter.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Delay --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Delay</maml:name> <maml:description> <maml:para>Specifies the interval between pings/tests, in seconds. The default value is 1 Second.</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>1</dev:defaultValue> </command:parameter> <!-- Parameter: Mode --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Mode</maml:name> <maml:description> <maml:para>The Ping Strategy (PingStrategy.Ads by default)</maml:para> <maml:para>Possible values: None, IP, HostName, IPOrHostName, Ads, AdsGetState, AdsTestConnection, Default</maml:para> </maml:description> <command:parameterValue required="true">PingStrategy</command:parameterValue> <dev:type> <maml:name>TwinCAT.PingStrategy</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Default</dev:defaultValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">None</command:parameterValue> <command:parameterValue required="false" variableLength="false">IP</command:parameterValue> <command:parameterValue required="false" variableLength="false">HostName</command:parameterValue> <command:parameterValue required="false" variableLength="false">IPOrHostName</command:parameterValue> <command:parameterValue required="false" variableLength="false">Ads</command:parameterValue> <command:parameterValue required="false" variableLength="false">AdsGetState</command:parameterValue> <command:parameterValue required="false" variableLength="false">AdsTestConnection</command:parameterValue> <command:parameterValue required="false" variableLength="false">Default</command:parameterValue> </command:parameterValueGroup> </command:parameter> <!-- Parameter: OnlinePorts --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OnlinePorts</maml:name> <maml:description> <maml:para>Determines all active/online ports from the target and tests them. The 'OnlinePorts' switch overrides the 'DefaultPorts' and 'Port' parameters.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Quiet --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Quiet</maml:name> <maml:description> <maml:para>The Quiet mode. Returns a boolean only ($true, if one ping succeeded and $false if all failed)</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: ScanSeconds --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="TTL,TimeToLive,TimeoutSeconds"> <maml:name>ScanSeconds</maml:name> <maml:description> <maml:para>Sets timeout for each single test request. The test fails if a (single) response isn't received before the timeout expires. The default timeout is 2 seconds.</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>2</dev:defaultValue> </command:parameter> <!-- Parameter: SourceRoute --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="Source"> <maml:name>SourceRoute</maml:name> <maml:description> <maml:para>The source system where to test the Route.</maml:para> </maml:description> <command:parameterValue required="true">RouteTarget</command:parameterValue> <dev:type> <maml:name>TwinCAT.RouteTarget</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> <!-- Parameter set: Route --> <command:syntaxItem> <maml:name>Test-AdsRoute</maml:name> <!-- Parameter: Port --> <command:parameter required="false" globbing="false" pipelineInput="false" position="1"> <maml:name>Port</maml:name> <maml:description> <maml:para>The Port(s) of the target system to test.</maml:para> </maml:description> <command:parameterValue required="true">int[]</command:parameterValue> <dev:type> <maml:name>System.Int32[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: InputObject --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="named" aliases="Destination"> <maml:name>InputObject</maml:name> <maml:description> <maml:para>The routes targets to test with this Cmdlet.</maml:para> </maml:description> <command:parameterValue required="true">RouteTargetCollection</command:parameterValue> <dev:type> <maml:name>TwinCAT.RouteTargetCollection</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Count --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Count</maml:name> <maml:description> <maml:para>Specifies the number of echo/ping requests to send. The default value is 1.</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>1</dev:defaultValue> </command:parameter> <!-- Parameter: DefaultPorts --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>DefaultPorts</maml:name> <maml:description> <maml:para>Tests all default ports. The following ports will be tested: 10000, 300, 301, 302, 303, 501, 801, 811, 821, 831, 850, 851, 852, 853, 854, 855, 19200 The 'DefaultPorts' switch overrides the 'Port' parameter.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Delay --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Delay</maml:name> <maml:description> <maml:para>Specifies the interval between pings/tests, in seconds. The default value is 1 Second.</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>1</dev:defaultValue> </command:parameter> <!-- Parameter: Mode --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Mode</maml:name> <maml:description> <maml:para>The Ping Strategy (PingStrategy.Ads by default)</maml:para> <maml:para>Possible values: None, IP, HostName, IPOrHostName, Ads, AdsGetState, AdsTestConnection, Default</maml:para> </maml:description> <command:parameterValue required="true"> |