Remove-AdsRoute
SYNOPSIS
Remove an ADS Route.
SYNTAX
Address (Default)
Remove-AdsRoute [-Destination <IRoute>] [-Address] <String[]> [-Quiet] [-Force] [-Credentials <PSCredential>]
[-Mode <RouteChangeMode>] [-ProgressAction <ActionPreference>] [-WhatIf] [-Confirm] [<CommonParameters>]
NetId
Remove-AdsRoute [-Destination <IRoute>] [-NetId] <AmsNetId> [-Quiet] [-Force] [-Credentials <PSCredential>]
[-Mode <RouteChangeMode>] [-ProgressAction <ActionPreference>] [-WhatIf] [-Confirm] [<CommonParameters>]
Route
Remove-AdsRoute [-Destination <IRoute>] [-InputObject] <RouteTargetCollection> [-Quiet] [-Force]
[-Credentials <PSCredential>] [-Mode <RouteChangeMode>] [-ProgressAction <ActionPreference>] [-WhatIf]
[-Confirm] [<CommonParameters>]
DESCRIPTION
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.
EXAMPLES
EXAMPLE 1
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*"
Removes the Routes "CP-15ECA0" and "TC3TESTA1-CP67X" from the local system.
EXAMPLE 2
PS> Get-AdsRoute | Remove-AdsRoute -silent
Removes all registered routes from the local system.
PARAMETERS
-Destination
The destination address, where to Remove the specified route.
This can be the NetId, the HostName or the IPAddress
Type: IRoute
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Address
The address for the ADS route to remove.
This can be the NetId, the HostName or the IPAddress.
Wildcards are permitted.
Type: String[]
Parameter Sets: Address
Aliases: Name
Required: True
Position: 0
Default value: None
Accept pipeline input: False
Accept wildcard characters: True
-NetId
The NetID of the route to remove.
Type: AmsNetId
Parameter Sets: NetId
Aliases:
Required: True
Position: 0
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-InputObject
A collection of routes to remove (Pipeline support).
Type: RouteTargetCollection
Parameter Sets: Route
Aliases:
Required: True
Position: 0
Default value: None
Accept pipeline input: True (ByValue)
Accept wildcard characters: False
-Quiet
The Quiet parameter suppresses the 'ShouldProcess' messsage and the Cmdlet will be processed without further user confirmation.
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)
Type: SwitchParameter
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False
-Credentials
Destination system route credentials (only if removing remotely).
Type: PSCredential
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: System.Management.Automation.PSCredential
Accept pipeline input: False
Accept wildcard characters: False
-Mode
The Mode parameter indicates if the Router should be deleted on on side or on both sides (default).
Possible values: Single, Both
Type: RouteChangeMode
Parameter Sets: (All)
Aliases:
Accepted values: Single, Both
Required: False
Position: Named
Default value: Both
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
-ProgressAction
{{ Fill ProgressAction Description }}
Type: ActionPreference
Parameter Sets: (All)
Aliases: proga
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.