| XrlCmdMap* _cmds | _cmds |
[protected]
| XrlFeaTargetBase (XrlCmdMap* cmds = 0)
| XrlFeaTargetBase |
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. |
| ~XrlFeaTargetBase ()
| ~XrlFeaTargetBase |
[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.
| const string& name ()
| name |
[const]
Get Xrl instance name associated with command map.
| 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 finder_event_observer_0_1_xrl_target_birth (
const string& target_class,
const string& target_instance)
| finder_event_observer_0_1_xrl_target_birth |
[protected pure virtual]
Pure-virtual function that needs to be implemented to:
Announce target birth to observer.
Parameters:
| target_class | the target class name. |
| target_instance | the target instance name. |
| XrlCmdError finder_event_observer_0_1_xrl_target_death (
const string& target_class,
const string& target_instance)
| finder_event_observer_0_1_xrl_target_death |
[protected pure virtual]
Pure-virtual function that needs to be implemented to:
Announce target death to observer.
Parameters:
| target_class | the target class name. |
| target_instance | the target instance name. |
| XrlCmdError fea_click_0_1_load_click ()
| fea_click_0_1_load_click |
[protected pure virtual]
Pure-virtual function that needs to be implemented to:
| XrlCmdError fea_click_0_1_unload_click ()
| fea_click_0_1_unload_click |
[protected pure virtual]
Pure-virtual function that needs to be implemented to:
| XrlCmdError fea_click_0_1_enable_click (
const bool& enable)
| fea_click_0_1_enable_click |
[protected pure virtual]
Pure-virtual function that needs to be implemented to:
Enable/disable Click FEA support.
Parameters:
| enable | if true, then enable the Click FEA support, otherwise disable it. |
| XrlCmdError fea_click_0_1_start_click ()
| fea_click_0_1_start_click |
[protected pure virtual]
Pure-virtual function that needs to be implemented to:
| XrlCmdError fea_click_0_1_stop_click ()
| fea_click_0_1_stop_click |
[protected pure virtual]
Pure-virtual function that needs to be implemented to:
| XrlCmdError fea_click_0_1_enable_duplicate_routes_to_kernel (
const bool& enable)
| fea_click_0_1_enable_duplicate_routes_to_kernel |
[protected pure virtual]
Pure-virtual function that needs to be implemented to:
Enable/disable duplicating the Click routes to the system kernel.
Parameters:
| enable | if true, then enable duplicating the Click routes to the system kernel, otherwise disable it. |
| XrlCmdError fea_click_0_1_enable_kernel_click (
const bool& enable)
| fea_click_0_1_enable_kernel_click |
[protected pure virtual]
Pure-virtual function that needs to be implemented to:
Enable/disable kernel-level Click FEA support.
Parameters:
| enable | if true, then enable the kernel-level Click FEA support, otherwise disable it. |
| XrlCmdError fea_click_0_1_enable_kernel_click_install_on_startup (
const bool& enable)
| fea_click_0_1_enable_kernel_click_install_on_startup |
[protected pure virtual]
Pure-virtual function that needs to be implemented to:
Enable/disable installing kernel-level Click on startup.
Parameters:
| enable | if true, then install kernel-level Click on startup. |
| XrlCmdError fea_click_0_1_set_kernel_click_modules (
const string& modules)
| fea_click_0_1_set_kernel_click_modules |
[protected pure virtual]
Pure-virtual function that needs to be implemented to:
Specify the list of kernel Click modules to load on startup if installing kernel-level Click on startup is enabled. The file names of the kernel modules are separated by colon.
Parameters:
| modules | the list of kernel Click modules (separated by colon) to load. |
| XrlCmdError fea_click_0_1_set_kernel_click_mount_directory (
const string& directory)
| fea_click_0_1_set_kernel_click_mount_directory |
[protected pure virtual]
Pure-virtual function that needs to be implemented to:
Specify the kernel-level Click mount directory.
Parameters:
| directory | the kernel-level Click mount directory. |
| XrlCmdError fea_click_0_1_set_kernel_click_config_generator_file (
const string& kernel_click_config_generator_file)
| fea_click_0_1_set_kernel_click_config_generator_file |
[protected pure virtual]
Pure-virtual function that needs to be implemented to:
Specify the external program to generate the kernel-level Click configuration.
Parameters:
| kernel_click_config_generator_file | the name of the external program to generate the kernel-level Click configuration. |
| XrlCmdError fea_click_0_1_enable_user_click (
const bool& enable)
| fea_click_0_1_enable_user_click |
[protected pure virtual]
Pure-virtual function that needs to be implemented to:
Enable/disable user-level Click FEA support.
Parameters:
| enable | if true, then enable the user-level Click FEA support, otherwise disable it. |
| XrlCmdError fea_click_0_1_set_user_click_command_file (
const string& user_click_command_file)
| fea_click_0_1_set_user_click_command_file |
[protected pure virtual]
Pure-virtual function that needs to be implemented to:
Specify the user-level Click command file.
Parameters:
| user_click_command_file | the name of the user-level Click command file. |
| XrlCmdError fea_click_0_1_set_user_click_command_extra_arguments (
const string& user_click_command_extra_arguments)
| fea_click_0_1_set_user_click_command_extra_arguments |
[protected pure virtual]
Pure-virtual function that needs to be implemented to:
Specify the extra arguments to the user-level Click command.
Parameters:
| user_click_command_extra_arguments | the extra arguments to the user-level Click command. |
| XrlCmdError fea_click_0_1_set_user_click_command_execute_on_startup (
const bool& user_click_command_execute_on_startup)
| fea_click_0_1_set_user_click_command_execute_on_startup |
[protected pure virtual]
Pure-virtual function that needs to be implemented to:
Specify whether to execute on startup the user-level Click command.
Parameters:
| user_click_command_execute_on_startup | if true, then execute the user-level Click command on startup. |
| XrlCmdError fea_click_0_1_set_user_click_control_address (
const IPv4& user_click_control_address)
| fea_click_0_1_set_user_click_control_address |
[protected pure virtual]
Pure-virtual function that needs to be implemented to:
Specify the address to use for control access to the user-level Click.
Parameters:
| user_click_control_address | the address to use for control access to the user-level Click. |
| XrlCmdError fea_click_0_1_set_user_click_control_socket_port (
const uint32_t& user_click_control_socket_port)
| fea_click_0_1_set_user_click_control_socket_port |
[protected pure virtual]
Pure-virtual function that needs to be implemented to:
Specify the socket port to use for control access to the user-level Click.
Parameters:
| user_click_control_socket_port | the socket port to use for control access to the user-level Click. |
| XrlCmdError fea_click_0_1_set_user_click_startup_config_file (
const string& user_click_startup_config_file)
| fea_click_0_1_set_user_click_startup_config_file |
[protected pure virtual]
Pure-virtual function that needs to be implemented to:
Specify the configuration file to be used by user-level Click on startup.
Parameters:
| user_click_startup_config_file | the name of the configuration file to be used by user-level Click on startup. |
| XrlCmdError fea_click_0_1_set_user_click_config_generator_file (
const string& user_click_config_generator_file)
| fea_click_0_1_set_user_click_config_generator_file |
[protected pure virtual]
Pure-virtual function that needs to be implemented to:
Specify the external program to generate the user-level Click configuration.
Parameters:
| user_click_config_generator_file | the name of the external program to generate the user-level Click configuration. |
| XrlCmdError fea_fib_0_1_add_fib_client4 (
const string& client_target_name,
const bool& send_updates,
const bool& send_resolves)
| fea_fib_0_1_add_fib_client4 |
[protected pure virtual]
Pure-virtual function that needs to be implemented to:
Add a FIB client.
Parameters:
| client_target_name | the target name of the FIB client to add. |
| send_updates | whether updates should be sent. |
| send_resolves | whether resolution requests should be sent. |
| XrlCmdError fea_fib_0_1_add_fib_client6 (
const string& client_target_name,
const bool& send_updates,
const bool& send_resolves)
| fea_fib_0_1_add_fib_client6 |
[protected pure virtual]
| XrlCmdError fea_fib_0_1_delete_fib_client4 (
const string& client_target_name)
| fea_fib_0_1_delete_fib_client4 |
[protected pure virtual]
Pure-virtual function that needs to be implemented to:
Delete a FIB client.
Parameters:
| client_target_name | the target name of the FIB client to delete. |
| XrlCmdError fea_fib_0_1_delete_fib_client6 (
const string& client_target_name)
| fea_fib_0_1_delete_fib_client6 |
[protected pure virtual]
| XrlCmdError fea_firewall_0_1_start_transaction (
uint32_t& tid)
| fea_firewall_0_1_start_transaction |
[protected pure virtual]
Pure-virtual function that needs to be implemented to:
Start firewall configuration transaction.
Parameters:
| tid | the transaction ID returned by this operation. |
| XrlCmdError fea_firewall_0_1_commit_transaction (
const uint32_t& tid)
| fea_firewall_0_1_commit_transaction |
[protected pure virtual]
Pure-virtual function that needs to be implemented to:
Commit firewall configuration transaction.
Parameters:
| tid | the transaction ID for this operation. |
| XrlCmdError fea_firewall_0_1_abort_transaction (
const uint32_t& tid)
| fea_firewall_0_1_abort_transaction |
[protected pure virtual]
Pure-virtual function that needs to be implemented to:
Abort firewall configuration transaction.
Parameters:
| tid | the transaction ID for this operation. |
| XrlCmdError fea_firewall_0_1_add_entry4 (
const uint32_t& tid,
const uint32_t& rule_number,
const string& ifname,
const string& vifname,
const IPv4Net& src_network,
const IPv4Net& dst_network,
const uint32_t& ip_protocol,
const uint32_t& src_port_begin,
const uint32_t& src_port_end,
const uint32_t& dst_port_begin,
const uint32_t& dst_port_end,
const string& action)
| fea_firewall_0_1_add_entry4 |
[protected pure virtual]
Pure-virtual function that needs to be implemented to:
Add an IPv4 firewall entry.
Parameters:
| tid | the transaction ID for this operation. |
| rule_number | the rule number for this entry. |
| ifname | the name of the interface where this filter is to be applied. |
| vifname | the name of the vif where this filter is to be applied. |
| src_network | the source IPv4 network address prefix. |
| dst_network | the destination IPv4 network address prefix. |
| ip_protocol | the IP protocol number (1-255, or 0 if wildcard). |
| src_port_begin | the source TCP/UDP begin port (0-65535). |
| src_port_end | the source TCP/UDP end port (0-65535). |
| dst_port_begin | the destination TCP/UDP begin port (0-65535). |
| dst_port_end | the destination TCP/UDP end port (0-65535). |
| action | the action to be taken when this filter is matched. It is one of the following keywords: "none", "pass", "drop", "reject". |
| XrlCmdError fea_firewall_0_1_replace_entry4 (
const uint32_t& tid,
const uint32_t& rule_number,
const string& ifname,
const string& vifname,
const IPv4Net& src_network,
const IPv4Net& dst_network,
const uint32_t& ip_protocol,
const uint32_t& src_port_begin,
const uint32_t& src_port_end,
const uint32_t& dst_port_begin,
const uint32_t& dst_port_end,
const string& action)
| fea_firewall_0_1_replace_entry4 |
[protected pure virtual]
Pure-virtual function that needs to be implemented to:
Replace an IPv4 firewall entry.
Parameters:
| tid | the transaction ID for this operation. |
| rule_number | the rule number for this entry. |
| ifname | the name of the interface where this filter is to be applied. |
| vifname | the name of the vif where this filter is to be applied. |
| src_network | the source IPv4 network address prefix. |
| dst_network | the destination IPv4 network address prefix. |
| ip_protocol | the IP protocol number (1-255, or 0 if wildcard). |
| src_port_begin | the source TCP/UDP begin port (0-65535). |
| src_port_end | the source TCP/UDP end port (0-65535). |
| dst_port_begin | the destination TCP/UDP begin port (0-65535). |
| dst_port_end | the destination TCP/UDP end port (0-65535). |
| action | the action to be taken when this filter is matched. It is one of the following keywords: "none", "pass", "drop", "reject". |
| XrlCmdError fea_firewall_0_1_delete_entry4 (
const uint32_t& tid,
const uint32_t& rule_number,
const string& ifname,
const string& vifname,
const IPv4Net& src_network,
const IPv4Net& dst_network,
const uint32_t& ip_protocol,
const uint32_t& src_port_begin,
const uint32_t& src_port_end,
const uint32_t& dst_port_begin,
const uint32_t& dst_port_end)
| fea_firewall_0_1_delete_entry4 |
[protected pure virtual]
Pure-virtual function that needs to be implemented to:
Delete an IPv4 firewall entry.
Parameters:
| tid | the transaction ID for this operation. |
| rule_number | the rule number for this entry. |
| ifname | the name of the interface where this filter is to be deleted. |
| vifname | the name of the vif where this filter is to be deleted. |
| src_network | the source IPv4 network address prefix. |
| dst_network | the destination IPv4 network address prefix. |
| ip_protocol | the IP protocol number (1-255, or 0 if wildcard). |
| src_port_begin | the source TCP/UDP begin port (0-65535). |
| src_port_end | the source TCP/UDP end port (0-65535). |
| dst_port_begin | the destination TCP/UDP begin port (0-65535). |
| dst_port_end | the destination TCP/UDP end port (0-65535). |
| XrlCmdError fea_firewall_0_1_delete_all_entries4 (
const uint32_t& tid)
| fea_firewall_0_1_delete_all_entries4 |
[protected pure virtual]
Pure-virtual function that needs to be implemented to:
Delete all IPv4 firewall entries.
Parameters:
| tid | the transaction ID for this operation. |
| XrlCmdError fea_firewall_0_1_get_entry_list_start4 (
uint32_t& token,
bool& more)
| fea_firewall_0_1_get_entry_list_start4 |
[protected pure virtual]
Pure-virtual function that needs to be implemented to:
Get a token for a list of IPv4 firewall entries.
Parameters:
| token | to be provided when calling get_entry_list_next4. |
| more | true if the list is not empty. |
| XrlCmdError fea_firewall_0_1_get_entry_list_next4 (
const uint32_t& token,
uint32_t& rule_number,
string& ifname,
string& vifname,
IPv4Net& src_network,
IPv4Net& dst_network,
uint32_t& ip_protocol,
uint32_t& src_port_begin,
uint32_t& src_port_end,
uint32_t& dst_port_begin,
uint32_t& dst_port_end,
string& action,
bool& more)
| fea_firewall_0_1_get_entry_list_next4 |
[protected pure virtual]
Pure-virtual function that needs to be implemented to:
Get the next item in a list of IPv4 firewall entries.
Parameters:
| token | returned by a previous call to get_entry_list_start4. |
| rule_number | the rule number for this entry. |
| ifname | the name of the interface where this filter exists. |
| vifname | the name of the vif where this filter exists. |
| src_network | the source IPv4 network address prefix. |
| dst_network | the destination IPv4 network address prefix. |
| ip_protocol | the IP protocol number (1-255, or 0 if wildcard). |
| src_port_begin | the source TCP/UDP begin port (0-65535). |
| src_port_end | the source TCP/UDP end port (0-65535). |
| dst_port_begin | the destination TCP/UDP begin port (0-65535). |
| dst_port_end | the destination TCP/UDP end port (0-65535). |
| action | the action taken when this filter is matched. It is one of the following keywords: "none", "pass", "drop", "reject". |
| more | true if the list has more items remaining. |
| XrlCmdError fea_firewall_0_1_add_entry6 (
const uint32_t& tid,
const uint32_t& rule_number,
const string& ifname,
const string& vifname,
const IPv6Net& src_network,
const IPv6Net& dst_network,
const uint32_t& ip_protocol,
const uint32_t& src_port_begin,
const uint32_t& src_port_end,
const uint32_t& dst_port_begin,
const uint32_t& dst_port_end,
const string& action)
| fea_firewall_0_1_add_entry6 |
[protected pure virtual]
Pure-virtual function that needs to be implemented to:
Add an IPv6 firewall entry.
Parameters:
| tid | the transaction ID for this operation. |
| rule_number | the rule number for this entry. |
| ifname | the name of the interface where this filter is to be applied. |
| vifname | the name of the vif where this filter is to be applied. |
| src_network | the source IPv6 network address prefix. |
| dst_network | the destination IPv6 network address prefix. |
| ip_protocol | the IP protocol number (1-255, or 0 if wildcard). |
| src_port_begin | the source TCP/UDP begin port (0-65535). |
| src_port_end | the source TCP/UDP end port (0-65535). |
| dst_port_begin | the destination TCP/UDP begin port (0-65535). |
| dst_port_end | the destination TCP/UDP end port (0-65535). |
| action | the action to be taken when this filter is matched. It is one of the following keywords: "none", "pass", "drop", "reject". |
| XrlCmdError fea_firewall_0_1_replace_entry6 (
const uint32_t& tid,
const uint32_t& rule_number,
const string& ifname,
const string& vifname,
const IPv6Net& src_network,
const IPv6Net& dst_network,
const uint32_t& ip_protocol,
const uint32_t& src_port_begin,
const uint32_t& src_port_end,
const uint32_t& dst_port_begin,
const uint32_t& dst_port_end,
const string& action)
| fea_firewall_0_1_replace_entry6 |
[protected pure virtual]
Pure-virtual function that needs to be implemented to:
Replace an IPv6 firewall entry.
Parameters:
| tid | the transaction ID for this operation. |
| rule_number | the rule number for this entry. |
| ifname | the name of the interface where this filter is to be applied. |
| vifname | the name of the vif where this filter is to be applied. |
| src_network | the source IPv6 network address prefix. |
| dst_network | the destination IPv6 network address prefix. |
| ip_protocol | the IP protocol number (1-255, or 0 if wildcard). |
| src_port_begin | the source TCP/UDP begin port (0-65535). |
| src_port_end | the source TCP/UDP end port (0-65535). |
| dst_port_begin | the destination TCP/UDP begin port (0-65535). |
| dst_port_end | the destination TCP/UDP end port (0-65535). |
| action | the action to be taken when this filter is matched. It is one of the following keywords: "none", "pass", "drop", "reject". |
| XrlCmdError fea_firewall_0_1_delete_entry6 (
const uint32_t& tid,
const uint32_t& rule_number,
const string& ifname,
const string& vifname,
const IPv6Net& src_network,
const IPv6Net& dst_network,
const uint32_t& ip_protocol,
const uint32_t& src_port_begin,
const uint32_t& src_port_end,
const uint32_t& dst_port_begin,
const uint32_t& dst_port_end)
| fea_firewall_0_1_delete_entry6 |
[protected pure virtual]
Pure-virtual function that needs to be implemented to:
Delete an IPv6 firewall entry.
Parameters:
| tid | the transaction ID for this operation. |
| rule_number | the rule number for this entry. |
| ifname | the name of the interface where this filter is to be deleted. |
| vifname | the name of the vif where this filter is to be deleted. |
| src_network | the source IPv6 network address prefix. |
| dst_network | the destination IPv6 network address prefix. |
| ip_protocol | the IP protocol number (1-255, or 0 if wildcard). |
| src_port_begin | the source TCP/UDP begin port (0-65535). |
| src_port_end | the source TCP/UDP end port (0-65535). |
| dst_port_begin | the destination TCP/UDP begin port (0-65535). |
| dst_port_end | the destination TCP/UDP end port (0-65535). |
| XrlCmdError fea_firewall_0_1_delete_all_entries6 (
const uint32_t& tid)
| fea_firewall_0_1_delete_all_entries6 |
[protected pure virtual]
Pure-virtual function that needs to be implemented to:
Delete all IPv6 firewall entries.
Parameters:
| tid | the transaction ID for this operation. |
| XrlCmdError fea_firewall_0_1_get_entry_list_start6 (
uint32_t& token,
bool& more)
| fea_firewall_0_1_get_entry_list_start6 |
[protected pure virtual]
Pure-virtual function that needs to be implemented to:
Get a token for a list of IPv6 firewall entries.
Parameters:
| token | to be provided when calling get_entry_list_next6. |
| more | true if the list is not empty. |
| XrlCmdError fea_firewall_0_1_get_entry_list_next6 (
const uint32_t& token,
uint32_t& rule_number,
string& ifname,
string& vifname,
IPv6Net& src_network,
IPv6Net& dst_network,
uint32_t& ip_protocol,
uint32_t& src_port_begin,
uint32_t& src_port_end,
uint32_t& dst_port_begin,
uint32_t& dst_port_end,
string& action,
bool& more)
| fea_firewall_0_1_get_entry_list_next6 |
[protected pure virtual]
Pure-virtual function that needs to be implemented to:
Get the next item in a list of IPv6 firewall entries.
Parameters:
| token | returned by a previous call to get_entry_list_start6. |
| rule_number | the rule number for this entry. |
| ifname | the name of the interface where this filter exists. |
| vifname | the name of the vif where this filter exists. |
| src_network | the source IPv6 network address prefix. |
| dst_network | the destination IPv6 network address prefix. |
| ip_protocol | the IP protocol number (1-255, or 0 if wildcard). |
| src_port_begin | the source TCP/UDP begin port (0-65535). |
| src_port_end | the source TCP/UDP end port (0-65535). |
| dst_port_begin | the destination TCP/UDP begin port (0-65535). |
| dst_port_end | the destination TCP/UDP end port (0-65535). |
| action | the action taken when this filter is matched. It is one of the following keywords: "none", "pass", "drop", "reject". |
| more | true if the list has more items remaining. |
| XrlCmdError ifmgr_0_1_set_restore_original_config_on_shutdown (
const bool& enable)
| ifmgr_0_1_set_restore_original_config_on_shutdown |
[protected pure virtual]
| XrlCmdError ifmgr_0_1_get_configured_interface_names (
XrlAtomList& ifnames)
| ifmgr_0_1_get_configured_interface_names |
[protected pure virtual]
| XrlCmdError ifmgr_0_1_get_configured_vif_names (
const string& ifname,
XrlAtomList& vifs)
| ifmgr_0_1_get_configured_vif_names |
[protected pure virtual]
| XrlCmdError ifmgr_0_1_get_configured_vif_flags (
const string& ifname,
const string& vif,
bool& enabled,
bool& broadcast,
bool& loopback,
bool& point_to_point,
bool& multicast)
| ifmgr_0_1_get_configured_vif_flags |
[protected pure virtual]
| XrlCmdError ifmgr_0_1_get_configured_vif_pif_index (
const string& ifname,
const string& vif,
uint32_t& pif_index)
| ifmgr_0_1_get_configured_vif_pif_index |
[protected pure virtual]
| XrlCmdError ifmgr_0_1_get_configured_vif_addresses4 (
const string& ifname,
const string& vif,
XrlAtomList& addresses)
| ifmgr_0_1_get_configured_vif_addresses4 |
[protected pure virtual]
| XrlCmdError ifmgr_0_1_get_configured_vif_addresses6 (
const string& ifname,
const string& vif,
XrlAtomList& addresses)
| ifmgr_0_1_get_configured_vif_addresses6 |
[protected pure virtual]
| XrlCmdError ifmgr_0_1_get_configured_address_flags4 (
const string& ifname,
const string& vif,
const IPv4& address,
bool& enabled,
bool& broadcast,
bool& loopback,
bool& point_to_point,
bool& multicast)
| ifmgr_0_1_get_configured_address_flags4 |
[protected pure virtual]
| XrlCmdError ifmgr_0_1_get_configured_address_flags6 (
const string& ifname,
const string& vif,
const IPv6& address,
bool& enabled,
bool& loopback,
bool& point_to_point,
bool& multicast)
| ifmgr_0_1_get_configured_address_flags6 |
[protected pure virtual]
| XrlCmdError ifmgr_0_1_get_configured_interface_enabled (
const string& ifname,
bool& enabled)
| ifmgr_0_1_get_configured_interface_enabled |
[protected pure virtual]
| XrlCmdError ifmgr_0_1_get_configured_interface_discard (
const string& ifname,
bool& discard)
| ifmgr_0_1_get_configured_interface_discard |
[protected pure virtual]
| XrlCmdError ifmgr_0_1_get_configured_interface_unreachable (
const string& ifname,
bool& unreachable)
| ifmgr_0_1_get_configured_interface_unreachable |
[protected pure virtual]
| XrlCmdError ifmgr_0_1_get_configured_interface_management (
const string& ifname,
bool& management)
| ifmgr_0_1_get_configured_interface_management |
[protected pure virtual]
| XrlCmdError ifmgr_0_1_get_configured_mac (
const string& ifname,
Mac& mac)
| ifmgr_0_1_get_configured_mac |
[protected pure virtual]
| XrlCmdError ifmgr_0_1_get_configured_mtu (
const string& ifname,
uint32_t& mtu)
| ifmgr_0_1_get_configured_mtu |
[protected pure virtual]
| XrlCmdError ifmgr_0_1_get_configured_no_carrier (
const string& ifname,
bool& no_carrier)
| ifmgr_0_1_get_configured_no_carrier |
[protected pure virtual]
| XrlCmdError ifmgr_0_1_get_configured_baudrate (
const string& ifname,
uint64_t& baudrate)
| ifmgr_0_1_get_configured_baudrate |
[protected pure virtual]
| XrlCmdError ifmgr_0_1_get_configured_vif_enabled (
const string& ifname,
const string& vif,
bool& enabled)
| ifmgr_0_1_get_configured_vif_enabled |
[protected pure virtual]
| XrlCmdError ifmgr_0_1_get_configured_prefix4 (
const string& ifname,
const string& vif,
const IPv4& address,
uint32_t& prefix_len)
| ifmgr_0_1_get_configured_prefix4 |
[protected pure virtual]
| XrlCmdError ifmgr_0_1_get_configured_broadcast4 (
const string& ifname,
const string& vif,
const IPv4& address,
IPv4& broadcast)
| ifmgr_0_1_get_configured_broadcast4 |
[protected pure virtual]
| XrlCmdError ifmgr_0_1_get_configured_endpoint4 (
const string& ifname,
const string& vif,
const IPv4& address,
IPv4& endpoint)
| ifmgr_0_1_get_configured_endpoint4 |
[protected pure virtual]
| XrlCmdError ifmgr_0_1_get_configured_prefix6 (
const string& ifname,
const string& vif,
const IPv6& address,
uint32_t& prefix_len)
| ifmgr_0_1_get_configured_prefix6 |
[protected pure virtual]
| XrlCmdError ifmgr_0_1_get_configured_endpoint6 (
const string& ifname,
const string& vif,
const IPv6& address,
IPv6& endpoint)
| ifmgr_0_1_get_configured_endpoint6 |
[protected pure virtual]
| XrlCmdError ifmgr_0_1_start_transaction (
uint32_t& tid)
| ifmgr_0_1_start_transaction |
[protected pure virtual]
| XrlCmdError ifmgr_0_1_commit_transaction (
const uint32_t& tid)
| ifmgr_0_1_commit_transaction |
[protected pure virtual]
| XrlCmdError ifmgr_0_1_abort_transaction (
const uint32_t& tid)
| ifmgr_0_1_abort_transaction |
[protected pure virtual]
| XrlCmdError ifmgr_0_1_create_interface (
const uint32_t& tid,
const string& ifname)
| ifmgr_0_1_create_interface |
[protected pure virtual]
| XrlCmdError ifmgr_0_1_delete_interface (
const uint32_t& tid,
const string& ifname)
| ifmgr_0_1_delete_interface |
[protected pure virtual]
| XrlCmdError ifmgr_0_1_configure_all_interfaces_from_system (
const uint32_t& tid,
const bool& enable)
| ifmgr_0_1_configure_all_interfaces_from_system |
[protected pure virtual]
Pure-virtual function that needs to be implemented to:
Implicitly configure all interfaces within the FEA by using information from the underlying system.
Parameters:
| tid | the transaction ID. |
| enable | if true, then enable the implicit configuration, otherwise disable it. |
| XrlCmdError ifmgr_0_1_configure_interface_from_system (
const uint32_t& tid,
const string& ifname,
const bool& enable)
| ifmgr_0_1_configure_interface_from_system |
[protected pure virtual]
Pure-virtual function that needs to be implemented to:
Implicitly configure an interface within the FEA by using information from the underlying system.
Parameters:
| tid | the transaction ID. |
| ifname | the name of the interface to configure. |
| enable | if true, then enable the implicit configuration, otherwise disable it. |
| XrlCmdError ifmgr_0_1_set_interface_enabled (
const uint32_t& tid,
const string& ifname,
const bool& enabled)
| ifmgr_0_1_set_interface_enabled |
[protected pure virtual]
| XrlCmdError ifmgr_0_1_set_interface_discard (
const uint32_t& tid,
const string& ifname,
const bool& discard)
| ifmgr_0_1_set_interface_discard |
[protected pure virtual]
| XrlCmdError ifmgr_0_1_set_interface_unreachable (
const uint32_t& tid,
const string& ifname,
const bool& unreachable)
| ifmgr_0_1_set_interface_unreachable |
[protected pure virtual]
| XrlCmdError ifmgr_0_1_set_interface_management (
const uint32_t& tid,
const string& ifname,
const bool& management)
| ifmgr_0_1_set_interface_management |
[protected pure virtual]
| XrlCmdError ifmgr_0_1_set_mac (
const uint32_t& tid,
const string& ifname,
const Mac& mac)
| ifmgr_0_1_set_mac |
[protected pure virtual]
| XrlCmdError ifmgr_0_1_restore_original_mac (
const uint32_t& tid,
const string& ifname)
| ifmgr_0_1_restore_original_mac |
[protected pure virtual]
| XrlCmdError ifmgr_0_1_set_mtu (
const uint32_t& tid,
const string& ifname,
const uint32_t& mtu)
| ifmgr_0_1_set_mtu |
[protected pure virtual]
| XrlCmdError ifmgr_0_1_restore_original_mtu (
const uint32_t& tid,
const string& ifname)
| ifmgr_0_1_restore_original_mtu |
[protected pure virtual]
| XrlCmdError ifmgr_0_1_create_vif (
const uint32_t& tid,
const string& ifname,
const string& vif)
| ifmgr_0_1_create_vif |
[protected pure virtual]
Pure-virtual function that needs to be implemented to:
Create a vif.
Parameters:
| ifname | the name of the physical interface associated with the new vif. |
| vif | name for new vif, must be unique across all the vifs in the system. |
| XrlCmdError ifmgr_0_1_delete_vif (
const uint32_t& tid,
const string& ifname,
const string& vif)
| ifmgr_0_1_delete_vif |
[protected pure virtual]
| XrlCmdError ifmgr_0_1_set_vif_enabled (
const uint32_t& tid,
const string& ifname,
const string& vif,
const bool& enabled)
| ifmgr_0_1_set_vif_enabled |
[protected pure virtual]
| XrlCmdError ifmgr_0_1_set_vif_vlan (
const uint32_t& tid,
const string& ifname,
const string& vif,
const uint32_t& vlan_id)
| ifmgr_0_1_set_vif_vlan |
[protected pure virtual]
Pure-virtual function that needs to be implemented to:
Set VLAN vif.
Parameters:
| ifname | the name of the physical interface associated with the VLAN. |
| vif | the name of the VLAN. |
| vlan_id | the VLAN ID. It must be in the range 0 through 4095. |
| XrlCmdError ifmgr_0_1_create_address4 (
const uint32_t& tid,
const string& ifname,
const string& vif,
const IPv4& address)
| ifmgr_0_1_create_address4 |
[protected pure virtual]
| XrlCmdError ifmgr_0_1_delete_address4 (
const uint32_t& tid,
const string& ifname,
const string& vif,
const IPv4& address)
| ifmgr_0_1_delete_address4 |
[protected pure virtual]
| XrlCmdError ifmgr_0_1_set_address_enabled4 (
const uint32_t& tid,
const string& ifname,
const string& vif,
const IPv4& address,
const bool& enabled)
| ifmgr_0_1_set_address_enabled4 |
[protected pure virtual]
| XrlCmdError ifmgr_0_1_get_configured_address_enabled4 (
const string& ifname,
const string& vif,
const IPv4& address,
bool& enabled)
| ifmgr_0_1_get_configured_address_enabled4 |
[protected pure virtual]
| XrlCmdError ifmgr_0_1_set_prefix4 (
const uint32_t& tid,
const string& ifname,
const string& vif,
const IPv4& address,
const uint32_t& prefix_len)
| ifmgr_0_1_set_prefix4 |
[protected pure virtual]
| XrlCmdError ifmgr_0_1_set_broadcast4 (
const uint32_t& tid,
const string& ifname,
const string& vif,
const IPv4& address,
const IPv4& broadcast)
| ifmgr_0_1_set_broadcast4 |
[protected pure virtual]
| XrlCmdError ifmgr_0_1_set_endpoint4 (
const uint32_t& tid,
const string& ifname,
const string& vif,
const IPv4& address,
const IPv4& endpoint)
| ifmgr_0_1_set_endpoint4 |
[protected pure virtual]
| XrlCmdError ifmgr_0_1_create_address6 (
const uint32_t& tid,
const string& ifname,
const string& vif,
const IPv6& address)
| ifmgr_0_1_create_address6 |
[protected pure virtual]
| XrlCmdError ifmgr_0_1_delete_address6 (
const uint32_t& tid,
const string& ifname,
const string& vif,
const IPv6& address)
| ifmgr_0_1_delete_address6 |
[protected pure virtual]
| XrlCmdError ifmgr_0_1_set_address_enabled6 (
const uint32_t& tid,
const string& ifname,
const string& vif,
const IPv6& address,
const bool& enabled)
| ifmgr_0_1_set_address_enabled6 |
[protected pure virtual]
| XrlCmdError ifmgr_0_1_get_configured_address_enabled6 (
const string& ifname,
const string& vif,
const IPv6& address,
bool& enabled)
| ifmgr_0_1_get_configured_address_enabled6 |
[protected pure virtual]
| XrlCmdError ifmgr_0_1_set_prefix6 ( const uint32_t& tid, const string& ifname, const string& vif, const IPv6& address, cons |