RIB Objects

This page contains descriptions of the RIB related objects in the FlexSwitch object models.

Attention

Attributes without default values listed are required in API calls.

Configuration Objects

IPv4Route

config/IPv4Route

Attribute Data Type Description Permitted Values
Vrf [Key] string VRF id for IPv4Route config DEFAULT: default
DestinationNw [Key] string IP address of the route
NetworkMask [Key] string mask of the route
Protocol string Protocol type of the route DEFAULT: STATIC
Cost uint32 Cost of this route DEFAULT: 0
NullRoute bool Specify if this is a null route DEFAULT: false
NextHop []NextHopInfo

IPv6Route

config/IPv6Route

Attribute Data Type Description Permitted Values
Vrf [Key] string VRF id for IPv6Route config DEFAULT: default
DestinationNw [Key] string IP address of the route
NetworkMask [Key] string mask of the route
Protocol string Protocol type of the route DEFAULT: STATIC
Cost uint32 Cost of this route DEFAULT: 0
NullRoute bool Specify if this is a null route DEFAULT: false
NextHop []NextHopInfo

PolicyPrefixSet

config/PolicyPrefixSet

Attribute Data Type Description Permitted Values
Name [Key] string Policy Prefix set name.
PrefixList []PolicyPrefix List of policy prefixes part of this prefix set.

PolicyCommunitySet

config/PolicyCommunitySet

Attribute Data Type Description Permitted Values
Name [Key] string Policy Community List name
CommunityList []string List of policy communities part of this community list.

PolicyExtendedCommunitySet

config/PolicyExtendedCommunitySet

Attribute Data Type Description Permitted Values
Name [Key] string Policy Extended Community List name.
ExtendedCommunityList []PolicyExtendedCommunity List of policy communities part of this community list.

PolicyASPathSet

config/PolicyASPathSet

Attribute Data Type Description Permitted Values
Name [Key] string Policy ASPath List name.
ASPathList []string List of ASPaths part of this list.

PolicyCondition

config/PolicyCondition

Attribute Data Type Description Permitted Values
Name [Key] string PolicyConditionName
ConditionType string Specifies the match criterion this condition defines SELECTION: MatchProtocol/MatchDstIpPrefix/
MatchSrcIpPrefix/MatchCommunity/
MatchExtendedCommunity/MatchLocalPref/
MatchASPath/MatchMED
Protocol string Protocol to match on if the ConditionType is set to MatchProtocol SELECTION: CONNECTED/STATIC/OSPF/BGP
IpPrefix string Used in conjunction with MaskLengthRange to specify the IP Prefix to match on when the ConditionType is MatchDstIpPrefix/MatchSrcIpPrefix. DEFAULT:""
MaskLengthRange string Used in conjuction with IpPrefix to specify specify the IP Prefix to match on when the ConditionType is MatchDstIpPrefix/MatchSrcIpPrefix. DEFAULT:""
PrefixSet string Name of a pre-defined prefix set to be used as a condition qualifier. DEFAULT:""
Community string BGP Community attrribute value to match on when the conditionType is MatchCommunity - based on RFC 1997. Can either specify the well-known communities or any other community value in the format AA:NN or 0x1234abcd format or a number. DEFAULT:""
CommunitySet string Name of a pre-defined list of BGP communities attribute to match on when the conditionType is MatchCommunity DEFAULT:""
ExtendedCommunityType string Specifies BGP Extended Community type (used along with value)to match on when the conditionType is MatchExtendedCommunity - based on RFC 4360.",SELECTION:"Route-Target"/"Route-Origin DEFAULT:""
ExtendedCommunityValue string Specifies BGP Extended Community value (used along with type)to match on when the conditionType is MatchExtendedCommunity - based on RFC 4360.This is a ":" separated string.
Examples: 200:10 / 192.168.0.2:300 / 3000.200:210
DEFAULT:""
ExtendedCommunitySet string Name of a pre-defined list of BGP Extended Community type/values to match on when the ConditionType is MatchExtendedCommunity DEFAULT:""
LocalPref uint32 BGP LocalPreference attribute value to match on when the ConditionType is MatchLocalPref. DEFAULT: 0
ASPath string BGP ASPath value (specified using regular expressions) to match on when ConditionType is MatchASPath. DEFAULT:""
ASPathSet string Name of a pre-defined list of ASPath values to match on when ConditionType is MATCHASPath DEFAULT:""
MED uint32 BGP MED value ro match on when ConditionType is MatchMED DEFAULT: 0

PolicyStmt

