|
| ||||||||||||||||
| XrlCmdMap* _cmds | _cmds |
[protected]
| XrlOspfTargetBase (XrlCmdMap* cmds = 0)
| XrlOspfTargetBase |
Constructor.
Parameters:
| cmds | an XrlCmdMap that the commands associated with the target should be added to. This is typically the XrlRouter associated with the target. |
| ~XrlOspfTargetBase ()
| ~XrlOspfTargetBase |
[virtual]
Destructor.
Dissociates instance commands from command map.
| bool set_command_map (XrlCmdMap* cmds)
| set_command_map |
Set command map.
Parameters:
| cmds | pointer to command map to associate commands with. This argument is typically a pointer to the XrlRouter associated with the target. |
Returns: true on success, false if cmds is null or a command map has already been supplied.
| inline const string& name ()
| name |
[const]
Get Xrl instance name associated with command map.
| inline const char* version ()
| version |
[const]
Get version string of instance.
| XrlCmdError common_0_1_get_target_name (
string& name)
| common_0_1_get_target_name |
[protected pure virtual]
Pure-virtual function that needs to be implemented to:
| XrlCmdError common_0_1_get_version (
string& version)
| common_0_1_get_version |
[protected pure virtual]
Pure-virtual function that needs to be implemented to:
Get version string from Xrl Target
| XrlCmdError common_0_1_get_status (
uint32_t& status,
string& reason)
| common_0_1_get_status |
[protected pure virtual]
Pure-virtual function that needs to be implemented to:
| XrlCmdError common_0_1_shutdown ()
| common_0_1_shutdown |
[protected pure virtual]
Pure-virtual function that needs to be implemented to:
Request clean shutdown of Xrl Target
| XrlCmdError ospf_0_1_set_router_id (
const uint32_t& id)
| ospf_0_1_set_router_id |
[protected pure virtual]
Pure-virtual function that needs to be implemented to:
| XrlCmdError ospf_0_1_get_router_id (
uint32_t& id)
| ospf_0_1_get_router_id |
[protected pure virtual]
Pure-virtual function that needs to be implemented to:
| XrlCmdError ospf_0_1_set_lsdb_limit (
const int32_t& limit)
| ospf_0_1_set_lsdb_limit |
[protected pure virtual]
Pure-virtual function that needs to be implemented to:
Set maximum number of AS-external LSA's
| XrlCmdError ospf_0_1_get_lsdb_limit (
int32_t& limit)
| ospf_0_1_get_lsdb_limit |
[protected pure virtual]
| XrlCmdError ospf_0_1_set_mospf (
const bool& enabled)
| ospf_0_1_set_mospf |
[protected pure virtual]
Pure-virtual function that needs to be implemented to:
| XrlCmdError ospf_0_1_get_mospf (
bool& enabled)
| ospf_0_1_get_mospf |
[protected pure virtual]
| XrlCmdError ospf_0_1_set_interarea_mc (
const bool& enabled)
| ospf_0_1_set_interarea_mc |
[protected pure virtual]
Pure-virtual function that needs to be implemented to:
Enable / Disable Inter-area multicast
| XrlCmdError ospf_0_1_get_interarea_mc (
bool& enabled)
| ospf_0_1_get_interarea_mc |
[protected pure virtual]
| XrlCmdError ospf_0_1_set_overflow_interval (
const int32_t& ovfl_int)
| ospf_0_1_set_overflow_interval |
[protected pure virtual]
Pure-virtual function that needs to be implemented to:
Set time to exit overflow state
| XrlCmdError ospf_0_1_get_overflow_interval (
int32_t& ovfl_int)
| ospf_0_1_get_overflow_interval |
[protected pure virtual]
| XrlCmdError ospf_0_1_set_flood_rate (
const int32_t& rate)
| ospf_0_1_set_flood_rate |
[protected pure virtual]
Pure-virtual function that needs to be implemented to:
Set flood rate - self orig per second
| XrlCmdError ospf_0_1_get_flood_rate (
int32_t& rate)
| ospf_0_1_get_flood_rate |
[protected pure virtual]
| XrlCmdError ospf_0_1_set_max_rxmt_window (
const uint32_t& window)
| ospf_0_1_set_max_rxmt_window |
[protected pure virtual]
Pure-virtual function that needs to be implemented to:
Set back-to-back retransmissions
| XrlCmdError ospf_0_1_get_max_rxmt_window (
uint32_t& window)
| ospf_0_1_get_max_rxmt_window |
[protected pure virtual]
| XrlCmdError ospf_0_1_set_max_dds (
const uint32_t& max_dds)
| ospf_0_1_set_max_dds |
[protected pure virtual]
Pure-virtual function that needs to be implemented to:
Set maximum simultaneous DB exchanges
| XrlCmdError ospf_0_1_get_max_dds (
uint32_t& max_dds)
| ospf_0_1_get_max_dds |
[protected pure virtual]
| XrlCmdError ospf_0_1_set_lsa_refresh_rate (
const uint32_t& rate)
| ospf_0_1_set_lsa_refresh_rate |
[protected pure virtual]
Pure-virtual function that needs to be implemented to:
Set rate to refresh DoNotAge LSAs
| XrlCmdError ospf_0_1_get_lsa_refresh_rate (
uint32_t& rate)
| ospf_0_1_get_lsa_refresh_rate |
[protected pure virtual]
| XrlCmdError ospf_0_1_set_p2p_adj_limit (
const uint32_t& max_adj)
| ospf_0_1_set_p2p_adj_limit |
[protected pure virtual]
Pure-virtual function that needs to be implemented to:
Set the maximum number of point-to-point links that will become adjacent to a particular neighbor. If there is no limit then value is zero.
| XrlCmdError ospf_0_1_get_p2p_adj_limit (
uint32_t& max_adj)
| ospf_0_1_get_p2p_adj_limit |
[protected pure virtual]
| XrlCmdError ospf_0_1_set_random_refresh (
const bool& enabled)
| ospf_0_1_set_random_refresh |
[protected pure virtual]
Pure-virtual function that needs to be implemented to:
| XrlCmdError ospf_0_1_get_random_refresh (
bool& enabled)
| ospf_0_1_get_random_refresh |
[protected pure virtual]
| XrlCmdError ospf_0_1_add_or_configure_area (
const uint32_t& area_id,
const bool& is_stub,
const uint32_t& default_cost,
const bool& import_summary_routes)
| ospf_0_1_add_or_configure_area |
[protected pure virtual]
Pure-virtual function that needs to be implemented to:
| XrlCmdError ospf_0_1_delete_area (
const uint32_t& area_id)
| ospf_0_1_delete_area |
[protected pure virtual]
Pure-virtual function that needs to be implemented to:
| XrlCmdError ospf_0_1_query_area (
const uint32_t& area_id,
bool& is_stub,
uint32_t& default_cost,
bool& import_summary_routes)
| ospf_0_1_query_area |
[protected pure virtual]
Pure-virtual function that needs to be implemented to:
| XrlCmdError ospf_0_1_list_area_ids (
XrlAtomList& area_ids)
| ospf_0_1_list_area_ids |
[protected pure virtual]
Pure-virtual function that needs to be implemented to:
Parameters:
| area_ids | list of value area_ids. Each id is a u32. |
| XrlCmdError ospf_0_1_add_or_configure_aggregate (
const uint32_t& area_id,
const IPv4& network,
const IPv4& netmask,
const bool& suppress_advertisement)
| ospf_0_1_add_or_configure_aggregate |
[protected pure virtual]
Pure-virtual function that needs to be implemented to:
Add or configure aggregate.
Parameters:
| area_id | id of area aggregate belongs to. |
| network | network identifier. |
| netmask | netmask identifier. |
| suppress_advertisement | of aggregate. |
| XrlCmdError ospf_0_1_delete_aggregate (
const uint32_t& area_id,
const IPv4& network,
const IPv4& netmask)
| ospf_0_1_delete_aggregate |
[protected pure virtual]
Pure-virtual function that needs to be implemented to:
Delete aggregate identified by area_id, network, and netmask
| XrlCmdError ospf_0_1_query_aggregate (
const uint32_t& area_id,
const IPv4& network,
const IPv4& netmask,
bool& suppress_advertisement)
| ospf_0_1_query_aggregate |
[protected pure virtual]
Pure-virtual function that needs to be implemented to:
Query aggregate identified by area_id, network, and netmask
| XrlCmdError ospf_0_1_list_aggregates (
const uint32_t& area_id,
XrlAtomList& networks,
XrlAtomList& netmasks)
| ospf_0_1_list_aggregates |
[protected pure virtual]
Pure-virtual function that needs to be implemented to:
Return list of aggregate identifiers for area identified by area_id. Two lists are returned, the nth elements in each list comprise the tuple (network,netmask) that uniquely identifies the aggregate within the area.
| XrlCmdError ospf_0_1_add_or_configure_host (
const IPv4& network,
const IPv4& netmask,
const uint32_t& area_id,
const uint32_t& cost)
| ospf_0_1_add_or_configure_host |
[protected pure virtual]
Pure-virtual function that needs to be implemented to:
Add or configure host routes.
Parameters:
| area_id | host is to be advertised in. |
| cost | metric associated with host (0-65535). |
| XrlCmdError ospf_0_1_delete_host (
const IPv4& network,
const IPv4& netmask,
const uint32_t& area_id)
| ospf_0_1_delete_host |
[protected pure virtual]
Pure-virtual function that needs to be implemented to:
Delete host identified by network and netmask
| XrlCmdError ospf_0_1_query_host (
const IPv4& network,
const IPv4& netmask,
const uint32_t& area_id,
uint32_t& cost)
| ospf_0_1_query_host |
[protected pure virtual]
Pure-virtual function that needs to be implemented to:
Query host identified by network and netmask
| XrlCmdError ospf_0_1_list_hosts (
const uint32_t& area_id,
XrlAtomList& networks,
XrlAtomList& netmasks)
| ospf_0_1_list_hosts |
[protected pure virtual]
Pure-virtual function that needs to be implemented to:
Return list of host identifiers for area identified by area_id. Two lists are returned, the nth elements in each list comprise the tuple (network,netmask) that uniquely identifies the host within the area.
| XrlCmdError ospf_0_1_add_vlink (
const uint32_t& transit_area,
const uint32_t& neighbor_id)
| ospf_0_1_add_vlink |
[protected pure virtual]
| XrlCmdError ospf_0_1_delete_vlink (
const uint32_t& transit_area,
const uint32_t& neighbor_id)
| ospf_0_1_delete_vlink |
[protected pure virtual]
| XrlCmdError ospf_0_1_vlink_set_transmit_delay (
const uint32_t& transit_area,
const uint32_t& neighbor_id,
const uint32_t& delay_secs)
| ospf_0_1_vlink_set_transmit_delay |
[protected pure virtual]
| XrlCmdError ospf_0_1_vlink_get_transmit_delay (
const uint32_t& transit_area,
const uint32_t& neighbor_id,
uint32_t& delay_secs)
| ospf_0_1_vlink_get_transmit_delay |
[protected pure virtual]
| XrlCmdError ospf_0_1_vlink_set_retransmit_interval (
const uint32_t& transit_area,
const uint32_t& neighbor_id,
const uint32_t& interval_secs)
| ospf_0_1_vlink_set_retransmit_interval |
[protected pure virtual]
| XrlCmdError ospf_0_1_vlink_get_retransmit_interval (
const uint32_t& transit_area,
const uint32_t& neighbor_id,
uint32_t& interval_secs)
| ospf_0_1_vlink_get_retransmit_interval |
[protected pure virtual]
| XrlCmdError ospf_0_1_vlink_set_hello_interval (
const uint32_t& transit_area,
const uint32_t& neighbor_id,
const uint32_t& interval_secs)
| ospf_0_1_vlink_set_hello_interval |
[protected pure virtual]
| XrlCmdError ospf_0_1_vlink_get_hello_interval (
const uint32_t& transit_area,
const uint32_t& neighbor_id,
uint32_t& interval_secs)
| ospf_0_1_vlink_get_hello_interval |
[protected pure virtual]
| XrlCmdError ospf_0_1_vlink_set_router_dead_interval (
const uint32_t& transit_area,
const uint32_t& neighbor_id,
const uint32_t& interval_secs)
| ospf_0_1_vlink_set_router_dead_interval |
[protected pure virtual]
| XrlCmdError ospf_0_1_vlink_get_router_dead_interval (
const uint32_t& transit_area,
const uint32_t& neighbor_id,
uint32_t& interval_secs)
| ospf_0_1_vlink_get_router_dead_interval |
[protected pure virtual]
| XrlCmdError ospf_0_1_vlink_set_authentication (
const uint32_t& transit_area,
const uint32_t& neighbor_id,
const string& type,
const string& key)
| ospf_0_1_vlink_set_authentication |
[protected pure virtual]
Pure-virtual function that needs to be implemented to:
Parameters:
| type | is one of "none", "cleartext", "md5" |
| XrlCmdError ospf_0_1_vlink_get_authentication (
const uint32_t& transit_area,
const uint32_t& neighbor_id,
string& type,
string& key)
| ospf_0_1_vlink_get_authentication |
[protected pure virtual]
| XrlCmdError ospf_0_1_list_vlinks (
const uint32_t& transit_id,
XrlAtomList& neighbor_ids)
| ospf_0_1_list_vlinks |
[protected pure virtual]
Pure-virtual function that needs to be implemented to:
Return list of neighbour id's (unsigned 32 bit values)
| XrlCmdError ospf_0_1_add_or_configure_external_route (
const IPv4Net& network,
const IPv4& gateway,
const uint32_t& type,
const uint32_t& cost,
const bool& multicast,
const uint32_t& external_route_tag)
| ospf_0_1_add_or_configure_external_route |
[protected pure virtual]
| XrlCmdError ospf_0_1_delete_external_route (
const IPv4Net& network,
const IPv4& gateway)
| ospf_0_1_delete_external_route |
[protected pure virtual]
| XrlCmdError ospf_0_1_query_external_route (
const IPv4Net& network,
const IPv4& gateway,
uint32_t& type,
uint32_t& cost,
bool& multicast,
uint32_t& external_route_tag)
| ospf_0_1_query_external_route |
[protected pure virtual]
| XrlCmdError ospf_0_1_list_external_routes (
const IPv4Net& network,
XrlAtomList& gateways)
| ospf_0_1_list_external_routes |
[protected pure virtual]
| XrlCmdError ospf_0_1_add_interface (
const string& identifier,
const uint32_t& if_index,
const uint32_t& area_id,
const uint32_t& cost,
const uint32_t& mtu,
const string& type,
const bool& on_demand,
const bool& passive)
| ospf_0_1_add_interface |
[protected pure virtual]
| XrlCmdError ospf_0_1_interface_set_if_index (
const string& identifier,
const uint32_t& index)
| ospf_0_1_interface_set_if_index |
[protected pure virtual]
| XrlCmdError ospf_0_1_interface_get_if_index (
const string& identifier,
uint32_t& index)
| ospf_0_1_interface_get_if_index |
[protected pure virtual]
| XrlCmdError ospf_0_1_interface_set_area_id (
const string& identifier,
const uint32_t& area_id)
| ospf_0_1_interface_set_area_id |
[protected pure virtual]
| XrlCmdError ospf_0_1_interface_get_area_id (
const string& identifier,
uint32_t& area_id)
| ospf_0_1_interface_get_area_id |
[protected pure virtual]
| XrlCmdError ospf_0_1_interface_set_cost (
const string& identifier,
const uint32_t& cost)
| ospf_0_1_interface_set_cost |
[protected pure virtual]
| XrlCmdError ospf_0_1_interface_get_cost (
const string& identifier,
uint32_t& cost)
| ospf_0_1_interface_get_cost |
[protected pure virtual]
| XrlCmdError ospf_0_1_interface_set_mtu (
const string& identifier,
const uint32_t& mtu)
| ospf_0_1_interface_set_mtu |
[protected pure virtual]
| XrlCmdError ospf_0_1_interface_get_mtu (
const string& identifier,
uint32_t& mtu)
| ospf_0_1_interface_get_mtu |
[protected pure virtual]
| XrlCmdError ospf_0_1_interface_set_type (
const string& identifier,
const string& type)
| ospf_0_1_interface_set_type |
[protected pure virtual]
| XrlCmdError ospf_0_1_interface_get_type (
const string& identifier,
string& type)
| ospf_0_1_interface_get_type |
[protected pure virtual]
| XrlCmdError ospf_0_1_interface_set_dr_priority (
const string& identifier,
const uint32_t& dr_priority)
| ospf_0_1_interface_set_dr_priority |
[protected pure virtual]
| XrlCmdError ospf_0_1_interface_get_dr_priority (
const string& identifier,
uint32_t& dr_priority)
| ospf_0_1_interface_get_dr_priority |
[protected pure virtual]
| XrlCmdError ospf_0_1_interface_set_transit_delay (
const string& identifier,
const uint32_t& delay_secs)
| ospf_0_1_interface_set_transit_delay |
[protected pure virtual]
| XrlCmdError ospf_0_1_interface_get_transit_delay (
const string& identifier,
uint32_t& delay_secs)
| ospf_0_1_interface_get_transit_delay |
[protected pure virtual]
| XrlCmdError ospf_0_1_interface_set_retransmit_interval (
const string& identifier,
const uint32_t& interval_secs)
| ospf_0_1_interface_set_retransmit_interval |
[protected pure virtual]
| XrlCmdError ospf_0_1_interface_get_retransmit_interval (
const string& identifier,
uint32_t& interval_secs)
| ospf_0_1_interface_get_retransmit_interval |
[protected pure virtual]
| XrlCmdError ospf_0_1_interface_set_router_dead_interval (
const string& identifier,
const uint32_t& interval_secs)
| ospf_0_1_interface_set_router_dead_interval |
[protected pure virtual]
| XrlCmdError ospf_0_1_interface_get_router_dead_interval (
const string& identifier,
uint32_t& interval_secs)
| ospf_0_1_interface_get_router_dead_interval |
[protected pure virtual]
| XrlCmdError ospf_0_1_interface_set_poll_interval (
const string& identifier,
const uint32_t& interval_secs)
| ospf_0_1_interface_set_poll_interval |
[protected pure virtual]
| XrlCmdError ospf_0_1_interface_get_poll_interval (
const string& identifier,
uint32_t& interval_secs)
| ospf_0_1_interface_get_poll_interval |
[protected pure virtual]
| XrlCmdError ospf_0_1_interface_set_authentication (
const string& identifier,
const string& type,
const string& key)
| ospf_0_1_interface_set_authentication |
[protected pure virtual]
| XrlCmdError ospf_0_1_interface_get_authentication (
const string& identifier,
string& type,
string& key)
| ospf_0_1_interface_get_authentication |
[protected pure virtual]
| XrlCmdError ospf_0_1_interface_set_multicast_forwarding (
const string& identifier,
const string& type)
| ospf_0_1_interface_set_multicast_forwarding |
[protected pure virtual]
Pure-virtual function that needs to be implemented to:
Set state of multicast forwarding on interface.
Parameters:
| type | multicast type can be one of three values: "blocked" meaning not enabled, "multicast" meaning data-link multicast, or "unicast" meaning multicast packets should be unicast on data-link. |
| XrlCmdError ospf_0_1_interface_get_multicast_forwarding (
const string& identifier,
string& type)
| ospf_0_1_interface_get_multicast_forwarding |
[protected pure virtual]
| XrlCmdError ospf_0_1_interface_set_on_demand (
const string& identifier,
const bool& on_demand)
| ospf_0_1_interface_set_on_demand |
[protected pure virtual]
| XrlCmdError ospf_0_1_interface_get_on_demand (
const string& identifier,
bool& on_demand)
| ospf_0_1_interface_get_on_demand |
[protected pure virtual]
| XrlCmdError ospf_0_1_interface_set_passive (
const string& identifier,
const bool& passive)
| ospf_0_1_interface_set_passive |
[protected pure virtual]
| XrlCmdError ospf_0_1_interface_get_passive (
const string& identifier,
bool& passive)
| ospf_0_1_interface_get_passive |
[protected pure virtual]
| XrlCmdError ospf_0_1_interface_set_igmp (
const string& identifier,
const bool& enabled)
| ospf_0_1_interface_set_igmp |
[protected pure virtual]
| XrlCmdError ospf_0_1_interface_get_igmp (
const string& identifier,
bool& enabled)
| ospf_0_1_interface_get_igmp |
[protected pure virtual]
| XrlCmdError ospf_0_1_delete_interface (
const string& identifier)
| ospf_0_1_delete_interface |
[protected pure virtual]
| XrlCmdError ospf_0_1_list_interfaces (
XrlAtomList& identifiers)
| ospf_0_1_list_interfaces |
[protected pure virtual]
| XrlCmdError ospf_0_1_interface_add_md5_key (
const string& identifier,
const uint32_t& key_id,
const string& md5key,
const string& start_receive,
const string& stop_receive,
const string& start_transmit,
const string& stop_transmit)
| ospf_0_1_interface_add_md5_key |
[protected pure virtual]
Pure-virtual function that needs to be implemented to:
Add md5 key to interface. The key may be used for both receiving and transmitting packets. Separate time periods are used to describe when the key is valid for receiving and transmitting. These periods are bound by times start_receive, stop_receive and start_transmit, stop_transmit. The expected date format is "%Y-%m-%d %H:%M:%S". This code uses strptime and strftime internally.
Parameters:
| identifier | interface key is to be used for. |
| key_id | a value between 1-255 that identifies the key. |
| XrlCmdError ospf_0_1_interface_get_md5_key (
const string& identifier,
const uint32_t& key_id,
string& md5key,
string& start_receive,
string& stop_receive,
string& start_transmit,
string& stop_transmit)
| ospf_0_1_interface_get_md5_key |
[protected pure virtual]
| XrlCmdError ospf_0_1_interface_delete_md5_key (
const string& identifier,
const uint32_t& key_id)
| ospf_0_1_interface_delete_md5_key |
[protected pure virtual]
| XrlCmdError ospf_0_1_interface_list_md5_keys (
const string& identifier,
XrlAtomList& key_ids)
| ospf_0_1_interface_list_md5_keys |
[protected pure virtual]
| XrlCmdError ospf_0_1_add_neighbor (
const IPv4& nbr_addr,
const bool& dr_eligible)
| ospf_0_1_add_neighbor |
[protected pure virtual]
| XrlCmdError ospf_0_1_get_neighbor (
const IPv4& nbr_addr,
bool& dr_eligible)
| ospf_0_1_get_neighbor |
[protected pure virtual]
| XrlCmdError ospf_0_1_delete_neighbor (
const IPv4& nbr_addr)
| ospf_0_1_delete_neighbor |
[protected pure virtual]
| XrlCmdError ospf_0_1_list_neighbors (
XrlAtomList& nbr_addrs)
| ospf_0_1_list_neighbors |
[protected pure virtual]
