Register-AdsNatRoute
SYNOPSIS
Changes an standard Route to an AmsNAT route on the target system (obsolete).
SYNTAX
Name (Default)
Register-AdsNatRoute [-Name] <String> -NATNetId <AmsNetId> [-Destination <String>] [-Quiet] [-Force]
[-WhatIf] [-Confirm] [<CommonParameters>]
NetId
Register-AdsNatRoute [-NetId] <AmsNetId> -NATNetId <AmsNetId> [-Destination <String>] [-Quiet] [-Force]
[-WhatIf] [-Confirm] [<CommonParameters>]
DESCRIPTION
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.
EXAMPLES
Example 1
PS> Register-AdsNatRoute -Name MyRoute -NATNetId 1.2.3.4.2.2
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').
Example 2
PS> Register-AdsNatRoute -NetId 1.2.3.4.1.1 -NATNetId 1.2.3.4.2.2 -Destination CX_1234
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'.
PARAMETERS
-Name
The Name of the Route where to add an AmsNAT entry. The Route name.
Type: String
Parameter Sets: Name
Aliases:
Required: True
Position: 0
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-NetId
The NetID which specifies the existing route where to add an AmsNAT entry. This NetId becomes the 'RemoteNetId' afterwards. The NetId.
Type: AmsNetId
Parameter Sets: NetId
Aliases:
Required: True
Position: 0
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-NATNetId
The NATNetId (the local representation of the remote system). The AmsNAT NetId.
Type: AmsNetId
Parameter Sets: (All)
Aliases:
Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Destination
The Destination system, where the AmsNAT translation is added. This Parameter allows RouteName, AmsNetId, IPAddress or HostName Tab completion: Completes route names from currently reachable ADS systems on the local TwinCAT system. The destination system.
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Quiet
The Quiet parameter suppresses the 'ShouldProcess' messsage and the Cmdlet will be processed without further user confirmation.. Value of the Quiet parameter
Type: SwitchParameter
Parameter Sets: (All)
Aliases: Silent
Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False
-Force
Forces the command (no confirmation, Resets the FailFastHandler) The quiet.
Type: SwitchParameter
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False
-Confirm
Prompts you for confirmation before running the cmdlet.
Type: SwitchParameter
Parameter Sets: (All)
Aliases: cf
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-WhatIf
Shows what would happen if the cmdlet runs. The cmdlet is not run.
Type: SwitchParameter
Parameter Sets: (All)
Aliases: wi
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.