EVPN Wizard Functions

sth::emulation_evpn_provider_port_config

Purpose

Spirent Extension (for Spirent HLTAPI only).

Configures or deletes an emulated provider-side test port

Synopsis

Note

M indicates that the argument is Mandatory .

sth::emulation_evpn_provider_port_config
   [-mode {create|delete}  M]
   [-port_handle <port_handle>]
   [-handle <handle>]
   [-dut_interface_ipv4_addr <a.b.c.d>]
   [-dut_interface_ipv4_addr_step <a.b.c.d>]
   [-dut_interface_ipv4_prefix_len <0-32>]
   [-sub_interface_enable {true|false}]
   [-sub_interface_count <0-255>]
   [-vlan_id <0-4095>]
   [-vlan_id_step <0-4095>]

Arguments

-port_handle

Specifies the test port to be added to the provider side of the EVPN 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 a provider-side test port. You must specify
           -port_handle.

delete     Deletes specified routers under the provide-side port.
           You must specify -handle.
-handle

Specifies the handle of routers created under the emulated test port. This argument is Mandatory for -mode delete.

-dut_interface_ipv4_addr

Defines the first IPv4 address of the DUT interfaces connected to the port. The default value is 192.85.1.1.

-dut_interface_ipv4_addr_step

Specifies the step size by which the DUT IPv4 address is incremented. The default value is 0.0.1.0. The number of times that the step repeats is the same as the number of sub-interfaces. This argument is available when -sub_interface_enable is set to true.

-dut_interface_ipv4_prefix_len

Specifies the IPv4 address prefix length of DUT interface connected to the port. Possible values range from 0 to 32. The default value is 24.

-sub_interface_enable

Enables or disables sub-interface on the DUT. Possible values are true and false. The default value is false. When this argument is enabled, you can specify the following arguments:

-sub_interface_count
-dut_interface_ipv4_addr_step
-vlan_id
-vlan_id_step
-sub_interface_count

Defines the number of sub-interfaces on the DUT interface. Possible values range from 1 to 255. The default value is 1. This argument is available when -sub_interface_enable is set to true.

-vlan_id

Specifies the starting VLAN ID of DUT interfaces. Possible values range from 0 to 4095. The default value is 1. This argument is available when -sub_interface_enable is set to true.

-vlan_id_step

Specifies the step size by which the VLAN ID is incremented. Possible values range from 0 to 4095. The default value is 1. This argument is available when -sub_interface_enable is set to true.

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_evpn_provider_port_config function configures an emulated provider-side 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 a provider-side port:

set core_port_config_ret1 [sth::emulation_evpn_provider_port_config \
    -port_handle $port1\
    -mode create \
    -dut_interface_ipv4_addr          192.85.1.1 \
    -dut_interface_ipv4_addr_step     0.0.1.0 \
    -dut_interface_ipv4_prefix_length  24 \
    -sub_interface_enable             true \
    -sub_interface_count              10 \
    -vlan_id                          1 \
    -vlan_id_step                     1   \
    ]                    2   \

Sample output:

{status 1}

sth::emulation_evpn_cust_port_config

Purpose

Spirent Extension (for Spirent HLTAPI only).

Configures or deletes an emulated customer-side test port

Synopsis

Note

M indicates that the argument is Mandatory .

sth::emulation_evpn_cust_port_config
     [-mode {create|delete}  M]
     [-port_handle <port_handle>]
     [-handle <handle>]
     [-sub_interface_enable {true|false}]
     [-sub_interface_count <0-255>]
     [-vlan_id <0-4095>]
     [-vlan_id_step <0-4095>]

Arguments

-port_handle

Specifies the test port to be added to the customer side of the EVPN 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 a customer-side test port. You must specify
        -port_handle.

delete  Deletes specified routers under the customer-side port.
        You must specify -handle.
-handle

Specifies the handle of the CE routers. This argument is Mandatory for -mode delete.

-sub_interface_enable

Enables or disables sub-interfaces on the DUT interface. Possible values are true and false. The default value is false.

-sub_interface_count

Defines the number of sub-interfaces to be created for the DUT. Possible values range from 1 to 255. The default value is 1. This argument is available when -sub_interface_enable is set to true.

-vlan_id

Specifies the starting VLAN ID. Possible values range from 0 to 4095. The default value is 1. This argument is available when -sub_interface_enable is set to true.

-vlan_id_step

Defines the step size by which to increment the VLAN ID. Possible values range from 0 to 4095. The default value is 1. This argument is available when -sub_interface_enable is set to true.

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_evpn_cust_port_config function configures an emulated customer-side 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 a customer-side port:

set customer_port_config_ret1 [sth::emulation_evpn_cust_port_config \
    -port_handle $port2\
    -mode create \
    -sub_interface_enable             true \
    -sub_interface_count              10 \
    -vlan_id                          1 \
    -vlan_id_step                     1 \
    ]

Sample output:

{status 1}

sth::emulation_evpn_wizard_config

Purpose

Spirent Extension (for Spirent HLTAPI only).

Configures Ethernet VPN (EVPN, IEEE 802.1ah) network topology, creates emulated and simulated CE, P, and PE routers, specifies routing and labeling protocols, configures customer and provider side VPNs, and creates the traffic that is sent between VPNs, mapping the operations of the EVPN wizard in the Spirent TestCenter GUI.

Synopsis

Note

M indicates that the argument is Mandatory .

