Module Expr Str Import alias ImportFrom alias ImportFrom alias ImportFrom alias ImportFrom alias ImportFrom alias ImportFrom alias ImportFrom alias ImportFrom alias ImportFrom alias ImportFrom alias ImportFrom alias ImportFrom alias ImportFrom alias ImportFrom alias ImportFrom alias ImportFrom alias ImportFrom alias ImportFrom alias ImportFrom alias ImportFrom alias ImportFrom alias ImportFrom alias ImportFrom alias ImportFrom alias ImportFrom alias ImportFrom alias ImportFrom alias ImportFrom alias ImportFrom alias ImportFrom alias ImportFrom alias ImportFrom alias ImportFrom alias ImportFrom alias ImportFrom alias ImportFrom alias ImportFrom alias ImportFrom alias ImportFrom alias ImportFrom alias ImportFrom alias ImportFrom alias ImportFrom alias ImportFrom alias Assign NameStore Str Assign NameStore AttributeLoad NameLoad attr Assign NameStore AttributeLoad NameLoad attr ClassDef bases NameLoad body Expr Str FunctionDef arguments args NameParam NameParam NameParam NameParam NameParam NameParam NameParam defaults body Assign AttributeStore NameLoad attr NameLoad Assign AttributeStore NameLoad attr NameLoad Assign AttributeStore NameLoad attr NameLoad Assign AttributeStore NameLoad attr NameLoad Assign AttributeStore NameLoad attr NameLoad Assign AttributeStore NameLoad attr NameLoad decorator_list decorator_list ClassDef bases NameLoad body FunctionDef arguments args NameParam NameParam NameParam NameParam NameParam NameParam NameParam NameParam NameParam NameParam NameParam defaults NameLoad NameLoad NameLoad NameLoad NameLoad NameLoad NameLoad NameLoad body Expr Str Expr Call AttributeLoad Call NameLoad NameLoad NameLoad attr Assign NameStore Dict Assign SubscriptStore NameLoad Index NameLoad NameLoad Assign SubscriptStore NameLoad Index NameLoad NameLoad Assign SubscriptStore NameLoad Index NameLoad NameLoad Assign SubscriptStore NameLoad Index NameLoad NameLoad Assign SubscriptStore NameLoad Index NameLoad NameLoad Assign SubscriptStore NameLoad Index NameLoad NameLoad Expr Call AttributeLoad NameLoad attr NameLoad Expr Call AttributeLoad NameLoad attr Assign AttributeStore NameLoad attr NameLoad Assign AttributeStore NameLoad attr NameLoad Assign AttributeStore NameLoad attr NameLoad If NameLoad body ImportFrom alias Expr Call AttributeLoad NameLoad attr AttributeLoad AttributeLoad NameLoad attr attr decorator_list FunctionDef arguments args NameParam NameParam defaults body Assign NameStore AttributeLoad AttributeLoad AttributeLoad NameLoad attr attr attr Assign NameStore AttributeLoad AttributeLoad AttributeLoad NameLoad attr attr attr If AttributeLoad NameLoad attr body Expr Call AttributeLoad NameLoad attr NameLoad NameLoad decorator_list FunctionDef arguments args NameParam NameParam defaults body Assign NameStore AttributeLoad AttributeLoad AttributeLoad NameLoad attr attr attr Assign NameStore AttributeLoad AttributeLoad AttributeLoad NameLoad attr attr attr If AttributeLoad NameLoad attr body Expr Call AttributeLoad NameLoad attr NameLoad NameLoad decorator_list FunctionDef arguments args NameParam NameParam NameParam defaults body If AttributeLoad NameLoad attr body Assign NameStore AttributeLoad NameLoad attr Assign NameStore NameLoad Assign NameStore AttributeLoad AttributeLoad NameLoad attr attr orelse Return If BoolOpOr Call NameLoad NameLoad NameLoad Call NameLoad NameLoad NameLoad body Assign NameStore BinOpAdd BinOpAdd AttributeLoad AttributeLoad NameLoad attr attr Str Call NameLoad AttributeLoad AttributeLoad NameLoad attr attr Assign NameStore NameLoad Assign NameStore NameLoad orelse If BoolOpOr Call NameLoad NameLoad NameLoad Call NameLoad NameLoad NameLoad body Assign NameStore AttributeLoad AttributeLoad NameLoad attr attr Assign NameStore AttributeLoad AttributeLoad NameLoad attr attr Assign NameStore AttributeLoad AttributeLoad NameLoad attr attr orelse Return Assign NameStore Call NameLoad NameLoad NameLoad NameLoad NameLoad NameLoad NameLoad If AttributeLoad NameLoad attr body Expr Call AttributeLoad NameLoad attr NameLoad decorator_list FunctionDef arguments args NameParam defaults body Expr Call AttributeLoad AttributeLoad Call AttributeLoad NameLoad attr attr attr AttributeLoad NameLoad attr Lambda arguments args NameParam NameParam defaults Call AttributeLoad NameLoad attr SubscriptLoad NameLoad Index Str SubscriptLoad NameLoad Index Str Expr Call AttributeLoad AttributeLoad Call AttributeLoad NameLoad attr attr attr AttributeLoad NameLoad attr Lambda arguments args NameParam NameParam defaults Call AttributeLoad NameLoad attr SubscriptLoad NameLoad Index Str Expr Call AttributeLoad AttributeLoad Call AttributeLoad NameLoad attr attr attr AttributeLoad NameLoad attr Lambda arguments args NameParam NameParam defaults Call AttributeLoad NameLoad attr SubscriptLoad NameLoad Index Str decorator_list FunctionDef arguments args NameParam NameParam defaults body Assign NameStore Call AttributeLoad NameLoad attr Expr Call NameLoad Str keyword NameLoad NameLoad Expr Call AttributeLoad NameLoad attr decorator_list FunctionDef arguments args NameParam defaults body Pass decorator_list FunctionDef arguments args NameParam defaults body Expr Str Expr Call NameLoad Str decorator_list FunctionDef arguments args NameParam NameParam NameParam NameParam NameParam NameParam NameParam NameParam NameParam NameParam NameParam NameParam NameParam NameParam NameParam NameParam defaults NameLoad NameLoad NameLoad NameLoad NameLoad NameLoad NameLoad NameLoad NameLoad NameLoad NameLoad NameLoad NameLoad body Expr Str Assign NameStore Dict Assign SubscriptStore NameLoad Index AttributeLoad NameLoad attr NameLoad Assign SubscriptStore NameLoad Index AttributeLoad NameLoad attr NameLoad Assign SubscriptStore NameLoad Index NameLoad NameLoad Assign SubscriptStore NameLoad Index NameLoad NameLoad Assign SubscriptStore NameLoad Index NameLoad NameLoad Assign SubscriptStore NameLoad Index NameLoad NameLoad Assign SubscriptStore NameLoad Index NameLoad NameLoad Assign SubscriptStore NameLoad Index NameLoad NameLoad If Call AttributeLoad NameLoad attr NameLoad body Assign SubscriptStore NameLoad Index NameLoad NameLoad Assign SubscriptStore NameLoad Index NameLoad NameLoad Assign SubscriptStore NameLoad Index NameLoad NameLoad Assign SubscriptStore NameLoad Index NameLoad NameLoad orelse If Call AttributeLoad NameLoad attr NameLoad body Assign SubscriptStore NameLoad Index NameLoad NameLoad Assign SubscriptStore NameLoad Index NameLoad NameLoad Assign SubscriptStore NameLoad Index NameLoad NameLoad Assign SubscriptStore NameLoad Index NameLoad NameLoad orelse Pass If NameLoad body Assign SubscriptStore NameLoad Index NameLoad NameLoad If NameLoad body Assign SubscriptStore NameLoad Index NameLoad NameLoad If NameLoad body Assign SubscriptStore NameLoad Index NameLoad NameLoad If NameLoad body Assign SubscriptStore NameLoad Index NameLoad NameLoad Expr Call NameLoad Str NameLoad decorator_list FunctionDef arguments args NameParam NameParam defaults body Expr Str Assign NameStore Dict Assign SubscriptStore NameLoad Index AttributeLoad NameLoad attr NameLoad Expr Call NameLoad Str NameLoad decorator_list FunctionDef arguments args NameParam NameParam defaults body Expr Str Assign NameStore Dict Assign SubscriptStore NameLoad Index AttributeLoad NameLoad attr NameLoad Expr Call NameLoad Str NameLoad decorator_list FunctionDef arguments args NameParam NameParam NameParam NameParam defaults body Expr Str Assert BoolOpOr CompareEq NameLoad NameLoad CompareEq NameLoad NameLoad Assign NameStore Str Assign NameStore Dict If CompareEq NameLoad NameLoad body Assign NameStore Dict AttributeLoad NameLoad attr NameLoad orelse If CompareEq NameLoad NameLoad body Assign NameStore Dict AttributeLoad NameLoad attr NameLoad Assign NameStore Dict AttributeLoad NameLoad attr AttributeLoad NameLoad attr NameLoad NameLoad Expr Call NameLoad NameLoad NameLoad decorator_list FunctionDef arguments args NameParam NameParam NameParam defaults NameLoad Str body Expr Str Assign NameStore Dict Assign SubscriptStore NameLoad Index Str ListLoad Str Str If NameLoad body Expr Call AttributeLoad SubscriptLoad NameLoad Index Str attr NameLoad Assign SubscriptStore NameLoad Index Str NameLoad Return Call NameLoad Str NameLoad decorator_list FunctionDef arguments args NameParam NameParam NameParam NameParam defaults NameLoad NameLoad body Expr Str Assign NameStore Str Assign NameStore Dict Assign SubscriptStore NameLoad Index NameLoad NameLoad If NameLoad body Assign SubscriptStore NameLoad Index NameLoad NameLoad If NameLoad body Assign NameStore Str Assign SubscriptStore NameLoad Index NameLoad NameLoad Assign TupleStore NameStore NameStore Call AttributeLoad NameLoad attr NameLoad Assign SubscriptStore NameLoad Index NameLoad NameLoad Assign SubscriptStore NameLoad Index NameLoad NameLoad If BoolOpAnd CompareEq NameLoad AttributeLoad NameLoad attr Call AttributeLoad NameLoad attr NameLoad body Assign SubscriptStore NameLoad Index NameLoad Call NameLoad Call AttributeLoad Call AttributeLoad NameLoad attr NameLoad attr Return Call NameLoad NameLoad NameLoad decorator_list FunctionDef arguments args NameParam NameParam NameParam defaults NameLoad body Expr Str Assign NameStore Str Assign NameStore Dict Assign SubscriptStore NameLoad Index NameLoad NameLoad If NameLoad body Assign NameStore Str Assign SubscriptStore NameLoad Index NameLoad NameLoad Assign TupleStore NameStore NameStore Call AttributeLoad NameLoad attr NameLoad Assign SubscriptStore NameLoad Index NameLoad NameLoad Assign SubscriptStore NameLoad Index NameLoad NameLoad Expr Call NameLoad NameLoad NameLoad decorator_list FunctionDef arguments args NameParam NameParam NameParam NameParam NameParam NameParam NameParam defaults NameLoad NameLoad NameLoad body Expr Str Assert CompareIn NameLoad TupleLoad NameLoad NameLoad Str Assign NameStore Dict Assign SubscriptStore NameLoad Index AttributeLoad NameLoad attr NameLoad Assign SubscriptStore NameLoad Index AttributeLoad NameLoad attr NameLoad Assign SubscriptStore NameLoad Index AttributeLoad NameLoad attr NameLoad Assign SubscriptStore NameLoad Index AttributeLoad NameLoad attr NameLoad Assign SubscriptStore NameLoad Index AttributeLoad NameLoad attr NameLoad Expr Call NameLoad Str NameLoad decorator_list FunctionDef arguments args NameParam NameParam defaults body Expr Str Assign NameStore Dict Assign SubscriptStore NameLoad Index AttributeLoad NameLoad attr NameLoad Expr Call NameLoad Str NameLoad decorator_list FunctionDef arguments args NameParam NameParam defaults Str body Assign NameStore Dict Assign SubscriptStore NameLoad Index Str ListLoad Str Str Str Assign SubscriptStore NameLoad Index Str NameLoad Return Call NameLoad Str NameLoad decorator_list FunctionDef arguments args NameParam NameParam NameParam defaults Str Str body Expr Str Assign NameStore Dict Assign SubscriptStore NameLoad Index Str ListLoad Str NameLoad Assign SubscriptStore NameLoad Index Str NameLoad Return Call NameLoad Str NameLoad decorator_list FunctionDef arguments args NameParam NameParam NameParam NameParam defaults Str body Expr Str Assign NameStore Dict If BoolOpOr CompareEq NameLoad Str CompareEq NameLoad Str body Assign SubscriptStore NameLoad Index Str ListLoad Str NameLoad NameLoad Str orelse Assign SubscriptStore NameLoad Index Str ListLoad Str Str NameLoad Str Assign SubscriptStore NameLoad Index Str NameLoad Return Call NameLoad Str NameLoad decorator_list FunctionDef arguments args NameParam NameParam NameParam NameParam defaults body Assert CompareIn NameLoad TupleLoad Str Str Str Assert Call NameLoad GeneratorExp Call NameLoad NameLoad NameLoad comprehension NameStore NameLoad Str If CompareIs NameLoad NameLoad body Assign NameStore ListLoad Assign NameStore BinOpAdd BinOpAdd Str NameLoad Str Assign NameStore Dict Assign SubscriptStore NameLoad Index AttributeLoad NameLoad attr NameLoad If CompareEq NameLoad Str body Assign SubscriptStore NameLoad Index AttributeLoad NameLoad attr NameLoad orelse Assign SubscriptStore NameLoad Index AttributeLoad NameLoad attr NameLoad Expr Call NameLoad NameLoad NameLoad decorator_list FunctionDef arguments args NameParam NameParam NameParam defaults body Expr Str Expr Call AttributeLoad NameLoad attr Str NameLoad NameLoad decorator_list FunctionDef arguments args NameParam NameParam defaults body Expr Str Assign NameStore Str Assign NameStore Dict Assign SubscriptStore NameLoad Index AttributeLoad NameLoad attr NameLoad Assign NameStore Call NameLoad NameLoad NameLoad Return NameLoad decorator_list FunctionDef arguments args NameParam NameParam NameParam defaults body Expr Str Expr Call AttributeLoad NameLoad attr Str NameLoad NameLoad decorator_list FunctionDef arguments args NameParam NameParam defaults body Expr Str Assign NameStore Str Assign NameStore Dict Assign SubscriptStore NameLoad Index AttributeLoad NameLoad attr NameLoad Assign NameStore Call NameLoad NameLoad NameLoad Return NameLoad decorator_list FunctionDef arguments args NameParam NameParam NameParam defaults body Expr Str Assign NameStore Str Assign NameStore Dict Assign SubscriptStore NameLoad Index Str NameLoad Assign SubscriptStore NameLoad Index Str NameLoad Expr Call NameLoad NameLoad NameLoad decorator_list FunctionDef arguments args NameParam NameParam NameParam defaults body Expr Str Assign NameStore Str Assign NameStore Dict Assign SubscriptStore NameLoad Index Str NameLoad Assign SubscriptStore NameLoad Index Str NameLoad Expr Call NameLoad NameLoad NameLoad decorator_list FunctionDef arguments args NameParam NameParam NameParam NameParam NameParam defaults NameLoad NameLoad body Expr Str Assert CompareIn NameLoad TupleLoad NameLoad NameLoad Str Assign NameStore Str Assign NameStore Dict Assign SubscriptStore NameLoad Index AttributeLoad NameLoad attr NameLoad Assign SubscriptStore NameLoad Index AttributeLoad NameLoad attr NameLoad If CompareIsNot NameLoad NameLoad body Assign SubscriptStore NameLoad Index AttributeLoad NameLoad attr NameLoad Assign SubscriptStore NameLoad Index AttributeLoad NameLoad attr NameLoad Expr Call NameLoad NameLoad NameLoad decorator_list FunctionDef arguments args NameParam NameParam NameParam NameParam defaults NameLoad NameLoad body Expr Str Assert CompareIn NameLoad TupleLoad NameLoad NameLoad Str Assign NameStore Str Assign NameStore Dict Assign SubscriptStore NameLoad Index AttributeLoad NameLoad attr NameLoad If CompareIsNot NameLoad NameLoad body Assign SubscriptStore NameLoad Index AttributeLoad NameLoad attr NameLoad Assign SubscriptStore NameLoad Index AttributeLoad NameLoad attr NameLoad Assign NameStore Call NameLoad NameLoad NameLoad Return NameLoad decorator_list FunctionDef arguments args NameParam defaults body Expr Str Assign TupleStore NameStore NameStore Call AttributeLoad NameLoad attr Str If Call AttributeLoad NameLoad attr NameLoad body Assign NameStore BinOpAdd BinOpAdd Call NameLoad Call AttributeLoad NameLoad attr NameLoad Str NameLoad Return TupleLoad AttributeLoad NameLoad attr NameLoad orelse Return TupleLoad AttributeLoad NameLoad attr NameLoad decorator_list NameLoad decorator_list
N/A N/A This module offers a class to enable your code to speak BGP protocol.

 N/A netaddr ryu.lib hub ryu.services.protocols.bgp.core_manager CORE_MANAGER ryu.services.protocols.bgp.signals.emit BgpSignalBus ryu.services.protocols.bgp.api.base call ryu.services.protocols.bgp.api.base PREFIX ryu.services.protocols.bgp.api.base NEXT_HOP ryu.services.protocols.bgp.api.base ROUTE_DISTINGUISHER ryu.services.protocols.bgp.api.base ROUTE_FAMILY ryu.services.protocols.bgp.rtconf.common LOCAL_AS ryu.services.protocols.bgp.rtconf.common ROUTER_ID ryu.services.protocols.bgp.rtconf.common BGP_SERVER_PORT ryu.services.protocols.bgp.rtconf.common DEFAULT_BGP_SERVER_PORT ryu.services.protocols.bgp.rtconf.common DEFAULT_REFRESH_MAX_EOR_TIME ryu.services.protocols.bgp.rtconf.common DEFAULT_REFRESH_STALEPATH_TIME ryu.services.protocols.bgp.rtconf.common DEFAULT_LABEL_RANGE ryu.services.protocols.bgp.rtconf.common REFRESH_MAX_EOR_TIME ryu.services.protocols.bgp.rtconf.common REFRESH_STALEPATH_TIME ryu.services.protocols.bgp.rtconf.common LABEL_RANGE ryu.services.protocols.bgp.rtconf neighbors ryu.services.protocols.bgp.rtconf vrfs ryu.services.protocols.bgp.rtconf.base CAP_MBGP_IPV4 ryu.services.protocols.bgp.rtconf.base CAP_MBGP_IPV6 ryu.services.protocols.bgp.rtconf.base CAP_MBGP_VPNV4 ryu.services.protocols.bgp.rtconf.base CAP_MBGP_VPNV6 ryu.services.protocols.bgp.rtconf.base CAP_ENHANCED_REFRESH ryu.services.protocols.bgp.rtconf.base MULTI_EXIT_DISC ryu.services.protocols.bgp.rtconf.base SITE_OF_ORIGINS ryu.services.protocols.bgp.rtconf.neighbors DEFAULT_CAP_MBGP_IPV4 ryu.services.protocols.bgp.rtconf.neighbors DEFAULT_CAP_MBGP_VPNV4 ryu.services.protocols.bgp.rtconf.neighbors DEFAULT_CAP_MBGP_VPNV6 ryu.services.protocols.bgp.rtconf.neighbors DEFAULT_CAP_ENHANCED_REFRESH ryu.services.protocols.bgp.rtconf.neighbors DEFAULT_CONNECT_MODE ryu.services.protocols.bgp.rtconf.neighbors PEER_NEXT_HOP ryu.services.protocols.bgp.rtconf.neighbors PASSWORD ryu.services.protocols.bgp.rtconf.neighbors IS_ROUTE_SERVER_CLIENT ryu.services.protocols.bgp.rtconf.neighbors IS_NEXT_HOP_SELF ryu.services.protocols.bgp.rtconf.neighbors CONNECT_MODE ryu.services.protocols.bgp.rtconf.neighbors LOCAL_ADDRESS ryu.services.protocols.bgp.rtconf.neighbors LOCAL_PORT ryu.services.protocols.bgp.info_base.base Filter ryu.services.protocols.bgp.info_base.ipv4 Ipv4Path ryu.services.protocols.bgp.info_base.ipv6 Ipv6Path ryu.services.protocols.bgp.info_base.vpnv4 Vpnv4Path ryu.services.protocols.bgp.info_base.vpnv6 Vpnv6Path N/A NEIGHBOR_CONF_MED multi_exit_disc N/A RF_VPN_V4 N/A vrfs VRF_RF_IPV4 N/A RF_VPN_V6 N/A vrfs VRF_RF_IPV6 EventPrefix N/A object N/A N/A 
    Used to pass an update on any best remote path to
    best_path_change_handler.

    ================ ======================================================
    Attribute        Description
    ================ ======================================================
    remote_as        The AS number of a peer that caused this change
    route_dist       None in the case of ipv4 or ipv6 family
    prefix           A prefix was changed
    nexthop          The nexthop of the changed prefix
    label            mpls label for vpnv4 prefix
    is_withdraw      True if this prefix has gone otherwise False
    ================ ======================================================

     __init__ N/A N/A self remote_as route_dist prefix nexthop label is_withdraw N/A N/A N/A N/A self remote_as remote_as N/A N/A self route_dist route_dist N/A N/A self prefix prefix N/A N/A self nexthop nexthop N/A N/A self label label N/A N/A self is_withdraw is_withdraw N/A N/A BGPSpeaker N/A object N/A __init__ N/A N/A self as_number router_id bgp_server_port refresh_stalepath_time refresh_max_eor_time best_path_change_handler peer_down_handler peer_up_handler ssh_console label_range N/A DEFAULT_BGP_SERVER_PORT DEFAULT_REFRESH_STALEPATH_TIME DEFAULT_REFRESH_MAX_EOR_TIME None None None False DEFAULT_LABEL_RANGE N/A N/A Create a new BGPSpeaker object with as_number and router_id to
        listen on bgp_server_port.

        ``as_number`` specifies an Autonomous Number. It must be an integer
        between 1 and 65535.

        ``router_id`` specifies BGP router identifier. It must be the
        string representation of an IPv4 address (e.g. 10.0.0.1).

        ``bgp_server_port`` specifies TCP listen port number. 179 is
        used if not specified.

        ``refresh_stalepath_time`` causes the BGP speaker to remove
        stale routes from the BGP table after the timer expires, even
        if the speaker does not receive a Router-Refresh End-of-RIB
        message. This feature is disabled (not implemented yet).

        ``refresh_max_eor_time`` causes the BGP speaker to generate a
        Route-Refresh End-of-RIB message if it was not able to
        generate one due to route flapping. This feature is disabled
        (not implemented yet).

        ``best_path_change_handler``, if specified, is called when any
        best remote path is changed due to an update message or remote
        peer down. The handler is supposed to take one argument, the
        instance of an EventPrefix class instance.

        ``peer_down_handler``, if specified, is called when BGP peering
        session goes down.

        ``peer_up_handler``, if specified, is called when BGP peering
        session goes up.

         N/A N/A N/A N/A super BGPSpeaker self __init__ N/A settings N/A N/A N/A settings N/A LOCAL_AS as_number N/A N/A settings N/A ROUTER_ID router_id N/A N/A settings N/A BGP_SERVER_PORT bgp_server_port N/A N/A settings N/A REFRESH_STALEPATH_TIME refresh_stalepath_time N/A N/A settings N/A REFRESH_MAX_EOR_TIME refresh_max_eor_time N/A N/A settings N/A LABEL_RANGE label_range N/A N/A N/A self _core_start settings N/A N/A N/A self _init_signal_listeners N/A N/A self _best_path_change_handler best_path_change_handler N/A N/A self _peer_down_handler peer_down_handler N/A N/A self _peer_up_handler peer_up_handler N/A ssh_console N/A ryu.services.protocols.bgp.operator ssh N/A N/A N/A hub spawn N/A N/A ssh SSH_CLI_CONTROLLER start N/A _notify_peer_down N/A N/A self peer N/A N/A N/A remote_ip N/A N/A N/A peer protocol recv_open_msg bgp_identifier N/A remote_as N/A N/A N/A peer protocol recv_open_msg my_as N/A N/A self _peer_down_handler N/A N/A N/A N/A self _peer_down_handler remote_ip remote_as N/A _notify_peer_up N/A N/A self peer N/A N/A N/A remote_ip N/A N/A N/A peer protocol recv_open_msg bgp_identifier N/A remote_as N/A N/A N/A peer protocol recv_open_msg my_as N/A N/A self _peer_up_handler N/A N/A N/A N/A self _peer_up_handler remote_ip remote_as N/A _notify_best_path_changed N/A N/A self path is_withdraw N/A N/A N/A N/A path source N/A N/A nexthop N/A path nexthop N/A is_withdraw is_withdraw N/A remote_as N/A N/A path source remote_as N/A N/A N/A N/A N/A isinstance path Ipv4Path N/A isinstance path Ipv6Path N/A N/A prefix N/A N/A N/A N/A path nlri addr / N/A str N/A N/A path nlri length N/A route_dist None N/A label None N/A N/A N/A N/A isinstance path Vpnv4Path N/A isinstance path Vpnv6Path N/A N/A prefix N/A N/A path nlri prefix N/A route_dist N/A N/A path nlri route_dist N/A label N/A N/A path nlri label_list N/A N/A N/A ev N/A EventPrefix remote_as route_dist prefix nexthop label is_withdraw N/A N/A self _best_path_change_handler N/A N/A N/A N/A self _best_path_change_handler ev N/A _init_signal_listeners N/A N/A self N/A N/A N/A N/A N/A N/A N/A N/A CORE_MANAGER get_core_service _signal_bus register_listener N/A BgpSignalBus BGP_BEST_PATH_CHANGED N/A N/A N/A _ info N/A N/A N/A self _notify_best_path_changed N/A info N/A path N/A info N/A is_withdraw N/A N/A N/A N/A N/A N/A CORE_MANAGER get_core_service _signal_bus register_listener N/A BgpSignalBus BGP_ADJ_DOWN N/A N/A N/A _ info N/A N/A N/A self _notify_peer_down N/A info N/A peer N/A N/A N/A N/A N/A N/A CORE_MANAGER get_core_service _signal_bus register_listener N/A BgpSignalBus BGP_ADJ_UP N/A N/A N/A _ info N/A N/A N/A self _notify_peer_up N/A info N/A peer N/A _core_start N/A N/A self settings N/A N/A N/A waiter N/A N/A hub Event N/A N/A call core.start waiter waiter settings N/A N/A N/A waiter wait N/A _serve_forever N/A N/A self N/A N/A N/A N/A shutdown N/A N/A self N/A N/A N/A  Shutdown BGP speaker

         N/A N/A call core.stop N/A neighbor_add N/A N/A self address remote_as enable_ipv4 enable_vpnv4 enable_vpnv6 enable_enhanced_refresh next_hop password multi_exit_disc site_of_origins is_route_server_client is_next_hop_self local_address local_port connect_mode N/A DEFAULT_CAP_MBGP_IPV4 DEFAULT_CAP_MBGP_VPNV4 DEFAULT_CAP_MBGP_VPNV6 DEFAULT_CAP_ENHANCED_REFRESH None None None None False False None None DEFAULT_CONNECT_MODE N/A N/A  This method registers a new neighbor. The BGP speaker tries to
        establish a bgp session with the peer (accepts a connection
        from the peer and also tries to connect to it).

        ``address`` specifies the IP address of the peer. It must be
        the string representation of an IP address. Only IP v4 is
        supported now.

        ``remote_as`` specifies the AS number of the peer. It must be
        an integer between 1 and 65535.

        ``enable_ipv4`` enables IPv4 address family for this
        neighbor. The default is True.

        ``enable_vpnv4`` enables VPNv4 address family for this
        neighbor. The default is False.

        ``enable_vpnv6`` enables VPNv6 address family for this
        neighbor. The default is False.

        ``next_hop`` specifies the next hop IP address. If not
        specified, host's ip address to access to a peer is used.

        ``password`` is used for the MD5 authentication if it's
        specified. By default, the MD5 authenticaiton is disabled.

        ``multi_exit_disc`` specifies multi exit discriminator (MED) value.
        The default is None and if not specified, MED value is
        not sent to the neighbor. It must be an integer.

        ``site_of_origins`` specifies site_of_origin values.
        This parameter must be a list of string.

        ``is_route_server_client`` specifies whether this neighbor is a
        router server's client or not.

        ``is_next_hop_self`` specifies whether the BGP speaker announces
        its own ip address to iBGP neighbor or not as path's next_hop address.

        ``connect_mode`` specifies how to connect to this neighbor.
        CONNECT_MODE_ACTIVE tries to connect from us.
        CONNECT_MODE_PASSIVE just listens and wait for the connection.
        CONNECT_MODE_BOTH use both methods.
        The default is CONNECT_MODE_BOTH

        ``local_address`` specifies Loopback interface address for
        iBGP peering.

        ``local_port`` specifies source TCP port for iBGP peering.

         N/A bgp_neighbor N/A N/A N/A bgp_neighbor N/A N/A neighbors IP_ADDRESS address N/A N/A bgp_neighbor N/A N/A neighbors REMOTE_AS remote_as N/A N/A bgp_neighbor N/A PEER_NEXT_HOP next_hop N/A N/A bgp_neighbor N/A PASSWORD password N/A N/A bgp_neighbor N/A IS_ROUTE_SERVER_CLIENT is_route_server_client N/A N/A bgp_neighbor N/A IS_NEXT_HOP_SELF is_next_hop_self N/A N/A bgp_neighbor N/A CONNECT_MODE connect_mode N/A N/A bgp_neighbor N/A CAP_ENHANCED_REFRESH enable_enhanced_refresh N/A N/A N/A netaddr valid_ipv4 address N/A N/A N/A bgp_neighbor N/A CAP_MBGP_IPV4 enable_ipv4 N/A N/A bgp_neighbor N/A CAP_MBGP_IPV6 False N/A N/A bgp_neighbor N/A CAP_MBGP_VPNV4 enable_vpnv4 N/A N/A bgp_neighbor N/A CAP_MBGP_VPNV6 enable_vpnv6 N/A N/A N/A N/A netaddr valid_ipv6 address N/A N/A N/A bgp_neighbor N/A CAP_MBGP_IPV4 False N/A N/A bgp_neighbor N/A CAP_MBGP_IPV6 True N/A N/A bgp_neighbor N/A CAP_MBGP_VPNV4 False N/A N/A bgp_neighbor N/A CAP_MBGP_VPNV6 False N/A N/A N/A multi_exit_disc N/A N/A N/A bgp_neighbor N/A MULTI_EXIT_DISC multi_exit_disc N/A site_of_origins N/A N/A N/A bgp_neighbor N/A SITE_OF_ORIGINS site_of_origins N/A local_address N/A N/A N/A bgp_neighbor N/A LOCAL_ADDRESS local_address N/A local_port N/A N/A N/A bgp_neighbor N/A LOCAL_PORT local_port N/A N/A call neighbor.create bgp_neighbor N/A neighbor_del N/A N/A self address N/A N/A N/A  This method unregister the registered neighbor. If a session with
        the peer exists, the session will be closed.

        ``address`` specifies the IP address of the peer. It must be
        the string representation of an IP address.

         N/A bgp_neighbor N/A N/A N/A bgp_neighbor N/A N/A neighbors IP_ADDRESS address N/A N/A call neighbor.delete bgp_neighbor N/A neighbor_reset N/A N/A self address N/A N/A N/A  This method reset the registered neighbor.

        ``address`` specifies the IP address of the peer. It must be
        the string representation of an IP address.

         N/A bgp_neighbor N/A N/A N/A bgp_neighbor N/A N/A neighbors IP_ADDRESS address N/A N/A call core.reset_neighbor bgp_neighbor N/A neighbor_update N/A N/A self address conf_type conf_value N/A N/A N/A  This method changes the neighbor configuration.

        ``conf_type`` specifies configuration type which you want to change.
        Currently ryu.services.protocols.bgp.bgpspeaker.NEIGHBOR_CONF_MED
        can be specified.

        ``conf_value`` specifies value for the configuration type.

         N/A N/A N/A conf_type NEIGHBOR_CONF_MED N/A conf_type CONNECT_MODE N/A func_name neighbor.update N/A attribute_param N/A N/A N/A conf_type NEIGHBOR_CONF_MED N/A N/A attribute_param N/A N/A neighbors MULTI_EXIT_DISC conf_value N/A N/A N/A conf_type CONNECT_MODE N/A N/A attribute_param N/A N/A neighbors CONNECT_MODE conf_value N/A param N/A N/A neighbors IP_ADDRESS N/A neighbors CHANGES address attribute_param N/A N/A call func_name param N/A neighbor_state_get N/A N/A self address format N/A None json N/A N/A  This method returns the state of peer(s) in a json
        format.

        ``address`` specifies the address of a peer. If not given, the
        state of all the peers return.

         N/A show N/A N/A N/A show N/A params N/A neighbor summary N/A address N/A N/A N/A N/A N/A show N/A params append address N/A N/A show N/A format format N/A N/A call operator.show show N/A prefix_add N/A N/A self prefix next_hop route_dist N/A None None N/A N/A  This method adds a new prefix to be advertized.

        ``prefix`` must be the string representation of an IP network
        (e.g., 10.1.1.0/24).

        ``next_hop`` specifies the next hop address for this
        prefix. This parameter is necessary for only VPNv4 and VPNv6
        address families.

        ``route_dist`` specifies a route distinguisher value. This
        parameter is necessary for only VPNv4 and VPNv6 address
        families.

         N/A func_name network.add N/A networks N/A N/A N/A networks N/A PREFIX prefix N/A next_hop N/A N/A N/A networks N/A NEXT_HOP next_hop N/A route_dist N/A N/A func_name prefix.add_local N/A N/A networks N/A ROUTE_DISTINGUISHER route_dist N/A N/A rf p N/A N/A self _check_rf_and_normalize prefix N/A N/A networks N/A ROUTE_FAMILY rf N/A N/A networks N/A PREFIX p N/A N/A N/A rf N/A vrfs VRF_RF_IPV6 N/A N/A netaddr valid_ipv4 next_hop N/A N/A N/A networks N/A NEXT_HOP N/A str N/A N/A N/A N/A netaddr IPAddress next_hop ipv6 N/A N/A call func_name networks N/A prefix_del N/A N/A self prefix route_dist N/A None N/A N/A  This method deletes a advertized prefix.

        ``prefix`` must be the string representation of an IP network
        (e.g., 10.1.1.0/24).

        ``route_dist`` specifies a route distinguisher value. This
        parameter is necessary for only VPNv4 and VPNv6 address
        families.

         N/A func_name network.del N/A networks N/A N/A N/A networks N/A PREFIX prefix N/A route_dist N/A N/A func_name prefix.delete_local N/A N/A networks N/A ROUTE_DISTINGUISHER route_dist N/A N/A rf p N/A N/A self _check_rf_and_normalize prefix N/A N/A networks N/A ROUTE_FAMILY rf N/A N/A networks N/A PREFIX p N/A N/A call func_name networks N/A vrf_add N/A N/A self route_dist import_rts export_rts site_of_origins route_family multi_exit_disc N/A None RF_VPN_V4 None N/A N/A  This method adds a new vrf used for VPN.

        ``route_dist`` specifies a route distinguisher value.

        ``import_rts`` specifies route targets to be imported.

        ``export_rts`` specifies route targets to be exported.

        ``site_of_origins`` specifies site_of_origin values.
        This parameter must be a list of string.

        ``route_family`` specifies route family of the VRF.
        This parameter must be RF_VPN_V4 or RF_VPN_V6.
         N/A N/A route_family N/A RF_VPN_V4 RF_VPN_V6 route_family must be RF_VPN_V4 or RF_VPN_V6 N/A vrf N/A N/A N/A vrf N/A N/A vrfs ROUTE_DISTINGUISHER route_dist N/A N/A vrf N/A N/A vrfs IMPORT_RTS import_rts N/A N/A vrf N/A N/A vrfs EXPORT_RTS export_rts N/A N/A vrf N/A N/A vrfs SITE_OF_ORIGINS site_of_origins N/A N/A vrf N/A N/A vrfs VRF_RF route_family N/A N/A call vrf.create vrf N/A vrf_del N/A N/A self route_dist N/A N/A N/A  This method deletes the existing vrf.

        ``route_dist`` specifies a route distinguisher value.

         N/A vrf N/A N/A N/A vrf N/A N/A vrfs ROUTE_DISTINGUISHER route_dist N/A N/A call vrf.delete vrf N/A vrfs_get N/A N/A self format N/A json N/A N/A show N/A N/A N/A show N/A params N/A vrf routes all N/A N/A show N/A format format N/A N/A call operator.show show N/A rib_get N/A N/A self family format N/A ipv4 json N/A N/A  This method returns the BGP routing information in a json
        format. This will be improved soon.

        ``family`` specifies the address family of the RIB.

         N/A show N/A N/A N/A show N/A params N/A rib family N/A N/A show N/A format format N/A N/A call operator.show show N/A neighbor_get N/A N/A self routetype address format N/A json N/A N/A  This method returns the BGP adj-RIB-in information in a json
        format.

        ``routetype`` This parameter is necessary for only received-routes
        and sent-routes.

          received-routes : paths received and not withdrawn by given peer

          sent-routes : paths sent and not withdrawn to given peer

        ``address`` specifies the IP address of the peer. It must be
        the string representation of an IP address.

         N/A show N/A N/A N/A N/A routetype sent-routes N/A routetype received-routes N/A N/A N/A show N/A params N/A neighbor routetype address all N/A N/A N/A show N/A params N/A neighbor received-routes address all N/A N/A show N/A format format N/A N/A call operator.show show N/A _set_filter N/A N/A self filter_type address filters N/A N/A N/A N/A filter_type N/A in out filter type must be 'in' or 'out' N/A N/A all N/A N/A isinstance f Filter N/A f filters all the items in filters must be an instance of Filter sub-class N/A N/A filters None N/A N/A filters N/A N/A func_name N/A N/A neighbor. filter_type _filter.set N/A param N/A N/A N/A param N/A N/A neighbors IP_ADDRESS address N/A N/A filter_type in N/A N/A N/A param N/A N/A neighbors IN_FILTER filters N/A N/A N/A param N/A N/A neighbors OUT_FILTER filters N/A N/A call func_name param N/A out_filter_set N/A N/A self address filters N/A N/A N/A  This method sets out-filter to neighbor.

        ``address`` specifies the IP address of the peer.

        ``filters`` specifies a filter list to filter the path advertisement.
        The contents must be an instance of Filter sub-class

        If you want to define out-filter that send only a particular
        prefix to neighbor, filters can be created as follows;

          p = PrefixFilter('10.5.111.0/24',
                           policy=PrefixFilter.POLICY_PERMIT)

          all = PrefixFilter('0.0.0.0/0',
                             policy=PrefixFilter.POLICY_DENY)

          pList = [p, all]

          self.bgpspeaker.out_filter_set(neighbor_address, pList)

        NOTE:
        out-filter evaluates paths in the order of Filter in the pList.

         N/A N/A N/A self _set_filter out address filters N/A out_filter_get N/A N/A self address N/A N/A N/A  This method gets out-filter setting from the specified neighbor.

        ``address`` specifies the IP address of the peer.

        Returns a list object containing an instance of Filter sub-class

         N/A func_name neighbor.out_filter.get N/A param N/A N/A N/A param N/A N/A neighbors IP_ADDRESS address N/A out_filter N/A call func_name param N/A out_filter N/A in_filter_set N/A N/A self address filters N/A N/A N/A This method sets in-bound filters to a neighbor.

        ``address`` specifies the IP address of the neighbor

        ``filters`` specifies filter list applied before advertised paths are
        imported to the global rib. All the items in the list must be an
        instance of Filter sub-class.

         N/A N/A N/A self _set_filter in address filters N/A in_filter_get N/A N/A self address N/A N/A N/A This method gets in-bound filters of the specified neighbor.

        ``address`` specifies the IP address of the neighbor.

        Returns a list object containing an instance of Filter sub-class

         N/A func_name neighbor.in_filter.get N/A param N/A N/A N/A param N/A N/A neighbors IP_ADDRESS address N/A in_filter N/A call func_name param N/A in_filter N/A bmp_server_add N/A N/A self address port N/A N/A N/A This method registers a new BMP (BGP monitoring Protocol)
        server. The BGP speaker starts to send BMP messages to the
        server. Currently, only one BMP server can be registered.

        ``address`` specifies the IP address of a BMP server.

        ``port`` specifies the listen port number of a BMP server.
         N/A func_name bmp.start N/A param N/A N/A N/A param N/A host address N/A N/A param N/A port port N/A N/A call func_name param N/A bmp_server_del N/A N/A self address port N/A N/A N/A  This method unregister the registered BMP server.

        ``address`` specifies the IP address of a BMP server.

        ``port`` specifies the listen port number of a BMP server.
         N/A func_name bmp.stop N/A param N/A N/A N/A param N/A host address N/A N/A param N/A port port N/A N/A call func_name param N/A attribute_map_set N/A N/A self address attribute_maps route_dist route_family N/A None RF_VPN_V4 N/A N/A This method sets attribute mapping to a neighbor.
        attribute mapping can be used when you want to apply
        attribute to BGPUpdate under specific conditions.

        ``address`` specifies the IP address of the neighbor

        ``attribute_maps`` specifies attribute_map list that are used
        before paths are advertised. All the items in the list must
        be an instance of AttributeMap class

        ``route_dist`` specifies route dist in which attribute_maps
        are added.

        ``route_family`` specifies route family of the VRF.
        This parameter must be RF_VPN_V4 or RF_VPN_V6.

        We can set AttributeMap to a neighbor as follows;

          pref_filter = PrefixFilter('192.168.103.0/30',
                                     PrefixFilter.POLICY_PERMIT)

          attribute_map = AttributeMap([pref_filter],
                                       AttributeMap.ATTR_LOCAL_PREF, 250)

          speaker.attribute_map_set('192.168.50.102', [attribute_map])

         N/A N/A route_family N/A RF_VPN_V4 RF_VPN_V6 route_family must be RF_VPN_V4 or RF_VPN_V6 N/A func_name neighbor.attribute_map.set N/A param N/A N/A N/A param N/A N/A neighbors IP_ADDRESS address N/A N/A param N/A N/A neighbors ATTRIBUTE_MAP attribute_maps N/A N/A route_dist None N/A N/A N/A param N/A N/A vrfs ROUTE_DISTINGUISHER route_dist N/A N/A param N/A N/A vrfs VRF_RF route_family N/A N/A call func_name param N/A attribute_map_get N/A N/A self address route_dist route_family N/A None RF_VPN_V4 N/A N/A This method gets in-bound filters of the specified neighbor.

        ``address`` specifies the IP address of the neighbor.

        ``route_dist`` specifies route distinguisher that has attribute_maps.

        ``route_family`` specifies route family of the VRF.
        This parameter must be RF_VPN_V4 or RF_VPN_V6.

        Returns a list object containing an instance of AttributeMap

         N/A N/A route_family N/A RF_VPN_V4 RF_VPN_V6 route_family must be RF_VPN_V4 or RF_VPN_V6 N/A func_name neighbor.attribute_map.get N/A param N/A N/A N/A param N/A N/A neighbors IP_ADDRESS address N/A N/A route_dist None N/A N/A N/A param N/A N/A vrfs ROUTE_DISTINGUISHER route_dist N/A N/A param N/A N/A vrfs VRF_RF route_family N/A attribute_maps N/A call func_name param N/A attribute_maps N/A _check_rf_and_normalize N/A N/A prefix N/A N/A N/A  check prefix's route_family and if the address is
        IPv6 address, return IPv6 route_family and normalized IPv6 address.
        If the address is IPv4 address, return IPv4 route_family
        and the prefix itself.

         N/A N/A ip masklen N/A N/A prefix split / N/A N/A N/A netaddr valid_ipv6 ip N/A N/A ipv6_prefix N/A N/A N/A str N/A N/A netaddr IPAddress ip / masklen N/A N/A N/A vrfs VRF_RF_IPV6 ipv6_prefix N/A N/A N/A N/A vrfs VRF_RF_IPV4 prefix N/A staticmethod N/A