config/PolicyStmt

Attribute Data Type Description Permitted Values
SetActions []PolicyAction A set of attr/value pairs to be set associatded with this statement.
Name [Key] string Policy Statement Name
MatchConditions string Specifies whether to match all/any of the conditions of this policy statement SELECTION: any/all
DEFAULT: all
Conditions []string List of conditions added to this policy statement
Action string Action for this policy statement SELECTION: permit/deny
DEFAULT: deny

PolicyDefinition

config/PolicyDefinition

Attribute Data Type Description Permitted Values
Name [Key] string Policy Name
Priority int32 Priority of the policy w.r.t other policies configured MIN: 0, MAX: 255
MatchType string Specifies whether to match all/any of the statements within this policy SELECTION:all/any
DEFAULT: all
PolicyType string Specifies the intended protocol application for the policy SELECTION: BGP/OSPF/ALL
DEFAULT: ALL
StatementList []PolicyDefinitionStmtPriority Specifies list of statements along with their precedence order.

RedistributionPolicy

config/RedistributionPolicy

Attribute Data Type Description Permitted Values
Vrf [Key] string VRF id for Redistribution policy config
Target [Key] string Target protocol for redistribution SELECTION: BGP/OSPF
Source [Key] string Source Protocol for redistribution SELECTION: CONNECTED/STATIC
Policy string Policy to be applied from source to Target

State Objects

IPv4RouteState

state/IPv4Route

Attribute Data Type Description Permitted Values
Vrf [Key] string VRF id for IPv4Route state DEFAULT: default
DestinationNw string IP address of the route
Protocol string Protocol type of the route DEFAULT: STATIC
IsNetworkReachable bool Indicates whether this network is reachable
RouteCreatedTime string Time when the route was added
RouteUpdatedTime string Time when the route was last updated
NextHopList []NextHopInfo List of next hops to reach this network
PolicyList []string List of policies applied on this route
NextBestRoute NextBestRouteInfo

IPv6RouteState

state/IPv6Route

Attribute Data Type Description Permitted Values
Vrf [Key] string VRF id for IPv6Route state DEFAULT: default
DestinationNw [Key] string IP address of the route
Protocol string Protocol type of the route DEFAULT: STATIC
IsNetworkReachable bool Indicates whether this network is reachable
RouteCreatedTime string Time when the route was added
RouteUpdatedTime string Time when the route was last updated
NextHopList []NextHopInfo List of next hops to reach this network
PolicyList []string List of policies applied on this route
NextBestRoute NextBestRouteInfo

RIBEventState

state/RIBEvent

Attribute Data Type Description Permitted Values
Vrf [Key] string VRF id for RIBEventState
Index uint32 Event ID
TimeStamp string Time when the event occured
EventInfo string Detailed description of the event"

PolicyPrefixSetState

state/PolicyPrefixSet

Attribute Data Type Description Permitted Values
Name [Key] string Policy Prefix set name.
PrefixList []PolicyPrefix List of policy prefixes part of this prefix set.
PolicyConditionList []string List of policy conditions using this prefix set

PolicyCommunitySetState

state/PolicyCommunitySet

Attribute Data Type Description Permitted Values
Name [Key] string Policy Community list name.
CommunityList []string List of policy communities part of this community list.
PolicyConditionList []string List of policy conditions using this community list

PolicyExtendedCommunitySetState

state/PolicyExtendedCommunitySet

Attribute Data Type Description Permitted Values
Name [Key] string Policy Community list name.
ExtendedCommunityList []PolicyExtendedCommunity List of policy extended communities part of this extended community list.
PolicyConditionList []string List of policy conditions using this extended community list

PolicyASPathSetState

state/PolicyASPathSet

Attribute Data Type Description Permitted Values
Name [Key] string Policy ASPath list name.
ASPathList []string List of ASPaths part of this community list.
PolicyConditionList []string List of policy conditions using this aspath list

PolicyConditionState

state/PolicyCondition

Attribute Data Type Description Permitted Values
Name [Key] string Condition name
ConditionInfo string
PolicyStmtList []string List of policy statements using this condition

PolicyStmtState

state/PolicyStmt

Attribute Data Type Description Permitted Values
Name [Key] string PolicyStmtState
MatchConditions string Specifies whether to match all/any of the conditions of this policy statement
Conditions []string List of conditions added to this policy statement
Action string Action corresponding to this policy statement
SetActions []PolicyAction A set of attr/value pairs to be set associatded with this statement.
PolicyList []string List of policies using this policy statement

