Routing Convergence Wizard Functions¶
sth::emulation_rtgconvergence_ingress_port_config¶
Purpose¶
Spirent Extension (for Spirent HLTAPI only).
Configures or deletes an emulated ingress port
Synopsis¶
Note
M indicates that the argument is Mandatory .
sth::emulation_rtgconvergence_ingress_port_config [-mode {create|delete} M] [-port_handle <port_handle>] [-handle <handle>] [-sub_if_enable <true|false>] [-vlan_id <0-4095>] [-ipv4_addr <a.b.c.d>] [-router_id <IPV4>] [-dut_ipv4_addr <a.b.c.d>] [-ipv4_prefix_length <1-32>] [-indirect_router_id <IPV4>] [-dut_ipv6_addr <IPV6>] [-ipv6_addr <IPV6>] [-ipv6_prefix_length <1-128>] [-indirect_router_ipv6_addr <IPV6>]
Arguments¶
-
-port_handle¶ Specifies the ingress test port to be added to the Routing convergence network. This argument is Mandatory for -mode create.
-
-mode¶ Specifies the action to be performed. This argument is mandatory. Possible values are described below:
create Adds ingress test port. You must specify -port_handle. delete Deletes specified routers under the ingress port. You must specify -handle.
-
-handle¶ Specifies the handle of routers created under the emulated test port. This argument is Mandatory for -mode delete.
-
-sub_if_enable¶ Enables or disables sub interfaces on the ingress test port Possible values are true(enables) and false(disables).
Default: false
-
-vlan_id¶ Specifies the ID for the first VLAN in a block
Default: 1
-
-ipv4_addr¶ Specifies the IP address of the emulated device
Default: 192.85.1.3
-
-router_id¶ Specifies the router ID of the emulated device.
Default: 192.0.0.1
-
-dut_ipv4_addr¶ Specifies the IP address of the DUT
Default: 192.85.1.1
-
-ipv4_prefix_length¶ Specifies the prefix length of the IP address
Default: 24
-
-indirect_router_id¶ Specifies the router ID of the indirectly connected router in a Multi-hop BGP convergence test
Default: 192.10.0.1
-
-indirect_router_ipv6_addr¶ Specifies the router ID of the indirectly connected router in an IPv6 Multi-hop BGP convergence test
Default: 2001::3
-
-dut_ipv6_addr¶ Specifies the IPv6 address of the DUT
Default: ::
-
-ipv6_addr¶ Specifies the IPv6 address of the emulated device
Default: 2001::2
-
-ipv6_prefix_length¶ Specifies the prefix length of the IPv6 address
Default: 64
Return Values¶
Depending on the specific language that HLTAPI uses, the function returns a keyed list/dictionary/hash (See Introduction for more information on return value formats) using the following keys (with corresponding data):
status Success (1) or failure (0) of the operation
log An error message (if the operation failed)
Description¶
The sth::emulation_rtgconvergence_ingress_port_config function configures an
emulated ingress port, or deletes the routers under the port
(specified by -handle). Use the -port_handle argument to specify the port to
be added. Use the -action argument to specify the action to perform.
Examples¶
The following example configures an ingress port:
set ingress_port_config_ret1 [sth::emulation_rtgconvergence_ingress_port_config \
-mode create\
-port_handle $port1\
-sub_if_enable true\
-vlan_id 1\
-ipv4_addr 10.1.1.2\
-router_id 1.1.1.1\
-dut_ipv4_addr 10.1.1.1\
-ipv4_prefix_length 24\
-indirect_router_id 1.0.0.0\
-indirect_router_ipv6_addr ::1\
-dut_ipv6_addr 2002::1\
-ipv6_addr 2002::3\
-ipv6_prefix_length 64\
]
Sample output:
{status 1}
sth::emulation_rtgconvergence_egress_port_config¶
Purpose¶
Spirent Extension (for Spirent HLTAPI only).
Configures or deletes an emulated ingress port
Synopsis¶
Note
M indicates that the argument is Mandatory .
sth::emulation_rtgconvergence_egress_port_config [-mode {create|delete} M] [-port_handle <port_handle>] [-handle <handle>] [-sub_if_enable <true|false>] [-port_type <primary_egress|secondary_egress>] [-vlan_id <0-4095>] [-ipv4_addr <a.b.c.d>] [-router_id <IPV4>] [-dut_ipv4_addr <a.b.c.d>] [-ipv4_prefix_length <1-32>] [-indirect_router_id <IPV4>] [-dut_ipv6_addr <IPV6>] [-ipv6_addr <IPV6>] [-ipv6_prefix_length <1-128>] [-indirect_router_ipv6_addr <IPV6>]
Arguments¶
-
-port_handle¶ Specifies the egress test port to be added to the Routing convergence network. This argument is Mandatory for -mode create.
-
-mode¶ Specifies the action to be performed. This argument is mandatory. Possible values are described below:
create Adds egress test port. You must specify -port_handle. delete Deletes specified routers under the egress port. You must specify -handle.
-
-handle¶ Specifies the handle of routers created under the emulated test port. This argument is Mandatory for -mode delete.
-
-sub_if_enable¶ Enables or disables sub interfaces on the egress test port Possible values are true(enables) and false(disables).
Default: false
-
-port_type¶ Specifies the type of egress port
Default: primary_egress
-
-vlan_id¶ Specifies the ID for the first VLAN in a block
Default: 1
-
-ipv4_addr¶ Specifies the IP address of the emulated device
Default: 192.85.1.3
-
-router_id¶ Specifies the router ID of the emulated device.
Default: 192.0.0.1
-
-dut_ipv4_addr¶ Specifies the IP address of the DUT
Default: 192.85.1.1
-
-ipv4_prefix_length¶ Specifies the prefix length of the IP address
Default: 24
-
-indirect_router_id¶ Specifies the router ID of the indirectly connected router in a Multi-hop BGP convergence test
Default: 192.10.0.1
-
-indirect_router_ipv6_addr¶ Specifies the router ID of the indirectly connected router in an IPv6 Multi-hop BGP convergence test
Default: 2001::3
-
-dut_ipv6_addr¶ Specifies the IPv6 address of the DUT
Default: ::
-
-ipv6_addr¶ Specifies the IPv6 address of the emulated device
Default: 2001::2
-
-ipv6_prefix_length¶ Specifies the prefix length of the IPv6 address
Default: 64
Return Values¶
Depending on the specific language that HLTAPI uses, the function returns a keyed list/dictionary/hash (See Introduction for more information on return value formats) using the following keys (with corresponding data):
status Success (1) or failure (0) of the operation
log An error message (if the operation failed)
Description¶
The sth::emulation_rtgconvergence_egress_port_config function configures an
emulated egress port, or deletes the routers under the port
(specified by -handle). Use the -port_handle argument to specify the port to
be added. Use the -action argument to specify the action to perform.
Examples¶
The following example configures an egress port:
set egress_port_config_ret1 [sth::emulation_rtgconvergence_egress_port_config \
-mode create\
-port_handle $port1\
-sub_if_enable true\
-port_type primary_egress\
-vlan_id 1\
-ipv4_addr 10.1.1.2\
-router_id 1.1.1.1\
-dut_ipv4_addr 10.1.1.1\
-ipv4_prefix_length 24\
-indirect_router_id 1.0.0.0\
-indirect_router_ipv6_addr ::1\
-dut_ipv6_addr 2002::1\
-ipv6_addr 2002::3\
-ipv6_prefix_length 64\
]
Sample output:
{status 1}
sth::emulation_rtgconvergence_config¶
Purpose¶
Spirent Extension (for Spirent HLTAPI only).
Configures two types of IPv4 and IPv6 data-plane Unicast routing convergence tests for the BGP (Single and Multihop),OSPFv2, OSPFv3, RIP (all versions) and IS-IS protocols.
Capable to configure test scenarios for two and three port tests, creates emulated routers with associated protocol options, number and type of routes with route options, selects and creates the traffic that is sent between routers.
Synopsis¶
Note
M indicates that the argument is Mandatory .
sth::emulation_rtgconvergence_config
[-mode {create|delete} M]
[-handle <handle>]
[-max_convergence_time <NUMERIC>]
[-ip_version <ipv4|ipv6>]
[-protocol <isis|multi_hop_bgp|ospfv2|ospfv3|rip|single_hop_bgp>]
[-test_type <cost_change|ecmp_local_interface_failure|
ecmp_remote_interface_failure|external_script|
local_interface_failure|loss_of_adjacency|
remote_interface_failure|route_withdrawal>]
[-command_working_dir <ANY>]
[-command_arguments <ANY>]
[-command_line <ANY>]
[-perform_reversion_test <true|false>]
[-bgp_use_gateway_as_dut_ip_addr <true|false>]
[-bgp_dut_ipv4_addr <a.b.c.d>]
[-bgp_dut_ipv4_addr_step <a.b.c.d>]
[-bgp_dut_ipv6_addr <aaaa:bbbb:cccc:dddd:eeee:ffff:gggg:hhhh>]
[-bgp_dut_ipv6_addr_step <aaaa:bbbb:cccc:dddd:eeee:ffff:gggg:hhhh>]
[-bgp_mode <ebgp|ibgp>
[-bgp_enable_4byte_dut_as_num <true|false>]
[-bgp_enable_4byte_as_num <true|false>]
[-bgp_dut_as_num_4byte <string>]
[-bgp_dut_as_num_4byte_step <string>]
[-bgp_dut_as <1-65535>]
[-bgp_dut_as_step <1-65535>]
[-bgp_as_num_4byte <string>]
[-bgp_as_num_4byte_step <string>]
[-bgp_as_num_step <0-65535>]
[-bgp_as_num <0-65535>]
[-bgp_graceful_restart <true|false>]
[-bgp_enable_sr <true|false>]
[-bgp_enable_bfd <true|false>]
[-bgp_enable_pack_routes <true|false>]
[-bgp_igp_protocol <isis|ospf|rip>]
[-bgp_authentication <md5|none>]
[-bgp_password <string>]
[-ospfv2_area_id <a.b.c.d>]
[-ospfv2_network_type <broadcast|native|p2p>]
[-ospfv2_router_priority <0-255>]
[-ospfv2_interface_cost <1-65535>]
[-ospfv2_options <HEX>]
[-ospfv2_enable_bfd <true|false>]
[-ospfv2_sr_algorithm <string>]
[-ospfv2_sid_label_base <NUMERIC>]
[-ospfv2_sid_label_range <NUMERIC>]
[-ospfv2_node_sid_index <NUMERIC>]
[-ospfv2_node_sid_index_step <NUMERIC>]
[-ospfv2_enable_graceful_restart <true|false>]
[-ospfv2_graceful_restart_type <llsignalling|none|rfcstandard>]
[-ospfv2_simulated_topology_type <fully_meshed|grid|hub_and_spoke|ring tree>]
[-ospfv2_summary_lsa_percent <double>]
[-ospfv2_simulated_router_id <a.b.c.d>]
[-ospfv2_stub_lsa_percent <double>]
[-ospfv2_external_lsa_percent <double>]
[-ospfv2_authentication <md5|none|simple>]
[-ospfv2_password <string>]
[-ospfv2_md5_key_id <0-255>]
[-ospfv3_area_id <a.b.c.d>]
[-ospfv3_enable_bfd <true|false>]
[-ospfv3_router_priority <0-255>]
[-ospfv3_network_type <broadcast|native|p2p>]
[-ospfv3_options <HEX>]
[-ospfv3_simulated_topology_type <fully_meshed|grid|hub_and_spoke|ring tree>]
[-ospfv3_external_route_percent <double>]
[-ospfv3_intra_area_route_percent <double>]
[-ospfv3_inter_area_route_percent <double>]
[-ospfv3_simulated_router_id <a.b.c.d>]
[-isis_level <level1|level1_and_2|level2>]
[-isis_network_type <broadcast|p2p>]
[-isis_router_priority <0-127>]
[-isis_area1 <string>]
[-isis_area2 <string>]
[-isis_area3 <string>]
[-isis_circuit_id <0-99>]
[-isis_dut_system_id <aa:bb:cc:dd:ee:ff>]
[-isis_enable_bfd <true|false>]
[-isis_enable_graceful_restart <true|false>]
[-isis_hello_padding <true|false>]
[-isis_use_src_mac_as_router_system_id <true|false>]
[-isis_router_system_id_start <aa:bb:cc:dd:ee:ff>]
[-isis_router_system_id_step <aa:bb:cc:dd:ee:ff>]
[-isis_sr_sid_label_base <0-16777215>]
[-isis_sr_algorithm <string>]
[-isis_sr_sid_range <1-65535>]
[-isis_sr_node_sid_index <0-16777215>]
[-isis_sr_node_sid_index_step <0-16777215>]
[-isis_metric_mode <narrow|narrow_and_wide|wide>]
[-isis_l1_metric <1-63>]
[-isis_l2_metric <1-68>]
[-isis_l1_wide_metric <0-16777214>]
[-isis_l2_wide_metric <0-16777214>]
[-isis_authentication <md5|none|simple>]
[-isis_password <string>]
[-isis_md5_key_id <0-255>]
[-isis_simulated_topology_type <fully_meshed|grid|hub_and_spoke|ring|tree>]
[-isis_simulated_router_id <a.b.c.d>]
[-isis_internal_route_percent <double>]
[-isis_system_id_start <aa:bb:cc:dd:ee:ff>]
[-isis_external_route_percent <double>]
[-rip_version <ng|v1|v2>]
[-rip_enable_bfd <true|false>]
[-rip_authentication <md5|none|simple>]
[-rip_password <string>]
[-rip_md5_key_id <0-255>]
[-interface_type <broadcast|point_to_point>]
[-max_interface_per_router <1-10000>]
[-num_simulated_routers <1-10000>]
[-max_routers_per_transit_network <2-10000>]
[-num_of_rows <1-10000>]
[-grid_emulated_router_position <attached_to_grid|member_of_grid>]
[-attach_row_index <1-10000>]
[-num_of_columns <1-10000>]
[-attach_column_index <1-10000>]
[-fullmesh_num_routers <1-100>]
[-fullmesh_emulated_router_position <attached_to_mesh|member_of_mesh>]
[-ring_num_routers <1-10000>]
[-ring_emulated_router_position <attached_to_ring|member_of_ring>]
[-hubspoke_num_routers <1-100>]
[-hubspoke_emulated_router_position <attached_to_hub|attached_to_spoke|member_hub|member_spoke>]
[-route_count_per_router <1-65535>]
[-route_start_ipv4_addr <a.b.c.d>]
[-route_start_ipv6_addr <aaaa:bbbb:cccc:dddd:eeee:ffff:gggg:hhhh>]
[-route_ipv4_addr_step <a.b.c.d>]
[-route_ipv6_addr_step <aaaa:bbbb:cccc:dddd:eeee:ffff:gggg:hhhh>]
[-prefix_distribution_type <custom|exponential|fixed|internet|linear>]
[-route_end_ipv4_prefix_length <1-32>]
[-route_start_ipv6_prefix_length <1-128>]
[-route_start_ipv4_prefix_length <1-32>]
[-route_end_ipv6_prefix_length <1-128>]
[-prefix_length_distribution <0-100>]
[-load_percentage <0-100>]
[-frame_size <0-65535>]
Arguments¶
-
-handle¶ Specifies the Routing convergence network configuration handle. This argument is required for -mode delete.
-
-mode¶ Specifies the action to be performed. This argument is mandatory. Possible values are described below:
create Creates a Routing convergence network configuration delete Deletes the Routing convergence network configuration specified by -handle
-
-max_convergence_time¶ Specifies the maximum number of seconds during which the DUT is expected to converge and resume data plane traffic
Default: 70
-
-ip_version¶ Specifies the IP version of the protocol
Default: ipv4
-
-protocol¶ Specifies the routing protocol on which to perform the convergence test.
Default: single_hop_bgp
-
-test_type¶ Specifies the type of convergence test to run. Available when 3 ports are configured
Default: cost_change
-
-command_working_dir¶ Specifies the working directory for the script. Available when -test_type is set to external_script.
-
-command_arguments¶ Specifies the arguments for the script. Available when -test_type is set to external_script.
-
-command_line¶ Specifies the command line for the script. Available when -test_type is set to external_script.
-
-perform_reversion_test¶ After running the convergence test from ingress to egress, run the test the other direction, and perform convergence measurement when traffic switches from secondary egress port to primary egress port. Only applicable for 3-port tests.
Default: false
-
-bgp_use_gateway_as_dut_ip_addr¶ Specifies to use the DUT as the gateway
Default: false
-
-bgp_dut_ipv4_addr¶ Specifies the IPv4 address of the BGP peer for the session Available when -bgp_use_gateway_as_dut_ip_addr is true
Default: 192.85.1.1
-
-bgp_dut_ipv4_addr_step¶ Specifies the IPv4 address step value of the BGP peer for the session Available when -bgp_use_gateway_as_dut_ip_addr is true
Default: 0.0.0.0
-
-bgp_dut_ipv6_addr¶ Specifies the IPv6 address of the BGP peer for the session Available when -bgp_use_gateway_as_dut_ip_addr is true
Default: ::2
-
-bgp_dut_ipv6_addr_step¶ Specifies the IPv6 address step value of the BGP peer for the session Available when -bgp_use_gateway_as_dut_ip_addr is true
Default: ::
-
-bgp_mode¶ Specifies the BGP mode Possible values are ebgp (external BGP), ibgp (internal BGP)
Default: ebgp
-
-bgp_enable_4byte_dut_as_num¶ Enables or disables 4-byte DUT autonomous system numbers Possible values are true(enables) and false(disables).
Default: false
-
-bgp_enable_4byte_as_num¶ Enables or disables 4-byte autonomous system numbers Possible values are true(enables) and false(disables).
Default: false
-
-bgp_dut_as_num_4byte¶ Specifies the 4-byte autonomous system number for the emulated BGP router
Default: 1.1001
-
-bgp_dut_as_num_4byte_step¶ Specifies the increment value by which to create subsequent DUT 4-byte autonomous system numbers
Default: 0
-
-bgp_dut_as¶ Specifies the autonomous system number of the BGP peer routersession on the DUT
Default: 1001
-
-bgp_dut_as_step¶ Specifies the increment value by which to create subsequent DUT autonomous system numbers
Default: 0
-
-bgp_as_num_4byte¶ Specifies the 4-byte autonomous system number for the emulated BGP router
Default: 1.1
-
-bgp_as_num_4byte_step¶ Specifies the increment value by which to create subsequent 4-byte autonomous system numbers
Default: 0
-
-bgp_as_num¶ Specifies the autonomous system number for the emulated BGP router
Default: 1
-
-bgp_as_num_step¶ Increment value by which to create subsequent autonomous system numbers
Default: 0
-
-bgp_graceful_restart¶ Enables or disables Graceful Restart on the emulated BGP router. Possible values are true(enables) and false(disables).
Default: false
-
-bgp_enable_sr¶ Specifies to configure BGP SR parameters Possible values are true(enables) and false(disables).
Default: false
-
-bgp_enable_bfd¶ Enables or disables BFD on the emulated BGP router. Possible values are true(enables) and false(disables).
Default: false
-
-bgp_enable_pack_routes¶ Enables or disables route packing. Possible values are true(enables) and false(disables).
Default: false
-
-bgp_igp_protocol¶ Specifies the IGP protocol.
Default: ospf
-
-bgp_authentication¶ Specifies the type of authentication to be used
Default: none
-
-bgp_password¶ Specifies the password when -bgp_authentication is set as md5
Default: Spirent
-
-ospfv2_area_id¶ Specifies the IP address indicating the area to which the emulated router belongs.
Default: 0.0.0.0
-
-ospfv2_network_type¶ Specifies the type of the network link
Default: native
-
-ospfv2_router_priority¶ Specifies the router priority of the emulated router
Default: 0
-
-ospfv2_interface_cost¶ Specifies the cost of the interface connecting the emulated router to the neighbor DUT router
Default: 1
-
-ospfv2_options¶ A bit mask(hex) that specifies the settings of the OSPF Options field in Hello packets sent to the DUT
Default: 0x02 (ebit)
-
-ospfv2_enable_bfd¶ Enables or disables BFD on the emulated router. Possible values are true(enables) and false(disables).
Default: false
-
-ospfv2_sr_algorithm¶ Specifies the OSPF SR algorithm
Default: 0
-
-ospfv2_sid_label_base¶ Specifies the value of the SID or label
Default: 100
-
-ospfv2_sid_label_range¶ Number of values ranging from the starting value defined in the SID/Label Sub-TLV
Default: 100
-
-ospfv2_node_sid_index¶ Specifies the SID index of the node
Default: 0
-
-ospfv2_node_sid_index_step¶ Specifies the increment value by which to create subsequent SID indexes
Default: 1
-
-ospfv2_enable_graceful_restart¶ Enables or disables Graceful Restart on the emulated OSPF router. Possible values are true(enables) and false(disables).
Default: false
-
-ospfv2_graceful_restart_type¶ Specifies the type of the graceful restart
Default: none
-
-ospfv2_simulated_topology_type¶ Specifies the simulated topology type
Default: tree
-
-ospfv2_summary_lsa_percent¶ Specifies the OSPF summary LSA percent
Default: 0.0
-
-ospfv2_simulated_router_id¶ Specifies the simulated router ID
Default: 1.0.0.1
-
-ospfv2_stub_lsa_percent¶ Specifies the OSPF stub LSA percent
Default: 0.0
-
-ospfv2_external_lsa_percent¶ Specifies the OSPF external LSA percent
Default: 100.0
-
-ospfv2_authentication¶ Specifies the type of authentication to be used
Default: none
-
-ospfv2_password¶ Specifies the password when -ospfv2_authentication is set as md5
Default: Spirent
-
-ospfv2_md5_key_id¶ Specifies the MD5 key used for the MD5 authentication
-
-ospfv3_area_id¶ Specifies the IP address indicating the area to which the emulated router belongs.
Default: 0.0.0.0
-
-ospfv3_enable_bfd¶ Enables or disables BFD on the OSPFv3 emulated router. Possible values are true(enables) and false(disables).
Default: false
-
-ospfv3_router_priority¶ Specifies the router priority of the emulated router
Default: 0
-
-ospfv3_options¶ A bit mask(hex) that specifies the settings of the OSPFv3 Options field in Hello packets sent to the DUT
Default: 13
-
-ospfv3_network_type¶ Specifies the type of the network link
Default: native
-
-ospfv3_simulated_topology_type¶ Specifies the simulated topology type
Default: tree
-
-ospfv3_external_route_percent¶ Specifies the OSPFv3 external LSA percent
Default: 0.0
-
-ospfv3_intra_area_route_percent¶ Specifies the OSPFv3 intra area route percent
Default: 100.0
-
-ospfv3_inter_area_route_percent¶ Specifies the OSPFv3 inter area route percent
Default: 0.0
-
-ospfv3_simulated_router_id¶ Specifies the simulated router ID
Default: 1.0.0.1
-
-isis_level¶ Specifies the circuit type of the emulated router
Default: level2
-
-isis_network_type¶ Specifies the type of the ISIS interface
Default: broadcast
-
-isis_router_priority¶ Specifies the router priority used to determine which router should act as the designated router
Default: 0
-
-isis_area1¶ Specifies the area address. Spirent TestCenter supports up to 3 addresses per emulated router. Area 1 address is Mandatory .
Default: 000001
-
-isis_area2¶ Specifies the area 2 address
Dependency: -isis_area1
Default: “” (empty string)
-
-isis_area3¶ Specifies the area 3 address
Dependency: -isis_area2
Default: “” (empty string)
-
-isis_circuit_id¶ Specifies the 1-octet HEX identifier of the emulated router interface
Default: 1
-
-isis_enable_bfd¶ Enables or disables BFD for this router Possible values are true(enables) and false(disables).
Default: false
-
-isis_dut_system_id¶ Specifies DUT system id
Default: 00:00:00:00:00:01
-
-isis_enable_graceful_restart¶ Enables or disables Graceful Restart on the emulated OSPF router. Possible values are true(enables) and false(disables).
Default: false
-
-isis_hello_padding¶ Determines whether to insert Hello Padding in Hello Packets
Default: true
-
-isis_use_src_mac_as_router_system_id¶ Determines whether to use source mac address as router system id or not.
Default: true
-
-isis_router_system_id_start¶ Specifies the first system id
Default: 00:00:00:00:00:01
-
-isis_router_system_id_step¶ Increments the system id
Default: 00:00:00:00:00:01
-
-isis_sr_algorithm¶ Specifies the ISIS SR algorithm
Default: 0
-
-isis_sr_node_sid_index¶ Specifies the value of the first SID index
Default: 0
-
-isis_sr_sid_label_base¶ Specifies the value of the first SID/Label
Default: 100
-
-isis_sr_node_sid_index_step¶ Specifies the increment value by which to create subsequent indexes
Default: 1
-
-isis_sid_range¶ Number of SIDs/labels to configure
Default: 100
-
-isis_metric_mode¶ Specifies the length of the metric field in the LSP
- narrow Router advertises routes with a narrow
- (6-bit) metric
- narrow_and_wide Router advertises the same route with
- both metrics
- wide Router advertises routes with a wide
- metric
Default: narrow_and_wide
-
-isis_l1_metric¶ Specifies the metric of the emulated router interface
Dependency: -isis_level level1
Default: 1
-
-isis_l1_wide_metric¶ Specifies the 3-octet traffic engineering metric of a link from the emulated router to the SUT
Dependency: -isis_level level1
Default: 1
-
-isis_l2_metric¶ Specifies the metric of the emulated router interface
Dependency: -isis_level level2
Default: 1
-
-isis_l2_wide_metric¶ Specifies the 3-octet traffic engineering metric of a link from the emulated router to the SUT
Dependency: -isis_level level2
Default: 1
-
-isis_authentication¶ Specifies the authentication method to use for ISIS
Default: none
-
-isis_password¶ Specifies the password used for authentication of ISIS messages
Dependency: -isis_authentication simple or md5
Default: Spirent
-
-isis_md5_key_id¶ Specifies the MD5 authentication key
Dependency: -isis_authentication md5
-
-isis_simulated_topology_type¶ Specifies the simulated topology type
Default: tree
-
-isis_internal_route_percent¶ Specifies the ISIS internal route percent
Default: 100.0
-
-isis_external_route_percent¶ Specifies the ISIS external route percent
Default: 0.0
-
-isis_system_id_start¶ Specifies the ISIS system ID
Default: 10:00:00:00:00:01
-
-isis_simulated_router_id¶ Specifies the simulated router ID
Default: 1.0.0.1
-
-rip_version¶ Specifies the RIP version to be used for each emulated router
Default: v2
-
-rip_enable_bfd¶ Enables or disables BFD for this router Possible values are true(enables) and false(disables).
Default: false
-
-rip_authentication¶ Specifies the authentication method to use for RIP
Default: none
-
-rip_password¶ Specifies the password used for authentication of RIP messages
Dependency: -rip_authentication simple or md5
Default: Spirent
-
-rip_md5_key_id¶ Specifies the MD5 authentication key
Dependency: -rip_authentication md5
-
-interface_type¶ Specifies the interface type used to connect simulated routers.
Default: point_to_point
-
-max_interface_per_router¶ Specifies the maximum number of interfaces per router.
Default: 4
-
-num_simulated_routers¶ Specifies total number of simulated routers that will be created on all emulated routers.
Default: 50
-
-max_routers_per_transit_network¶ Specifies the maximum number of routers per transit network. This attribute is valid only when the -interface_type is set to broadcast.
Default: 5
-
-num_of_rows¶ Specifies the number of rows in the grid.
Default: 4
-
-grid_emulated_router_position¶ Specifies the location of the emulated router in the grid.
- attached_to_grid Emulated router is attached to one of the
- simulated routers in the grid.
member_of_grid Emulated router is a member of the grid.
Default: attached_to_grid
-
-attach_row_index¶ Specifies row index
For an emulated router attached to a simulated router, the row index in the grid of the simulated router to which the emulated router is attached. For an emulated router that is a member of the grid, the row index in the grid where the emulated router is located.
Default: 1
-
-num_of_columns¶ Specifies the number of columns in the grid
Default: 4
-
-attach_column_index¶ Specifies the column index
Default: 1
-
-fullmesh_num_routers¶ Specifies the total number of routers in the full mesh topology.
Default: 10
-
-fullmesh_emulated_router_position¶ Specifies the location of the emulated router in the full mesh.
- attached_to_mesh Emulated router is attached to one of the
- simulated routers in the full mesh.
member_of_mesh Emulated router is a member of the full mesh.
Default: attached_to_mesh
-
-ring_num_routers¶ Specifies the total number of routers in the ring topology.
Default: 10
-
-ring_emulated_router_position¶ Specifies the location of the emulated router in the ring.
- attached_to_ring Emulated router is attached to one of the
- simulated routers in the ring.
member_of_ring Emulated router is a member of the ring.
Default: attached_to_ring
-
-hubspoke_num_routers¶ Specifies the total number of routers in the hubspoke topology.
Default: 10
-
-hubspoke_emulated_router_position¶ Specifies the location of the emulated router in the hubspoke.
attached_to_hub Emulated router is attached to a hub simulated router. attached_to_spoke Emulated router is attached to a spoke simulated router. member_hub Emulated router is a member as a hub. member_spoke Emulated router is a member as a spoke.Default: attached_to_hub
-
-route_count_per_router¶ Specifies the route count per router
Default: 1
-
-route_start_ipv4_addr¶ Specifies the first IPv4 route advertised
Default: 10.1.1.0
-
-route_start_ipv6_addr¶ Specifies the first IPv6 route advertised
Default: 3000::
-
-route_ipv4_addr_step¶ Identifies which part of the IPv4 address to increment for subsequent routes
Default: 0.0.1.0
-
-route_ipv6_addr_step¶ Identifies which part of the IPv6 address to increment for subsequent routes
Default: 0:0:1::
-
-prefix_distribution_type¶ Specifies how network prefix lengths will be distributed
Default: fixed
-
-prefix_length_distribution¶ Specifies the prefix length
Default: 0
-
-route_start_ipv4_prefix_length¶ Specifies the length of the network portion of the first IPv4 route identifier
Default: 24
-
-route_end_ipv4_prefix_length¶ Specifies the length of the network portion of the last IPv4 route identifier
Default: 24
-
-route_start_ipv6_prefix_length¶ Specifies the length of the network portion of the last IPv6 route identifier
Default: 64
-
-route_end_ipv6_prefix_length¶ Specifies the length of the network portion of the last IPv6 route identifier
Default: 64
-
-load_percentage¶ Specifies the traffic rate as a percentage of bandwidth
Default: 10
-
-frame_size¶ Specifies the size of frames, including CRC
Default: 128
Return Values¶
Depending on the specific language that HLTAPI uses, the function returns a keyed list/dictionary/hash (See Introduction for more information on return value formats) using the following keys (with corresponding data):
handle Routing convergence configuration handle created by this function
status Success or Failure of the operation
log Error message if command returns {status 0}
The following keys are returned when you specify -mode create:
ingress_router ingress router handle
egress_router egress router handle
secondary_egress_router secondary egress router handle
convergence convergence handle
ospfv2 OSPFv2 handle
ospfv3 OSPFv3 handle
isis ISIS handle
rip RIP handle
bgp BGP handle
bfd BFD handle
stream_id Streamblock handle
Description¶
The sth::emulation_rtgconvergence_config function configures or deletes
a Routing convergence topology, mapping the operations of the Routing convergence wizard
on the Spirent TestCenter GUI.
Use the -mode argument to specify the operation to perform. See the -mode argument for a description of the actions.
Examples¶
The following example creates a Routing convergence topology:
sth::emulation_rtgconvergence_config \ -mode create\ -max_convergence_time 15\ -ip_version ipv4\ -protocol ospfv2\ -test_type cost_change\ -command_working_dir E:/Logs\ -command_arguments "-a 1"\ -command_line C:/Users/mkatta/Desktop/abc.key\ -perform_reversion_test true\ -bgp_use_gateway_as_dut_ip_addr true\ -bgp_dut_ipv4_addr 1.1.1.1\ -bgp_dut_ipv4_addr_step 0.0.0.0\ -bgp_dut_ipv6_addr ::2\ -bgp_dut_ipv6_addr_step ::0\ -bgp_mode ibgp\ -bgp_enable_4byte_dut_as_num true\ -bgp_enable_4byte_as_num true\ -bgp_dut_as_num_4byte 1.1001\ -bgp_dut_as_num_4byte_step 0\ -bgp_dut_as 1001\ -bgp_dut_as_step 0\ -bgp_as_num_4byte 1.1\ -bgp_as_num_4byte_step 0\ -bgp_as_num_step 0\ -bgp_as_num 1\ -bgp_graceful_restart false\ -bgp_enable_sr false\ -bgp_enable_bfd true\ -bgp_enable_pack_routes false\ -bgp_igp_protocol ospf\ -bgp_authentication md5\ -bgp_password spirent1\ -ospfv2_area_id 0.0.0.0\ -ospfv2_network_type p2p\ -ospfv2_router_priority 0\ -ospfv2_interface_cost 1\ -ospfv2_options 2\ -ospfv2_enable_bfd true\ -ospfv2_sr_algorithm 0\ -ospfv2_sid_label_base 100\ -ospfv2_sid_label_range 100\ -ospfv2_node_sid_index 0\ -ospfv2_node_sid_index_step 1\ -ospfv2_enable_graceful_restart false\ -ospfv2_graceful_restart_type llsignalling\ -ospfv2_simulated_topology_type tree\ -ospfv2_summary_lsa_percent 0.0\ -ospfv2_simulated_router_id 1.0.0.1\ -ospfv2_stub_lsa_percent 0.0\ -ospfv2_external_lsa_percent 100.0\ -ospfv2_authentication md5\ -ospfv2_password spirent1\ -ospfv2_md5_key_id 1\ -ospfv3_area_id 0.0.0.0\ -ospfv3_enable_bfd true\ -ospfv3_router_priority 0\ -ospfv3_network_type native\ -ospfv3_options 13\ -ospfv3_simulated_topology_type tree\ -ospfv3_external_route_percent 0.0\ -ospfv3_intra_area_route_percent 0.0\ -ospfv3_inter_area_route_percent 0.0\ -ospfv3_simulated_router_id 10.1.1.1\ -isis_level level2\ -isis_network_type p2p\ -isis_router_priority 0\ -isis_area1 0001\ -isis_area2 0002\ -isis_area3 0003\ -isis_circuit_id 1\ -isis_dut_system_id 00:00:00:00:00:01\ -isis_enable_bfd true\ -isis_enable_graceful_restart false\ -isis_hello_padding true\ -isis_use_src_mac_as_router_system_id false\ -isis_router_system_id_start 00:00:00:00:00:01\ -isis_router_system_id_step 00:00:00:00:00:01\ -isis_sr_sid_label_base 100\ -isis_sr_algorithm 0\ -isis_sr_sid_range 100\ -isis_sr_node_sid_index 0\ -isis_sr_node_sid_index_step 1\ -isis_metric_mode narrow_and_wide\ -isis_l1_metric 1\ -isis_l2_metric 1\ -isis_l1_wide_metric 1\ -isis_l2_wide_metric 1\ -isis_authentication md5\ -isis_password spirent1\ -isis_md5_key_id 1\ -isis_simulated_topology_type tree\ -isis_simulated_router_id 1.1.1.1\ -isis_internal_route_percent 0.0\ -isis_system_id_start 00:00:00:00:00:01\ -isis_external_route_percent 0.0\ -rip_version v1\ -rip_enable_bfd false\ -rip_authentication md5\ -rip_password spirent1\ -rip_md5_key_id 1\ -route_count_per_router 1\ -route_start_ipv4_addr 10.0.0.1\ -route_start_ipv6_addr 3000::2\ -route_ipv4_addr_step 0.0.0.0\ -route_ipv6_addr_step ::0\ -prefix_distribution_type custom\ -route_end_ipv4_prefix_length 24\ -route_start_ipv6_prefix_length 64\ -route_start_ipv4_prefix_length 24\ -route_end_ipv6_prefix_length 64\ -prefix_length_distribution "100 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0"\ -interface_type point_to_point\ -max_interface_per_router 3\ -num_simulated_routers 10\ -max_routers_per_transit_network 2\ -num_of_rows 3\ -grid_emulated_router_position attached_to_grid\ -attach_row_index 1\ -num_of_columns 1\ -attach_column_index 1\ -fullmesh_num_routers 10\ -fullmesh_emulated_router_position attached_to_mesh\ -ring_num_routers 10\ -ring_emulated_router_position attached_to_ring\ -hubspoke_num_routers 10\ -hubspoke_emulated_router_position attached_to_spoke\ -load_percentage 10\ -frame_size 128\
]
Sample Output:
{status 1} {handle {{convergence convergencegenparams1} {ingress_router router1}
{egress_router router2} {second_egress_router router3} {ospfv2 {ospfv2routerconfig1
ospfv2routerconfig2 ospfv2routerconfig3}} {ospfv3 {}} {isis {}} {rip {}} {bgp {}}
{bfd {bfdrouterconfig1 bfdrouterconfig2 bfdrouterconfig3}} {stream_id streamblock1}}}
sth::emulation_rtgconvergence_control¶
Purpose¶
Spirent Extension (for Spirent HLTAPI only).
Starts or stops the specified Routing convergence topology
Synopsis¶
Note
M indicates that the argument is Mandatory .
sth::emulation_rtgconvergence_control
[-action {start|stop} M]
[-port_handle <port_handle>]
[-handle <handle>]
Arguments¶
-
-port_handle¶ Specifies the port on which routers will start or stop. You must specify either -handle or -port_handle, but not both.
-
-handle¶ Specifies the routers to start or stop. You must specify either -handle or -port_handle, but not both.
-
-action¶ Specifies the action to performed. This argument is Mandatory . Possible values are described below:
start Starts the specified Routing convergence network stop Stops the specified Routing convergence network
Return Values¶
Depending on the specific language that HLTAPI uses, the function returns a keyed list/dictionary/hash (See Introduction for more information on return value formats) using the following keys (with corresponding data):
status Success (1) or failure (0) of the operation log An error message (if the operation failed)
Description¶
Thesth::emulation_rtgconvergence_controlfunction controls the configured Routing convergence topology. Use the -action argument to start or stop the test.
Examples¶
Sample Input:
sth::emulation_rtgconvergence_control \
-port_handle $port1 port2 \
-action start
Sample Output:
{status 1}
sth::emulation_rtgconvergence_info¶
Purpose¶
Spirent Extension (for Spirent HLTAPI only).
Retrieves statistics for the Routing convergence test
Synopsis¶
Note
M indicates that the argument is Mandatory .
sth::emulation_routing_mpls_info
[-mode {isis|ospfv2|ospfv3|bgp|rip|bfd|summary} M]
[-handle <handle>]
[-port_handle <port_handle>]
Arguments¶
-
-handle¶ Specifies the router from which to retrieve statistics. You must specify either -handle or -port_handle, but not both.
-
-port_handle¶ Specifies the port from which to retrieve statistics
-
-mode¶ Determines the protocol for which statistics will be retrieved. This argument is Mandatory . Possible values are isis, ospfv2, ospfv3, bgp, rip, bfd, and summary.
Return Values¶
Depending on the specific language that HLTAPI uses, the function returns a keyed list/dictionary/hash (See Introduction for more information on return value formats) using the following keys (with corresponding data):
status Success (1) or failure (0) of the operation
log An error message (if the operation failed)
The following keys are returned when you specify -mode isis:
TxPtpHelloCount Number of point-to-point Hellos sent to the SUT
RxPtpHelloCount Number of point-to-point Hellos received from the SUT
TxL1LanHelloCount Number of L1 Tx LAN Hellos sent to the SUT
RxL1LanHelloCount Number of L1 Rx LAN Hellos received from the SUT
TxL1LspCount Number of L1 Tx LSPs sent to the SUT
RxL1LspCount Number of L1 Rx LSPs received from the SUT
TxL1CsnpCount Number of L1 Tx CSNPs sent to the SUT
RxL1CsnpCount Number of L1 Rx CSNPs received from the SUT
TxL1PsnpCount Number of L1 Tx PSNPs sent to the SUT
RxL1PsnpCount Number of L1 Rx PSNPs received from the SUT
TxL2LanHelloCount Number of L2 Tx LAN Hellos sent to the SUT
RxL2LanHelloCount Number of L2 Rx LAN Hellos received from the SUT
TxL2LspCount Number of L2 Tx LSPs sent to the SUT
RxL2LspCount Number of L2 Rx LSPs received from the SUT
TxL2CsnpCount Number of L2 Tx CSNPs sent to the SUT
RxL2CsnpCount Number of L2 Rx CSNPs received from the SUT
TxL2PsnpCount Number of L2 Tx PSNPs sent to the SUT
RxL2PsnpCount Number of L2 Rx PSNPs received from the SUT
AdjacencyLevel Adjacency level
The following keys are returned when you specify -mode ospfv2:
TxHello Number of Hello packets sent
RxHello Number of Hello packets received
TxDd Number of Database Description packets sent
RxDd Number of Database Description packets received
TxRouterLsa Number of Router LSAs sent
RxRouterLsa Number of Router LSAs received
TxNetworkLsa Number of Network LSAs sent
RxNetworkLsa Number of Network LSAs received
TxSummaryLsa Number of Summary LSAs sent
RxSummaryLsa Number of Summary LSAs received
TxAsbrSummaryLsa Number of ASBR-Summary LSAs sent
RxAsbrSummaryLsa Number of ASBR-Summary-LSAs received
TxAsExternalLsa Number of External LSAs sent
RxAsExternalLsa Number of External LSAs received
TxNssaLsa Number of NSSA LSAs sent
RxNssaLsa Number of NSSA LSAs received
TxAck Number of LSA packets sent
RxAck Number of LSA packets received
TxRequest Number of LS Request packets sent
RxRequest Number of LS Request packets received
TxUpdate Number of Update messages sent
RxUpdate Number of Update messages received
TxTeLsa Number of TE-LSAs sent
RxTeLsa Number of TE-LSAs received
TxRiLsa Number of Router Info LSAs sent
RxRiLsa Number of Router Info LSAs received
TxEpLsa Number of Extended Prefix LSAs sent
RxEpLsa Number of Extended Prefix LSAs received
TxElLsa Number of Extended Link LSAs sent
RxElLsa Number of Extended Link LSAs received
SessionUpCount Session up count
areaId Area ID
ipv4SrcAddr IPv4 source address
The following keys are returned when you specify -mode ospfv3:
TxHello Number of Hello packets sent
RxHello Number of Hello packets received
TxDd Number of Database Description packets sent
RxDd Number of Database Description packets received
TxRouterLsa Number of Router LSAs sent
RxRouterLsa Number of Router LSAs received
TxNetworkLsa Number of Network LSAs sent
RxNetworkLsa Number of Network LSAs received
TxSummaryLsa Number of Summary LSAs sent
RxSummaryLsa Number of Summary LSAs received
TxAsbrSummaryLsa Number of ASBR-Summary LSAs sent
RxAsbrSummaryLsa Number of ASBR-Summary-LSAs received
TxAsExternalLsa Number of External LSAs sent
RxAsExternalLsa Number of External LSAs received
TxNssaLsa Number of NSSA LSAs sent
RxNssaLsa Number of NSSA LSAs received
TxAck Number of LSA packets sent
RxAck Number of LSA packets received
TxRequest Number of LS Request packets sent
RxRequest Number of LS Request packets received
TxUpdate Number of Update messages sent
RxUpdate Number of Update messages received
RxIntraAreaPrefixLsa Number of Intra-Area-Prefix LSAs received
TxIntraAreaPrefixLsa Number of Intra-Area-Prefix LSAs sent
RxInterAreaPrefixLsa Number of Inter-area-prefix LSAs received
TxInterAreaPrefixLsa Number of Inter-area-prefix LSAs sent
RxInterAreaRouterLsa Number of Inter-area-router LSAs received
TxInterAreaRouterLsa Number of Inter-area-router LSAs sent
RxLinkLsa Number of link LSAs received
TxLinkLsa Number of link LSAs sent
TxNssaLsa Number of NSSA LSAs sent
RxNssaLsa Number of Link LSAs received
RxERouterLsa Number of Extended Router LSAs received
TxERouterLsa Number of Extended Router LSAs sent
RxENetworkLsa Number of Extended Network LSAs received
TxENetworkLsa Number of Extended Network LSAs sent
RxEIntraAreaPrefixLsa Number of Extended Intra-Area Prefix LSAs received
TxEIntraAreaPrefixLsa Number of Extended Intra-Area Prefix LSAs sent
RxEInterAreaPrefixLsa Number of Extended Inter-Area Prefix LSAs received
TxEInterAreaPrefixLsa Number of Extended Inter-Area Prefix LSAs sent
RxEInterAreaRouterLsa Number of Extended Inter-Area Router LSAs received
TxEInterAreaRouterLsa Number of Extended Inter-Area Router LSAs sent
RxELinkLsa Number of Extended Link LSAs received
TxELinkLsa Number of Extended Link LSAs sent
The following keys are returned when you specify -mode bgp:
TxAdvertisedRouteCount Total cumulative feasible routes sent in all UPDATE packets
RxAdvertisedRouteCount Total cumulative feasible routes received
TxWithdrawnRouteCount Total number of unfeasible routes sent in all UPDATE packets
RxWithdrawnRouteCount Total cumulative unfeasible routes received
TxNotificationCount Number of Notification packets sent
RxNotificationCount Number of Notification packets received
TxAdvertisedUpdateCount Total number of UPDATE packets with feasible routes sent
RxAdvertisedUpdateCount Number of Update packets received from DUT
TxWithdrawnUpdateCount Total number of UPDATE packets with unfeasible routes sent
TxKeepAliveCount Total number of KEEPALIVE packets sent to the DUT
RxKeepAliveCount Total number of KEEPALIVE packets received from the DUT
TxOpenCount Total number of OPEN packets sent to the DUT
RxOpenCount BGP Open messages received from DUT
TxRouteRefreshCount Number of advertised Route Refresh messages transmitted
RxRouteRefreshCount Number of advertised Route Refresh messages received
OutstandingRouteCount Number of routes that should be in the DUT's current route table
LastRxUpdateRouteCount Number of routes in the last-received UPDATE message
TxNotifyCode Last Notification code the emulated router sent to the DUT
TxNotifySubCode Sub-code for the last Notification sent to the DUT
RxNotifyCode Last Notification code the emulated router received from the DUT
RxNotifySubCode Sub-code for the last Notification received from the DUT
TxRtConstraintCount Number of RT-Constraint routes sent for this router
RxRtConstraintCount Number of RT-Constraint routes received for this router
SessionUpCount Number of router sessions in Established state
The following keys are returned when you specify -mode rip:
TxAdvertisedUpdateCount Number of advertised routes sent
RxAdvertisedUpdateCount Number of advertised routes
TxWithdrawnUpdateCount Number of unreachable (metric 16) routes
RxWithdrawnUpdateCount Number of unreachable (metric 16) routes received
The following keys are returned when you specify -mode bfd:
TimeoutCount Number of timeout conditions detected by BFD
FlapCount Number of times a flap event was detected by BFD
TxCount Number of BFD packets sent on this router
RxCount Number of BFD packets received on this router
The following keys are returned when you specify -mode summary:
bgp_summaryportxRouterUpCount Number of BGP routers in Up state
bgp_summaryportxRouterDownCount Number of BGP routers in Down state
bgp_summaryportxIdleCount Number of BGP routers in Idle state
bgp_summaryportxConnectCount Number of BGP routers in Connect state
bgp_summaryportxActiveCount Number of BGP routers in Active state
bgp_summaryportxOpenSentCount Number of BGP routers in Open Sent state
bgp_summaryportxOpenConfirmCount Number of BGP routers in Open Confirm state
bgp_summaryportxEstablishedCount Number of BGP routers in Established state
bfd_summaryportxRouterUpCount Number of routers in Up state
bfd_summaryportxRouterDownCount Number of routers in Down state
bfd_summaryportxSessionsUpCount Number of BFD sessions in Up state
bfd_summaryportxSessionsDownCount Number of BFD sessions in Down and AdminDown state
bfd_summaryportxMicroBfdSessionsUpCount Number of Micro-BFD sessions in Up state
bfd_summaryportxMicroBfdSessionsDownCount Number of Micro-BFD sessions in Down and AdminDown state
ospf_summaryportxRouterUpCount Number of OSPFv2 routers in Up state
ospf_summaryportxRouterDownCount Number of OSPFv2 routers in Down state
ospf_summaryportxWaitingCount Number of OSPFv2 routers in Waiting state
ospf_summaryportxP2PCount Number of OSPFv2 routers in P2P state
ospf_summaryportxDrOtherCount Number of OSPFv2 routers in DrOther state
ospf_summaryportxBackupCount Number of OSPFv2 routers in Backup state
ospf_summaryportxDrCount Number of OSPFv2 routers in Dr state
ospfv3_SummaryPortxRouterUpCount Number of OSPFv3 routers in Up state
ospfv3_SummaryPortxRouterDownCount Number of OSPFv3 routers in Down state
ospfv3_SummaryPortxWaitingCount Number of OSPFv3 routers in Waiting state
ospfv3_SummaryPortxP2PCount Number of OSPFv3 routers in P2P state
ospfv3_SummaryPortxDrOtherCount Number of OSPFv3 routers in Dr Other state
ospfv3_SummaryPortxBackupCount Number of OSPFv3 routers in Backup state
ospfv3_SummaryPortxDrCount Number of OSPFv3 routers in Dr state
isis_summaryportxRouterUpCount Number of ISIS routers in Up state
isis_summaryportxRouterDownCount Number of ISIS routers in Down state
isis_summaryportxIdleCount Number of ISIS routers in Idle state
isis_summaryportxInitCount Number of ISIS routers in INIT state
isis_summaryportxGrCount Number of ISIS routers in GR state
isis_summaryportxGrHelperCount Number of ISIS routers in GR Helper state
rip_summaryportxRouterUpCount Number of routers in Open state
rip_summaryportxRouterDownCount Number of routers in NotStarted/Closed state
Description¶
The sth::emulation_rtgconvergence_info function provides information about
the configured Routing convergence network topology.
Examples¶
The following example retrieves OSPFv2 statistics from a specified router:
sth::emulation_routing_mpls_info \
-handle $router_handles \
-mode ospfv2]
Sample output:
{status 1} {ospfv2_results {{port1 {{router1 {{TxHello 0} {RxHello 1} {TxDd 1}
{RxDd 0} {TxRouterLsa 0} {RxRouterLsa 0} {TxNetworkLsa 0} {RxNetworkLsa 0} {TxSummaryLsa 0}
{RxSummaryLsa 0} {TxAsbrSummaryLsa 0} {RxAsbrSummaryLsa 0} {TxAsExternalLsa 0}
{RxAsExternalLsa 0} {TxNssaLsa 0} {RxNssaLsa 0} {TxAck 0} {RxAck 0} {TxRequest 0}
{RxRequest 0} {TxUpdate 0} {RxUpdate 0} {TxTeLsa 0} {RxTeLsa 0} {TxRiLsa 0}
{RxRiLsa 0} {TxEpLsa 0} {RxEpLsa 0} {TxElLsa 0} {RxElLsa 0} {SessionUpCount 0}
{areaId 0.0.0.0} {ipv4SrcAddr 10.1.1.2}}}}} {port2 {{router2 {{TxHello 1} {RxHello 1}
{TxDd 1} {RxDd 0} {TxRouterLsa 0} {RxRouterLsa 0} {TxNetworkLsa 0} {RxNetworkLsa 0}
{TxSummaryLsa 0} {RxSummaryLsa 0} {TxAsbrSummaryLsa 0} {RxAsbrSummaryLsa 0}
{TxAsExternalLsa 0} {RxAsExternalLsa 0} {TxNssaLsa 0} {RxNssaLsa 0} {TxAck 0} {RxAck 0}
{TxRequest 0} {RxRequest 0} {TxUpdate 0} {RxUpdate 0} {TxTeLsa 0} {RxTeLsa 0} {TxRiLsa 0}
{RxRiLsa 0} {TxEpLsa 0} {RxEpLsa 0} {TxElLsa 0} {RxElLsa 0} {SessionUpCount 0} {areaId 0.0.0.0}
{ipv4SrcAddr 10.1.1.3}}}}} {port3 {{router3 {{TxHello 1} {RxHello 1} {TxDd 0} {RxDd 2}
{TxRouterLsa 0} {RxRouterLsa 0} {TxNetworkLsa 0} {RxNetworkLsa 0} {TxSummaryLsa 0}
{RxSummaryLsa 0} {TxAsbrSummaryLsa 0} {RxAsbrSummaryLsa 0} {TxAsExternalLsa 0}
{RxAsExternalLsa 0} {TxNssaLsa 0} {RxNssaLsa 0} {TxAck 0} {RxAck 0} {TxRequest 0}
{RxRequest 0} {TxUpdate 0} {RxUpdate 0} {TxTeLsa 0} {RxTeLsa 0} {TxRiLsa 0} {RxRiLsa 0}
{TxEpLsa 0} {RxEpLsa 0} {TxElLsa 0} {RxElLsa 0} {SessionUpCount 0} {areaId 0.0.0.0}
{ipv4SrcAddr 10.1.1.4}}}}}}}