Set-AdsRouteProperty
SYNOPSIS
Sets route properties.
SYNTAX
NetId (Default)
Set-AdsRouteProperty [-RouteName] <String> [[-NetId] <AmsNetId>] -PropertyName <String> -Value <Object>
[-Timeout <Int32>] [-Force] [-WhatIf] [-Confirm] [<CommonParameters>]
Route
Set-AdsRouteProperty [-RouteName] <String> -InputObject <IRoute> -PropertyName <String> -Value <Object>
[-Timeout <Int32>] [-Force] [-WhatIf] [-Confirm] [<CommonParameters>]
AddressStr
Set-AdsRouteProperty [-RouteName] <String> -Address <String> -PropertyName <String> -Value <Object>
[-Timeout <Int32>] [-Force] [-WhatIf] [-Confirm] [<CommonParameters>]
Session
Set-AdsRouteProperty [-RouteName] <String> -Session <ISession> -PropertyName <String> -Value <Object>
[-Timeout <Int32>] [-Force] [-WhatIf] [-Confirm] [<CommonParameters>]
SessionId
Set-AdsRouteProperty [-RouteName] <String> -SessionId <Int32> -PropertyName <String> -Value <Object>
[-Timeout <Int32>] [-Force] [-WhatIf] [-Confirm] [<CommonParameters>]
DESCRIPTION
This Cmdlet sets properties at existing routes, for example enabling/disabling a route.
EXAMPLES
Example 1
PS> Set-AdsRouteProperty -RouteName MyRoute -PropertyName Disabled -value true
Disables the Route 'MyRoute' on the Local system.
Example 2
PS> Set-AdsRouteProperty -RouteName MyRoute -PropertyName Enabled -value true
Enables 'MyRoute' on the Local system.
PARAMETERS
-RouteName
Name of the Route to be changed. Tab completion: Completes route names from currently reachable ADS systems on the local TwinCAT system. The net id.
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Position: 2
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-NetId
Specifies the target system as NetId (where to change the property). Tab completion: Completes AmsNetId values from remote (non-local) reachable routes. The net id.
Type: AmsNetId
Parameter Sets: NetId
Aliases:
Required: False
Position: 1
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-InputObject
Specifies the target system as IRoute object (where to change the route property) Tab completion: Completes route names from remote (non-local) reachable routes. The input object.
Type: IRoute
Parameter Sets: Route
Aliases: Destination
Required: True
Position: Named
Default value: None
Accept pipeline input: True (ByValue)
Accept wildcard characters: False
-Address
Specifies the target system as RouteName/IPAddress/HostName or AmsNetId as string (where to change the property). Wildcards are permitted. Tab completion: Completes route names from remote (non-local) reachable routes. The address.
Type: String
Parameter Sets: AddressStr
Aliases:
Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: True
-Session
Specifies the target system (where to change the route property) as session. The address.
Type: ISession
Parameter Sets: Session
Aliases:
Required: True
Position: Named
Default value: None
Accept pipeline input: True (ByValue)
Accept wildcard characters: False
-SessionId
Specifies the Session (with unique ID) where to change the route property. Tab completion: Completes IDs of active TwinCAT sessions (created with New-TcSession). The Session ID.
Type: Int32
Parameter Sets: SessionId
Aliases:
Required: True
Position: Named
Default value: -1
Accept pipeline input: False
Accept wildcard characters: False
-PropertyName
Sets the specified property of the route. The property value is in the 'Value' argument. The name of the property to set.
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Value
Sets property value of the route. The property itself is specified by the 'PropertyName' argument. The value.
Type: Object
Parameter Sets: (All)
Aliases:
Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Timeout
The communication ADS timeout in milliseconds. A value of 0 disables the timeout. A value <= 0 sets the Default (5000 ms). The ADS communication timeout in milliseconds.
Type: Int32
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: -1
Accept pipeline input: False
Accept wildcard characters: False
-Force
Forces this command. It suppresses the ShouldContinue settings and bypasses the FailFastInterceptor to retry communication in every case. Force flag.
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.