PolicyDefinitionState

state/PolicyDefinition

Attribute Data Type Description Permitted Values
Name [Key] string PolicyDefinitionState
IpPrefixList []string List of networks/IP Prefixes this policy has been applied on to.

RouteDistanceState

state/RouteDistance

Attribute Data Type Description Permitted Values
Protocol [Key] string RouteDistanceState protocol
Distance int32 The current value of the admin distance of this protocol

RouteStatState

state/RouteStat

Attribute Data Type Description Permitted Values
Vrf [Key] string Vrf DEFAULT: default
TotalRouteCount int32 Total number of routes on the system
ECMPRouteCount int32 ECMP routes on the system
V4RouteCount int32 Total number of IPv4 routes on the system
V6RouteCount int32 Total number of IPv6 routes on the system
PerProtocolRouteCountList []PerProtocolRouteCount Per Protocol routes stats

RouteStatsPerProtocolState

state/RouteStatsPerProtocol

Attribute Data Type Description Permitted Values
Vrf [Key] string VRF id
Protocol [Key] string Protocol type of the route
V4Routes []RouteInfoSummary Brief summary info of ipv4 routes of this protocol type
V6Routes []RouteInfoSummary Brief summary info of ipv6 routes of this protocol type

RouteStatsPerInterfaceState

state/RouteStatsPerInterface

Attribute Data Type Description Permitted Values
Vrf [Key] string VRF id
Intfref [Key] string Interface of the next hop
V4Routes []string Brief summary info of ipv4 routes which have nexthop on this interface
V6Routes []string Brief summary info of ipv6 routes which have nexthop on this interface

Structures

NextHopInfo

Attribute Date Type Description Permitted Values
NextHopIp string next hop ip of the route DEFAULT: 0.0.0.0
NextHopIntRef string Interface name or ifindex of port/lag or vlan on which this next hop is configured
Weight int32 Weight of the next hop MIN:0, MAX:31
DEFAULT:0

NextBestRouteInfo

Attribute Date Type Description Permitted Values
Protocol string
NextHopList []NextHopInfo List of next hops to reach this network

PolicyPrefix

Attribute Date Type Description Permitted Values
Prefix string Used in conjunction with MaskLengthRange to specify the IP Prefix to match on when the ConditionType is MatchDstIpPrefix/MatchSrcIpPrefix. DEFAULT:""
MaskLengthRange string Used in conjuction with IpPrefix to specify specify the IP Prefix to match on when the ConditionType is MatchDstIpPrefix/MatchSrcIpPrefix. DEFAULT:""

PolicyExtendedCommunity

Attribute Date Type Description Permitted Values
Type string Type of extended community",SELECTION:"Route-Target"/"Route-Origin
Value string A : separated value of the extended community, examples: 200:10 / 192.168.0.2:300 / 3000.200:210

PolicyAction

Attribute Date Type Description Permitted Values
Attr string Attribute on which action is being applied SELECTION: Community/LocalPref/
ExtendedCommunity/PrependASPath/MED
Community string "BGP Community attribute value when the action attr is Community.Can either specify the well-known communities or any other community value in the format AA:NN or 0x1234abcd format or a number. DEFAULT:""
ExtendedCommunityType string Specifies BGP Extended Community type (used along with value)to set when the attr is ExtendedCommunity - based on RFC 4360. SELECTION: Route-Target/Route-Origin
DEFAULT:""
ExtendedCommunityValue string Specifies BGP Extended Community value (used along with type)to set when the attr is ExtendedCommunity - based on RFC 4360.This is a ":" separated string.
Examples: 200:10 / 192.168.0.2:300 / 3000.200:210
DEFAULT:""
LocalPref uint32 BGP LocalPreference attribute value when the action attr is LocalPref. DEFAULT:0
PrependASPath string BGP ASPath Value (specified using regular expressions) to prepend when the attr is ASPath DEFAULT:""
MED uint32 BGP MED Value to set when attr is MED DEFAULT: 0

PolicyDefinitionStmtPriority

Attribute Date Type Description Permitted Values
Priority int32 Priority of the policy w.r.t other policies configured MIN:0, MAX:255
Statement string

PerProtocolRouteCount

Attribute Date Type Description Permitted Values
Protocol string
RouteCount int32
EcmpCount int32

RouteInfoSummary

Attribute Date Type Description Permitted Values
DestinationNw string IP address of the route
IsInstalledInHw bool Indicates whether this route is installed in HW
NextHopList []NextHopInfo List of next hops to reach this network