sth::emulation_evpn_wizard_config
    [-handle  <handle>  M]
    [-mode  {create|delete}  M]

    Test Configurations

    [-traffic_encapsulation {ipv4|ipv6|no_ip}]
    [-unicast_enable {true|false}]
    [-multicast_enable {true|false}]
    [-pbb_enable   {true|false}]

    Provider Router Configurations

    [-dut_router_id  <a.b.c.d>]
    [-dut_as  <1-65535>]
    [-dut_4byte_as_enable  {true|false}]
    [-dut_4byte_as  <integer>:<integer>]
    [-use_cust_ports {true|false}]
    [-use_provider_ports  {true|false}]
    [-igp_protocol  {ospf|isis|rip|none}]
    [-mpls_protocol  {none|ldp|rsvp|ospf|isis}]
    [-igp_ospf_area_id  <a.b.c.d>]
    [-igp_ospf_network_type  {native|broadcast|p2p}]
    [-igp_ospf_router_priority  <0-255>]
    [-igp_ospf_interface_cost  <1-65535>]
    [-igp_ospf_options  <0 -  0x7f >]
    [-igp_ospf_auth_mode  {none|simple|md5}]
    [-igp_ospf_auth_password  <password>]
    [-igp_ospf_auth_md5_key  <0-255>]
    [-igp_ospf_graceful_restart_enable  {true|false}]
    [-igp_ospf_graceful_restart_type  {none|rfc_standard|ll_signalling}]
    [-igp_ospf_bfd_enable  {true|false}]
    [-igp_isis_level  {level1|level2|level1_and_2}]
    [-igp_isis_network_type  {broadcast|p2p}]
    [-igp_isis_router_priority  <0-127>]
    [-igp_isis_area1  <ANY>]
    [-igp_isis_area2  <ANY>]
    [-igp_isis_area3  <ANY>]
    [-igp_isis_circuit_id  <0-255>]
    [-igp_isis_auth_mode  {none|simple|md5}]
    [-igp_isis_auth_password  <ANY>]
    [-igp_isis_auth_md5_key  <0-255>]
    [-igp_isis_metric_mode  {narrow|wide|narrow_and_wide}]
    [-igp_isis_l1_metric  <1-63>]
    [-igp_isis_l1_wide_metric  <0-16777215>]
    [-igp_isis_l2_metric  <1-63>]
    [-igp_isis_l2_wide_metric  <0-16777215>]
    [-igp_isis_graceful_restart_enable  {true|false}]
    [-igp_isis_hello_padding  {true|false}]
    [-igp_isis_bfd_enable  {true|false}]
    [-mpls_rsvp_bandwidth_per_link  {1-2147483647}]
    [-mpls_rsvp_bandwidth_per_tunnel  {1-2147483647}]
    [-mpls_rsvp_egress_label  {next_available|implicit_null|explicit_null }]
    [-mpls_rsvp_transit  {accept_all|accept_configured }]
    [-mpls_rsvp_min_label  {1-65535}]
    [-mpls_rsvp_max_label  {1-65535}]
    [-mpls_rsvp_graceful_restart_enable  {true|false}]
    [-mpls_rsvp_recover_time  <0-4294967295>]
    [-mpls_rsvp_restart_time  <0-4294967295>]
    [-mpls_rsvp_bfd_enable  {true|false}]
    [-mpls_rsvp_request_conf  {true|false}]
    [-mpls_rsvp_hello_enable  {true|false}]
    [-mpls_rsvp_hello_interval  <1-2147483647>]
    [-mpls_rsvp_bundle_interval  <1-2147483647>]
    [-mpls_rsvp_bundle_mode {manual|observation}]
    [-mpls_rsvp_summary_refresh_interval  <1-2147483647>]
    [-mpls_rsvp_inter_packet_delay  <1-2147483647>]
    [-mpls_rsvp_refresh_interval  <1-2147483647>]
    [-mpls_rsvp_reliable_delivery  {true|false}]
    [-mpls_rsvp_ack_mode {immediate|piggyback}]
    [-mpls_rsvp_retrans_interval  <1-2147483647>]
    [-mpls_rsvp_retrans_limit  <0-10>]
    [-mpls_rsvp_retrans_delta  <0-3>]
    [-mpls_ldp_hello_type  { direct|targeted}]
    [-mpls_ldp_transport_mode  { none|tester_ip|router_id }]
    [-mpls_ldp_hello_interval   <1-21845>]
    [-mpls_ldp_keepalive_interval   <1-21845>]
    [-mpls_ldp_egress_label   { next_available|implicit_null|explicit_null }]
    [-mpls_ldp_min_label  <1-65535>]
    [-mpls_ldp_graceful_restart_enable  {true|false}]
    [-mpls_ldp_recover_time  <0-4294967>]
    [-mpls_ldp_reconnect_time  <0-4294967>]
    [-mpls_ldp_bfd_enable  {true|false}]
    [-mpls_ldp_label_adv_mode  {downstream_unsolicited|downstream_on_demand}]
    [-mpls_ldp_auth_mode  {none|md5}]
    [-mpls_ldp_auth_password  <ANY>]
    [-mpls_ospf_sr_algorithms  <0-4294967295>]
    [-mpls_ospf_sid_base   <0-4294967295>]
    [-mpls_ospf_sid_range   <0-65535>]
    [-mpls_ospf_node_sid_index <0-4294967295>]
    [-mpls_ospf_node_sid_index_step  <0-4294967295>]
    [-mpls_isis_sr_algorithm  <0-4294967295>]
    [-mpls_isis_sid_base   <0-4294967295>]
    [-mpls_isis_sid_range   <0-65535>]
    [-mpls_isis_node_sid_index <0-4294967295>]
    [-mpls_isis_node_sid_index_step   <0-4294967295>]
    [-p_router_enable {true|false}]
    [-p_router_num_per_subif <1-65535>]
    [-p_router_topology_type {tree|grid}]
    [-p_router_id_start <a.b.c.d>]
    [-p_router_id_step <a.b.c.d>]
    [-p_router_ipv4_addr <a.b.c.d>]
    [-p_router_ipv4_prefix_len <0-32>]
    [-pe_router_num_per_subif  <1-10000>]
    [-pe_router_id_start   <a.b.c.d>]
    [-pe_router_id_step   <a.b.c.d>]
    [-bgp_route_reflector_enable {true|false}]
    [-bgp_route_reflector_ids  <a.b.c.d>]

    EVI Generation Parameters

    [-vrf_count <1-65535>]
    [-vrf_rd_assignment {use_rt|manual}]
    [-vrf_route_target_start <ANY>]
    [-vrf_route_target_step <ANY>]
    [-cust_ce_vrf_assignment {round_robin|sequential}]
    [-cust_rd_start  <ANY>]
    [-cust_rd_step_per_vrf_enable {true|false}]
    [-cust_rd_step_per_vrf  <ANY>]
    [-cust_rd_step_per_ce_enable {true|false}]
    [-cust_rd_step_per_ce  <ANY>]

    [-provider_pe_vrf_assignment {vpn_per_pe|pe_per_vpn}]
    [-provider_pe_vrf_count <integer>]
    [-provider_pe_vrf_all_assign {true|false}]
    [-provider_ce_bgp_as_enable {true|false}]

    [-provider_ce_bgp_as <1-65535>]
    [-provider_ce_bgp_as_step_per_ce_enable  {true|false}]
    [-provider_ce_bgp_as_step_per_ce <1-65535>]
    [-provider_ce_bgp_as_step_per_vrf_enable {true|false}]
    [-provider_ce_bgp_as_step_per_vrf <1-65535>]

    [-provider_ce_bgp_4byte_as_enable {true|false}]
    [-provider_ce_bgp_4byte_as <ANY>]
    [-provider_ce_bgp_4byte_as_step_per_ce_enable {true|false}]
    [-provider_ce_bgp_4byte_as_step_per_ce <1-65535>]
    [-provider_ce_bgp_4byte_as_step_per_vrf_enable {true|false}]
    [-provider_ce_bgp_4byte_as_step_per_vrf <1-65535>]

    [-provider_rd_start  <ANY>]
    [-provider_rd_step_per_vrf_enable  {true|false}]
    [-provider_rd_step_per_vrf  <ANY>]
    [-provider_rd_step_per_ce_enable  {true|false}]
    [-provider_rd_step_per_ce  <ANY>]

    EVPN Parameters

    [-provider_ethernet_tags_per_evi  <1-2147483647>]
    [-provider_ethernet_start_tag  <1-2147483647>]
    [-provider_ethernet_step_tag <1-2147483647>]
    [-ethernet_segment_type {type0|type1|type2|type3|type4|type5}]
    [-ethernet_segment_id <ANY>]
    [-ethernet_segment_id_step <ANY>]
    [-ethernet_segment_route {true|false}]

    MAC Blocks Parameters

    [-host_mac_start <MAC>]
    [-host_mac_step <NUMERIC>]
    [-host_mac_prefix <0-48>]
    [-host_overlap {true|false}]
    [-route_mpls_label_type <route|site>]
    [-route_mpls_label_start <0-1048575>]
    [-vlan_enable {true|false}]
    [-host_vlan_id  <0-4095>]
    [-host_vlan_id_step_per_evi  <0-4095>]
    [-host_vlan_id_step_per_host <0-4095>]
    [-host_num_cust_vlans <0-9>]
    [-host_num_core_vlans <0-9>]
    [-vpn_host_assignment {hosts_per_ce|hosts_per_vpn|total_hosts}]
    [-total_hosts <1-2147483647>]
    [-cust_hosts_per_ce <1-2147483647>]
    [-core_hosts_per_ce <1-2147483647>]
    [-ipv4_route_start  <a.b.c.d>]
    [-ipv4_route_step <integer> ]
    [-ipv4_route_prefix <1-32>]
    [-ipv6_route_start <aaaa:bbbb:cccc:dddd:eeee:ffff:gggg:hhhh>]
    [-ipv6_route_step <integer>]
    [-ipv6_route_prefix <1-128>]

    PBB EVPN Parameters

    [-isid_start <1-2147483647>]
    [-isid_step <NUMERIC>]
    [-isid_count <1-2147483647>]
    [-bmac_assignment {per_ce|per_evi|per_pe}]
    [-cust_mac_addr <MAC>]
    [-cust_mac_addr_step <NUMERIC>]
    [-cust_mac_addr_prefix <0-48>]
    [-cust_cmac_count <1-2147483647>]
    [-provider_mac_addr <MAC>]
    [-provider_mac_addr_step <NUMERIC>]
    [-provider_mac_addr_prefix <0-48>]
    [-provider_mac_addr_prefix <0-48>]
    [-provider_cmac_count <1-2147483647>]

    Traffic Generation Parameters

   [-traffic_flow_direction {none|fully_meshed|cust_to_core|core_to_customer|bidrectional}]
   [-traffic_stream_group_method {aggregate|vpn }]
   [-traffic_use_single_stream_per_endpoint_pair {true|false}]
   [-traffic_load_percent_provider <0-100>]
   [-traffic_load_percent_cust <0-100>]

Arguments

-handle

Specifies the EVPN 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 EVPN network configuration

delete   Deletes the EVPN network configuration specified by
         -handle
-traffic_encapsulation

Specifies the traffic encapsulation mode. Possible values are:

ipv4       IPv4

ipv6       IPv6

no_ip      Ethernet

The default value is no_ip.

-unicast_enable

Enables or disables unicast

Values: true, false

Default: true

-multicast_enable

Enables or disables multicast

Values: true, false

Default: false

-pbb_enable

Enables or disables Provider Backbone Bridge (PBB) traffic

Values: true, false

Default: false

-dut_router_id

Specifies the router ID for the DUT. The value must be in IPv4 format. The default value is 10.0.0.1.

-dut_as

The Autonomous System (AS) number of the DUT. Possible values range from 1 to 65535. The default value is 1.

-dut_4byte_as_enable

Enables or disables the 4-byte AS number on the DUT. Possible values are true (enable) and false (disable). The default value is false.

-dut_4byte_as

Specifies the 4-byte AS number of the DUT, in the format of <integer>:<integer>. The integer must be less than 65535. The default value is 1:1.

-use_cust_ports

Determines whether to set the DUT to port connection for customer ports. Possible values are true and false. Set it to false if the test does not use customer-side ports. The default value is true.

-use_provider_ports

