BgpWithdrawRouteCommand Object


Description:

Withdraw the BGP routes from the list of routers.

Can be used with Command Sequencer: Yes

GUI Command Name: BGP: Withdraw Route

Parents: Sequencer, StcSystem

BgpWithdrawRouteCommand Writable Attributes

Attribute Description
Common Writable Attributes ProgressCancelled
CategoryFilter

Category filter on the routes to be withdrawn.

Type: enum

Default: ANY

Possible Values:

Value Description
UNDEFINED

Route category is UNDEFINED.

PRIMARY

Route category is PRIMARY.

SECONDARY

Route category is SECONDARY.

UNIQUE

Route category is UNIQUE.

ANY

Route category is ANY.

PercentFilter

Percent of the total routes to be withdrawn.

Type: double

Default: 100.0

Range: 0 - 100

PrefixFilter

Prefix filter on the routes to be withdrawn.

Type: u8

Default: 0

Range: 0 - 128

RouteList

Select one or more routers.

Type: handle

Default: 0

BgpWithdrawRouteCommand Read-Only Attributes

Read-Only Attribute Description
Common Read-Only Attributes ElapsedTime, EndTime, ProgressCurrentStep, ProgressCurrentStepName, ProgressCurrentValue, ProgressDisplayCounter, ProgressMaxValue, ProgressStepsCount, StartTime, State, Status