Struct RouteServerRoute

#[non_exhaustive]
pub struct RouteServerRoute {
    pub route_server_endpoint_id: Option<String>,
    pub route_server_peer_id: Option<String>,
    pub route_installation_details: Option<Vec<RouteServerRouteInstallationDetail>>,
    pub route_status: Option<RouteServerRouteStatus>,
    pub prefix: Option<String>,
    pub as_paths: Option<Vec<String>>,
    pub med: Option<i32>,
    pub next_hop_ip: Option<String>,
}

Describes a route in the route server's routing database.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

route_server_endpoint_id: Option<String>

The ID of the route server endpoint that received this route.

route_server_peer_id: Option<String>

The ID of the route server peer that advertised this route.

route_installation_details: Option<Vec<RouteServerRouteInstallationDetail>>

Details about the installation status of this route in route tables.

route_status: Option<RouteServerRouteStatus>

The current status of the route in the routing database. Values are in-rib or in-fib depending on if the routes are in the RIB or the FIB database.

The Routing Information Base (RIB) serves as a database that stores all the routing information and network topology data collected by a router or routing system, such as routes learned from BGP peers. The RIB is constantly updated as new routing information is received or existing routes change. This ensures that the route server always has the most current view of the network topology and can make optimal routing decisions.

The Forwarding Information Base (FIB) serves as a forwarding table for what route server has determined are the best-path routes in the RIB after evaluating all available routing information and policies. The FIB routes are installed on the route tables. The FIB is recomputed whenever there are changes to the RIB.

prefix: Option<String>

The destination CIDR block of the route.

as_paths: Option<Vec<String>>

The AS path attributes of the BGP route.

med: Option<i32>

The Multi-Exit Discriminator (MED) value of the BGP route.

next_hop_ip: Option<String>

The IP address for the next hop.

Implementations

impl RouteServerRoute

pub fn route_server_endpoint_id(&self) -> Option<&str>

The ID of the route server endpoint that received this route.

pub fn route_server_peer_id(&self) -> Option<&str>

The ID of the route server peer that advertised this route.

pub fn route_installation_details( &self, ) -> &[RouteServerRouteInstallationDetail]

Details about the installation status of this route in route tables.

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .route_installation_details.is_none().

pub fn route_status(&self) -> Option<&RouteServerRouteStatus>

The current status of the route in the routing database. Values are in-rib or in-fib depending on if the routes are in the RIB or the FIB database.

The Routing Information Base (RIB) serves as a database that stores all the routing information and network topology data collected by a router or routing system, such as routes learned from BGP peers. The RIB is constantly updated as new routing information is received or existing routes change. This ensures that the route server always has the most current view of the network topology and can make optimal routing decisions.

The Forwarding Information Base (FIB) serves as a forwarding table for what route server has determined are the best-path routes in the RIB after evaluating all available routing information and policies. The FIB routes are installed on the route tables. The FIB is recomputed whenever there are changes to the RIB.

pub fn prefix(&self) -> Option<&str>

The destination CIDR block of the route.

pub fn as_paths(&self) -> &[String]

The AS path attributes of the BGP route.

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .as_paths.is_none().

pub fn med(&self) -> Option<i32>

The Multi-Exit Discriminator (MED) value of the BGP route.

pub fn next_hop_ip(&self) -> Option<&str>

The IP address for the next hop.

impl RouteServerRoute

pub fn builder() -> RouteServerRouteBuilder

Creates a new builder-style object to manufacture RouteServerRoute.

Trait Implementations

impl Clone for RouteServerRoute

fn clone(&self) -> RouteServerRoute

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for RouteServerRoute

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl PartialEq for RouteServerRoute

fn eq(&self, other: &RouteServerRoute) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for RouteServerRoute