Determines whether to set the DUT to port connection for provider ports. Possible values are true and false. Set it to false if the test does not use provider-side ports. The default value is true.

-igp_protocol

Specifies the Interior Gateway Protocol (IGP) to be used by the DUT. Possible values are:

OSPF     OSPF
ISIS     ISIS
RIP      RIP
NONE     No IGP protocol

The default value is OSPF.

-mpls_protocol

Specifies the MPLS protocol to be used by the DUT. Possible values are:

NONE     No MPLS protocol
LDP      LDP
RSVP     RSVP-TE
OSPF     OSPF SR
ISIS     ISIS SR

The default value is LDP.

-igp_ospf_area_id

Specifies the IP address that indicates the customer-side area to which the emulated router belongs. The default value is 0.0.0.0. This argument is available when -igp_protocol is set to OSPF.

-igp_ospf_network_type

Specifies the network link type to use. Possible values are:

native      Use the adjacency specified by the port-type

broadcast   Use a Broadcast adjacency

p2p         Use a P2P adjacency

The default value is native. This argument is available when -igp_protocol is set to OSPF.

-igp_ospf_router_priority

Specifies the router priority of the emulated router. Possible values range from 0 to 255. The default value is 0. This argument is available when -igp_protocol is set to OSPF.

-igp_ospf_interface_cost

Specifies the cost of the interface connecting the emulated router to the neighbor DUT router. Possible values range from 1 to 65535. The default value is 1. This argument is available when -igp_protocol is set to OSPF.

-igp_ospf_options

Specifies the Options field that describes the optional OSPF capabilities of the router. Possible values range from 0 to 0x7f. The values are described below:

tbit      Type of Service (TOS) (T,0).
ebit      Specifies the way AS-external-LSAs are flooded (E,1)
mcbit     Specifies whether IP multicast datagrams are forwarded (MC,2)
npbit     Specifies the handling of Type-7 LSAs (NSSA) (N/P,3)
eabit     Specifies the router's willingness to receive and
          forward External-Attributes-LSAs (EA,4)
dcbit     Specifies the router's handling of demand circuits (DC,5)
obit      Specifies the router's willingness to receive and forward
          Opaque LSAs as specified in RFC 2370 (O,6)
unused7   This bit is not used

The default for OSPFv2 is 0x02, which sets the E-bit.

-igp_ospf_auth_mode

Specifies the type of OSPFv2 authentication to be used. Possible values are:

none     No authentication
simple   Use simple authentication
md5      Use MD5 authentication

The default value is none. This argument is available when -igp_protocol is set to OSPF.

-igp_ospf_auth_password

Specifies the password used for OSPFv2 authentication. This argument is available when -igp_ospf_auth_mode is set to simple or md5. When you specify -igp_ospf_auth_mode simple, the value must be of 1-8 alphanumeric characters. When you specify -igp_ospf_auth_mode md5, the value must be of 1-16 alphanumeric characters. The default value is “spirent”.

-igp_ospf_auth_md5_key

Specifies the MD5 key used for OSPFv2 authentication. Possible values range from 0 to 255. The default value is 1. This argument is available when -igp_ospf_auth_mode is set to md5.

-igp_ospf_graceful_restart_enable

Enables or disables graceful restart for OSPF sessions. Possible values are true (enable) and false (disable). The default value is false. This argument is available when -igp_protocol is set to OSPF.

-igp_ospf_graceful_restart_type

Specifies the type of graceful restart to be used by the OSPF session. Possible values are:

 none              No graceful restart
 rfc_standard      RFC3623
 ll_signalling     Link-Layer Signaling

The default value is none.
-igp_ospf_bfd_enable

Enables or disables Bidirectional Forwarding Detection (BFD) on the OSPF interface. Possible values are true (enable) and false (disable). The default value is false. This argument is available when -igp_protocol is set to OSPF.

-igp_isis_level

Specifies the IS-IS level to be used on the customer side. It defines the type of adjacency that Spirent HLTAPI establishes with the DUT. Possible values are described below:

level1             Level 1 (intra-area)
level2             Level 2 (inter-area)
level1_and_2       Both Level 1 and Level 2

The default value is level2. This argument is available when -igp_protocol is set to ISIS.

-igp_isis_network_type

Specifies the IS-IS network type on the customer side. Possible values are:

broadcast     Broadcast network
p2p           P2P network

The default value is broadcast. This argument is available when -igp_protocol is set to ISIS.

-igp_isis_router_priority

Specifies the priority for the emulated IS-IS router. Possible values range from 0 to 127. The default value is 0. This argument is available when -igp_protocol is set to ISIS.

-igp_isis_area1

Specifies the Mandatory area address 1. You must specify at least one address. Spirent HLTAPI supports up to three addresses per emulated router. This argument is available when -igp_protocol is set to ISIS.

-igp_isis_area2

Specifies the optional area address 2. This argument is available when -igp_protocol is set to ISIS. The default value is “”.

-igp_isis_area3

Specifies the optional area address 3. This argument is available when -igp_protocol is set to ISIS. The default value is “”.

-igp_isis_circuit_id

Specifies the circuit ID for the IS-IS session. Possible values range from 0 to 255. The default value is 1. This argument is available when -igp_protocol is set to ISIS.

-igp_isis_auth_mode

Specifies the type of IS-IS authentication to be used. Possible values are:

none      No authentication
simple    Use simple authentication
md5       Use the MD5 key ID

The default value is none. This argument is available when -igp_protocol is set to ISIS.

-igp_isis_auth_password

Specifies the password used for IS-IS authentication. This argument is available when -igp_isis_auth_mode is set to simple or md5. When you specify -igp_isis_auth_mode simple, the value must be of 1-8 alphanumeric characters. When you specify -igp_isis_auth_mode md5, the value must be of 1-16 alphanumeric characters. The default value is “spirent”.

-igp_isis_auth_md5_key

Specifies the MD5 key used in IS-IS authentication. Possible values range from 0 to 255. The default value is 1. This argument is available when -igp_isis_auth_mode is set to md5.

-igp_isis_metric_mode

Specifies the length of the metric field in the Link State Path (LSP) packet. This argument is available when -igp_protocol is set to ISIS. Possible values are described below:

narrow             Router advertises routes with a
                   narrow (6-bit) metric
wide               Router advertises routes with a wide
                  (24 or 32-bit) metric (required for IS-IS TE)
narrow_and_wide    Router advertises the same route with both
                   metrics

The default value is narrow_and_wide.

-igp_isis_l1_metric

Specifies the metric of the emulated router interface. It is blank and disabled if -igp_isis_level is set to level2 or if -igp_isis_metric_mode is set to wide. Possible values range from 1 to 63. The default value is 1.

-igp_isis_l1_wide_metric

Indicates the 3-octet metric of a link from the emulated ISIS router to the DUT. It is blank and disabled if -igp_isis_level is set to level2 or if -igp_isis_metric_mode is set to narrow. Possible values range from 0 to 16777215. The default value is 1.

-igp_isis_l2_metric

Indicates the metric of the emulated ISIS router interface. It is blank and disabled if -igp_isis_level is set to level1 or if -igp_isis_metric_mode is set to wide. Possible values range from 1 to 63. The default value is 1.

-igp_isis_l2_wide_metric

Indicates the 3-octet traffic engineering metric of a link from the emulated ISIS router to the DUT. It is blank and disabled if -igp_isis_level is set to level1 or if -igp_isis_metric_mode is set to narrow. Possible values range from 0 to 16777215. The default is 1.

-igp_isis_graceful_restart_enable

Enables or disables the IS-IS graceful restart. Possible values are false (disable) and true (enable). The default value is false.

-igp_isis_hello_padding

Enables or disables Hello padding for IS-IS sessions. Possible values are true (enable) and false (disable). The default value is true. This argument is available when you specify -igp_protocol ISIS.

-igp_isis_bfd_enable

Enables or disables BFD on IS-IS interfaces. Possible values are true (enable) and false (disable). The default value is false.

Specifies the maximum bandwidth per ISIS/OSPFv2 TE link, in bytes per second, for simulated provider router topology links. Possible values range from 1 to 2147483647. The default value is 100000. This argument is available when you specify -mpls_protocol RSVP.

-mpls_rsvp_bandwidth_per_tunnel

Specifies the RSVP-TE bandwidth rate, in bytes per second, for provider tunnels. Possible values range from 1 to 2147483647. The default value is 0. This argument is available when you specify -mpls_protocol RSVP.

-mpls_rsvp_egress_label

Specifies the label to be advertised when emulated router is at the tail-end of the tunnel. This argument is available when you specify -mpls_protocol rsvp. The values are described below:

next_available     Advertises the next available label

implicit_null      Advertises label 3, the implicit null label

explicit_null      Advertise label 9, the explicit null label

The default value is next_available.

-mpls_rsvp_transit

Defines the RESV message sent when emulated router is not the tail-end router for PATH messages it receives. This argument is available when you specify -mpls_protocol rsvp. Possible values are described below:

