RouteGenApplyCommand Object


Description:

Apply the specified route/topology generator parameters. When the apply command is called, the route/topology parameters are expanded into protocol specific objects (OSPF LSAs, IS-IS LSPs, BGP routes, RIP routes, and so on).

Can be used with Command Sequencer: No

Parents: Sequencer, StcSystem

RouteGenApplyCommand Writable Attributes

Attribute Description
Common Writable Attributes ProgressCancelled
DeleteRoutesOnApply

How to handle pre-existing routes when the route/topology generator parameters are applied.

Type: enum

Default: PROMPT

Possible Values:

Value Description
PROMPT

Prompt user for YES/NO response.

YES

Delete pre-existing routes.

NO

Keep pre-existing routes. Note: This may cause duplicate routes, if the new route addresses overlap the old route addresses.

GenParams

Route/topology generator parameters to apply.

Type: handle

Default: 0

RouteGenApplyCommand Read-Only Attributes

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

A summary string describing the results of the route/topology generation.

Type: string

Default: "" (empty string)