| Overview | Package | Class | Deprecated | Help |
| Properties | |
|---|---|
| addPathSendLimit |
Specifies the operational value for the ADD-PATH send limit for the policy statement. Configure a value from the valid range, or enable multipath advertisement with value -1.
type=int default=0 minimum=-1 maximum=16 Displayed(tab/group)=Add Paths Send Limit (/Add Paths Send Limit) |
| adminTagPolicy |
type=Pointer default= Displayed(tab/group)=Admin Tag Policy Name (/Admin Tag Policy) |
| advertiseLabel |
Specifies the advertisement label mode for the route matching this entry.
type=rp.AdvertiseLabelMode default=none Displayed(tab/group)=Advertise Label |
| aigpMetric |
type=rp.AigpMetric default=none Displayed(tab/group)=Metric (/Accumulated IGP Metric) |
| aigpMetricParam |
Specifies the Add, subtract or set metric value.
aigpMetric and aigpMetricParam are mutually exclusive.
type=string default= minimum=0 maximum=32 Displayed(tab/group)=Policy/Global Variable (/Accumulated IGP Metric/) |
| aigpMetricValue |
Specifies the Add, subtract or set metric value.
aigpMetric and aigpMetricParam are mutually exclusive.
type=long default=0 minimum=0 maximum=4294967295 Displayed(tab/group)=Value (/Accumulated IGP Metric) |
| bfdSidAddressType |
The value of tRPAdminPSAActSrv6RPathBfdSidTyp specifies the type of
tRPAdminPSAActSrv6RPathBfdSid.
type=rtr.InetAddressType default=unknown |
| bfdSidParam |
The value of tRPAdminPSAActSrv6RPathBfdSidPar specifies the variable
name that must be resolved to get the SRv6 Return Path BFD SID to set
in route.
The value of this object tRPAdminPSAActSrv6RPathBfdSidPar is ignored
when the object tRPAdminPSAActSrv6RPathBfdSidSrc has a value different
from actionParam(2).
type=string default= minimum=0 maximum=32 Displayed(tab/group)=Policy/Global Variable (/SRv6 Return Path BFD/) |
| bfdSidValue |
The value of tRPAdminPSAActSrv6RPathBfdSid specifies the the SRv6
Return Path BFD SID.
The SID can only be set if tRPAdminPSAcptActSrMaintPolicy is set.
type=InetAddress default=0:0:0:0:0:0:0:0 Displayed(tab/group)=BFD Sid value (/SRv6 Return Path BFD) |
| bgpHighPriority |
Specifies when enabled that prefixes for routes matching the entry have a higher priority for next-hop resolution when a BGP topology change is processed.
type=boolean default=false Displayed(tab/group)=BGP High Priority |
| bgpLeaking |
Specifies whether BGP leaking is applied for the route matching this entry.
type=boolean default=false Displayed(tab/group)=BGP Leaking |
| bgpMedExpression |
Indicates the expression that is used to calculate the BGP MED value. The value of this object is ignored when the object
bgpMedSource has a value different from 'expression'.
type=string default= minimum=0 maximum=64 Displayed(tab/group)=Expression (/BGP Metric) |
| bgpMedSource |
Specifies the source to resolve to get the BGP MED value.
When the value is 'igp', the BGP MED value is set to the IGP cost of
the route or tunnel that resolves the BGP next-hop of the received BGP
route.
When the value is 'minIgp', the BGP MED value is set to the minimum
IGP cost;i.e. if the cost of the resolving route or tunnel increases
the advertised MED is not changed.
When the value is 'medValue', the BGP MED value is set to the value of
bgpMedValue.
When the value is 'expression', the BGP MED value is set based on a
calculation of the provided expression in bgpMedExpression.
type=rp.BGPMedSource default=none Displayed(tab/group)=Source (/BGP Metric) |
| bgpMedValue |
Specifies the the BGP MED value. The value of this object can be a string containing the BGP MED value
or a variable name that needs to be resolved to get the BGP MED value.The value of this object can be a string
containing the BGP MED value in the range [0..4294967295] or a variable name that needs to be resolved to get the BGP MED value.
The value of this object is ignored when the object bgpMedSource has a value different from 'medValue'.
type=string default= minimum=0 maximum=32 Displayed(tab/group)=Policy/Global Variable (/BGP Metric/MED Value) |
| bgpPreferAigp |
Specifies when enabled that the routing policy uses the AIGP metric as the BGP Tunnel metric for path selection.
type=boolean default=false Displayed(tab/group)=Preference AIGP (/BGP Tunnel Metric) |
| bgpTunlMetPrefMed |
specifies whether it is preferred to use the value of the received MED attribute as BGP Tunnel Metric.
If the value is 'true', the attached MED attribute is preferred to use as TTM metric above the Bgp Tunnel Metric.
If a MED metric is not attached or if the value is 'false' or if AIGP metric is preferred, the TTM metric is set based on the attached AIGP metric or
set to Bgp Tunnel Metric.
The value of this object is ignored if the object Bgp Tunnel Metric is empty.
type=boolean default=false Displayed(tab/group)=Preference MED (/BGP Tunnel Metric) |
| bgpTunnelMetric |
Specifies the the BGP Tunnel Metric value. The value of this object can be a string containing the BGP Tunnel value
or a variable name that needs to be resolved to get the BGP Tunnel value.The value of this object can be a string
containing the BGP Tunnel value in the range [0..4294967295] or a variable name that needs to be resolved to get the BGP Tunnel value.
type=string default= minimum=0 maximum=32 Displayed(tab/group)=Policy/Global Variable (/BGP Tunnel Metric/) |
| communityAction1 |
DEPRECATED: 11.0.R1- Deprecated from 11.0 R1 for 7750, 7450, 7710 and 7950 nodes. Moved to AddCommunityAction or RemoveCommunityAction or ReplaceCommunityAction depending on communityAction1 type type=rp.ActionQualifier default=none |
| communityAction2 |
DEPRECATED: 11.0.R1- Deprecated from 11.0 R1 for 7750, 7450, 7710 and 7950 nodes. Moved to AddCommunityAction or RemoveCommunityAction or ReplaceCommunityAction depending on communityAction2 type type=rp.ActionQualifier default=none |
| communityName1 |
The community list name configured for the Action.
It is used in conjunction with communityAction1: communityName1 should not be set
if communityAction1 is ActionQualifier.none
DEPRECATED: 11.0.R1- Deprecated from 11.0 R1 for 7750, 7450, 7710 and 7950 nodes. Moved to AddCommunityAction or RemoveCommunityAction or ReplaceCommunityAction depending on communityAction1 type type=string default= minimum=0 maximum=64 |
| communityName2 |
The community list name configured for the Action.
It is used in conjunction with communityAction2: communityName2 should not be set
if communityAction2 is ActionQualifier.none
DEPRECATED: 11.0.R1- Deprecated from 11.0 R1 for 7750, 7450, 7710 and 7950 nodes. Moved to AddCommunityAction or RemoveCommunityAction or ReplaceCommunityAction depending on communityAction2 type type=string default= minimum=0 maximum=64 |
| createMplsTunnel |
specifies whether a MPLS tunnel must be instantiated for the route matching the entry.
type=boolean default=false Displayed(tab/group)=Create MPLS Tunnel |
| damping |
type=string default= minimum=0 maximum=32 Displayed(tab/group)=Damping Profile Name (/Damping) |
| destinationClass |
Specifies the default admin destination-class for this policy-statement. A value of 0 means no destination-class.
type=int default=0 minimum=0 maximum=255 Displayed(tab/group)=Destination Class Index (/Source/Destination Class Index) |
| disableRtTableInstall |
Specifies whether to disable the installation of a BGP route in the Routing Table and the
Forwarding Information Base (FIB).
type=boolean default=false |
| egressStats |
specifies whether to collect egress statistics for BGP Labeled Unicast routes
type=boolean default=false Displayed(tab/group)=Egress Statistics (/Statistics) |
| flexAlgo |
Specifies the identifier of theFlexible Algorithm.The value of this object can be a string containing the Flex Algo Id
value in the range [128..255] or a variable name that needs to be resolved to get the Flex Algo Id.
type=string default= minimum=0 maximum=32 Displayed(tab/group)=Policy/Global Variable (/Flex-Algo/) |
| ingressStats |
specifies whether to collect ingress statistics for BGP Labeled Unicast routes
type=boolean default=false Displayed(tab/group)=Ingress Statistics (/Statistics) |
| instBackupPath |
Specifies whether the installation of a backup path is desired for the route matching this entry.
type=boolean default=false Displayed(tab/group)=Install Backup Path |
| isBfdSidEnabled |
type=boolean default=false Displayed(tab/group)=Use BFD Sid (/SRv6 Return Path BFD) |
| isNextHopEnabled |
type=boolean default=false Displayed(tab/group)=Use Next Hop (/Next Hop) |
| localPreference |
BGP local preference configured for the Action.
It is used in conjunction with localPreferenceSet:
localPreference should not be set (to values other than 0) if localPreferenceSet is TruthValue.false
localPreference and localPreferenceParam are mutually exclusive.
type=long default=0 minimum=0 maximum=4294967295 Displayed(tab/group)=Value (/BGP Local Preference) |
| localPreferenceParam |
BGP local preference configured for the Action.
It is used in conjunction with localPreferenceSet:
localPreference should not be set (to values other than 0) if localPreferenceSet is TruthValue.false
localPreference and localPreferenceParam are mutually exclusive.
type=string default= minimum=0 maximum=32 Displayed(tab/group)=Policy/Global Variable (/BGP Local Preference/) |
| localPreferenceSet |
type=generic.TruthValue default=false Displayed(tab/group)=Local Preference Set (/BGP Local Preference) |
| metricAction |
type=rp.MetricQualifier default=none Displayed(tab/group)=Action (/Metric) |
| metricParam |
The metric value configured for the Action.
It is used in conjunction with metricAction: metricValue should not be set
if metricAction is MetricQualifier.none
metricValue and metricParam are mutually exclusive.
type=string default= minimum=0 maximum=32 Displayed(tab/group)=Policy/Global Variable (/Metric/) |
| metricSource |
Indicates the source of the default action metric.
type=rp.MetricSource default=metricVal Displayed(tab/group)=Source (/Metric) |
| metricValue |
The metric value configured for the Action.
It is used in conjunction with metricAction: metricValue should not be set
if metricAction is MetricQualifier.none
metricValue and metricParam are mutually exclusive.
type=long default=0 minimum=0 maximum=4294967295 Displayed(tab/group)=Value (/Metric) |
| nextHop |
Next hop IP address configured for the Action.
IT is used in conjunction with isNextHopEnabled: nextHop should not be set
if isNextHopEnabled is false.
nextHop and nextHopParam are mutually exclusive.
type=InetAddress default=0.0.0.0 Displayed(tab/group)=Value (/Next Hop) |
| nextHopParam |
Next hop IP address configured for the Action.
nextHop and nextHopParam are mutually exclusive.
type=string default= minimum=0 maximum=32 Displayed(tab/group)=Policy/Global Variable (/Next Hop/) |
| nextHopPeerAddress |
Indicates whether the next-hop must be set to the peer address.
type=boolean default=false Displayed(tab/group)=Peer Address (/Next Hop) |
| nextHopSelf |
Either nextHop or nextHopSelf can be set to TruthValue.true but not both.
type=generic.TruthValue default=false Displayed(tab/group)=Advertise Next Hop Self |
| nextHopType |
Next hop IP address configured for the Action.
IT is used in conjunction with isNextHopEnabled: nextHop should not be set
if isNextHopEnabled is false.
type=rtr.InetAddressType default=ipv4 |
| origin |
Specifies the origin of the route exported into BGP if it doesnot match any entry.
origin and originParam are mutually exclusive.
type=rp.Origin default=none Displayed(tab/group)=Value (/Route Origin) |
| originParam |
Specifies the origin of the route exported into BGP if it doesnot match any entry.
origin and originParam are mutually exclusive.
type=string default= minimum=0 maximum=32 Displayed(tab/group)=Policy/Global Variable (/Route Origin/) |
| originValidationState |
Specifies the origin validation state for this entry.
originValidationState and originValidationStateParam are mutually exclusive.
type=rp.OriginValidationState default=notApplicable Displayed(tab/group)=Value (/Origin Validation State) |
| originValidationStateParam |
Specifies the origin validation state for this entry.
originValidationState and originValidationStateParam are mutually exclusive.
type=string default= minimum=0 maximum=32 Displayed(tab/group)=Policy/Global Variable (/Origin Validation State/) |
| pathAction |
type=rp.ActionQualifier default=none Displayed(tab/group)=BGP AS Path Action (Path) |
| pathName |
The name of the As path list configured for the Action.
It is used in conjunction with pathAction: if pathAction is ActionQualifier.none
pathName should not be set.
type=string default= minimum=0 maximum=32 Displayed(tab/group)=BGP AS Path Name (Path) |
| prefTransFrr |
Specifies the value of tRPAdminPSDefActPrefTransFrr specifies whether transport fast-re-route should be preferred.
type=boolean default=false Displayed(tab/group)=Prefer Transport FRR |
| preference |
Specifies the preference to be applied to the route.
preference and preferenceParam are mutually exclusive.
type=long default=0 minimum=0 maximum=255 Displayed(tab/group)=Value (/Route Preference) |
| preferenceParam |
Specifies the preference to be applied to the route.
preference and preferenceParam are mutually exclusive.
type=string default= minimum=0 maximum=32 Displayed(tab/group)=Policy/Global Variable (/Route Preference/) |
| prependAs |
The As number to prepend configured for the Action.
It is used in conjunction with prependCount: prependCount should be 0 if prependAs is not 0.
PrependAs and prependAsParam are mutually exclusive.
type=long default=0 minimum=0 maximum=4294967295 Displayed(tab/group)=BGP AS Prepend number (Path) |
| prependAsParam |
The As number to prepend configured for the Action.
It is used in conjunction with prependCount: prependCount should be 0 if prependAs is not 0.
PrependAs and prependAsParam are mutually exclusive.
type=string default= minimum=0 maximum=32 Displayed(tab/group)=BGP AS Prepend Policy/Global Variable (Path/) |
| prependCount |
type=long default=0 minimum=0 maximum=50 Displayed(tab/group)=Prepend Count (Path) |
| prependCountParam |
The variable name that must be resolved to get prepend count configured for the Action.
type=string default= minimum=0 maximum=32 Displayed(tab/group)=Prepend Count Policy/Global Variable (Path/) |
| prependMostRecentAS |
Specifies whether the most recent AS number must be prepended to the AS-Path attribute of the route.
type=boolean default=false Displayed(tab/group)=Prepend Most Recent AS (Path) |
| resolveStatic |
Specifies when enabled that the BGP next-hop for the route matching this entry is the resolved next-hop of the static route.
This parameter affects BGP export policies and applies only to BGP routes created by exporting static routes with indirect next-hops.
When the parameter is enabled, the BGP next-hop is the resolved next-hop of the static route.
When the parameter is not enabled, the BGP next-hop is copied from the indirect next-hop.
type=boolean default=false |
| routeType |
Specifies the OSPF route type for the route.
routeType and routeTypeParam are mutually exclusive.
type=rp.RouteType default=0 Displayed(tab/group)=Value (/OSPF Route Type) |
| routeTypeParam |
Specifies the OSPF route type for the route.
routeType and routeTypeParam are mutually exclusive.
type=string default= minimum=0 maximum=32 Displayed(tab/group)=Policy/Global Variable (/OSPF Route Type/) |
| sourceClass |
Specifies the default admin source-class for this policy-statement. A value of 0 means no source-class.
type=int default=0 minimum=0 maximum=255 Displayed(tab/group)=Source Class Index (/Source/Destination Class Index) |
| srLabelIndex |
The value of srLabelIndex specifies the the Segment Routing (SR) Label Index value.
The value of this object can be a string containing the SR label Index value in the range [1..524287] or a variable name that needs to be
resolved to get the SR Label Index.
type=string default= minimum=0 maximum=32 Displayed(tab/group)=Policy/Global Variable (/SR Label Index/) |
| srLabelIndexPrefIgp |
The value of srLabelIndexPrefIgp specifies whether it is preferred to use the SR Label Index from the IGP route.
When the value is 'true', BGP will use the SR Label Index form the IGP route when present else it will use the value from
srLabelIndex. When the value is 'false', BGP will always use the srLabelIndex.
The value of this object is ignored when the object srLabelIndex is empty.
type=generic.TruthValue default=false Displayed(tab/group)=Preference IGP (/SR Label Index) |
| srMaintPolicy |
specifies the named segment routing (SR) maintenance policy for SR policy routes.
type=Pointer default= Displayed(tab/group)=SR Maintenance Policy (/SR Maintenance Policy) |
| srReturnPathBfdLable |
The value of tRPAdminPSAActSrReturnPathBfdLbl specifies the Return
Path MPLS label for the BFD packet from the route matching this entry.
The SID can only be set if tRPAdminPSAcptActSrMaintPolicy is set.
The value of this object can be a string containing the label value in
the range [32..1048512] or a variable name TPolicyVariableName that
needs to be resolved to get the label. An empty string means that it
is disabled.
type=string default= minimum=0 maximum=32 Displayed(tab/group)=Policy/Global Variable (/SR Return Path BFD Label/) |
| srv6Locator |
The value of srv6Locator specifies the Segment
Routing over IPv6 (SRv6) locator to advertise for the route matching
this entry.
The locator name must exist in TIMETRA-SRV6:vRtrSrv6LocatorTable.
The value of this object can be a string containing the
locator or a variable name TPolicyVariableName that needs
to be resolved to get the locator. An empty string
means that it is disabled.
The objects tRPAdminPSAcptActSrv6Locator and
tRPAdminPSAcptActSrv6MSLocator are mutually exclusive.
type=Pointer default= Displayed(tab/group)=SRv6 Locator (/SRv6 Locator) |
| stickyECMP |
The Sticky ECMP parameter specifies whether or not the routing policy permits sticky ECMP considerations for route management on
routers that support this capability. When the route to a sticky ECMP prefix has multiple ECMP next-hops and one or more of those
next-hops go down, affected flows are redistributed as evenly as possible to the remaining next-hops. Unaffected traffic flows continue to
be hashed to the same next-hops that existed prior to the failures.
type=boolean default=false Displayed(tab/group)=Sticky ECMP |
| tag |
Specifies the tag for the route.
tag and tagParam are mutually exclusive.
DEPRECATED: 14.0.R1 - Use tagInDecimal instead. type=string default=0 minimum=1 maximum=8 units=hex |
| tagInDecimal |
Specifies the tag for the route.
tag and tagParam are mutually exclusive.
type=long default=0 minimum=0 maximum=4294967295 Displayed(tab/group)=Value (/OSPF, RIP or ISIS Tag) |
| tagParam |
Specifies the tag for the route.
tag and tagParam are mutually exclusive.
type=string default= minimum=0 maximum=32 Displayed(tab/group)=Policy/Global Variable (/OSPF, RIP or ISIS Tag/) |
| udpTunnelCreateEnabled |
type=boolean default=false Displayed(tab/group)=Create UDP Tunnels Enabled |
| Properties inherited from rp.StatementItem |
|---|
| itemType |
| Properties inherited from rp.PolicyObjectBaseItem |
|---|
| policyName, routingInstance, routingInstanceName |
| Properties inherited from policy.PolicyItemDefinition |
|---|
| containingPolicyDisplayedName, containingPolicyId |
| Properties inherited from policy.PolicyObject |
|---|
| description, displayedName, globalPolicy, id, isLocal, policyType, siteId, siteName, templateObject |
| Properties inherited from ManagedObject |
|---|
| actionMask, children-Set, deploymentState, isFaultSquelched, name, objectFullName, selfAlarmed |