accept_all         The router sends an RESV message with
                   the next available label for every PATH
                   message received by the unique MAC/VLAN
                   combination on the port

accept_configured  The router sends an RESV message with
                   the next available label in response to PATH
                   messages that match one of its egress
                   tunnels

The default value is accept_configured.

-mpls_rsvp_min_label

Defines the minimum label number used by the RSVP session. Possible values range from 1 to 65535. The default value is 16. This argument is available when you specify -mpls_protocol RSVP.

-mpls_rsvp_max_label

Defines the maximum label number used by the RSVP session. Possible values range from 1 to 65535. The default value is 65535. This argument is available when you specify -mpls_protocol RSVP.

-mpls_rsvp_graceful_restart_enable

Enables or disables graceful restart for RSVP. Possible values are false (disable) and true (enable). The default value is false.

-mpls_rsvp_recover_time

Specifies the length of time (in milliseconds) that the sender wants the recipient to re-synchronize RSVP and MPLS forwarding state with the sender, after the re-establishment of Hello synchronization. Possible values range from 0 to 4294967295. The default value is 0. This argument is available when -mpls_rsvp_graceful_restart_enable is set to true.

-mpls_rsvp_restart_time

Specifies the amount of time (in milliseconds) it takes the sender of the object to restart its RSVP component and the communication channel used for RSVP communication. Possible values are 0 to 4294967295. The default value is 3000. This argument is available when -mpls_rsvp_graceful_restart_enable is set to true.

-mpls_rsvp_bfd_enable

Enables or disables BFD on RSVP interfaces. Possible values are true (enable) and false (disable). The default value is false.

-mpls_rsvp_request_conf

Determines whether to include an RESV_CONFIRM object in the RESV message. Possible values are true and false. When it is set to true, an RESV_CONFIRM object will be included in the RESV message. The default value is false.

-mpls_rsvp_hello_enable

Enables or disables Hello packets for RSVP sessions. Possible values are true (enable) and false (disable). The default value is false.

-mpls_rsvp_hello_interval

Specifies the interval between RSVP Hello packets. Possible values range from 1 to 2147483647. The default value is 1000. This argument is available when -mpls_rsvp_hello_enable is set to true.

-mpls_rsvp_bundle_mode

Specifies the bundle mode. Possible values are:

observation    Start bundling only after receiving a bundled message
manual         Start bundling immediately

The default value is observation.

-mpls_rsvp_bundle_interval

Specifies the time interval (in milliseconds) to wait before sending queued messages. Messages are held in a buffer and are sent out as a bundle after the interval (in ms) expires or when message size exceeds the MTU. Possible values range from 1 to 2147483647. The default value is 1000.

-mpls_rsvp_summary_refresh_interval

Specifies the time interval (in milliseconds) to gather refresh messages that would have been sent out individually. Possible values range from 1 to 2147483647. The default value is 9000.

-mpls_rsvp_inter_packet_delay

Specifies the time delay (in milliseconds) between transmitted RSVP packets. Possible values range from 0 to 2147483647. The default value is 30.

-mpls_rsvp_refresh_interval

Specifies the time interval for a PATH and RESV message to be sent out to the path receiver to refresh the PATH/RESV state along each hop of the path. Possible values range from 1 to 2147483647. The default value is 30000.

-mpls_rsvp_reliable_delivery

Enables or disables reliable delivery for RSVP sessions. Possible values are true (enable) and false (disable). The default value is false.

-mpls_rsvp_ack_mode

Specifies the ACK message transmission mode

Values:

immediate      Send ACK immediately

piggyback      Send multiple message IDs in one ACK when the
               ACK timer expires

Default: immediate

-mpls_rsvp_retrans_interval

Specifies the initial retransmission interval (in milliseconds) for unacknowledged messages. Possible values range from 1 to 2147483647. The default value is 500.

-mpls_rsvp_retrans_limit

Specifies the maximum number of times a message is transmitted without being acknowledged. Possible values range from 0 to 10. The default value is 3.

-mpls_rsvp_retrans_delta

Specifies the multiplier by which the retransmission interval is increased each time an unacknowledged message is retransmitted. Possible values range from 0 to 3. The default value is 1.

-mpls_ldp_hello_type

Specifies the type of Hello packets for LDP. Possible values are:

direct    The Peer IP address is the DUT interface address.
          Used to locate directly connected neighbors.

targeted  The Peer IP address is the DUT loopback address.
          Used to locate neighbors which are not directly connected.

This argument is available when you specify -mpls_protocol LDP.

-mpls_ldp_transport_mode

Specifies the mode of the LDP Transport Address TLV. Possible values are:

none          The Transport Address TLV will not be included in
              LDP Hello messages

tester_ip     The LSR will take the emulated router interface
              address as the transport address and include
              the Transport Address TLV in LDP Hello messages

router_id     The LSR will take the emulated router ID, that is,
              the loopback address as the transport address and
              include the Transport Address TLV in LDP Hello
              messages.

The default value is tester_ip. This argument is available when you specify -mpls_protocol LDP.

-mpls_ldp_hello_interval

Specifies the amount of time, in seconds, between Hello messages in an LDP session. Possible values range from 1 to 21845. The default value is 5. This argument is available when you specify -mpls_protocol LDP.

-mpls_ldp_keepalive_interval

Specifies the amount of time, in seconds, between KEEPALIVE messages. Possible values range from 1 to 21845. The default value is 60. This argument is available when you specify -mpls_protocol LDP.

-mpls_ldp_egress_label

Specifies the emulated label to be advertised by the emulated peer. Possible values are described below:

next_available     Advertises the next available label
implicit_null      Advertises label 3, the implicit null label
explicit_null      Advertise label 9, the explicit null label

The default value is next_available. This argument is available when you specify -mpls_protocol LDP.

-mpls_ldp_min_label

Defines the minimum label number used by the LDP session. Possible values range from 1 to 65535. The default value is 16. This argument is available when you specify -mpls_protocol LDP.

-mpls_ldp_graceful_restart_enable

Enables or disables graceful restart for LDP sessions. Possible values are true (enable) and false (disable). The default value is false. This argument is available when you specify -mpls_protocol LDP.

-mpls_ldp_recover_time

Specifies the length of time (in milliseconds) that the sender desires for the recipient to re-synchronize LDP and MPLS forwarding state with the sender, after the re-establishment of Hello synchronization. Possible values are 0 to 4294967. The default value is 140. This argument is available when -mpls_ldp_graceful_restart_enable is set to true.

-mpls_ldp_reconnect_time

Specifies the amount of time, in seconds, it takes Spirent HLTAPI to reconnect after a graceful restart. To use this argument, you must set -mpls_ldp_graceful_restart_enable to true and specify a value for the -mpls_ldp_recover_time argument. Possible values range from 0 to 4294967. The default value is 60.

-mpls_ldp_bfd_enable

Enables or disables BFD on LDP interfaces. Possible values are true (enable) and false (disable). The default value is false. This argument is available when -mpls_protocol is set to LDP.

-mpls_ldp_label_adv_mode

Specifies the label advertisement mode for LDP sessions. Possible values are downstream_unsolicited and downstream_on_demand. The default value is downstream_on_demand.

-mpls_ldp_auth_mode

Specifies the authentication type for LDP. Possible values are:

none     No authentication
md5       MD5 authentication

The default value is none.

-mpls_ldp_auth_password

Specifies the password used for LDP authentication. This argument is available when -mpls_ldp_auth_mode is set to md5. The default value is “Spirent”.

-mpls_ospf_sr_algorithms

A comma-separated list of integers to specify the algorithm to calculate the reachability to other nodes or to prefixes attached to these nodes. Possible values range from 0 to 255. The default value is 0. This argument is available when -mpls_protocol is set to OSPF.

-mpls_ospf_sid_base

Specifies the base value for the SID/Label range. Possible values range from 0 to 4294967295. The default value is 100. This argument is available when -mpls_protocol is set to OSPF.

-mpls_ospf_sid_range

Specifies the size of the SID/Label range for OSPF SR. Possible values range from 0 to 65535. The default value is 100. This argument is available when -mpls_protocol is set to OSPF.

-mpls_ospf_node_sid_index

Specifies the index value for the SID sub-TLV of OSPF SR. Possible values range from 0 to 4294967295. The default value is 0. This argument is available when -mpls_protocol is set to OSPF.

-mpls_ospf_node_sid_index_step

Specifies the increment value with which to create subsequent SID indexes of ISIS SR. Possible values range from 0 to 4294967295. The default value is 1. This argument is available when -mpls_protocol is set to OSPF.

-mpls_isis_sr_algorithm

Specifies the ISIS SR algorithm, in string format. The default value is 0. This argument is available when -mpls_protocol is set to ISIS.

-mpls_isis_sid_base

