| Overview | Package | Class | Deprecated | Help |
| Properties | |
|---|---|
| activeMgVmId |
Indicates the active VM included in the route policy entry.
type=int default=0 minimum=0 maximum=20 Displayed(tab/group)=Active MG VM-ID |
| addInterfaceNames |
Specifies the Interface names
type=string default= minimum=0 maximum=1100 Displayed(tab/group)=Interface Names (/Interface Subnets) |
| aggContributor |
Specifies whether aggregate contributor routes should be matched on.
When the value is 'true', only the more-specific prefixes that are
actually contributors are matched.
type=boolean default=false Displayed(tab/group)=Aggregate Contributor |
| area |
The OSPF area configured for From Criteria.
It is used in conjunction with areaSet: area should not be set if areaSet value is TruthValue.false
type=InetAddress default=0.0.0.0 Displayed(tab/group)=OSPF Area (/OSPF) |
| areaIpAddrType |
type=rtr.InetAddressType default=ipv4 |
| areaSet |
type=generic.TruthValue default=false Displayed(tab/group)=OSPF Area Set (/OSPF) |
| asPathGroupName |
type=string default= minimum=0 maximum=32 Displayed(tab/group)=AS Path Group Name |
| asPathLength |
Indicates the AS numbers in the BGP route to match against.
It can be a string stipulating the range [0-255], or a variable used to resolve the AS-Path length.
type=string default= minimum=0 maximum=32 Displayed(tab/group)=AS Path Length |
| asPathLengthIndicator |
Indicates if a higher or lower value is used to match the AS Path length against.
type=rp.IndicatorType default=equal Displayed(tab/group)=AS Path Length Indicator |
| asPathLengthUnique |
Indicates if a unique AS numbers is used to match the AS path length against.
When the value is true, multiple occurrences of the AS-Path count as 1 for calculating the AS-Path length.
type=boolean default=false Displayed(tab/group)=AS Path Length Unique |
| asPathName |
type=string default= minimum=0 maximum=32 Displayed(tab/group)=AS Path Name |
| bgpPathType |
The value of property indicates the path type to match the BGP route on.
type=rp.PathType default=none Displayed(tab/group)=BGP Path Type |
| bgpRouteMvpn |
Specifies the ng-MVPN route type used for matching when the policy is applied to multicast routes.
The configurable BGP MVPN route types 1 to 7 are based on RFC 6514
type=rp.MvpnRouteType default=none Displayed(tab/group)=BGP MVPN Route Type (/Multicast) |
| clusterAddressFive |
Indicates the fifth IP address encoded within the cluster parameter to match the BGP route on.
The fifth IP address mask pair is matched against the fifth most recent added cluster.
type=InetAddress default=0.0.0.0 Displayed(tab/group)=IP Address Five (/Cluster ID IP Addresses) |
| clusterAddressFiveMask |
Indicates the length of the fifth IP address encoded within the cluster parameter to match the BGP route on.
type=int default=0 minimum=0 maximum=32 Displayed(tab/group)=Mask (/Cluster ID IP Addresses) |
| clusterAddressFour |
Indicates the fourth IP address encoded within the cluster parameter to match the BGP route on.
The fourth IP address mask pair is matched against the fourth most recent added cluster.
type=InetAddress default=0.0.0.0 Displayed(tab/group)=IP Address Four (/Cluster ID IP Addresses) |
| clusterAddressFourMask |
Indicates the length of the fourth IP address encoded within the cluster parameter to match the BGP route on.
type=int default=0 minimum=0 maximum=32 Displayed(tab/group)=Mask (/Cluster ID IP Addresses) |
| clusterAddressOne |
Indicates the first IP address encoded within the cluster parameter to match the BGP route on.
The first IP address mask pair is matched against the most recently added cluster.
type=InetAddress default=0.0.0.0 Displayed(tab/group)=IP Address One (/Cluster ID IP Addresses) |
| clusterAddressOneMask |
Indicates the length of the first IP address encoded within the cluster parameter to match the BGP route on.
type=int default=0 minimum=0 maximum=32 Displayed(tab/group)=Mask (/Cluster ID IP Addresses) |
| clusterAddressThree |
Indicates the third IP address encoded within the cluster parameter to match the BGP route on.
The third IP address mask pair is matched against the third most recent added cluster.
type=InetAddress default=0.0.0.0 Displayed(tab/group)=IP Address Three (/Cluster ID IP Addresses) |
| clusterAddressThreeMask |
Indicates the length of the third IP address encoded within the cluster parameter to match the BGP route on.
type=int default=0 minimum=0 maximum=32 Displayed(tab/group)=Mask (/Cluster ID IP Addresses) |
| clusterAddressTwo |
Indicates the second IP address encoded within the cluster parameter to match the BGP route on.
The second IP address mask pair is matched against the second most recent added cluster.
type=InetAddress default=0.0.0.0 Displayed(tab/group)=IP Address Two (/Cluster ID IP Addresses) |
| clusterAddressTwoMask |
Indicates the length of the second IP address encoded within the cluster parameter to match the BGP route on.
type=int default=0 minimum=0 maximum=32 Displayed(tab/group)=Mask (/Cluster ID IP Addresses) |
| clusterAddressTypeFive |
type=rtr.InetAddressType default=ipv4 valid enums=ipv4 (Where parent is one of (rp.PolicyStatementEntry)) |
| clusterAddressTypeFour |
type=rtr.InetAddressType default=ipv4 valid enums=ipv4 (Where parent is one of (rp.PolicyStatementEntry)) |
| clusterAddressTypeOne |
type=rtr.InetAddressType default=ipv4 valid enums=ipv4 (Where parent is one of (rp.PolicyStatementEntry)) |
| clusterAddressTypeThree |
type=rtr.InetAddressType default=ipv4 valid enums=ipv4 (Where parent is one of (rp.PolicyStatementEntry)) |
| clusterAddressTypeTwo |
type=rtr.InetAddressType default=ipv4 valid enums=ipv4 (Where parent is one of (rp.PolicyStatementEntry)) |
| clusterIdNone |
Indicates whether only routes without any cluster IP parameter(s) should be matched on.
When the value is true, only routes without any cluster IP parameter(s) are matched.
This parameter is ignored when a cluster IP address(es) are configured.
type=boolean default=false Displayed(tab/group)=Cluster Id None |
| color |
specifies the SR policy color ID to match the route on.
The value can be a string containing the SR policy color ID value in the range [0..4294967295].
type=string default= minimum=0 maximum=32 Displayed(tab/group)=Color |
| communityCount |
Indicates the number of BGP communities in the BGP route to match against.
It can be a string stipulating the range [0-255], or a variable used to resolve the community count.
type=string default= minimum=0 maximum=32 Displayed(tab/group)=Community Count |
| communityCountIndicator |
Indicates if a higher or lower value is used to match the Community Count against.
type=rp.IndicatorType default=equal Displayed(tab/group)=Community Count Indicator |
| communityCountType |
Indicates which communities are used to match the Community Count against.
type=rp.CommunityCountType default=both Displayed(tab/group)=Community Count Type |
| communityName |
type=string default= minimum=0 maximum=64 Displayed(tab/group)=Community List Name |
| customProperties |
This is used for any custom properties for this object.
type=Map (string to string) |
| distinguisher |
specifies the SR policy distinguisher to match the route on.
The value can be a string containing the SR policy distinguisher value in the range [0..4294967295].
type=string default= minimum=0 maximum=32 Displayed(tab/group)=Distinguisher |
| endPoint |
Tspecifies the SR policy endpoint IP address to match the route on
type=InetAddress default=0.0.0.0 Displayed(tab/group)=End Point |
| endPointType |
type=rtr.InetAddressType default=ipv4 |
| evpnType |
Indicates the BGP route to match on.
type=rp.EvpnType default=none Displayed(tab/group)=EVPN Type |
| family |
Specifies the address families that this condition would match against.
type=bgp.BGPFamilyMask default=unspecified Displayed(tab/group)=Family |
| flowDstPrefixList |
Contains the name of the flow-spec destination prefix list to match on.
type=string default= minimum=0 maximum=64 Displayed(tab/group)=Destination Prefix List Name (/Flow-Spec) |
| flowSrcPrefixList |
Contains the name of the flow-spec source prefix list to match on.
type=string default= minimum=0 maximum=64 Displayed(tab/group)=Source Prefix List Name (/Flow-Spec) |
| igmpHostPrefixList |
type=string default= minimum=0 maximum=64 Displayed(tab/group)=IGMP Host Prefix List Name (/Multicast) |
| instanceIndex |
The value of instanceIndex specifies the instance
identifier of the ISIS or OSPF(v3) protocol running in the router instance.
The value of instanceIndex must be 0 in case ProtocolBits has a value different
from isis(5), ospf(6) and ospf3(12).
The supported instance range depends on the protocol that is set in ProtocolBits
protocol isis - instance range 0..127.
protocol ospf - instance range 0..31.
protocol ospf3 - instance range 0..31|64..95.
If the value of instanceIndex is 4294967295, all instances of the ISIS or OSPF(v3) protocol are leaked into BGP.
type=long default=0 minimum=0 maximum=4294967295 Displayed(tab/group)=Instance ID (/ISIS/OSPF Instance Configuration) |
| interfaceName |
type=string default= minimum=0 maximum=32 Displayed(tab/group)=Interface Name |
| isAllInstances |
Setting this value to true will cause the instanceIndex
to be set to a value of 2147483647 representing ALL.
type=boolean default=false Displayed(tab/group)=All Instances (/ISIS/OSPF Instance Configuration) |
| isSrv6SidPrefixEnabled |
type=boolean default=false Displayed(tab/group)=Use Srv6 Sid Prefix (/SRv6 Sid Prefix) |
| isisExternal |
type=generic.TruthValue default=false Displayed(tab/group)=IS-IS External Route (/ISIS) |
| localPreference |
Indicates the AS number in the BGP route to match against.
It can be a string stipulating the range [0..4294967295], or a variable used to resolve the AS-Path length.
type=string default= minimum=0 maximum=32 Displayed(tab/group)=Local Preference |
| localPreferenceIndicator |
Indicates if a higher or lower value is used to match the Local Preference against.
type=rp.IndicatorType default=equal Displayed(tab/group)=Local Preference Indicator |
| mcastGroupPrefixList |
type=string default= minimum=0 maximum=64 Displayed(tab/group)=Multicast Group Prefix List Name (/Multicast) |
| mcastSourceIpAddress |
type=InetAddress default=0.0.0.0 Displayed(tab/group)=Multicast Source IP Address (/Multicast) |
| mcastSourceIpAddressType |
Specifies type of mcastSourceIpAddress, as defined in InetAddress MIB.
type=rtr.InetAddressType default=ipv4 |
| mcastSourcePrefixList |
Contains the name of the source address prefix list to match on.
mcastSourceIpAddress and mcastSourcePrefixList are mutually exclusive.
type=string default= minimum=0 maximum=64 Displayed(tab/group)=Multicast Source Prefix List Name (/Multicast) |
| metric |
Indicates the metric used to match the BGP route against.
It can be a string stipulating the range [0..4294967295], or a variable used to resolve the metric value.
type=string default= minimum=0 maximum=32 Displayed(tab/group)=Metric |
| metricIndicator |
Indicates if a higher or lower value is used to match the Metric against.
type=rp.IndicatorType default=equal Displayed(tab/group)=Metric Indicator |
| nextHop |
Indicates the next-hop IP address to match the BGP route against.
type=InetAddress default=0.0.0.0 Displayed(tab/group)=Next Hop |
| nextHopPrefixList |
Indicates the Next Hop Prefix-List to match the BGP route against.
The Next Hop Prefix List is ignored if the Next Hop IP address is configured in Next Hop parameter.
type=string default= minimum=0 maximum=32 Displayed(tab/group)=Next Hop Prefix-List |
| nextHopType |
type=rtr.InetAddressType default=ipv4 |
| noRouteTag |
Setting this value to true will match routes that are untagged
type=boolean default=false Displayed(tab/group)=No Route Tag |
| origin |
NOTE: From NFM-P 17.3+ (SAM 15.R1) GUI, Origin type has changed on Global and Local Policy.
This is only changed on enum displayed name, not the enum value.
default=none Displayed(tab/group)=Origin |
| originValidationState |
type=rp.OriginValidationState default=notApplicable Displayed(tab/group)=Origin Validation State |
| ospfRouteType |
type=rp.RouteType default=0 Displayed(tab/group)=OSPF Route Type (/OSPF) |
| policy |
Specifies the policy match criterion for this entry.
It is used to link match criteria over multiple policy entries, to implement more complex match conditions.
type=string default= minimum=0 maximum=255 Displayed(tab/group)=Policy Statement Name |
| prefixList1 |
type=string default= minimum=0 maximum=64 |
| prefixList2 |
type=string default= minimum=0 maximum=64 |
| prefixList3 |
type=string default= minimum=0 maximum=64 |
| prefixList4 |
type=string default= minimum=0 maximum=64 |
| prefixList5 |
type=string default= minimum=0 maximum=64 |
| routeDistinguisherPointer |
It's specifies the route distinguisher (RD) list to match the route on.
type=Pointer default= Displayed(tab/group)=Route Distinguisher |
| rp.CommunityExpression-Set |
type=Children-Set |
| rp.FromCriteriaPrefixListMembers-Set |
type=Children-Set |
| rp.PSFromCriteriaPrefixListOverride-Set |
type=Children-Set |
| rp.PSPolicyVariables-Set |
type=Children-Set |
| serviceId |
The value specifies the service ID of the interface subnets to match on.
The value of this object can be a string containing the service ID
value. An empty string means that no service ID is configured.
If interface subnets are configured without service ID,
it is assumed they belong to the BASE routing instance.
type=string default= minimum=0 maximum=32 Displayed(tab/group)=Service ID (/Interface Subnets) |
| srv6SidPrefixAddress |
The value of srv6SidPrefixAddress indicates the SRv6 SID
prefix to match the BGP route on.
The value of this object is ignored when the object
tRPOperPSFromCritSrv6SidPfxSrc has a value different from
actionValue(1).
type=InetAddress default=0:0:0:0:0:0:0:0 Displayed(tab/group)=SRv6 Sid Prefix Address (/SRv6 Sid Prefix) |
| srv6SidPrefixLength |
The value of srv6SidPrefixLength indicates the the prefix
length of the SRv6 SID prefix.
The value of this object is ignored when the object
tRPOperPSFromCritSrv6SidPfxSrc has a value different from
actionValue(1)..
type=int default=0 minimum=0 maximum=128 Displayed(tab/group)=SRv6 Sid Prefix Length (/SRv6 Sid Prefix) |
| srv6SidPrefixParam |
The value of srv6SidPfxParam indicates the variable
name that must be resolved to get the SRv6 SID prefix to match on.
The value of this object is ignored when the object
tRPOperPSFromCritSrv6SidPfxSrc has a value different from
actionParam(2).
type=string default= minimum=0 maximum=32 Displayed(tab/group)=Policy/Global Variable (/SRv6 Sid Prefix/) |
| srv6SidPrefixType |
The value of srv6SidPrefixType indicates the type of
tRPOperPSFromCritSrv6SidPfxAddr.
The value of this object is ignored when the object
tRPOperPSFromCritSrv6SidPfxSrc has a value different from
actionValue(1).
type=rtr.InetAddressType default=unknown |
| srv6TLV |
The value of srv6TLV indicates whether BGP routes
should be matched with or without any SRv6 TLV present in the prefix
SID attribute.
none (0) - match condition is disabled
present (1) - match only the BGP routes with a SRv6 TLV present
notPresent (2) - match only the BGP routes without any SRv6 TLV
type=rp.Srv6TLVType default=none Displayed(tab/group)=SRv6 TLV |
| state |
type=rp.SrrpMasterState default=none Displayed(tab/group)=State |
| staticRouteTag |
type=long default=0 minimum=0 maximum=4294967295 Displayed(tab/group)=Static Route Tag |
| Overridden Properties | |
|---|---|
| itemType |
default=from |
| protocol |
suppress enums=mpls (Where parent is one of (rp.PolicyStatementEntry)) |
| Properties inherited from rp.Criteria |
|---|
| entryId, isDeployed, isisLevel, neighborIpAddress, neighborIpAddressType, neighborIpAddressWithZoneIndex, neighborIpAddressZoneIndexPointer, neighborPrefixList, protocol, protocolBits |
| 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 |
| Methods |
|---|
neId
: string -
policyName
: string -
entryId
: int -
continueOnFailure
: continueOnFailure - (Optional) Continue processing requests in this stream if an exception occurs, unless the request is invalid. Default: false
result
: string - The result of the executed command (returned as a string).
rp.FromCriteria.expandPolicyStatementException
filter
: FilterHolder -
resultFilter
: ResultFilter - (Optional) Filter for narrowing down the information returned per object
continueOnFailure
: continueOnFailure - (Optional) Continue processing requests in this stream if an exception occurs, unless the request is invalid. Default: false
infoList
: List (generic.CommonManagedEntityInformation) -