Specifies the base value for the SID/Label range of OSPF SR. Possible values range from 0 to 4294967295. The default value is 100. This argument is available when -mpls_protocol is set to ISIS.

-mpls_isis_sid_range

Specifies the size of the SID/Label range for OSPF SR. Possible values range from 0 to 65535. The default value is 100. This argument is available when -mpls_protocol is set to ISIS.

-mpls_isis_node_sid_index

Specifies the index value for the SID sub-TLV of ISIS SR. Possible values range from 0 to 4294967295. The default value is 0. This argument is available when -mpls_protocol is set to ISIS.

-mpls_isis_node_sid_index_step

Specifies the increment value with which to create subsequent SID indexes of the ISIS SR. Possible values range from 0 to 4294967295. The default value is 1. This argument is available when -mpls_protocolo is set to ISIS.

-p_router_enable

Enables or disables the emulation of provider (P) routers in the test. Possible values are true and false. When it is set to false, only provider edge routers will be emulated or simulated. The default value is true.

-p_router_num_per_subif

Specifies the number of P routers per sub-interface on the provider side. Only one emulated P router can be created per sub-interface. If this number is greater than 1, the additional P routers are simulated through the IGP protocol routes. The topology for the additional P routers is determined by the -p_router_topology_type option. Possible values range from 1 to 65535. The default value is 1. This argument is available when -p_router_enable is set to true.

-p_router_topology_type

Defines the topology of the provider network. Possible values are tree and grid. The default value is tree.

-p_router_id_start

Defines the first loopback address of emulated P routers. The value must be in IPv4 format. The default value is 192.0.1.1. This argument is available when -p_router_enable is set to true.

-p_router_id_step

Specifies the step value by which to generate additional loopback addresses for the emulated P routers. The value must be in IPv4 format. The default value is 0.0.1.0. This argument is available when -p_router_enable is set to true.

-p_router_ipv4_addr

Specifies the starting IPv4 interface address of the emulated P routers. The default value is 1.0.0.1. This argument is available when -p_router_enable is set to true.

-p_router_ipv4_prefix_len

Specifies the IP prefix length on the simulated P router. Possible values range from 0 to 32. The default value is 24. This argument is available when -p_router_enable is set to true.

-pe_router_num_per_subif

Defines the number of PE routers created on each provider sub-interface. Possible values range from 1 to 65535. The default value is 1. This argument is available when -p_router_enable is set to true.

-pe_router_id_start

Specifies the starting IPv4 address for the PE router. The default is 10.0.0.2. This argument is available when -p_router_enable is set to true.

-pe_router_id_step

Defines the step size by which the provider-side PE router is incremented. The default value is 0.0.0.1. This argument is available when -p_router_enable is set to true.

-bgp_route_reflector_enable

Enables or disables route reflectors on the core side. Possible values are true (enable) and false (disable). The default value is false.

-bgp_route_reflector_ids

Specifies the BGP route reflector ID. The value must be in IPv4 format. The default value is 0.0.0.0.

-vrf_count

Specifies the number of VPN Routing and Forwarding tables (VRFs) to be configured. Possible values range from 1 to 65535. The default is 1.

-vrf_rd_assignment

Specifies the route distinguisher assignment mode. Possible values are:

use_rt   Use the route target field for all
         route distinguishers in the VPN

manual   Manually configure route distinguishers

The default value is use_rt.

-vrf_route_target_start

Specifies the starting route target for the VPN, in the format of AS-Number:Value or IPv4-Address:Value. The default value is 1:00.

-vrf_route_target_step

Specifies the step size by which the route target is incremented. The value must be in the format of AS-Number:Value or IPv4-Address:Value. The default value is 1:00.

-cust_ce_vrf_assignment

Determines how VRFs are assigned to CE routers on the customer side. Possible values are:

round_robin        The first CE created is assigned to
                   the first VRF. The second CE created
                   is assigned to the second VRF, and so forth.
                   When the specified number of VRFs is reached,
                   the VRF assignment repeats from the first
                   VRF.

sequential         CEs created are assigned to the
                   first VRF until the calculated number of CEs
                   per VRF is reached. Additional CEs are
                   assigned to the second and subsequent VRFs in
                   the same fashion.
-cust_rd_start

Specifies the starting route distinguisher on the customer side. This argument is available when -vrf_rd_assignment is set to MANUAL. The default value is 1:0.

-cust_rd_step_per_vrf_enable

Enables or disables the step value for additional customer-side route distinguishers per VPN. Possible values are true and false. The default value is true.

-cust_rd_step_per_vrf

Specifies the step value by which to generate additional customer-side route distinguishers per VPN. The default value is 1:0.

-cust_rd_step_per_ce_enable

Enables or disables the step value for additional customer-side route distinguishers per CE. Possible values are true and false. The default value is false.

-cust_rd_step_per_ce

Specifies the step value by which to generate additional customer-side route distinguishers per CE. The default value is 0:0. This argument is available when -cust_rd_step_per_ce_enable is set to true.

-cust_route_count_per_ce

Specifies the number of routes that will be added to each customer-side CE. The default value is 1.

-provider_pe_vrf_assignment

Specifies how VPNs are assigned to PE routers. Possible values are:

vpn_per_pe   VPNs will be distributed across a set of PEs
pe_per_vpn   PEs will be distributed across a set of VPNs

The default value is vpn_per_pe.

-provider_pe_vrf_count

Specifies the number of items (VPNs or PEs) assigned to each target (VPN or PE). When -provider_pe_vrf_assignment is set to vpn_per_pe, this argument indicates the number of VPNs assigned to each PE, and possible values range from 1 to the number of VPNs. When -provider_pe_vrf_assignment is set to pe_per_vpn, this argument indicates the number of PEs assigned to each VPN, and possible values range from 1 to the number of PEs. The default value is 1.

If the value is less than the maximum number of items, and there is more than one target, the specified number of items are assigned in a round-robin fashion to each target. This argument is available when -provider_pe_vrf_all_assign is set to false.

-provider_pe_vrf_all_assign

Determines whether each PE uses all VPNs. Possible values are true and false. If it is set to false, you can manually set the number of VPNs that each PE will advertise routes for. The default value is false.

-provider_ce_bgp_as_enable

Enables or disables BGP AS numbers for CEs on the provider side. Possible values are true (enable) and false (disable). The default value is false.

-provider_ce_bgp_as

Specifies the starting BGP AS number on the provider side. Possible values range from 1 to 65535. The default value is 1. This argument is available when -provider_ce_bgp_as_enable is set to true.

-provider_ce_bgp_as_step_per_ce_enable

Enables or disables the step value for additional CE BGP AS numbers across CEs on the provider side. Possible values are true (enable) and false (disable). The default value is false.

-provider_ce_bgp_as_step_per_ce

Specifies the step value by which to generate additional CE BGP AS numbers across CEs on the provider side. Possible values range from 1 to 65535. The default value is 1. This argument is available when -provider_ce_bgp_as_step_per_ce_enable is set to true.

-provider_ce_bgp_as_step_per_vrf_enable

Enables or disables the step value for additional CE BGP AS numbers across VPNs on the provider side. Possible values are true (enable) and false (disable). The default is true.

-provider_ce_bgp_as_step_per_vrf

Specifies the step value by which to generate additional CE BGP AS numbers across VPNs on the provider side. Possible values range from 1 to 65535. The default value is 1.

-provider_ce_bgp_4byte_as_enable

Enables or disables 4-byte AS numbers for CE routers on the provider side. Possible values are true (enable) and false (disable). The default value is false.

-provider_ce_bgp_4byte_as

Defines the first 4-byte AS number for CEs on the provider side. The default value is 1:01. This argument is available when -provider_ce_bgp_4byte_as_enable is set to true.

-provider_ce_bgp_4byte_as_step_per_ce_enable

Enables or disables the step value for additional CE 4-byte AS numbers across CEs on the provider side. Possible values are true (enable) and false (disable). The default value is false.

-provider_ce_bgp_4byte_as_step_per_ce

Specifies the step value by which to generate additional CE 4-byte AS numbers across CEs on the provider side. Possible values range from 1 to 65535. The default value is 1. This argument is available when -provider_ce_bgp_4byte_as_step_per_ce_enable is set to true.

-provider_ce_bgp_4byte_as_step_per_vrf_enable

Enables or disables the step value for additional CE 4-byte AS numbers per VPN on the provider side. Possible values are true (enable) and false (disable). The default value is true.

-provider_ce_bgp_4byte_as_step_per_vrf

Specifies the step value by which to generate additional CE 4-byte AS numbers across VPNs on the provider side. Possible values range from 1 to 65535. The default value is 1.

-provider_rd_start

Specifies the starting route distinguisher for provider sites. The default value is 1:0.

-provider_rd_step_per_vrf_enable

Enables or disables the step value for additional route distinguishers per VPN on the provider side. Possible values are true (enable) and false (disable). The default value is true.

-provider_rd_step_per_vrf

Specifies the step value by which to generate additional route distinguishers across VPNs on the provider side. The default value is 1:0.

-provider_rd_step_per_ce_enable

Enables or disables the step value for additional route distinguishers across CE routers on the provider side. Possible values are true (enable) and false (disable). The default value is false.

-provider_rd_step_per_ce

Specifies the step value by which to generate additional route distinguishers across CE routers on the provider side. The default value is 0:0.

-provider_route_count_per_ce

Specifies the number of routes that will be added to each CE router on the provider side. The default value is 1.

-provider_ethernet_tags_per_evi

Number of provider side tags to create per EVI

Values: 1-2147483647

Default: 1

-provider_ethernet_start_tag

Specifies the value of the first Ethernet tag

Values: 1-2147483647

Default: 1

-provider_ethernet_step_tag

Increment value by which to create subsequent tags

Values: 1-2147483647

Default: 1

-ethernet_segment_type

Specifies the Ethernet segment type

Values:

type0       Operator
type1       IEEE 802.1AX LACP
type2       Bridged LAN
type3       MAC Based
type4       Router ID
type5       Autonomous System

Default: type0

-ethernet_segment_id

Specifies the segment ID to identify the link between the CE and a PE

Values: 10-byte hexadecimal

Default: 00:00:00:00:00:00:00:00:00

-ethernet_segment_id_step

Increment value by which to create subsequent segment IDs

Values: 10-byte hexadecimal

Default: 00:00:00:00:00:00:00:00:00

-ethernet_segment_route

Enables or disables Ethernet segment routes

Values: true, false

Default: false

-host_mac_start

Specifies the MAC address of first host

Values: MAC

Default: 0.0.1.0.0.1

-host_mac_step

Increment value by which to create subsequent MAC addresses

Values: integer

Default: 1

-host_mac_prefix

Specifies the prefix for the host MAC address

Values: 0-48

Default: 48

-host_overlap

Determines whether to allow host overlap when starting a new CE host block

Values:

true
Restart the numbering of the emulated CE host block’s MAC address at the -host_mac_start value
false
Continue incrementing the MAC address

Default: false

-route_mpls_label_type

Specifies the MPLS label type for the VPN route

Values:

route Label per Site

site Label per Route

Default: site

-route_mpls_label_start

Specifies the value of the first MPLS label

Default: 16

-vlan_enable

Enables or disables host VLANs

Values: true, false

Default: false

-host_vlan_id

Specifies the ID of the first VLAN

Values: 0-4095

Default: 100

-host_vlan_id_step_per_host

Increment value by which to create subsequent VLAN IDs per host

Values: 0-4095

Default: 0

-host_vlan_id_step_per_evi

Increment value by which to create subsequent VLAN IDs per VPN

Values: 0-4095

Default: 0

-host_num_cust_vlans

Number of VLAN headers on the customer side

Values: 1-9

Default: 1

-host_num_core_vlans

Number of VLAN headers on the provider side

Values: 1-9

Default: 1

-vpn_host_assignment

Specifies how hosts or MAC addresses are assigned

Values:

hosts_per_ce       Hosts/MACs per CE
hosts_per_vpn      Hosts/MACs per VPN
total_hosts        Total Hosts/MACs

Default: hosts_per_ce

-total_hosts

Specifies the total number of hosts

Default: 100

-cust_hosts_per_ce

Number of hosts per customer CE

Values: 1-2147483647

Default: 1

-core_hosts_per_ce

Number of hosts per provider CE

Values: 1-2147483647

Default: 1

-ipv4_route_start

Specifies the first IP address assigned to the route

Values: IPv4

Default: 110.1.1.0

-ipv4_route_step

Increment value by which to create subsequent IP addresses

Values: integer

Default: 1

-ipv4_route_prefix

Specifies the IPv4 prefix length

Values: 1-32

Default: 32

-ipv6_route_start

Specifies the first IP address assigned to the route

Values: IPv6

Default: 2001::

-ipv6_route_step

Increment value by which to create subsequent IPv6 addresses

Values: integer

Default: 1

-ipv6_route_prefix

Specifies the IPv6 prefix length

Values: 1-128

Default: 128

-isid_start

Specifies the value of the first Backbone Service Instance Identifier (I-SID)

Values: 1-16777215

Default: 1

-isid_step

Increment value by which to create additional I-SIDs

Values: 1-16777215

Default: 1

-isid_count

Specifies the number of service instance tags to create

Values: 1-16777215

Default: 1

-bmac_assignment

Specifies how the MAC address of the backbone router is assigned

Values:

per_ce Per CE per_evi Per EVI per_pe Per PE

Default: per_evi

-cust_mac_addr

Specifies the first MAC address of the customer side router

Default: 0.0.1.0.0.1

-cust_mac_addr_step

Increment value by which to create subsequent MAC addresses for customer side routers

Default: 1

-cust_mac_addr_prefix

Specifies the MAC prefix for the customer side router

Values: 0-48

Default: 48

-cust_cmac_count

Specifies the number of MAC addresses to create for customer side routers

Values: 1-2147483647

Default: 1

-provider_mac_addr

Specifies the first MAC address of the provider side router

Values: Integer

Default: 0.0.1.0.0.1

-provider_mac_addr_step

Increment value by which to create subsequent MAC addresses for provider side routers

Default: 1

-provider_mac_addr_prefix

Specifies the MAC prefix for the provider side router

Values: 0-48

Default: 48

-provider_cmac_count

Specifies the number of MAC addresses to create for provider side routers

Values: 1-2147483647

Default: 1

-traffic_flow_direction

Specifies the type of traffic flows to create. This argument is available when -traffic_enable is set to true. Possible values are described below:

 cust_to_core   Traffic is created from the customer side to
                the core side

 core_to_cust   Traffic is created from the core side to
                the customer side

 bidirectional  Traffic is created from  both directions

 fully_meshed   Traffic is created in a fully meshed pattern

 none           None

The default value is bidirectional.
-traffic_stream_group_method

Determines how to aggregate streams in a streamblock. Possible values are:

aggregate  Aggregates all streams into a single streamblock

vpn        Aggregates all streams for a single VPN into a
           single streamblock
-traffic_use_single_stream_per_endpoint_pair

Determines whether Spirent HLTAPI will assign a single stream ID to each endpoint pair. Possible values are true and false. The default value is false.

-traffic_load_percent_provider

Specifies the load percentage for test traffic from each provider-side port. Possible values range from 0 to 100. The default value is 10.

-traffic_load_percent_cust

Specifies the load percentage for test traffic from each customer-side port. Possible values range from 0 to 100. The default value is 10.

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      EVPN network 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:

ce_router           CE router handle
p_router            P router handle
rr_router           RR router handle
pe_router           PE router handle
vpn                 VPN handle
ospf                OSPF SR handle
isis                ISIS SR handle
ldp                 LDP handle
rsvp                RSVP-TE handle
bgp                 BGP handle
bfd                 BFD handle
rip                 RIP handle
stream_id           Streamblock handle

Description

The sth::emulation_evpn_wizard_config function creates or deletes EVPN network topologies, mapping the operations of the EVPN Wizard in the Spirent TestCenter GUI. Use the -mode argument to specify the action to perform.

Before you use the function, you must configure customer and provider test ports using the sth::emulation_evpn_provider_port_config and sth::emulation_evpn_cust_port_config functions.

If the operation fails, Spirent HLTAPI returns an error message.

Examples

The following example creates a EVPN network topology:

set evpn_config_isis_ret1 [sth::emulation_evpn_wizard_config \
    -mode                                     create \
    -dut_router_id                            10.0.0.1 \
    -dut_as                                   1 \
    -dut_4byte_as_enable                      false \
    -dut_4byte_as                             1:1 \
    -use_provider_ports                      true \
    -use_cust_ports                          true \
    -igp_protocol                             isis \
    -mpls_protocol                            isis \
    -igp_isis_level                           level2 \
    -igp_isis_network_type                    broadcast \
    -igp_isis_area1                           00001 \
    -igp_isis_circuit_id                      1  \
    -igp_isis_auth_mode                       none \
    -igp_isis_auth_password                   Spirent \
    -igp_isis_auth_md5_key                    1 \
    -igp_isis_metric_mode                     narrow_and_wide \
    -igp_isis_l1_metric                       1 \
    -igp_isis_l1_wide_metric                  1 \
    -igp_isis_l2_metric                       1 \
    -igp_isis_l2_wide_metric                  1 \
    -igp_isis_graceful_restart_enable         false \
    -igp_isis_hello_padding                   true  \
    -igp_isis_bfd_enable                      false \
    -mpls_isis_sr_algorithm                   0 \
    -mpls_isis_sid_base                       100 \
    -mpls_isis_sid_range                      100 \
    -mpls_isis_node_sid_index                 0 \
    -mpls_isis_node_sid_index_step            1 \
    -p_router_enable                          false \
    -p_router_num_per_subif                   1 \
    -p_router_topology_type                   tree \
    -p_router_id_start                        192.0.1.1 \
    -p_router_id_step                         0.0.1.0 \
    -p_router_ipv4_addr                      1.0.0.1 \
    -p_router_ipv4_prefix_len                24 \
    -pe_router_num_per_subif                 1 \
    -pe_router_id_start                       10.0.0.2 \
    -pe_router_id_step                        0.0.0.1 \
    -bgp_route_reflector_enable               false \
    -bgp_route_reflector_ids                  0.0.0.0 \
    -vrf_count                                10 \
    -vrf_rd_assignment                        manual \
    -vrf_route_target_start                   1:1 \
    -vrf_route_target_step                    1:1 \
    -cust_ce_vrf_assignment                   round_robin \
    -provider_pe_vrf_assignment               vpn_per_pe \
    -provider_pe_vrf_all_assign               true \
    -traffic_flow_direction                   bidirectional \
    -traffic_stream_group_method                aggregate \
    -traffic_use_single_stream_per_endpoint_pair  false \
    -traffic_load_percent_provider                  10 \
    -traffic_load_percent_cust                     10 \
    -traffic_encapsulation                       no_ip \
    -unicast_enable                             true \
    -multicast_enable                           false \
    -pbb_enable                                 false \
    -provider_ethernet_tags_per_evi             1 \
    -provider_ethernet_start_tag                1 \
    -provider_ethernet_step_tag                 1 \
    -ethernet_segment_type                      type0 \
    -ethernet_segment_id         "00:00:00:00:00:00:00:00:00" \
    -ethernet_segment_id_step    "00:00:00:00:00:00:00:00:00" \
    -ethernet_segment_route      false \
    -host_mac_start              "00:00:01:00:00:01" \
    -host_mac_step               1 \
    -host_mac_prefix             48 \
    -host_overlap                false \
    -route_mpls_label_type       site \
    -route_mpls_label_start      16 \
    -vlan_enable                 false \
    -host_vlan_id                100 \
    -host_vlan_id_step_per_evi     1 \
    -host_vlan_id_step_per_host    0 \
    -host_num_cust_vlans           1 \
    -host_num_core_vlans           1 \
    -vpn_host_assignment         hosts_per_ce \
    -total_hosts                   2 \
    -cust_hosts_per_ce             1 \
    -core_hosts_per_ce             1 \
    -isid_start                   1 \
    -isid_step                   1 \
    -isid_count                  1 \
    -bmac_assignment             per_evi \
    -cust_mac_addr               "00:00:01:00:00:01" \
    -cust_mac_addr_step          1 \
    -cust_mac_addr_prefix        48 \
    -cust_cmac_count             1 \
    -provider_mac_addr           "00:00:01:00:00:01" \
    -provider_mac_addr_step      1 \
    -provider_mac_addr_prefix    48 \
    -provider_cmac_count             1 \

Sample output:

{status 1} {handle {{vpn {vpnidgroup1 vpnidgroup2 vpnidgroup3 vpnidgroup4
vpnidgroup5 vpnidgroup6 vpnidgroup7 vpnidgroup8 vpnidgroup9 vpnidgroup10}}
{ce_router {emulateddevice21 emulateddevice22 emulateddevice23 emulateddevice24
emulateddevice25 emulateddevice26 emulateddevice27 emulateddevice28
emulateddevice29 emulateddevice30}} {p_router {}} {rr_router {}} {pe_router
{emulateddevice1 emulateddevice2 emulateddevice3 emulateddevice4
emulateddevice5 emulateddevice6 emulateddevice7 emulateddevice8 emulateddevice9
emulateddevice10 emulateddevice11 emulateddevice12 emulateddevice13
emulateddevice14 emulateddevice15 emulateddevice16 emulateddevice17
emulateddevice18 emulateddevice19 emulateddevice20}} {ospfv2 {}} {ospfv3 {}}
{isis {isisrouterconfig1 isisrouterconfig2 isisrouterconfig3 isisrouterconfig4
isisrouterconfig5 isisrouterconfig6 isisrouterconfig7 isisrouterconfig8
isisrouterconfig9 isisrouterconfig10}} {ldp {}} {rsvp {}} {bgp
{bgprouterconfig1 bgprouterconfig2 bgprouterconfig3 bgprouterconfig4
bgprouterconfig5 bgprouterconfig6 bgprouterconfig7 bgprouterconfig8
bgprouterconfig9 bgprouterconfig10}} {bfd {}} {stream_id {streamblock1
streamblock2}}}}

sth::emulation_evpn_control

Purpose

Spirent Extension (for Spirent HLTAPI only).

Starts or stops the specified EVPN topology

Synopsis

Note

M indicates that the argument is Mandatory .

sth::emulation_evpn_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 EVPN network

stop    Stops the specified EVPN 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

The sth::emulation_evpn_control function controls the configured EVPN topology. Use the -action argument to start or stop the test.

Examples

Sample Input:

sth::emulation_evpn_control \
    -port_handle $port1 port2 \
    -action start

Sample Output:

{status 1}

sth::emulation_evpn_info

Purpose

Spirent Extension (for Spirent HLTAPI only).

Retrieves statistics for the EVPN test

Synopsis

Note

M indicates that the argument is Mandatory .

sth::emulation_routing_mpls_info
    [-mode {rsvp|ldp|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 rsvp, ldp, isis, ospfv2, 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 rsvp:

EventInProgress                 Event in progress
TxPath                          Number of PATH messages sent
RxPath                          Number of PATH messages received
TxReservation                   Number of Reservation messages sent
RxReservation                   Number of Reservation messages received
TxPathError                     Number of PATH Error messages sent
RxPathError                     Number of PATH Error messages received
TxReservationError              Number of Reservation Error messages sent
RxReservationError              Number of Reservation Error messages received
TxReservationConfirmation       Number of Reservation Confirm messages sent
RxReservationConfirmation       Number of Reservation Confirm messages received
TxPathTeardown                  Number of PATH Tear Down messages sent
RxPathTeardown                  Number of PATH Tear Down messages received
TxReservationTeardown           Number of Reservation Tear Down messages sent
RxReservationTeardown           Number of Reservation Tear Down messages received
LspUpCount                      Number of LSPs in Up state
LspDownCount                    Number of LSPs in Down state
LspConnectingCount              Number of LSPs in Connecting state
MinLspSetupTime                 Minimum time (in ms) to set up an LSP on the session
MaxLspSetupTime                 Maximum time (in ms) to set up an LSP on the session
AvgLspSetupTime                 Average time (in ms) to set up an LSP on the session
LastTxReservationErrorCode      Reports the last Reservation Error message code sent
LastRxReservationErrorCode      Reports the last Reservation Error message code received
LastTxPathErrorCode             Reports the last PATH Error message code sent
LastRxPathErrorCode             Reports the last PATH Error message code received
TxHello                         Number of Hello packets sent
RxHello                         Number of Hello packets received
TxPathRecovery                  Number of PATH Recovery packets sent
RxPathRecovery                  Number of PATH Recovery packets received
EgressLspUpCount                Number of egress LSPs in Up state
TxNotify                        Number of Notify packets sent
RxNotify                        Number of Notify packets received
Timestamp                       Timestamp of the results

The following keys are returned when you specify -mode ldp:

TxDirectHellosCount             Number of direct Hellos sent
TxIpv4DirectHellosCount         Number of IPv4 direct Hellos sent
TxIpv6DirectHellosCount         Number of IPv6 direct Hellos sent
RxDirectHellosCount             Number of direct Hellos received
RxIpv4DirectHellosCount         Number of IPv4 direct Hellos received
RxIpv6DirectHellosCount         Number of IPV6 direct Hellos received
TxTargetedHellosCount           Number of targeted Hellos sent
TxIpv4TargetedHellosCount       Number of IPv4 targeted Hellos sent
TxIpv6TargetedHellosCount       Number of IPv6 targeted Hellos sent
RxTargetedHellosCount           Number of targeted Hellos received
RxIpv4TargetedHellosCount       Number of IPv4 targeted Hellos received
RxIpv6TargetedHellosCount       Number of IPv6 targeted Hellos received
LspUpCount                      Number of LSPs in Up state
NumLspDownCount                 Number of LSPs in Down state
TxKeepAliveCount                Number of Keepalives sent
RxKeepAliveCount                Number of Keepalives received
TxLabelRequestsCount            Number of Label Requests sent
RxLabelRequestsCount            Number of Label Requests received
TxLabelMappingCount             Number of Label Mapping messages sent
RxLabelMappingCount             Number of Label Mapping messages received
TxLabelAbortCount               Number of Label Abort requests sent
RxLabelAbortCount               Number of Label Abort requests received
TxLabelWithdrawCount            Number of Label Withdraw messages sent
RxLabelWithdrawCount            Number of Label Withdraw messages received
TxLabelReleaseCount             Number of Label Release messages sent
RxLabelReleaseCount             Number of Label Release messages received
TxNotificationCount             Number of Notification messages sent
RxNotificationCount             Number of Notification messages received
TxAddrWithdrawCount             Number of Address Withdraw messages sent
RxAddrWithdrawCount             Number of Address Withdraw messages received
TxNotifyCode                    Notification code sent in string format
RxNotifyCode                    Notification code received in string format
LdpSessionVersion               LDP session version

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:

ldp_summaryportxRouterUpCount             Number of LDP routers in Up state
ldp_summaryportxRouterDownCount           Number of LDP routers in Down state
ldp_summaryportxSessionDownCount          Number of LDP routers in SessionDown state
ldp_summaryportxSessionUpCount            Number of LDP routers in SessionUp state
ldp_summaryportxSessionFailedCount        Number of LDP routers in SessionFailed state
ldp_summaryportxSessionOpenCount          Number of LDP routers in SessionOpen state
ldp_summaryportxSessionConnectCount       Number of LDP routers in SessionConnect state
ldp_summaryportxSessionRestartCount       Number of LDP routers in SessionRestart state
ldp_summaryportxSessionHelperCount        Number of LDP routers in SessionHelper state

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

rsvp_summaryportxRouterUpCount         Number of routers in Up state
rsvp_summaryportxRouterDownCount       Number of routers in Down state
rsvp_summaryportxInitCount             Number of routers in INIT state
rsvp_summaryportxUpCount               Number of routers in Up state

rip_summaryportxRouterUpCount          Number of routers in Open state
rip_summaryportxRouterDownCount        Number of routers in NotStarted/Closed state

Description

The sth::emulation_evpn_info function provides information about the configured EVPN network topology.

Examples

The following example retrieves OSPFv2 statistics from a specified router:

sth::emulation_evpn_info \
   -handle $router_handles \
   -mode isis]

Sample output:

{status 1} {isis_results {{port1 {{emulateddevice1 {{TxPtpHelloCount 0}
{RxPtpHelloCount 0} {TxL1LanHelloCount 0} {RxL1LanHelloCount 0} {TxL1LspCount
0} {RxL1LspCount 0} {TxL1CsnpCount 0} {RxL1CsnpCount 0} {TxL1PsnpCount 0}
{RxL1PsnpCount 0} {TxL2LanHelloCount 2} {RxL2LanHelloCount 0} {TxL2LspCount 0}
{RxL2LspCount 0} {TxL2CsnpCount 0} {RxL2CsnpCount 0} {TxL2PsnpCount 0}
{RxL2PsnpCount 0} {AdjacencyLevel {Level 2}}}} {emulateddevice3
{{TxPtpHelloCount 0} {RxPtpHelloCount 0} {TxL1LanHelloCount 0}
{RxL1LanHelloCount 0} {TxL1LspCount 0} {RxL1LspCount 0} {TxL1CsnpCount 0}
{RxL1CsnpCount 0} {TxL1PsnpCount 0} {RxL1PsnpCount 0} {TxL2LanHelloCount 2}
{RxL2LanHelloCount 0} {TxL2LspCount 0} {RxL2LspCount 0} {TxL2CsnpCount 0}
{RxL2CsnpCount 0} {TxL2PsnpCount 0} {RxL2PsnpCount 0} {AdjacencyLevel {Level
2}}}} {emulateddevice5 {{TxPtpHelloCount 0} {RxPtpHelloCount 0}
{TxL1LanHelloCount 0} {RxL1LanHelloCount 0} {TxL1LspCount 0} {RxL1LspCount 0}
{TxL1CsnpCount 0} {RxL1CsnpCount 0} {TxL1PsnpCount 0} {RxL1PsnpCount 0}
{TxL2LanHelloCount 2} {RxL2LanHelloCount 0} {TxL2LspCount 0} {RxL2LspCount 0}
{TxL2CsnpCount 0} {RxL2CsnpCount 0} {TxL2PsnpCount 0} {RxL2PsnpCount 0}
{AdjacencyLevel {Level 2}}}} {emulateddevice7 {{TxPtpHelloCount 0}
{RxPtpHelloCount 0} {TxL1LanHelloCount 0} {RxL1LanHelloCount 0} {TxL1LspCount
0} {RxL1LspCount 0} {TxL1CsnpCount 0} {RxL1CsnpCount 0} {TxL1PsnpCount 0}
{RxL1PsnpCount 0} {TxL2LanHelloCount 2} {RxL2LanHelloCount 0} {TxL2LspCount 0}
{RxL2LspCount 0} {TxL2CsnpCount 0} {RxL2CsnpCount 0} {TxL2PsnpCount 0}
{RxL2PsnpCount 0} {AdjacencyLevel {Level 2}}}} {emulateddevice9
{{TxPtpHelloCount 0} {RxPtpHelloCount 0} {TxL1LanHelloCount 0}
{RxL1LanHelloCount 0} {TxL1LspCount 0} {RxL1LspCount 0} {TxL1CsnpCount 0}
{RxL1CsnpCount 0} {TxL1PsnpCount 0} {RxL1PsnpCount 0} {TxL2LanHelloCount 3}
{RxL2LanHelloCount 0} {TxL2LspCount 0} {RxL2LspCount 0} {TxL2CsnpCount 0}
{RxL2CsnpCount 0} {TxL2PsnpCount 0} {RxL2PsnpCount 0} {AdjacencyLevel {Level
2}}}} {emulateddevice11 {{TxPtpHelloCount 0} {RxPtpHelloCount 0}
{TxL1LanHelloCount 0} {RxL1LanHelloCount 0} {TxL1LspCount 0} {RxL1LspCount 0}
{TxL1CsnpCount 0} {RxL1CsnpCount 0} {TxL1PsnpCount 0} {RxL1PsnpCount 0}
{TxL2LanHelloCount 2} {RxL2LanHelloCount 0} {TxL2LspCount 0} {RxL2LspCount 0}
{TxL2CsnpCount 0} {RxL2CsnpCount 0} {TxL2PsnpCount 0} {RxL2PsnpCount 0}
{AdjacencyLevel {Level 2}}}} {emulateddevice13 {{TxPtpHelloCount 0}
{RxPtpHelloCount 0} {TxL1LanHelloCount 0} {RxL1LanHelloCount 0} {TxL1LspCount
0} {RxL1LspCount 0} {TxL1CsnpCount 0} {RxL1CsnpCount 0} {TxL1PsnpCount 0}
{RxL1PsnpCount 0} {TxL2LanHelloCount 2} {RxL2LanHelloCount 0} {TxL2LspCount 0}
{RxL2LspCount 0} {TxL2CsnpCount 0} {RxL2CsnpCount 0} {TxL2PsnpCount 0}
{RxL2PsnpCount 0} {AdjacencyLevel {Level 2}}}} {emulateddevice15
{{TxPtpHelloCount 0} {RxPtpHelloCount 0} {TxL1LanHelloCount 0}
{RxL1LanHelloCount 0} {TxL1LspCount 0} {RxL1LspCount 0} {TxL1CsnpCount 0}
{RxL1CsnpCount 0} {TxL1PsnpCount 0} {RxL1PsnpCount 0} {TxL2LanHelloCount 2}
{RxL2LanHelloCount 0} {TxL2LspCount 0} {RxL2LspCount 0} {TxL2CsnpCount 0}
{RxL2CsnpCount 0} {TxL2PsnpCount 0} {RxL2PsnpCount 0} {AdjacencyLevel {Level
2}}}} {emulateddevice17 {{TxPtpHelloCount 0} {RxPtpHelloCount 0}
{TxL1LanHelloCount 0} {RxL1LanHelloCount 0} {TxL1LspCount 0} {RxL1LspCount 0}
{TxL1CsnpCount 0} {RxL1CsnpCount 0} {TxL1PsnpCount 0} {RxL1PsnpCount 0}
{TxL2LanHelloCount 2} {RxL2LanHelloCount 0} {TxL2LspCount 0} {RxL2LspCount 0}
{TxL2CsnpCount 0} {RxL2CsnpCount 0} {TxL2PsnpCount 0} {RxL2PsnpCount 0}
{AdjacencyLevel {Level 2}}}} {emulateddevice19 {{TxPtpHelloCount 0}
{RxPtpHelloCount 0} {TxL1LanHelloCount 0} {RxL1LanHelloCount 0} {TxL1LspCount
0} {RxL1LspCount 0} {TxL1CsnpCount 0} {RxL1CsnpCount 0} {TxL1PsnpCount 0}
{RxL1PsnpCount 0} {TxL2LanHelloCount 2} {RxL2LanHelloCount 0} {TxL2LspCount 0}
{RxL2LspCount 0} {TxL2CsnpCount 0} {RxL2CsnpCount 0} {TxL2PsnpCount 0}
{RxL2PsnpCount 0} {AdjacencyLevel {Level 2}}}}}}}}