ISIS Functions¶
sth::emulation_isis_config¶
Purpose¶
Creates, enables, disables, modifies, or deletes an emulated IS-IS router on a Spirent TestCenter port. You can create one or more IS-IS routers. Each IS-IS-enabled port can emulate different types of routers: Level 1 (intra-area), Level 2 (inter-area), or Level 1-2 (both).
The Integrated Intermediate System to Intermediate System (IS-IS) protocol is a link state, Interior Gateway Protocol (IGP) for IP and Connectionless Network Protocol (CLNP). Routers (Intermediate Systems) use IS-IS to exchange routes within a single network (routing domain). Based on the Open System Interconnection (OSI) architecture, IS-IS functionality is similar to that of IP-based OSPF. Packets or datagrams are forwarded based on the best topological path through the network to the destination.
Synopsis¶
Note
- M indicates that the argument is Mandatory .
- S indicates the argument is for
scalingscenarios.
sth::emulation_isis_config [-mode {create|activate|modify|delete|enable|disable|active|inactive} M] [-handle <isis_session_handle|device_handle|all>] [-port_handle <port_handle|all>] [-area_id <string>] [-area2_id <hexadecimal>] [-area3_id <hexadecimal>] [-atm_encapsulation {0|1}] [-authentication_mode {none|simple|md5}] [-bfd_registration {1|0}] [-circuit_id <0-255>] [-count <integer>] [-disable_ip {true|false}] [-enable_isis_lsp {1|0}] [-enable_jumbo_llc {true|false}] [-expand <true|false> S] [-flood_delay <0-3000>] [-gateway_ip_addr <a.b.c.d> ] [-gateway_ip_addr_step <a.b.c.d> ] [-gateway_ipv6_addr <aaaa:bbbb:cccc:dddd:eeee:ffff:gggg:hhhh> ] [-gateway_ipv6_addr_step <aaaa:bbbb:cccc:dddd:eeee:ffff:gggg:hhhh>] [-graceful_restart {0|1} ] [-graceful_restart_restart_time <0-65535>] [-hello_interval <1-65535> ] [-hello_padding {true|false} ] [-holding_time <1-65535> ] [-host_name <string>] [-instance_id <0-65535>] [-mt_flags {obit|abit}] [-l1_metric <1-63>] [-l1_wide_metric <0-16777215>] [-l1_bd_unit {BYTES_PER_SEC|BITS_PER_SEC|MBYTES_PER_SEC}] [-l1_sub_tlv {NONE|GROUP|MAX_BW|MAX_RSV_BW|UNRESERVED|LOCAL_IP|REMOTE_IP| DEFAULT_METRIC|IPV6_LOCAL_IP|IPV6_REMOTE_IP| UNIDIRECTIONAL_LINK_DELAY|MIN_MAX_UNIDIRECTIONAL_LINK_DELAY| UNIDIRECTIONAL_DELAY_VARIATION|UNIDIRECTIONAL_LINK_LOSS| UNIDIRECTIONAL_RESIDUAL_BANDWIDTH| UNIDIRECTIONAL_AVAILABLE_BANDWIDTH| UNIDIRECTIONAL_UTILIZED_BANDWIDTH}] [-l1_te_default_metric <NUMERIC>] [-l1_te_group <1-4294967295>] [-l1_plsb_instance <0-255>] [-l1_plsb_link_attr <0-16777215>] [-l1_plsb_link_metric <0-16777215>] [-l1_te_max_bd <1-4294967295>] [-l1_te_ext_admin_group <integer>] [-l1_te_rsvr_bd <1-4294967295>] [-l1_te_un_rsvr_bd0 <1-4294967295>] [-l1_te_un_rsvr_bd1 <1-4294967295>] [-l1_te_un_rsvr_bd2 <1-4294967295>] [-l1_te_un_rsvr_bd3 <1-4294967295>] [-l1_te_un_rsvr_bd4 <1-4294967295>] [-l1_te_un_rsvr_bd5 <1-4294967295>] [-l1_te_un_rsvr_bd6 <1-4294967295>] [-l1_te_un_rsvr_bd7 <1-4294967295>] [-l2_metric <1-63>] [-l2_wide_metric <0-16777215>] [-l2_bd_unit {BYTES_PER_SEC|BITS_PER_SEC|MBYTES_PER_SEC}] [-l2_sub_tlv {NONE|GROUP|MAX_BW|MAX_RSV_BW|UNRESERVED|LOCAL_IP|REMOTE_IP| DEFAULT_METRIC|IPV6_LOCAL_IP|IPV6_REMOTE_IP| UNIDIRECTIONAL_LINK_DELAY|MIN_MAX_UNIDIRECTIONAL_LINK_DELAY| UNIDIRECTIONAL_DELAY_VARIATION|UNIDIRECTIONAL_LINK_LOSS| UNIDIRECTIONAL_RESIDUAL_BANDWIDTH| UNIDIRECTIONAL_AVAILABLE_BANDWIDTH| UNIDIRECTIONAL_UTILIZED_BANDWIDTH}] [-l2_te_default_metric <NUMERIC>] [-l2_te_group <1-4294967295>] [-l2_plsb_instance <0-255>] [-l2_plsb_link_attr <0-16777215>] [-l2_plsb_link_metric <0-16777215>] [-l2_te_max_bd <1-4294967295>] [-l2_te_ext_admin_group <integer>] [-l2_te_rsvr_bd <1-4294967295>] [-l2_te_un_rsvr_bd0 <1-4294967295>] [-l2_te_un_rsvr_bd1 <1-4294967295>] [-l2_te_un_rsvr_bd2 <1-4294967295>] [-l2_te_un_rsvr_bd3 <1-4294967295>] [-l2_te_un_rsvr_bd4 <1-4294967295>] [-l2_te_un_rsvr_bd5 <1-4294967295>] [-l2_te_un_rsvr_bd6 <1-4294967295>] [-l2_te_un_rsvr_bd7 <1-4294967295>] [-spb_link_metric <0-16777215>] [-spb_port_id <0-65535>] [-spb_port_num <1-255>] [-intf_type {broadcast | ptop}] [-intf_ip_addr <a.b.c.d> ] [-intf_ip_addr_step <a.b.c.d> ] [-intf_ip_prefix_length <1-32> ] [-intf_ipv6_addr <aaaa:bbbb:cccc:dddd:eeee:ffff:gggg:hhhh> ] [-intf_ipv6_addr_step <aaaa:bbbb:cccc:dddd:eeee:ffff:gggg:hhhh> ] [-intf_ipv6_prefix_length <1-128> ] [-intf_metric <0-16777215> ] [-link_local_ipv6_addr <aaaa:bbbb:cccc:dddd:eeee:ffff:gggg:hhhh> ] [-link_local_ipv6_addr_step <aaaa:bbbb:cccc:dddd:eeee:ffff:gggg:hhhh>] [-link_local_ipv6_prefix_len <0-128>] [-ip_version {4|6|4_6} ] [-ipv6_te_router_id <128-bit router ID>] [-l2_type_flags {plsb|l2mp|spb}] [-lsp_life_time <1-65535> ] [-lsp_level {L1|L2}] [-lsp_size <1-65535>] [-lsp_refresh_interval <1-65535> ] [-mac_address_start <aa:bb:cc:dd:ee:ff>] [-md5_key_id <0-255>] [-multi_topology {0| 2 | 0,2}] [-overloaded {0|1} ] [-psnp_interval <1-20>] [-password < password>] [-pdu_password <alphanumeric>] [-pdu_md5_key_id <0-255>] [-retrans_interval <1-100>] [-router_priority <0-127>] [-pdu_type {l1_hello|l2_hello|l1_area_pdus|l2_domain_pdus}] [-pdu_authentication_mode {none|simple|md5}] [-remaining_time <0-65535>] [-router_id <a.b.c.d>] [-router_id_step <integer>] [-ipv6_router_id <aaaa:bbbb:cccc:dddd:eeee:ffff:gggg:hhhh>] [-ipv6_router_id_step <aaaa:bbbb:cccc:dddd:eeee:ffff:gggg:hhhh>] [-routing_level {L1|L2|L1L2}] [-system_id {000000000000 - FFFFFFFFFFFF} [-system_id_step <integer>] [-te_admin_group <1-4294967295> ] [-te_enable {0|1} ] [-te_max_bw <1-2147383647> ] [-te_max_resv_bw <1-2147383647> ] [-te_router_id <a.b.c.d> ] [-te_router_id_step <a.b.c.d>] [-te_unresv_bw_priority0 <1-2147383647> ] [-te_unresv_bw_priority1 <1-2147383647> ] [-te_unresv_bw_priority2 <1-2147383647> ] [-te_unresv_bw_priority3 <1-2147383647> ] [-te_unresv_bw_priority4 <1-2147383647> ] [-te_unresv_bw_priority5 <1-2147383647> ] [-te_unresv_bw_priority6 <1-2147383647> ] [-te_unresv_bw_priority7 <1-2147383647> ] [-vci <0-65535>] [-vci_step <0-65535>] [-view_routes {true|false}] [-vlan {0|1}] [-vlan_cfi {0|1} ] [-vlan_id <0-4095> ] [-vlan_id_mode {fixed|increment} ] [-vlan_id_step <1-4094> ] [-vlan_outer_id <0-4095>] [-vlan_outer_id_mode {fixed|increment}] [-vlan_outer_id_step <1-4094>] [-vlan_outer_user_priority <0-7>] [-vlan_user_priority <0-7> ] [-vpi <0-255>] [-vpi_step <0-255>] [-wide_metrics {0|1|2} ] [-tunnel_handle <GRE_tunnel_handle>]
Arguments¶
-
-area_id¶ Identifies the area address to use for the IS-IS router. Because IS-IS can reside in more than one area, an ID can be up to 13 octets long (1 to 13), so you specify each ID as a string of 2 to 26 hexadecimal characters. (There must be an even number of hex characters.) The default area ID is 000001. The number of area IDs is vendor dependent.
-
-area2_id¶ Spirent Extension (for Spirent HLTAPI only).
Specifies an optional second area address
Dependency: -area_id
Values: 3-14 octet hexadecimal
Default: “” (empty string)
-
-area3_id¶ Spirent Extension (for Spirent HLTAPI only).
Specifies an optional third area address
Dependency: -area2_id
Values: 3-14 octet hexadecimal
Default: “” (empty string)
-
-atm_encapsulation¶ Specifies the Layer 2 encapsulation of the ATM protocol interface associated with the emulated router. Possible values are 0 and 1. If it is set to 0, it indicates the Layer 2 encapsulation to be used is Ethernet. If it is set to 1, it indicates the Layer 2 encapsulation to be used is ATM interface.
-
-authentication_mode¶ Spirent Extension (for Spirent HLTAPI only).
Specifies the type of authentication to be used. Possible values are:
none - No authentication. simple - Use simple authentication. The packet is authenticated by the receiving router if the password matches the authentication key that is included in the packet. This method provides little security because the authentication key can be learned by capturing packets. md5- Use the MD-5 key ID for authentication. The packet contains a cryptographic checksum, but not the authentication key itself. The receiving router performs a calculation based on the MD-5 algorithm and an authentication key ID. The packet is authenticated if the calculated checksum matches. This method provides a stronger assurance that routing data originated from a router with a valid authentication key.
-
-bfd_registration¶ Specifies to enable or disable Bidirectional Forwarding Detection (BFD) registration. Possible values are 1 (enable) and 0 (disable). The default is 0.
-
-circuit_id¶ Spirent Extension (for Spirent HLTAPI only).
Specifies the interface ID of the emulated router. This option is not available for broadcast networks.
Values: 0-255
Default: 1
-
-count¶ The number of emulated routers to create on the interface. Possible values are 0 to <max_int>. The default is 1.
-
-enable_isis_lsp¶ Spirent Extension (for Spirent HLTAPI only).
Specifies whether the isislspconfig object is created when you call the
sth::emulation_isis_configfunction. Possible values are 0 and 1. When set to 1, it indicates the isislspconfig object is created by default. The default is 1.
-
-enable_jumbo_llc¶ Spirent Extension (for Spirent HLTAPI only).
Determines whether to use a frame size above 1492 bytes
Values: true, false
Default: false
-
-expand¶ Spirent Extension (for Spirent HLTAPI only).
Determines whether to expand the specified ISIS device parameters into emulated ISIS device objects. It is used in
Scalingtest scenarios. Possible values are true and false.When it is set to true, a list of emulated device handles (handle_list) with enabled ISIS device configurations are created and returned
When it is set to false, only ISIS parameters are configured with no handle returned.
-
-flood_delay¶ Spirent Extension (for Spirent HLTAPI only).
Specifies the time that the Intermediate System (IS) waits (in milliseconds) after sending an LSP or Complete Sequence Number PDUs (CSNP), before sending updated LSPs or CSNPs on the same broadcast link
Values: 0-3000
Default: 33
-
-gateway_ip_addr¶ Spirent Extension (for Spirent HLTAPI only).
Configures the IPv4 gateway address of the IS-IS router. The default for OSPFv2 is 192.85.1.1.
-
-gateway_ip_addr_step¶ Spirent Extension (for Spirent HLTAPI only).
Configures the IPv4 gateway address for multiple routers. This argument is used with the -gateway_ip_addr argument.
-
-gateway_ipv6_addr¶ Spirent Extension (for Spirent HLTAPI only).
Configures the IPv6 gateway address of the IS-IS router.
-
-gateway_ipv6_addr_step¶ Spirent Extension (for Spirent HLTAPI only).
Configures the IPv6 gateway address for multiple routers. This argument is used with the -gateway_ip_addr argument.
-
-graceful_restart¶ Specifies if IS-IS graceful restart is enabled on the simulated router. Possible values are 1 (enable Graceful Restart) or 0 (disable Graceful Restart). The default is 0. See RFC 3847 for more information.
-
-graceful_restart_restart_time¶ Specifies the maximum amount of time, in seconds, that the router will wait for a graceful restart to complete. Possible values are 0-65535.
-
-handle¶ Specifies the IS-IS handle(s) to use. This argument is Mandatory for modify, delete, enable, disable, active and inactive modes. When -mode is set to create, Spirent HLTAPI creates IS-IS over the provided device. (Please refer to the description of the -mode argument for more information)
-
-hello_interval¶ Specifies the amount of time, in seconds, between transmitting Layer 1 and Layer 2 protocol data units (PDUs). Possible values range from 1 to 65535. The default is 3.
-
-hello_padding¶ Specifies whether to insert hello padding in Hello packets for IS-IS emulation. Possible values are true (enable) and false (disable). The default is true.
-
-holding_time¶ Specifies the maximum amount of time, in seconds, between receipt of Hello PDUs before the link is pronounced down. Possible values range from 1 to 65535. The default is 10.
-
-host_name¶ Spirent Extension (for Spirent HLTAPI only).
Specifies the host name of the emulated router
Values: string (1-255 characters)
Default: Spirent-1
-
-disable_ip¶ Spirent Extension (for Spirent HLTAPI only).
Determines whether to disable IP and use Layer 2 packets
Values: true (disable IP), false
Default: false
-
-intf_type¶ Defines the type of network attached to the interface. Possible values are:
broadcast - Defines the network attached to the interface is a broadcast network. ptop - Defines the network attached to the interface is a peer-to-peer (or P2P) network. A peer-to-peer computer network uses diverse connectivity between participants in a network and the cumulative bandwidth of network participants.
-
-intf_ip_addr¶ Specifies the IPv4 address of the interface for the IS-IS emulated router that will establish an adjacency with the DUT. The default is 0.0.0.0. Note that both the IPv4 and IPv6 addresses can be configured on the interface for IPv4_6.
-
-intf_ip_addr_step¶ Defines the increment used to generate IP addresses for emulated routers. Spirent HLTAPI increments the -intf_ip_addr value. You must specify the interface IP address step when the -count argument is greater than 1. The default increment is 0.
-
-intf_ip_prefix_length¶ Specifies the prefix length on the emulated router. Possible values for IPv4 addresses range from 1 to 32; the default is 24.
-
-intf_ipv6_addr¶ Specifies the IPv6 address of the interface for the IS-IS emulated router that will establish an adjacency with the DUT. The default is 0:0:0:0:0:0:0:0.
-
-intf_ipv6_addr_step¶ Defines the increment used to generate IP addresses for emulated routers. Spirent HLTAPI increments the -intf_ipv6_addr value. You must specify the interface IP address step when the -count argument is greater than 1. The range of possible values is 0 to <max_int>. The default is 0.
-
-intf_ipv6_prefix_length¶ Specifies the prefix length on the IPv6 emulated router, Possible values for IPv6 addresses range from 1 to 128; the default is 64.
-
-ipv6_te_router_id¶ Spirent Extension (for Spirent HLTAPI only).
Specifies a 16-byte router ID used to identify the emulated router in traffic engineering topologies
Values: 128-bit router ID
Default: null
-
-l1_metric¶ Spirent Extension (for Spirent HLTAPI only).
Specifies the metric of the Layer 1 emulated router interface
Values: 1-63
Default: 1
-
-l1_wide_metric¶ Spirent Extension (for Spirent HLTAPI only).
Specifies the 3-octet traffic engineering metric of the Layer 1 link from the emulated router to the DUT
Values: 0-16777215
Default: 1
-
-l1_bd_unit¶ Spirent Extension (for Spirent HLTAPI only).
Specifies the unit of bandwidth value of ISIS Level 1 TE parameters.
Default: BYTES_PER_SEC
Possible Values:
Value Description BITS_PER_SEC Bandwidth values are in bits per second. BYTES_PER_SEC Bandwidth values are in bytes per second. MBYTES_PER_SEC Bandwidth values are in mbytes per second.
-
-l1_sub_tlv¶ Spirent Extension (for Spirent HLTAPI only).
Specifies the ISIS TE sub-TLV flags of ISIS Level 1 TE parameters. Possible Values:
Value Description NONE None active. GROUP (Color) ? the 4-octet bit mask assigned
by the network administrator. Each bit corresponds to one administrative group assigned to the interface.- MAX_BW Maximum bandwidth that can be used on
- the link from the emulated router.
- MAX_RSV_BW Maximum bandwidth that can be reserved
- on the link from the emulated router.
- UNRESERVED Reservable bandwidth for priority
- levels 0 through 7.
LOCAL_IP Disabled (not configured in ISIS). REMOTE_IP Disabled (not configured in ISIS). DEFAULT_METRIC Default metric. IPV6_LOCAL_IP Disabled (not configured in ISIS). IPV6_REMOTE_IP Disabled (not configured in ISIS). UNIDIRECTIONAL_LINK_DELAY Unidirectional Link Delay MIN_MAX_UNIDIRECTIONAL_LINK_DELAY Min/Max Unidirectional Link Delay. UNIDIRECTIONAL_DELAY_VARIATION Unidirectional Delay Variation. UNIDIRECTIONAL_LINK_LOSS Unidirectional Link Loss. UNIDIRECTIONAL_RESIDUAL_BANDWIDTH Unidirectional Residual Bandwidth. UNIDIRECTIONAL_AVAILABLE_BANDWIDTH Unidirectional Available Bandwidth. UNIDIRECTIONAL_UTILIZED_BANDWIDTH Unidirectional Utilized Bandwidth.
-
-l1_te_default_metric¶ Spirent Extension (for Spirent HLTAPI only).
Specifies the TE default metric of ISIS Level 1 TE parameters.
Default: 0
-
-l1_te_group¶ Spirent Extension (for Spirent HLTAPI only).
Specifies the (Color) ? the 4-octet bit mask assigned by the network administrator. Each bit corresponds to one administrative group assigned to the interface. Value: 1 - 4294967295
Default: 1
-
-l1_plsb_instance¶ Spirent Extension (for Spirent HLTAPI only).
Specifies the PLSB instance of ISIS Level 1 TE parameters. Value: 0 - 255
Default: 0
-
-l1_plsb_link_attr¶ Spirent Extension (for Spirent HLTAPI only).
Specifies the PLSB instance link attributes of ISIS Level 1 TE parameters. Value: 0 - 16777215
Default: 0
-
-l1_plsb_link_metric¶ Spirent Extension (for Spirent HLTAPI only).
Specifies the PLSB instance link metric of ISIS Level 1 TE parameters. Value: 0 - 16777215
Default: 8388608
-
-l1_te_max_bd¶ Spirent Extension (for Spirent HLTAPI only).
Specifies the maximum bandwidth that can be reserved on the link from the emulated router of ISIS Level 1 TE parameters. Value: 1 - 4294967295
Default: 100000
-
-l1_te_ext_admin_group¶ Spirent Extension (for Spirent HLTAPI only).
Specifies the extended administrative group value of ISIS Level 1 TE parameters.
-
-l1_te_rsvr_bd¶ Spirent Extension (for Spirent HLTAPI only).
Specifies the bandwidth that can be reserved on the link from the emulated router of ISIS Level 1 TE parameters. Value: 1 - 4294967295
Default: 100000
-
-l1_te_un_rsvr_bd0¶ Spirent Extension (for Spirent HLTAPI only).
Specifies the reservable bandwidth for priority level 0 of ISIS Level 1 TE parameters. Value: 1 - 4294967295
Default: 100000
-
-l1_te_un_rsvr_bd1¶ Spirent Extension (for Spirent HLTAPI only).
Specifies the reservable bandwidth for priority level 1 of ISIS Level 1 TE parameters. Value: 1 - 4294967295
Default: 100000
-
-l1_te_un_rsvr_bd2¶ Spirent Extension (for Spirent HLTAPI only).
Specifies the reservable bandwidth for priority level 2 of ISIS Level 1 TE parameters. Value: 1 - 4294967295
Default: 100000
-
-l1_te_un_rsvr_bd3¶ Spirent Extension (for Spirent HLTAPI only).
Specifies the reservable bandwidth for priority level 3 of ISIS Level 1 TE parameters. Value: 1 - 4294967295
Default: 100000
-
-l1_te_un_rsvr_bd4¶ Spirent Extension (for Spirent HLTAPI only).
Specifies the reservable bandwidth for priority level 4 of ISIS Level 1 TE parameters. Value: 1 - 4294967295
Default: 100000
-
-l1_te_un_rsvr_bd5¶ Spirent Extension (for Spirent HLTAPI only).
Specifies the reservable bandwidth for priority level 5 of ISIS Level 1 TE parameters. Value: 1 - 4294967295
Default: 100000
-
-l1_te_un_rsvr_bd6¶ Spirent Extension (for Spirent HLTAPI only).
Specifies the reservable bandwidth for priority level 6 of ISIS Level 1 TE parameters. Value: 1 - 4294967295
Default: 100000
-
-l1_te_un_rsvr_bd7¶ Spirent Extension (for Spirent HLTAPI only).
Specifies the reservable bandwidth for priority level 7 of ISIS Level 1 TE parameters. Value: 1 - 4294967295
Default: 100000
-
-l2_metric¶ Spirent Extension (for Spirent HLTAPI only).
Specifies the metric for the Layer 2 emulated router interface
Values: 1-63
Default: 1
-
-l2_wide_metric¶ Spirent Extension (for Spirent HLTAPI only).
Specifies the 3-octet traffic engineering metric of the Layer 2 link from the emulated router to the DUT
Values: 0-16777215
Default: 1
-
-l2_bd_unit¶ Spirent Extension (for Spirent HLTAPI only).
Specifies the unit of bandwidth value of ISIS Level 2 TE parameters.
Default: BYTES_PER_SEC
Possible Values:
Value Description BITS_PER_SEC Bandwidth values are in bits per second. BYTES_PER_SEC Bandwidth values are in bytes per second. MBYTES_PER_SEC Bandwidth values are in mbytes per second.
-
-l2_sub_tlv¶ Spirent Extension (for Spirent HLTAPI only).
Specifies the ISIS TE sub-TLV flags of ISIS Level 2 TE parameters. Possible Values:
Value Description NONE None active. GROUP (Color) ? the 4-octet bit mask assigned
by the network administrator. Each bit corresponds to one administrative group assigned to the interface.- MAX_BW Maximum bandwidth that can be used on
- the link from the emulated router.
- MAX_RSV_BW Maximum bandwidth that can be reserved
- on the link from the emulated router.
- UNRESERVED Reservable bandwidth for priority
- levels 0 through 7.
LOCAL_IP Disabled (not configured in ISIS). REMOTE_IP Disabled (not configured in ISIS). DEFAULT_METRIC Default metric. IPV6_LOCAL_IP Disabled (not configured in ISIS). IPV6_REMOTE_IP Disabled (not configured in ISIS). UNIDIRECTIONAL_LINK_DELAY Unidirectional Link Delay MIN_MAX_UNIDIRECTIONAL_LINK_DELAY Min/Max Unidirectional Link Delay. UNIDIRECTIONAL_DELAY_VARIATION Unidirectional Delay Variation. UNIDIRECTIONAL_LINK_LOSS Unidirectional Link Loss. UNIDIRECTIONAL_RESIDUAL_BANDWIDTH Unidirectional Residual Bandwidth. UNIDIRECTIONAL_AVAILABLE_BANDWIDTH Unidirectional Available Bandwidth. UNIDIRECTIONAL_UTILIZED_BANDWIDTH Unidirectional Utilized Bandwidth.
-
-l2_te_default_metric¶ Spirent Extension (for Spirent HLTAPI only).
Specifies the TE default metric of ISIS Level 2 TE parameters.
Default: 0
-
-l2_te_group¶ Spirent Extension (for Spirent HLTAPI only).
Specifies the (Color) ? the 4-octet bit mask assigned by the network administrator. Each bit corresponds to one administrative group assigned to the interface. Value: 1 - 4294967295
Default: 1
-
-l2_plsb_instance¶ Spirent Extension (for Spirent HLTAPI only).
Specifies the PLSB instance of ISIS Level 2 TE parameters. Value: 0 - 255
Default: 0
-
-l2_plsb_link_attr¶ Spirent Extension (for Spirent HLTAPI only).
Specifies the PLSB instance link attributes of ISIS Level 2 TE parameters. Value: 0 - 16777215
Default: 0
-
-l2_plsb_link_metric¶ Spirent Extension (for Spirent HLTAPI only).
Specifies the PLSB instance link metric of ISIS Level 2 TE parameters. Value: 0 - 16777215
Default: 8388608
-
-l2_te_max_bd¶ Spirent Extension (for Spirent HLTAPI only).
Specifies the maximum bandwidth that can be reserved on the link from the emulated router of ISIS Level 2 TE parameters. Value: 1 - 4294967295
Default: 100000
-
-l2_te_ext_admin_group¶ Spirent Extension (for Spirent HLTAPI only).
Specifies the extended administrative group value of ISIS Level 2 TE parameters.
-
-l2_te_rsvr_bd¶ Spirent Extension (for Spirent HLTAPI only).
Specifies the bandwidth that can be reserved on the link from the emulated router of ISIS Level 2 TE parameters. Value: 1 - 4294967295
Default: 100000
-
-l2_te_un_rsvr_bd0¶ Spirent Extension (for Spirent HLTAPI only).
Specifies the reservable bandwidth for priority level 0 of ISIS Level 2 TE parameters. Value: 1 - 4294967295
Default: 100000
-
-l2_te_un_rsvr_bd1¶ Spirent Extension (for Spirent HLTAPI only).
Specifies the reservable bandwidth for priority level 1 of ISIS Level 2 TE parameters. Value: 1 - 4294967295
Default: 100000
-
-l2_te_un_rsvr_bd2¶ Spirent Extension (for Spirent HLTAPI only).
Specifies the reservable bandwidth for priority level 2 of ISIS Level 2 TE parameters. Value: 1 - 4294967295
Default: 100000
-
-l2_te_un_rsvr_bd3¶ Spirent Extension (for Spirent HLTAPI only).
Specifies the reservable bandwidth for priority level 3 of ISIS Level 2 TE parameters. Value: 1 - 4294967295
Default: 100000
-
-l2_te_un_rsvr_bd4¶ Spirent Extension (for Spirent HLTAPI only).
Specifies the reservable bandwidth for priority level 4 of ISIS Level 2 TE parameters. Value: 1 - 4294967295
Default: 100000
-
-l2_te_un_rsvr_bd5¶ Spirent Extension (for Spirent HLTAPI only).
Specifies the reservable bandwidth for priority level 5 of ISIS Level 2 TE parameters. Value: 1 - 4294967295
Default: 100000
-
-l2_te_un_rsvr_bd6¶ Spirent Extension (for Spirent HLTAPI only).
Specifies the reservable bandwidth for priority level 6 of ISIS Level 2 TE parameters. Value: 1 - 4294967295
Default: 100000
-
-l2_te_un_rsvr_bd7¶ Spirent Extension (for Spirent HLTAPI only).
Specifies the reservable bandwidth for priority level 7 of ISIS Level 2 TE parameters. Value: 1 - 4294967295
Default: 100000
-
-spb_link_metric¶ Spirent Extension (for Spirent HLTAPI only).
Specifies the link metric. Value: 0 - 16777215
Default: 10
-
-spb_port_num¶ Spirent Extension (for Spirent HLTAPI only).
Specifies the Number of Ports Value: 1 - 255
Default: 1
-
-spb_port_id¶ Spirent Extension (for Spirent HLTAPI only).
Specifies the Port Identifier Value: 0 - 65535
Default: 0
-
-link_local_ipv6_addr¶ Spirent Extension (for Spirent HLTAPI only).
Specifies the starting link local IPv6 address for emulated routers. The value must be in IPv6 format. The default value is FE80::0.
-
-link_local_ipv6_addr_step¶ Spirent Extension (for Spirent HLTAPI only).
Specifies the difference between link local IPv6 addresses of consecutive routers when multiple emulated routers are created. The value must be in IPv6 format. The default value is ::1.
-
-link_local_ipv6_prefix_len¶ Spirent Extension (for Spirent HLTAPI only).
Specifies the prefix length for the link local IPv6 address of the emulated router. Possible values range from 0 to 128. The default is 64.
-
-intf_metric¶ The cost metric associated with the route. Possible values for wide metrics range from 1 to 16777214. Possible values for narrow metrics range from 1 to 63. See -wide_metrics for more information.
-
-ip_version¶ Specifies the IP version of the IS-IS emulated router. Possible values are 4 (for IPv4 address format), 6 (for IPv6 address format), or 4_6 for both IPv4 and IPv6 address formats. The default is 4. If you specify 4_6, wide metrics (see -wide_metrics) are automatically enabled.
-
-instance_id¶ Spirent Extension (for Spirent HLTAPI only).
Specifies the ID of the IS-IS instance
Values: 0-65535
Default: 0
-
-l2_type_flags¶ Spirent Extension (for Spirent HLTAPI only).
Specifies the Layer 2 link type
Values:
plsb Provider Link State Bridging (PLSB) l2mp Layer 2 Multi Path (L2MP) spb Shortest Path Bridge (SPB)
-
-lsp_life_time¶ Specifies the remaining lifetime (in seconds) of the LSP. Possible values range from 1 to 65535. The default is 1200.
-
-lsp_level¶ Spirent Extension (for Spirent HLTAPI only).
Specifies the level supported by the LSP. Possible values are L1 and L2. The default is L2 when -routing_level is L2 or L1L2, or L1 when -routing level is L1. Use this argument to specify the level to use to create the links.
-
-lsp_refresh_interval¶ Specifies the rate, in seconds, at which LSPs are re-sent. Possible values range from 1 to 65535. The default is 900.
-
-lsp_size¶ Spirent Extension (for Spirent HLTAPI only).
Specifies the maximum size of a link state PDU
Dependency: -enable_jumbo_llc false
Values: 1-65535
Default: 1492
-
-mac_address_start¶ Spirent Extension (for Spirent HLTAPI only).
Initial MAC address of the interfaces created for the IS-IS neighbor configuration.
-
-md5_key_id¶ Spirent Extension (for Spirent HLTAPI only).
Indicates MD5 authentication key used by MD5 authentication. Possible values range from 0 to 255. The default value is 1. You can specify this option when the -authentication_mode argument is set to “md5”.
-
-mode¶ Specifies the action to perform. Possible values are create, enable, disable, modify, delete, active and inactive. This argument is mandatory. The modes are described below: :
- activate
Enables ISIS devices and configures ISIS parameters for the devices created via the sth::interface_config function. This mode requires the value of param_handle as the input to the -handle option. Use this mode for
Scalingscenarios. Refer to -count and -expand options under thesth::interface_configfunction for more information. For this mode, only the following set of options are valid:area_id hello_padding ip_version routing_level system_id_step graceful_restart wide_metrics bfd_registration intf_type system_id system_id_step authentication_mode password md5_key_id
Creates devices and enables ISIS protocol. Requires -port_handle and -block_mode options. For this mode, the following options are required/supported along with the options specified above:
-block_mode -block_mode_index -mac_addr -mac_addr_step -mac_addr_step_per_port -mac_addr_step_per_vlan -ip_step_per_port -ip_step_per_vlan -intf_ipv6_prefix_len -ipv6_step_per_port -ipv6_step_per_vlan -link_local_ipv6_step_per_port -link_local_ipv6_step_per_vlan -name -vlan_user_pri -vlan_id_count -vlan_outer_id_count -vlan_outer_user_pri -intf_prefix_len -router_id_ipv6 -router_id_ipv6_step
Note
Please refer to the emulation_device_config documentation.
- create
- Creates and starts IS-IS router. When -port_handle is provided, Spirent HLTAPI creates one or more emulated routers that are associated with the specified port.
- enable
- Creates and starts one or more IS-IS routers on the port specified with the -port_handle argument. You must specify the -port_handle argument.
- disable
- Deletes all of the IS-IS routers from the port specified in the -handle argument. You must specify the -handle argument.
- modify
- Changes the configuration for the IS-IS router identified by the -handle argument. You must specify the -handle argument.
- delete
- Deletes all of the IS-IS routers from the port specified in the -handle argument. You must specify the -handle argument.
- active
- Enables the ISIS router specified by the -handle argument. You must specify a valid IS-IS session handle.
- inactive
- Disables the IS-IS router specified by the -handle argument. You must specify a valid IS-IS session handle. The configuration for the router is retained, when it is inactive and is available as configured if the router is active.
Note
- When -handle is provided for the create mode, the following
- options will be obsoleted:
-count -mac_address_start -intf_ip_addr -intf_ip_addr_step -intf_ip_prefix_length -ip_version -vlan -gateway_ip_addr -gateway_ip_addr_step -gateway_ip_addr -router_id -router_id_step -vci -vci_step -vlan_cfi -vlan_id -vlan_id_mode -vlan_id_step -vlan_user_priority -vpi -vpi_step -tunnel_handle -vlan_outer_id -vlan_outer_id_mode -vlan_outer_id_step -vlan_outer_user_priority -intf_ipv6_addr -intf_ipv6_addr_step -intf_ipv6_prefix_length -gateway_ipv6_addr -gateway_ipv6_addr_step
-
-mt_flags¶ Spirent Extension (for Spirent HLTAPI only).
Specifies the multi-topology flag
Values:
obit OBIT (Overload bit-0) abit ABIT (Attached bit-1)
-
-multi_topology¶ Spirent Extension (for Spirent HLTAPI only).
Specifies the topology identifier. Possible values are 0, 2 and 0,2. When you set the value to 0, only IPv4 routing topology is supported. When you set the value to 2, only IPv6 routing topology is supported. When you set the value to 0,2, both IPv4 and IPv6 routing topologies are supported. The default value is 0.
-
-overloaded¶ Sets the LSP database overload bit. This bit indicates that the LSP database on this router does not have enough memory to store a received LSP (that is, the simulated router is overloaded). Routers receiving an LSP with this bit set to 1 will not use the originating router as a transit router. They will destined to the overloaded router’s directly connected networks. Possible values are 0 (not overloaded) and 1 (overloaded). The default is 0.
-
-pdu_type¶ Spirent Extension (for Spirent HLTAPI only).
Specifies the PDU type for the authentication
Values:
l1_hello Layer 1 Hello PDUs l2_hello Layer 2 Hello PDUs l1_area_pdus Layer 1 Area PDUs l2_domain_pdus Layer 2 Domain PDUs
-
-pdu_authentication_mode¶ Spirent Extension (for Spirent HLTAPI only).
Specifies the type of per PDU authentication to be used
Values: none, simple, md5
-
-pdu_password¶ Spirent Extension (for Spirent HLTAPI only).
Specifies the password for the per PDU authentication
Dependency: -pdu_authentication_mode simple or
-pdu_authentication_mode md5Values: 1-16 alphanumeric for MD5 mode
1-253 alphanumeric for simple modeDefault: null
-
-pdu_md5_key_id¶ Spirent Extension (for Spirent HLTAPI only).
Specifies the MD5 key for the per PDU authentication
Dependency: -pdu_authentication_mode md5
Values: 0-255
Default: null
-
-port_handle¶ Specifies the handle of the port on which to create the IS-IS router.
-
-psnp_interval¶ Specifies the minimum period between sending Partial Sequence Number PDUs over the interface when the session router is the DR. Possible values are 1 to 20. The default is 10.
-
-password¶ Spirent Extension (for Spirent HLTAPI only).
You can specify this argument when -authentication_mode is set to “simple” or “md5”. Possible values are alphanumeric characters. The length of the values ranges from 1 to 253 in simple mode, while the length of the values ranges from 1 to 16 in md5 mode. The default value is “Spirent”.
-
-remaining_time¶ Spirent Extension (for Spirent HLTAPI only).
Specifies the allowable duration for a graceful restarting router to recover. If the value is not set or is set to 0, the emulated router will calculate this value based upon the expiry of the adjacency.
Values: 0-65535
Default: null
-
-retrans_interval¶ Spirent Extension (for Spirent HLTAPI only).
Specifies the number of seconds that the IS waits between successive retransmissions of the same LSP on the point-to-point link. This argument is not available for Ethernet.
Values: 1-100
Default: 5
-
-router_priority¶ Spirent Extension (for Spirent HLTAPI only).
Specifies the priority of the router used for election as a designated intermediate system
Dependency: -intf_type broadcast
Values: 0-127
Default:0
-
-router_id¶ Specifies the router ID of the emulated IS-IS router.
-
-router_id_step¶ Specifies the difference between router IDs of consecutive routers when multiple IS-IS routers are created with the -count argument. In the Spirent implementation, this step value is used as the step for -system_id. Possible values are 0 to max_int. The default is 1.
-
-ipv6_router_id¶ Specifies the IPv6 Router ID. The value must be in IPv6 format. The default is 2000::1
-
-ipv6_router_id_step¶ Specifies the IPv6 Router ID Step. The value must be in IPv6 format. The default is 0000::1
-
-routing_level¶ Specifies the supported routing level: L1 only, L2 only, or both L1 and L2 (L1L2). Routing information is exchanged between Level 1 routers and other Level 1 routers. Level 2 routers only exchange information with other Level 2 routers. Level 1-2 routers exchange information with both levels and are used to connect the inter-area routers with the intra-area routers. Possible values are L1, L2, or L1L2. The default is L1L2. Use this argument to specify the level to use to create the adjacency.
-
-system_id¶ Specifies the unique system ID used to identify an emulated router. A system ID is typically six-octet long; therefore, you specify each system ID as a string of 12 hexadecimal characters. Possible values range from 000000000000 to FFFFFFFFFFFF. The default is 0x0200+intf_ip in hex.
-
-system_id_step¶ Defines the step size in which the system ID (-system_id) is incremented. The default value is 1. You can use this argument if the value of -count is larger than 1.
-
-te_admin_group¶ Specifies the administrative group of the traffic engineering link. Possible values range from 1 to 4294967295. The default is 1.
-
-te_enable¶ Enables or disables traffic engineering (TE) on all links. Possible values are 0 and 1. The default is 0 (disable).
-
-te_max_bw¶ Specifies the maximum bandwidth of the traffic engineering link. Possible values range from 1 to 2147483647. The default is 100000 bytes per second.
-
-te_max_resv_bw¶ Specifies the maximum bandwidth that can be reserved for the traffic engineering link. Enter a floating point value. The default is 100000 bytes per second. Possible values range from 1 to 4294967295.
-
-te_router_id¶ Specifies the TE router ID. The default is 0.0.0.0.
-
-te_router_id_step¶ Defines the step size in which the TE router ID (-te_router_id ) is incremented. The default is 0.0.0.1.
-
-te_unresv_bw_priority0¶ Specifies the amount of bandwidth not yet reserved at priority level 0. The values corresponds to the bandwidth that can be reserved with a setup priority of 0 through 7. Arranged in ascending order, priority 0 occurs at the start of the sub-TLV and priority 7 at the end. The initial values, before any bandwidth is reserved, are all set to the value specified for the maximum reservable bandwidth (-te_max_resv_bw). Each value will be less than or equal to the maximum reservable bandwidth. The default is 100000 bytes per second.
-
-te_unresv_bw_priority1¶ Specifies the amount of bandwidth not yet reserved at priority level 1. The default is 100000 bytes per second.
-
-te_unresv_bw_priority2¶ Specifies the amount of bandwidth not yet reserved at priority level 2. The default is 100000 bytes per second.
-
-te_unresv_bw_priority3¶ Specifies the amount of bandwidth not yet reserved at priority level 3. The default is 100000 bytes per second.
-
-te_unresv_bw_priority4¶ Specifies the amount of bandwidth not yet reserved at priority level 4. The default is 100000 bytes per second.
-
-te_unresv_bw_priority5¶ Specifies the amount of bandwidth not yet reserved at priority level 5. The default is 100000 bytes per second.
-
-te_unresv_bw_priority6¶ Specifies the amount of bandwidth not yet reserved at priority level 6. The default is 100000 bytes per second.
-
-te_unresv_bw_priority7¶ Specifies the amount of bandwidth not yet reserved at priority level 7. The default is 100000 bytes per second.
-
-vci¶ Specifies the VCI of the first ATM PVC pool. Possible values range from 0 to 65535. You can use this argument when -atm_encapsulation is set to 1.
-
-vci_step¶ Specifies the step size in which the VCI value is incremented. Possible values range from 0 to 65535. You can use this argument when -atm_encapsulation is set to 1.
-
-view_routes¶ Spirent Extension (for Spirent HLTAPI only).
Determines whether to view received ISIS LSPs and routes for a router
Values: true, false
Default: false
-
-vlan¶ Disables or enables VLAN on the traffic generation tool interfaces. Possible values are 0 (disabled) and 1 (enabled). The default is 0. You can use this argument when -mode is create.
-
-vlan_cfi¶ Sets the canonical format indicator field in VLAN for the emulated router node. Possible values are 0 (Ethernet) and 1 (Token Ring). The default is 1. If set to 0, it indicates the network is Ethernet. If set to 1, it indicates that Token Ring and packets are dropped by Ethernet ports. You can use this argument only when -vlan is set to 1.
-
-vlan_id¶ Specifies the VLAN ID of the first VLAN sub-interface. Possible values range from 0 to 4095. The default is 1. When the mode is either “create” or “enable”, Spirent HLTAPI checks for a VLAN object on the port with the given VLAN ID. If no VLAN object with that ID exists, Spirent HLTAPI creates a VLAN object with the specified VLAN ID. You can use this argument only when -vlan is set to 1.
-
-vlan_id_mode¶ If you configure more than one interface on Spirent HLTAPI with VLAN, you can choose to either automatically increment the VLAN tag (mode “increment”) or leave it idle for each interface (mode “fixed”). If you set this argument to “increment”, then you must also specify the -vlan_id_step argument to indicate the step size. The default is increment. You can use this argument when -vlan is set to 1.
-
-vlan_id_step¶ The step size by which the VLAN value is incremented when you set -vlan_id_mode to “increment”. Possible values range from 1 to 4094. You must specify the step when the -count argument is greater than 1. The default is 1. You can use this argument only when -vlan is set to 1.
-
-vlan_outer_id¶ Spirent Extension (for Spirent HLTAPI only).
The outer VLAN ID of VLAN sub-interface. Possible values range from 0 to 4095. The default is 1. When you use -vlan_outer_id, you must specify -vlan_id.
-
-vlan_outer_id_mode¶ Spirent Extension (for Spirent HLTAPI only).
Specifies how Spirent TestCenter assigns VLAN tags to packets in the specified outer header when router count is greater than 1. Possible values are:
fixed - The outer VLAN ID is the same for all packets. The fixed outer VLAN ID is the value of the -vlan_outer_id argument. increment - For all packets, the outer VLAN tag ID increments by the step specified in the -vlan_outer_id_step argument.
-
-vlan_outer_id_step¶ Spirent Extension (for Spirent HLTAPI only).
The amount by which to increment the specified outer VLAN ID (-vlan_outer_id) for subsequent packets. Possible values range from 1 to 4094. You must specify this step when you specify “increment” for the -vlan_outer_id_mode argument.
-
-vlan_outer_user_priority¶ Spirent Extension (for Spirent HLTAPI only).
Specifies the VLAN priority to assign to the outer header. Possible values range from 0 to 7. The default is 0.
-
-vlan_user_priority¶ VLAN priority for the VLANs on this port. Possible values range from 0 to 7. The default is 0. You can use this argument only when -vlan is set to 1.
-
-vpi¶ Specifies the VPI of the first ATM PVC pool (for an ATM connection). Possible values are 0 to 255. You can use this argument only when -atm_encapsulation is set to 1.
-
-vpi_step¶ Specifies the step size in which the VPI value is incremented. Possible values are 0 to 255. You can use this argument only when -atm_encapsulation is set to 1.
-
-wide_metrics¶ Specifies the route type to be advertised by the router. Possible values are:
0 Router advertises routes with a narrow (6-bit) metric 1 Router advertises the same route with both metrics 2 Router advertises routes with a wide (24 or 32-bit) metric
The default value is 1.
-
-tunnel_handle¶ Specifies the GRE tunnel handle, an array value, initialized by the emulation_gre_config command. The router sends traffic through this tunnel.
Arguments Unsupported by Save as HLTAPI¶
The following Spirent HLTAPI arguments are currently not supported by the Save as HLTAPI function:
-enable_isis_lsp
Cisco-specific Arguments¶
The following arguments are specific to the Cisco HLTAPI but are not supported by Spirent HLTAPI:
-area_authentication_mode
-area_id_step
-area_password
-attach_bit
-csnp_interval
-discard_lsp
-domain_authentication_mode
-domain_password
-graceful_restart_mode
-hello_password
-interface_handle
-l1_router_priority
-l2_router_priority
-loopback_bfd_registration
-loopback_hello_password
-loopback_ip_addr
-loopback_ip_addr_count
-loopback_ip_addr_step
-loopback_ip_prefix_length
-loopback_l1_router_priority
-loopback_l2_router_priority
-loopback_te_admin_group
-loopback_te_max_bw
-loopback_te_max_resv_bw
-loopback_te_metric
-loopback_te_unresv_bw_priority0
-loopback_te_unresv_bw_priority1
-loopback_te_unresv_bw_priority2
-loopback_te_unresv_bw_priority3
-loopback_te_unresv_bw_priority4
-loopback_te_unresv_bw_priority5
-loopback_te_unresv_bw_priority6
-loopback_te_unresv_bw_priority7
-loopback_metric
-loopback_routing_level
-loopback_type
-max_packet_size
-multi_topology
-partition_repair
-te_metric
Vendor Specific Arguments Processed by Spirent HLTAPI Wrapper¶
-
-area_authentication_mode¶ Specifies the area authentication mode. Possible values are none, text and md5. The default is none.
-
-mac_address_init¶ MAC address that will be configured on the interface
Vendor Specific Arguments Ignored by Spirent HLTAPI Wrapper¶
-attach_bit
-domain_authentication_mode
-graceful_restart_mode
-graceful_restart_version
-l1_router_priority
-l2_router_priority
-max_packet_size
-partition_repair
-te_metric
-discard_lsp
Note
For more information about Spirent HLTAPI Wrapper, refer to Chapter 4 Spirent HLTAPI Wrapper in Spirent HLTAPI Programmer’s Reference.
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
- The handle that identifies the IS-IS router created by the
sth::emulation_isis_configfunction when you use “-mode create” or “-mode enable” to create a new IS-IS router. When you want to modify, disable, or delete an IS-IS router, you specify the handle as the value to the -handle argument. - handle_list
- A list of emulated devices enabled with IS-IS router configured by the
sth::emulation_isis_configfunction when expand is set true. - session_router
- The handle of the router used in this IS-IS session.
- status
- Success (1) or failure (0) of the operation.
- log
- An error message (if the operation failed).
- neighbor.<neighbor_handle>.area_id
- The area to which the router belongs. Not supported.
- neighbor.<neighbor_handle>.system_id
- The unique ID number of the system to which the router belongs. Not supported.
- neighbor.<neighbor_handle>.pseudonode_num
- The unique ID number of the neighboring virtual router.
- Not supported.
- neighbor.<neighbor_handle>.intf_ip_addr
- The IPv4 address of the interface for the IS-IS emulated router. Not supported.
- neighbor.<neighbor_handle>.intf_ipv6_addr
- The IPv6 address of the interface for the IS-IS emulated router. Not supported.
- link_local_ipv6_addr
- The IPv6 address of the local interface for this link. Not supported.
- link_local_ipv6_prefix_length
- The IPv6 prefix length for the local interface for this link. Not supported.
- pseudonode_num
- The unique ID number of the current virtual router. Not supported.
Description¶
The sth::emulation_isis_config function creates, enables,
disables, modifies, or deletes IS-IS routers from the specified port. Use
the -mode argument to specify the action to perform. (See the -mode
argument description for information about the actions.)
When you create an IS-IS router, use the -port_handle argument to specify the port handle that the emulated router will use. (The port handle value is contained in the keyed list returned by the connect function.)
In addition to specifying the port (-port_handle), you must also provide the following arguments when you create an IS-IS router:
-mode create
-intf_ip_addr
-router_id
-area_id
-system_id
When you create a router, Spirent HLTAPI automatically starts the router communication.
Each emulated router establishes adjacency with the neighboring SUT. Spirent HLTAPI uses the Hello protocol to discover neighbors and, on broadcast links, to elect a designated router, according to IS-IS specifications.
Each Spirent HLTAPI test module hosts an IS-IS stack capable of emulating multiple IS-IS routers per port.
Once you start an IS-IS session by creating routers, Spirent HLTAPI
handles all of the messages for the emulated routers. During the test, you
can use the sth::emulation_isis_control function to stop and re-start
individual routers. To stop and start all of the routers associated with a
particular port, use the disable and enable modes with the
sth::emulation_isis_config function. After you have created the routers for
your test, use the sth::emulation_isis_topology_route_config function to
set up routes.
Examples¶
#### HLTAPI for Tcl ####
The following example creates and starts an IS-IS IPv4 configuration:
sth::emulation_isis_config -count 1 \
-graceful_restart 0 \
-graceful_restart_restart_time 33 \
-hello_interval 15 \
-holding_time 40 \
-intf_ip_addr 192.168.1.6 \
-intf_ip_addr_step 0.0.0.2 \
-intf_ip_prefix_length 24 \
-intf_metric 5 \
-ip_version 4 \
-lsp_refresh_interval 3 \
-port_handle $port_handle1 \
-psnp_interval 20 \
-router_id_step 0.0.0.1 \
-routing_level L2 \
-te_admin_group 1 \
-te_max_bw 2000 \
-te_max_resv_bw 2000 \
-te_unresv_bw_priority1 1234 \
-system_id 1234567890ab \
-system_id_step 16 \
-te_router_id 11.11.11.11 \
-te_router_id_step 0.0.0.1 \
-vlan 1 \
-vlan_id 5 \
-vlan_user_priority 2 \
-wide_metrics 1 \
- intf_type ptop \
-mode create
Sample Output:
{{status $SUCCESS | $FAILURE}
{handle <ISIS_session_handle>}
{session_router <session_router_handle>}}
The following example enables IS-IS over a provided device:
puts "Config LDP--------------------"
set routerStatus [sth::emulation_ldp_config -mode create \
-port_handle $port1Handle \
-intf_ip_addr 13.25.0.2\
-loopback_ip_addr 13.25.0.1 \
-gateway_ip_addr 13.25.0.1\
-remote_ip_addr 13.25.0.2 \
-graceful_recovery_timer 55 \
-keepalive_interval 56 \
-reconnect_time 57 \
-recovery_time 58 \
-egress_label_mode exnull \
-label_adv on_demand \
-bfd_registration 1 \
]
puts "LDP: $routerStatus"
keylget routerStatus handle router
puts "Config IS-IS--------------------"
set routerStatus [sth::emulation_isis_config \
-handle $router\
-mode create \
-ip_version 4 \
-area_id 000000000001 \
]
puts "IS-IS: $routerStatus"
Sample output for example shown above:
Config LDP--------------------
LDP: {handle router1} {handles router1} {status 1}
Config IS-IS--------------------
IS-IS: {handle router1} {handles router1} {session_router isislspconfig1}
{status 1}
The following example stops and deletes the routers from the specified port:
sth::emulation_isis_config -handle $isisSessionHandle -mode delete
Sample input for the Scaling mode(activate) with -expand on -handle:
set hnd [keylget int_ret0 param_handle]
# param_handle returned from sth::interface_config
puts "Param List: $int_ret0"
set isis_ret [sth::emulation_isis_config \
-mode activate\
-handle $int_ret0 \
-area_id 000001\
-hello_padding true\
-ip_version 4\
-routing_level L2\
-system_id_step 00:00:00:00:00:01\
-graceful_restart 1\
-wide_metrics 2\
-bfd_registration 0\
-intf_type broadcast\
-expand true\
Sample Output:
{handle_list {emulateddevice1 emulateddevice2 emulateddevice3
emulateddevice4 emulateddevice5}} {handle {}} {status 1}
Sample input for the Scaling mode(activate) with -expand, -port_handle and -block_mode:
set isis_ret [sth::emulation_isis_config \
-mode activate\
-port_handle $port1 \
-block_mode ONE_DEVICE_PER_BLOCK\
-block_name_index 1\
-count 5\
-intf_ip_addr 11.111.11.11 \
-area_id 000001\
-hello_padding true\
-ip_version 4\
-routing_level L2\
-system_id_step 00:00:00:00:00:01\
-graceful_restart 1\
-wide_metrics 2\
-bfd_registration 0\
-intf_type broadcast\
-expand true\
Sample Output:
{param_handle emulateddevicegenparams1} {status 1} {handle_list
{emulateddevice1 emulateddevice2 emulateddevice3 emulateddevice4
emulateddevice5}} {handle {}}
#### HLTAPI for Python ####
The following example creates and starts an IS-IS IPv4 configuration:
device_ret0 = sth.emulation_isis_config (
mode = 'enable',
lsp_level = 'L2',
overloaded = '0',
lsp_life_time = '1200',
te_enable = '1',
te_unresv_bw_priority0= '100000',
te_unresv_bw_priority1= '100000',
te_unresv_bw_priority2= '100000',
te_unresv_bw_priority3= '100000',
te_unresv_bw_priority4= '100000',
te_unresv_bw_priority5= '100000',
te_unresv_bw_priority6= '100000',
te_unresv_bw_priority7= '100000',
authentication_mode = 'none',
intf_metric = '1',
port_handle = port_handle[0],
intf_ipv6_addr = '2000::2',
intf_ipv6_prefix_length= '64',
gateway_ipv6_addr = '2000::2',
router_id = '192.0.0.1',
mac_address_start = '00:10:94:00:00:01',
intf_ip_prefix_length= '24',
intf_ip_addr = '12.85.1.3',
gateway_ip_addr = '12.85.1.1',
hello_interval = '10',
ip_version = '4_6',
graceful_restart_restart_time= '3',
routing_level = 'L2',
lsp_refresh_interval= '900',
psnp_interval = '2',
intf_type = 'broadcast',
holding_time = '3',
graceful_restart = '0',
wide_metrics = '1',
hello_padding = 'true',
area_id = '000001');
Sample Output:
{'status': '1', 'handles': 'router1', 'handle': 'router1',
'session_router': 'isislspconfig1'}
#### HLTAPI for Perl ####
The following example creates and starts an IS-IS IPv4 configuration:
my %device_ret0 = sth::emulation_isis_config (
mode => 'enable',
lsp_level => 'L2',
overloaded => '0',
lsp_life_time => '1200',
te_enable => '1',
te_unresv_bw_priority0=> '100000',
te_unresv_bw_priority1=> '100000',
te_unresv_bw_priority2=> '100000',
te_unresv_bw_priority3=> '100000',
te_unresv_bw_priority4=> '100000',
te_unresv_bw_priority5=> '100000',
te_unresv_bw_priority6=> '100000',
te_unresv_bw_priority7=> '100000',
authentication_mode => 'none',
intf_metric => '1',
port_handle => "$hport[1]",
intf_ipv6_addr => '2000::2',
intf_ipv6_prefix_length=> '64',
gateway_ipv6_addr => '2000::2',
router_id => '192.0.0.1',
mac_address_start => '00:10:94:00:00:01',
intf_ip_prefix_length=> '24',
intf_ip_addr => '12.85.1.3',
gateway_ip_addr => '12.85.1.1',
hello_interval => '10',
ip_version => '4_6',
graceful_restart_restart_time=> '3',
routing_level => 'L2',
lsp_refresh_interval=> '900',
psnp_interval => '2',
intf_type => 'broadcast',
holding_time => '3',
graceful_restart => '0',
wide_metrics => '1',
hello_padding => 'true',
area_id => '000001');
Sample Output:
$VAR1 = 'handle';
$VAR2 = 'router1';
$VAR3 = 'handles';
$VAR4 = 'router1';
$VAR5 = 'status';
$VAR6 = '1';
$VAR7 = 'session_router';
$VAR8 = 'isislspconfig1';
End of Procedure Header
sth::emulation_isis_control¶
Purpose¶
Starts, stops, and controls flapping operations on an emulated IS-IS router. You can also use this function to delete an LSP.
Synopsis¶
Note
M indicates that the argument is Mandatory .
sth::emulation_isis_control [-mode {start|stop|restart|flap} M] [-handle {LSP_session_handle_list|all}] [-port_handle {port_handle_list|all}] [-withdraw {list of topology_elem_handles} ] [-advertise { list of topology_elem_handles }] [-flap_count <integer>] [-flap_down_time <0-10000000>] [-flap_interval_time <0-10000000>] [-flap_routes <list of route handles>]
Arguments¶
-
-advertise¶ Specifies the LSPs to advertise
-
-flap_count¶ Specifies the number of flaps. Each flap includes one route to advertise and one route to delete.
-
-flap_down_time¶ Specifies the amount of time, in seconds, during which the routes are withdrawn from their neighbors.
-
-flap_interval_time¶ During a flapping operation, the time (in seconds) between flap cycles.
-
-flap_routes¶ Perform periodic route flapping on topology elements
-
-handle¶ Identifies a list of routers to start or stop. Use “all” to pass all device handles. If nothing is specified, all devices under all ports will be passed.
-
-mode¶ Specifies the action to be taken. This argument is mandatory. Possible values are:
stop Stops the router with the specified handle start Starts the router with the specified handle restart Stops the router with the specified handle and then starts it again flap Enables route flapping
-
-port_handle¶ Identifies a list of ports on which to stop or start the router. Use “all” to pass all port handles. If nothing is specified, all devices under all ports will be passed.
-
-withdraw¶ Specifies the LSPs to delete
Cisco-specific Arguments¶
None
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_isis_control function controls the starting and
stopping of routers as well as deleting them. At the same time you can
delete LSPs.
Examples¶
#### HLTAPI for Tcl ####
To start an IS-IS router and withdraw the IP route at the same time:
sth::emulation_isis_control
-mode start -handle $isisSessionHandle \
-withdraw $isisRouteHandle
To stop and delete the routers:
sth::emulation_isis_control -mode stop -handle $isisSessionHandle
To restart a router:
sth::emulation_isis_control -mode restart -handle $isisSessionHandle
To call route flapping:
# Perform two full route flaps the ISIS router. Assume that we are already
# given an ISIS session handle isisSessionHandle and an ISIS IP route
# handle isisRouteHandle. Also assume that the ISIS router is running and
# in the "Up" state.
set status [::emulation_isis_control -mode flap -flap_count 2 \
-flap_down_time 10 -flap_interval_time 10 -flap_routes \
$isisRouteHandle -handle $isisSessionHandle]
Sample Output:
{status router1}
#### HLTAPI for Python ####
To start an IS-IS router:
ctrl_ret1 = sth.emulation_isis_control (
handle = device_list,
mode = 'start');
Sample Output:
{'status': '1'}
#### HLTAPI for Perl #### To start an IS-IS router:
my %ctrl_ret1 = sth::emulation_isis_control (
handle => "$device_list",
mode => 'start');
- Sample Output:
- $VAR1 = ‘status’; $VAR2 = ‘1’;
End of Procedure Header
sth::emulation_isis_topology_route_config¶
Purpose¶
Creates or modifies routes on or deletes routes from an emulated IS-IS router on a Spirent TestCenter port. This function also configures the properties of the IS-IS routes.
When you add a route (see description for -mode), Spirent HLTAPI returns the route handle in a keyed list with “connected_handles” as the key.
Synopsis¶
Note
M indicates that the argument is Mandatory .
sth::emulation_isis_topology_route_config
[-mode {create|modify|delete} M]
[-handle <isis_session_handle>]
[-elem_handle <lsp_handle> ]
[-external_count <1-4294967295>]
[-external_ip_pfx_len <1-32>]
[-external_ip_start <a.b.c.d>]
[-external_ip_step <1-255> ]
[-external_ipv6_pfx_len <1-128>]
[-external_ipv6_start <aaaa:bbbb:cccc:dddd:eeee:ffff:gggg:hhhh>]
[-external_ipv6_step <0-4294967295>|<aaaa:bbbb:cccc:dddd:eeee:ffff:gggg:hhhh>]
[-external_metric <1-63> ]
[-external_metric_type {internal|external}]
[-external_route_type {internal|external}]
[-external_up_down_bit {0|1} ]
[-ip_version {4|6|4_6} ]
[-link_ip_addr <a.b.c.d>]
[-link_narrow_metric <0-63>]
[-link_te {0|1}]
[-link_te_admin_group <1-4294967295> ]
[-link_te_max_bw <1-2147483647> ]
[-link_te_max_resv_bw <1-2147483647> ]
[-link_te_unresv_bw_priority0 <1-4294967295>]
[-link_te_unresv_bw_priority1 <1-4294967295>]
[-link_te_unresv_bw_priority2 <1-4294967295>]
[-link_te_unresv_bw_priority3 <1-4294967295>]
[-link_te_unresv_bw_priority4 <1-4294967295>]
[-link_te_unresv_bw_priority5 <1-4294967295>]
[-link_te_unresv_bw_priority6 <1-4294967295>]
[-link_te_unresv_bw_priority7 <1-4294967295>]
[-router_attached_bit {0|1} ]
[-router_connect {another_elem_handle}]
[-router_disconnect {another_elem_handle}]
[-router_id <a.b.c.d>]
[-router_overload_bit {0|1} ]
[-router_pseudonode_num <0-255>]
[-router_routing_level {L1|L2|L1L2}]
[-router_system_id <000000000000-FFFFFFFFFFFF> ]
[-router_te {0|1} ]
[-stub_count <1-4294967295>]
[-stub_ip_pfx_len <1-32> ]
[-stub_ip_start <a.b.c.d>]
[-stub_ip_step <a.b.c.d>]
[-stub_ipv6_pfx_len <1-128>]
[-stub_ipv6_start <aaaa:bbbb:cccc:dddd:eeee:ffff:gggg:hhhh>]
[-stub_ipv6_step <1-255>]
[-stub_metric <0-65535> ]
[-stub_up_down_bit {0|1}]
[-type { router|grid|stub|external}]
Arguments¶
-
-elem_handle¶ Specifies which topology element to modify or delete. You must specify this argument if the mode is modify or delete (see description for -mode).
-
-external_count¶ Specifies the number of prefixes to be advertised for an external network. Possible values range from 1 to 4294967295. The default is 1. Use this argument to configure a consecutive set of network prefixes.
-
-external_ip_pfx_len¶ The prefix length for the IPv4 external prefix. The IPv4 external prefixes are advertised by TLV 130 for narrow style, and TLV 135 for wide style. Possible values range from 1 to 32. The default is 24.
Note
- Use the -external_ip_pfx_len, -external_ip_start, -external_ip_step, -external_ipv6_pfx_len, -external_ipv6_start, -external_ipv6_step, -external_metric, -external_metric_type, -external_up_down_bit arguments to add or modify external networks behind a session router.
- The IPv4 external prefixes are advertised by TLV 130 for narrow style, TLV 135 for wide style. The IPv6 external prefixes are advertised by TLV 236 if MT disabled, TLV 237 if MT enabled. Both have external bit set.
-
-external_ip_start¶ The first prefix to be advertised in the external network. The default is 0.0.0.0. You must specify a prefix length (-external_ip_pfx_le) with this argument. See Note under the -external_ip_pfx_len argument.
-
-external_ip_step¶ The amount by which the prefix to be advertised should be increased. Possible values are 1 to 255. The default is 1. You must specify the -external_ip_start argument. You can specify the value in either numeric or IPv4 notation.
-
-external_ipv6_pfx_len¶ The prefix length for the IPv6 external prefix. The IPv6 external prefixes are advertised by TLV 236. Possible values range from 1 to 128. The default is 64. See note under the -external_ip_pfx_len argument.
-
-external_ipv6_start¶ The first prefix to be advertised in the external network. The default is 0:0:0:0:0:0:0:0. You must specify a prefix length (-external_ipv6_pfx_le) with this argument. See Note in -external_ip_pfx_len argument.
-
-external_ipv6_step¶ The amount by which the prefix to be advertised should be increased. You can specify the value in either numeric or IPv6 format. Possible numerical values range from 0 to 4294967295. The default value is 1. You must specify the -external_ipv6_start argument. See note under the -external_ip_pfx_len argument.
-
-external_metric¶ Specifies the metric value for external links. The range for wide style is different from narrow style. Possible values range from 1 to 63. See note under the -external_ip_pfx_len argument.
-
-external_route_type¶ Spirent Extension (for Spirent HLTAPI only).
Specifies the route type. Possible values are internal and external. The default is internal.
-
-external_metric_type¶ The type of metric element to configure for TLV 130. Possible values are 1 (internal) and 2 (external). The default is 1.
-
-external_up_down_bit¶ Specifies if the route is advertised from Level 2 to Level 1. Possible values are 0 (up) and 1 (down). The default is 0 (up). If the external up/down bit is set to down, it indicates that the route is advertised from Level 2 to Level 1. If it is set to up, the route is not advertised from Level 2 to Level 1.
-
-handle¶ Identifies the router on which to create, modify, or delete a topology element. This argument is Mandatory .
-
-ip_version¶ The IP version of the topology element. Possible values are 4, 6, or 4_6. The default value is 4_6. Note that you cannot change the IP version for the TE topology elements after you create them because Spirent HLTAPI only supports IPv4.
-
-link_ip_addr¶ Specifies the IP address of the interface corresponding to the current link. The default is 0.0.0.0.
-
-link_narrow_metric¶ Indicates whether to add or modify a narrow metric. Possible values range from 0 to 63. The default is 1.
-
-link_te¶ Indicates whether to enable traffic engineering on the link. Possible values are 1 (enable) and 0 (disable). The default is 0.
-
-link_te_admin_group¶ Specifies the link’s administrative group membership, expressed as the decimal equivalent of a 32-bit bit mask. Each set bit corresponds to one administrative group assigned to the interface. A link can belong to multiple groups. By convention, the least significant bit is referred to as “group 0”, and the most significant bit is referred to as “group 31”. Possible values range from 1 to 4294967295. The default is 1. The Administrative Group sub-TLV is TLV type 9.
-
-link_te_max_bw¶ Specifies the maximum bandwidth that can be used on this traffic engineering link in this direction (from the originating router to its neighbor). Possible values range from 1 to 2147483647. The default is 100000 bytes per second.
-
-link_te_max_resv_bw¶ Specifies the maximum reservable bandwidth sub-TLV (type 7), in bytes per second, that you can reserve on this link in this direction. The default is 100000 bytes per second.
-
-link_te_remote_ip_addr¶ The remote interface IP address sub-TLV (type 4). The default is 0.0.0.0.
-
-link_te_unresv_bw_priority0¶ Specifies the amount of bandwidth not yet reserved at priority level 0. The values correspond to the bandwidth that can be reserved with a setup priority of 0 through 7. Arranged in ascending order, priority 0 occurs at the start of the sub-TLV and priority 7 at the end. The initial values, before any bandwidth is reserved, are all set to the value specified for the maximum reservable bandwidth (-link_te_max_resv_bw). Each value will be less than or equal to the maximum reservable bandwidth. Possible values, in bytes per second, are 0 to 4294967295. The default is 100000 bytes per second.
-
-link_te_unresv_bw_priority1¶ Specifies the amount of bandwidth not yet reserved at priority level 1. Possible values, in bytes per second, are 0 to 4294967295. The default is 100000 bytes per second.
-
-link_te_unresv_bw_priority2¶ Specifies the amount of bandwidth not yet reserved at priority level 1. Possible values, in bytes per second, are 0 to 4294967295. The default is 100000 bytes per second.
-
-link_te_unresv_bw_priority3¶ Specifies the amount of bandwidth not yet reserved at priority level 1. Possible values, in bytes per second, are 0 to 4294967295. The default is 100000 bytes per second.
-
-link_te_unresv_bw_priority4¶ Specifies the amount of bandwidth not yet reserved at priority level 1. Possible values, in bytes per second, are 0 to 4294967295. The default is 100000 bytes per second.
-
-link_te_unresv_bw_priority5¶ Specifies the amount of bandwidth not yet reserved at priority level 1. Possible values, in bytes per second, are 0 to 4294967295. The default is 100000 bytes per second.
-
-link_te_unresv_bw_priority6¶ Specifies the amount of bandwidth not yet reserved at priority level 1. Possible values, in bytes per second, are 0 to 4294967295. The default is 100000 bytes per second.
-
-link_te_unresv_bw_priority7¶ Specifies the amount of bandwidth not yet reserved at priority level 1. Possible values, in bytes per second, are 0 to 4294967295. The default is 100000 bytes per second.
-
-mode¶ Specifies whether to create, modify, or delete LSPs from the emulated router’s LSR database. This argument is mandatory. Possible values are:
create - Creates a new LSP for the IS-IS session. The handle for the LSP is returned in the lsp_handle key (see Return Values). modify - Modifies the setup for the LSP specified in the -lsp_handle argument. delete - Removes the LSP specified in the -lsp_handle argument.
-
-router_attached_bit¶ Specifies whether to set the 0th LSP’s attached bit. Possible values are 1 (true) and 0 (false). The default is 0. The attached bit enables an L1 router to figure out who its closest L2 router is. You should set this bit if you are connected to either 1) other areas, or 2) other domains.
-
-router_connect¶ Specifies the handle of the IS-IS router to which you want to connect the current session router.
-
-router_disconnect¶ Specifies the handle of the IS-IS router from which you want to disconnect the current session router.
-
-router_id¶ Specifies the TE router ID. The default is 0.0.0.0.
-
-router_overload_bit¶ Specifies whether to enable the LSP’s overload bit on the router to add or modify. If enabled (1), sets the 0th LSP’s overload bit. The default is 0.
-
-router_pseudonode_num¶ Specifies the ID of the virtual router to add or modify. Possible values range from 0 to 255. The default is 0. A pseudo node is not a real router. It is an extra LSP in the LSP database that is created by the designated router.
-
-router_routing_level¶ Specifies the supported routing level: L1 , L2, or L1L2 (both). IS-IS has two layers of hierarchy: the backbone is called level-2, and the areas are called level-1. The default is L1L2.
-
-router_system_id¶ Specifies the system ID of the router to add or modify. A system ID is typically 6-octet long thus each ID is specified as a string of 12 hex characters. Possible values range from 000000000000 to FFFFFFFFFFFF. The default is 000001000003.
-
-router_te¶ Specifies whether the TE router ID is set. Possible values are 1 (true) and 0 (false). The default is 0.
-
-stub_count¶ Configures a consecutive set of network prefixes when adding or modifying internal (stub) networks behind a session router. The IPv4 stub networks are advertised by TLV 128 for narrow metric style and TLV 135 for wide metric style. The IPv6 stub networks are advertised by TLV 236. Possible values range from 1 to 4294967295. The default is 1.
-
-stub_ip_pfx_len¶ Specifies the prefix length of the stub network. Possible values for IPv4 addresses range from 1 to 32; the default is 24,
-
-stub_ip_start¶ The first prefix to be advertised in the IPv4 network. The default is 0.0.0.0. You must specify a prefix length (-stub_ip_pfx_le) with this argument,
-
-stub_ip_step¶ The amount by which the prefix to be advertised should be increased. Possible values are 1 to 255. The default is 1. You must specify the -stub_ip_start argument.
-
-stub_ipv6_pfx_len¶ Specifies the prefix length of the stub network. Possible values for IPv6 addresses range from 1 to 128; the default is 64.
-
-stub_ipv6_start¶ The first prefix to be advertised in the IPv6 network. The default is 0:0:0:0:0:0:0:0. You must specify a prefix length (-stub_ipv6_pfx_le) with this argument.
-
-stub_ipv6_step¶ The amount by which the prefix to be advertised should be increased. Possible values are 1 to 255. The default is 1. You must specify the -stub_ipv6_start argument.
-
-stub_metric¶ Specifies the metric value for stub links. The range for wide style is different from narrow style. Possible values range from 0 to 65535.
-
-stub_up_down_bit¶ Specifies whether the route is advertised from Level 2 to Level 1. Possible value are 1 (true) and 0 (false). The default is 0. If this argument is set to 1, the route is advertised from Level 2 to Level 1. If this argument is set to 0, the route is not advertised from Level 2 to Level 1.
-
-type¶ Specifies the type of topology element to be created. Possible values are:
router: an IS-IS router grid: a rectangular grid of IS-IS routers stub: a stub network with a number of reachable network prefixes external: external network with a number of reachable network prefixes
Arguments Unsupported by Save as HLTAPI¶
The sth::emulation_isis_topology_route_config function is currently not supported
by Save to HLTAPI. To test with this function, you must configure it manually in
the generated Spirent HLTAPI scripts.
Cisco-specific Arguments¶
The following arguments are specific to the Cisco HLTAPI but are not supported by Spirent HLTAPI:
-external_connect
-grid_col
-grid_connect
-grid_connect_session
-grid_disconnect
-grid_interface_metric
-grid_router_ip_pfx_len
-grid_router_metric
-grid_router_origin
-grid_router_up_down_bit
-grid_system_id_step
-grid_te_admin
-grid_te_ip_step
-grid_te_max_bw
-grid_te_max_resv_bw
-grid_te_metric
-grid_te_unresv_bw_priority0
-grid_te_unresv_bw_priority1
-grid_te_unresv_bw_priority2
-grid_te_unresv_bw_priority3
-grid_te_unresv_bw_priority4
-grid_te_unresv_bw_priority5
-grid_te_unresv_bw_priority6
-grid_te_unresv_bw_priority7
-grid_user_wide_metric
-link_te_metric
-router_system_id
-grid_ip_pfx_len
-grid_ip_start
-grid_ip_step
-grid_ipv6_pfx_len
-grid_ipv6_start
-grid_ipv6_step
-grid_link_type
-grid_router_id
-grid_router_id_step
-grid_row
-grid_start_system_id
-grid_start_te_ip
-grid_stub_per_router
-grid_te
-link_enable
-link_external
-link_ip_prefix_length
-link_ipv6_addr
-link_ipv6_prefix_length
-link_multi_topology
-link_te_remote_ip_addr
-link_te_remote_ipv6_addr
-link_up_down_bit
-link_wide_metric
-router_area_id
-router_host_name
-stub_connect
-te_router_id
-te_router_id_step
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):
elem_handle
<ISIS_elem_handle>
The handle that identifies the router created by the
``sth::emulation_isis_topology_route_config`` function.
version
{4|6|4_6}
The IP version of the IS-IS emulated router: IPv4, IPv6, or
IPv4/6.
router
connected_handles <connected_elem_handles>
The number of elements to which the router is connected.
grid
connected_session.$session.row<row>.col<col>
The location of the session by row and column number in the grid.
router.$row.$col <router_handle>
The row and column number of the router in the grid.
network stub
num_networks <num_networkstub_prefixes>
The number of internal (stub) network prefixes advertised.
external
num_networks <num_external_prefixes>
The number of external network prefixes advertised.
status
Success (1) or failure (0) of the operation.
log
An error message (if the operation failed).
Description¶
Each emulated IS-IS router simulates a topology of inter- connected routers behind itself. It accomplishes this by advertising Link State Protocol Data Units (LSPs), with the IS Neighbors TLV (Type/Length/Value) or the Extended Reachability TLV, to the SUT.
The sth::emulation_isis_topology_route_config function creates and
configures IP routes for the IS-IS protocol. Use the -elem_handle argument
to identify the router for which to create, modify, or delete a route. (The
router handle value is contained in the keyed list returned by the
sth::emulation_isis_config function.) Use the -mode argument to specify the
action to perform. See the -mode argument for a description of the actions.
Examples¶
The following example creates a route for each IS-IS router on port1. This example assumes you have created the ISIS session handle isisSessionHandle and LSP handle isisLspHandle:
sth::emulation_isis_topology_route_config -mode create \
-external_ip_pfx_len 24 \
-external_ip_start 1.2.3.4 \
-external_ip_step 0.0.0.3 \
-external_ipv6_pfx_len 128 \
-external_ipv6_start 3FFE:1111::1\
-external_ipv6_step 0000::05 \
-external_metric 10 \
-external_metric_type internal \
-handle $isisSessionHandle \
-ip_version 4 \
-router_routing_level L2 \
-router_system_id 1234567890ab \
-type external
End of Procedure Header
sth::emulation_isis_iih_config¶
Purpose¶
Creates or modifies the router topology under the specified ISIS emulated router, matching the operation of the ISIS LSP Generator from Spirent TestCenter GUI.
Synopsis¶
Note
M indicates that the argument is Mandatory .
sth::emulation_isis_iih_config
[-mode <create|modify|delete|active|inactive> M]
[-handle <isis_router_handle | isis_iih_handle> M]
[-iih_aed_bit {true|false}]
[-iih_base_vid <1-4095>]
[-iih_config_name <string>]
[-iih_ect_algo <string>]
[-iih_ipv4_addr_list <a.b.c.d>]
[-iih_ipv6_addr_list <aaaa:bbbb:cccc:dddd:eeee:ffff:gggg:hhhh>]
[-iih_mbit {SPBM}]
[-iih_mst_id_list <integer>]
[-iih_mt_id <0-4096>]
[-iih_revision_level <0-65535>]
[-iih_unicast_bit {true|false}]
[-iih_useflag {true|false}]
[-iih_vlan_list <string>]
Arguments¶
-
-mode¶ Specifies the action to perform. Possible values are create, modify, delete, active and inactive. This argument is Mandatory . The modes are described below: :
- create
- Creates ISIS IIH configuration under IS-IS router with the specified device handle.
- modify
- Changes the ISIS IIH configuration for the IS-IS router identified by the -handle argument. You must specify the -handle argument with IS-IS router handle.
- delete
- Deletes all IS-IS IIH configuration from the IIH specified in the -handle argument. You must specify the -handle argument.
- active
- Enables the ISIS IIH router specified by the -handle argument. You must specify a valid IS-IS IIH session handle.
- inactive
- Disables the IS-IS IIH router specified by the -handle argument. You must specify a valid IS-IS IIH session handle. The configuration for the router is retained, when it is inactive and is available as configured if the router is active.
-
-handle¶ Specifies the IS-IS handle(s) to use. This argument is Mandatory for create, modify, delete, active and inactive modes. When -mode is set to create, Spirent HLTAPI creates IS-IS IIH over the provided ISIS router device. (Please refer to the description of the -mode argument for more information)
-
-iih_aed_bit¶ Specifies the A bit. Possible Values are:
Value Description true A bit is set false A bit is not set Default: true
-
-iih_unicast_bit¶ Specifies the U bit. Possible Values are:
Value Description true U bit is set false U bit is not set
Default: false
-
-iih_base_vid¶ Specifies the Base VLAN ID (12-bits).
Values: 1 - 4095
Default: 1
-
-iih_config_name¶ Specifies the 32-byte configuration name.
Values: 1 - 32 characters
Default: Config1
-
-iih_ect_algo¶ Specifies the ECT Algorithm defined for SPB.
Values: Ect0080C200 - Ect0080C210
Default: Ect0080C201
-
-iih_ipv4_addr_list¶ Specifies the IPv4 Address List
Default: “” (empty string)
-
-iih_ipv6_addr_list¶ Specifies the IPv6 Address List
Default: “” (empty string)
-
-iih_mbit¶ Specifies the M-Bit (1-bit) The M-bit indicates if this Base-VID operates in SPBM (M = 1) or SPBV (M = 0) mode.
Default: SPBM
-
-iih_mst_id_list¶ Specifies the list of MST IDs.
Default: 1
-
-iih_mt_id¶ Specifies the Multi-Topology ID, a 12-bit field containing the ID of the topology being announced.
Values: 0 - 4096
Default: 0
-
-iih_revision_level¶ Specifies the 2-byte revision level.
Values: 0 - 65535
Default: 0
-
-iih_useflag¶ Specifies the Use ECT-Algorithm and Base-VID. Possible Values:
Value Description true Use ECT-Algorithm and Base-VID. false Do not use ECT-Algorithm and Base-VID.
Default: TRUE
-
-iih_vlan_list¶ Specifies the List of VLAN IDs.
Default: 1
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
- Retrieves a value indicating the success (1) or failure (0) of the operation.
Description¶
The sth::emulation_isis_iih_config function provides IIH configuration specified
for the routers with the ISIS configuration.
Examples¶
To configure the characteristics of ISIS IIH configuration under one ISIS router device whose l2_type_flags includes plsb (0) or spb (2):
set device_ret0 [sth::emulation_isis_config\
-mode enable\
-lsp_level L2 \
-overloaded 0 \
-lsp_life_time 1200 \
-l1_sub_tlv 0 \
-l1_bd_unit BYTES_PER_SEC \
-l1_te_max_bd 100000 \
-l1_te_rsvr_bd 100000 \
-l1_te_un_rsvr_bd0 100000 \
-l1_te_un_rsvr_bd1 100000 \
-l1_te_un_rsvr_bd2 100000 \
-l1_te_un_rsvr_bd3 100000 \
-l1_te_un_rsvr_bd4 100000 \
-l1_te_un_rsvr_bd5 100000 \
-l1_te_un_rsvr_bd6 100000 \
-l1_te_un_rsvr_bd7 100000 \
-l1_te_default_metric 0 \
-l1_te_group 1 \
-l2_te_group 1 \
-l2_sub_tlv UNRESERVED \
-l2_te_default_metric 0 \
-l2_bd_unit BYTES_PER_SEC \
-l2_te_un_rsvr_bd0 100000 \
-l2_te_un_rsvr_bd1 100000 \
-l2_te_un_rsvr_bd2 100000 \
-l2_te_un_rsvr_bd3 100000 \
-l2_te_un_rsvr_bd4 100000 \
-l2_te_un_rsvr_bd5 100000 \
-l2_te_un_rsvr_bd6 100000 \
-l2_te_un_rsvr_bd7 100000 \
-l2_te_max_bd 100000 \
-l2_te_rsvr_bd 100000 \
-authentication_mode none\
-pdu_type {l1_hello}\
-pdu_authentication_mode {none}\
-pdu_password {null}\
-pdu_md5_key_id {null}\
-intf_metric 1\
-holding_time 30\
-port_handle $port1\
-link_local_ipv6_addr 2000::2 \
-intf_ipv6_addr 2000::2 \
-link_local_ipv6_prefix_len 64 \
-intf_ipv6_prefix_length 64 \
-gateway_ipv6_addr 2000::2 \
-router_id 192.0.0.1 \
-mac_address_start 00:10:94:00:00:01 \
-intf_ip_prefix_length 24 \
-intf_ip_addr 12.85.1.3 \
-gateway_ip_addr 12.85.1.1 \
-l1_wide_metric 1 \
-hello_interval 10 \
-retrans_interval 5 \
-disable_ip false \
-enable_jumbo_llc false \
-ip_version 4_6 \
-view_routes false \
-routing_level L2 \
-graceful_restart_restart_time 3 \
-instance_id 0 \
-lsp_refresh_interval 900 \
-l2_type_flags spb \
-psnp_interval 2 \
-host_name Spirent-1 \
-lsp_size 1492 \
-l2_wide_metric 1 \
-router_priority 0 \
-flood_delay 33 \
-intf_type broadcast \
-mt_flags 0 \
-graceful_restart 0 \
-wide_metrics 1 \
-l2_metric 1 \
-hello_padding true \
-area_id 000001 \
-circuit_id 1 \
-l1_metric 1 \
]
set dev_hnd [keylget device_ret0 handle]
set device_iih [sth::emulation_isis_iih_config \
-mode create\
-handle $dev_hnd\
-iih_mt_id 200\
-iih_config_name 'myiih'\
-iih_base_vid 100 200\
-iih_ect_algo Ect0080C201 Ect0080C202\
-iih_mbit SPBM SPBM\
-iih_useflag true false\
-iih_aed_bit false]
Sample Output:
{handle_mt_port_captlv isismtportcaptlv1} {handle_spb_mcid_subtlv isisspbmcidsubtlv1}
{handle_ect_vid_tuple {isisectvidtuple1 isisectvidtuple2}}
{handle_spb_base_vid_subtlv isisspbbasevidsubtlv1}
{handle_site_capability_subtlv isissitecapabilitysubtlv1} {status 1}
{handle isisiihconfig1}
End of Procedure Header
sth::emulation_isis_lsp_generator¶
Purpose¶
Creates or modifies the router topology under the specified ISIS emulated router, matching the operation of the ISIS LSP Generator from Spirent TestCenter GUI.
Synopsis¶
Note
M indicates that the argument is Mandatory .
sth::emulation_isis_lsp_generator
[-mode {create|delete|modify} M]
[-handle <isis_session_handle>]
[-elem_handle <lsp_handle>]
[-loopback_adver_enable <false|true>]
[-get_return_handles {false | true}]
[-get_tlv_handles {false | true}]
[-lsp_life_time <1-65535> ]
[-ipv4_addr_end <a.b.c.d>]
[-ipv4_addr_start <a.b.c.d>]
[-delete_existing_routes {true|false}]
[-ipv4_isis_prefix_sid_tlv_flags {NONE | RBIT | NBIT | PBIT | EBIT
| VBIT | LBIT}]
[-tlv_handle <isis_subtlv_handle>]
[-ipv4_isis_prefix_sid_tlv_algorithm <integer>]
[-ipv4_isis_prefix_sid_tlv_sid_label_index <integer>]
[-ipv4_isis_prefix_sid_tlv_algorithm_step <integer>]
[-ipv4_isis_prefix_sid_tlv_sid_label_index_step <integer>]
[-ipv4_isis_prefix_attribute_sub_tlv_flags { XBIT | RBIT | NBIT}]
[-ipv6_isis_prefix_attribute_sub_tlv_flags { XBIT | RBIT | NBIT}]
[-ipv4_isis_source_router_id_sub_tlv <a.b.c.d>]
[-ipv6_isis_source_router_id_sub_tlv <aaaa:bbbb:cccc:dddd:eeee:ffff:gggg:hhhh>]
[-ipv6_isis_srv6_prefix_sid_sub_tlv_flags <integer>]
[-ipv6_isis_srv6_prefix_sid_sub_tlv_algorithm <integer>]
[-ipv4_isis_bier_label_binding_tlv_bfr_id <1-65535>]
[-ipv4_isis_bier_label_binding_tlv_sub_domain_id <0-255>]
[-ipv4_isis_bier_label_binding_tlv_igp_algorithm <0-255>]
[-ipv4_isis_bier_label_binding_tlv_bier_algorithm <0-255>]
[-ipv4_isis_bier_label_binding_tlv_type <0-255>]
[-ipv4_isis_bier_mpls_sub_tlv_encap_type <0-255>]
[-ipv4_isis_bier_mpls_sub_tlv_bs_len <0-255>]
[-ipv4_isis_bier_mpls_subtlv_label <0-4294967295>]
[-ipv4_isis_bier_mpls_subtlv_max_set_id <0-255>]
[-isis_lsp_neighbor_config_sys_id <aa:bb:cc:dd:ee:ff>]
[-isis_lsp_neighbor_config_sys_id_step <aa:bb:cc:dd:ee:ff>]
[-isis_lsp_neighbor_config_node_id <0-255>]
[-isis_lsp_neighbor_config_wide_metric <0-16777215>]
[-isis_lsp_neighbor_config_metric <0-63>]
[-isis_lsp_neighbor_config_enable_srlg_tlv {true|false}]
[-isis_lsp_neighbor_config_ipv4_addr <a.b.c.d>]
[-isis_lsp_neighbor_config_ipv4_addr_step <a.b.c.d>]
[-isis_lsp_neighbor_config_ipv4_nbr_addr_step <a.b.c.d>]
[-isis_lsp_neighbor_config_ipv4_nbr_addr <a.b.c.d>]
[-isis_lsp_neighbor_config_srlg_flags {UBIT|NBIT}]
[-isis_lsp_neighbor_config_srlg_values <integer>]
[-isis_lsp_neighbor_config_count <integer>]
[-isis_lsp_neighbor_config_te_params <string>]
[-isis_lsp_neighbor_config_te_bw_unit {BITS_PER_SEC|BYTES_PER_SEC|MBYTES_PER_SEC}]
[-isis_lsp_neighbor_config_te_local_ipv4 <a.b.c.d>]
[-isis_lsp_neighbor_config_te_local_ipv4_step <a.b.c.d>]
[-isis_lsp_neighbor_config_te_remote_ipv4 <a.b.c.d>]
[-isis_lsp_neighbor_config_te_remote_ipv4_step <a.b.c.d>]
[-isis_lsp_neighbor_config_te_local_ipv6 <aaaa:bbbb:cccc:dddd:eeee:ffff:gggg:hhhh>]
[-isis_lsp_neighbor_config_te_local_ipv6_step <aaaa:bbbb:cccc:dddd:eeee:ffff:gggg:hhhh>]
[-isis_lsp_neighbor_config_te_remote_ipv6 <aaaa:bbbb:cccc:dddd:eeee:ffff:gggg:hhhh>]
[-isis_lsp_neighbor_config_te_remote_ipv6_step <aaaa:bbbb:cccc:dddd:eeee:ffff:gggg:hhhh>]
[-isis_lsp_neighbor_config_te_group <1-4294967295>]
[-isis_lsp_neighbor_config_te_group_step <integer>]
[-isis_lsp_neighbor_tlv_config_te_group_step <integer>]
[-isis_lsp_neighbor_config_te_max_bw <1-4294967295>]
[-isis_lsp_neighbor_config_te_rsvr_bw <1-4294967295>]
[-isis_lsp_neighbor_config_te_unrsvr_bw0 <1-4294967295>]
[-isis_lsp_neighbor_config_te_unrsvr_bw1 <1-4294967295>]
[-isis_lsp_neighbor_config_te_unrsvr_bw2 <1-4294967295>]
[-isis_lsp_neighbor_config_te_unrsvr_bw3 <1-4294967295>]
[-isis_lsp_neighbor_config_te_unrsvr_bw4 <1-4294967295>]
[-isis_lsp_neighbor_config_te_unrsvr_bw5 <1-4294967295>]
[-isis_lsp_neighbor_config_te_unrsvr_bw6 <1-4294967295>]
[-isis_lsp_neighbor_config_te_unrsvr_bw7 <1-4294967295>]
[-isis_lsp_neighbor_config_te_default_metric <integer>]
[-isis_lsp_neighbor_config_te_ext_admin_group <integer>]
[-isis_lsp_neighbor_config_te_unilink_delay <string>]
[-isis_lsp_neighbor_config_te_unilink_delay_aflag {true|false}]
[-isis_lsp_neighbor_config_te_min_max_uni_link_min_delay <1-16777215>]
[-isis_lsp_neighbor_config_te_min_max_uni_link_max_delay <1-16777215>]
[-isis_lsp_neighbor_config_te_min_max_uni_link_delay_aflag <1-16777215>]
[-isis_lsp_neighbor_config_te_uni_delay_variation <1-16777215>]
[-isis_lsp_neighbor_config_te_uni_link_loss <0.000003-50.331642>]
[-isis_lsp_neighbor_config_te_uni_link_loss_aflag {true|false}]
[-isis_lsp_neighbor_config_te_uni_residual_bw <1-4294967295>]
[-isis_lsp_neighbor_config_te_uni_available_bw <1-4294967295>]
[-isis_lsp_neighbor_config_te_uni_utilized_bw <1-4294967295>]
[-isis_neighbor_srv6_end_x_sid_subtlv_custom_end_point_fn <integer>]
[-isis_neighbor_srv6_end_x_sid_subtlv_enable_custom_end_point_fn {true|false}]
[-isis_neighbor_srv6_end_x_sid_subtlv_end_point_func <string>]
[-isis_neighbor_srv6_end_x_sid_subtlv_flags <string>]
[-isis_neighbor_srv6_end_x_sid_subtlv_sid <aaaa:bbbb:cccc:dddd:eeee:ffff:gggg:hhhh>]
[-isis_neighbor_srv6_end_x_sid_subtlv_algorithm <integer>]
[-isis_neighbor_srv6_end_x_sid_subtlv_sid_step <aaaa:bbbb:cccc:dddd:eeee:ffff:gggg:hhhh>]
[-isis_neighbor_srv6_end_x_sid_subtlv_algorithm_step <integer>]
[-isis_neighbor_srv6_end_x_sid_subtlv_weight <integer>]
[-isis_neighbor_srv6_end_x_sid_custom_subtlv_sub_type <integer>]
[-isis_neighbor_srv6_end_x_sid_custom_subtlv_value <integer>]
[-isis_neighbor_srv6_end_x_sid_subtlv_count <integer>]
[-isis_neighbor_srv6_lan_end_x_sid_subtlv_count <integer>]
[-isis_neighbor_srv6_lan_end_x_sid_subtlv_algorithm <integer>]
[-isis_neighbor_srv6_lan_end_x_sid_subtlv_algorithm_step <integer>]
[-isis_neighbor_srv6_lan_end_x_sid_subtlv_custom_end_point_fn <integer>]
[-isis_neighbor_srv6_lan_end_x_sid_subtlv_enable_custom_end_point_fn {true|false}]
[-isis_neighbor_srv6_lan_end_x_sid_subtlv_end_point_func <string>]
[-isis_neighbor_srv6_lan_end_x_sid_subtlv_flags <string>]
[-isis_neighbor_srv6_lan_end_x_sid_subtlv_sid <aaaa:bbbb:cccc:dddd:eeee:ffff:gggg:hhhh>]
[-isis_neighbor_srv6_lan_end_x_sid_subtlv_sid_step <aaaa:bbbb:cccc:dddd:eeee:ffff:gggg:hhhh>]
[-isis_neighbor_srv6_lan_end_x_sid_subtlv_weight <integer>]
[-isis_neighbor_srv6_lan_end_x_sid_subtlv_system_id <aa:bb:cc:dd:ee:ff>]
[-isis_neighbor_srv6_lan_end_x_sid_subtlv_system_id_step <aa:bb:cc:dd:ee:ff>]
[-isis_neighbor_srv6_lan_end_x_sid_custom_subtlv_sub_type <integer>]
[-isis_neighbor_srv6_lan_end_x_sid_custom_subtlv_value <integer>]
[-isis_neighbor_lan_adj_sid_subtlv_flags <string>]
[-isis_neighbor_lan_adj_sid_subtlv_system_id <aa:bb:cc:dd:ee:ff>]
[-isis_neighbor_lan_adj_sid_subtlv_system_id_step <aa:bb:cc:dd:ee:ff>]
[-isis_neighbor_lan_adj_sid_subtlv_weight <integer>]
[-isis_neighbor_lan_adj_sid_subtlv_count <integer>]
[-isis_neighbor_plsb_link_metric_subtlv_link_attributes <0-16777215>]
[-isis_neighbor_plsb_link_metric_subtlv_link_metric <0-16777215>]
[-isis_neighbor_plsb_link_metric_subtlv_instance <0-255>]
[-isis_neighbor_spb_link_metric_subtlv_link_metric <0-16777215>]
[-isis_neighbor_spb_link_metric_subtlv_ports <1-255>]
[-isis_neighbor_spb_link_metric_subtlv_port_id <0-65535>]
[-isis_neighbor_sr_msd_subtlv_flags <string>]
[-isis_neighbor_sr_msd_subtlv_max_end_d <integer>]
[-isis_neighbor_sr_msd_subtlv_max_end_pop <integer>]
[-isis_neighbor_sr_msd_subtlv_max_seg_left <integer>]
[-isis_neighbor_sr_msd_subtlv_max_hencap <integer>]
[-isis_neighbor_sr_msd_subtlv_count <integer>]
[-isis_neighbor_sr_msd_subtlv_sub_type <integer>]
[-isis_neighbor_sr_msd_subtlv_value <integer>]
[-isis_neighbor_app_spec_attr_subtlv_lflag {true|false}]
[-isis_neighbor_app_spec_attr_subtlv_sa_bit_mask {RSVP_TE|SR_TE|LOOP_FREE_ALTERNATE|FLEX_ALGO}]
[-isis_neighbor_app_spec_attr_subtlv_sa_len <0-127>]
[-isis_neighbor_app_spec_attr_subtlv_uda_bit_mask <integer>]
[-isis_neighbor_app_spec_attr_subtlv_uda_len <0-127>]
[-isis_neighbor_app_spec_attr_subtlv_count <integer>]
[-isis_neighbor_app_spec_attr_subtlv_te_params <string>]
[-isis_neighbor_app_spec_attr_subtlv_te_bw_unit {BITS_PER_SEC|BYTES_PER_SEC|MBYTES_PER_SEC}]
[-isis_neighbor_app_spec_attr_subtlv_te_local_ipv4 <a.b.c.d>]
[-isis_neighbor_app_spec_attr_subtlv_te_remote_ipv4 <a.b.c.d>]
[-isis_neighbor_app_spec_attr_subtlv_te_remote_ipv4_step <a.b.c.d>]
[-isis_neighbor_app_spec_attr_subtlv_te_local_ipv4_step <a.b.c.d>]
[-isis_neighbor_app_spec_attr_subtlv_te_local_ipv6 <aaaa:bbbb:cccc:dddd:eeee:ffff:gggg:hhhh>]
[-isis_neighbor_app_spec_attr_subtlv_te_remote_ipv6 <aaaa:bbbb:cccc:dddd:eeee:ffff:gggg:hhhh>]
[-isis_neighbor_app_spec_attr_subtlv_te_remote_ipv6_step <aaaa:bbbb:cccc:dddd:eeee:ffff:gggg:hhhh>]
[-isis_neighbor_app_spec_attr_subtlv_te_local_ipv6_step <aaaa:bbbb:cccc:dddd:eeee:ffff:gggg:hhhh>]
[-isis_neighbor_app_spec_attr_subtlv_te_group <1-4294967295>]
[-isis_neighbor_app_spec_attr_subtlv_te_group_step <integer>]
[-isis_neighbor_app_spec_attr_tlv_config_te_group_step <integer>]
[-isis_neighbor_app_spec_attr_subtlv_te_max_bw <1-4294967295>]
[-isis_neighbor_app_spec_attr_subtlv_te_rsvr_bw <1-4294967295>]
[-isis_neighbor_app_spec_attr_subtlv_te_unrsvr_bw0 <1-4294967295>]
[-isis_neighbor_app_spec_attr_subtlv_te_unrsvr_bw1 <1-4294967295>]
[-isis_neighbor_app_spec_attr_subtlv_te_unrsvr_bw2 <1-4294967295>]
[-isis_neighbor_app_spec_attr_subtlv_te_unrsvr_bw3 <1-4294967295>]
[-isis_neighbor_app_spec_attr_subtlv_te_unrsvr_bw4 <1-4294967295>]
[-isis_neighbor_app_spec_attr_subtlv_te_unrsvr_bw5 <1-4294967295>]
[-isis_neighbor_app_spec_attr_subtlv_te_unrsvr_bw6 <1-4294967295>]
[-isis_neighbor_app_spec_attr_subtlv_te_unrsvr_bw7 <1-4294967295>]
[-isis_neighbor_app_spec_attr_subtlv_te_default_metric <integer>]
[-isis_neighbor_app_spec_attr_subtlv_te_ext_admin_group <integer>]
[-isis_neighbor_app_spec_attr_subtlv_te_unilink_delay <string>]
[-isis_neighbor_app_spec_attr_subtlv_te_unilink_delay_aflag {true|false}]
[-isis_neighbor_app_spec_attr_subtlv_te_min_max_uni_link_min_delay <1-16777215>]
[-isis_neighbor_app_spec_attr_subtlv_te_min_max_uni_link_max_delay <1-16777215>]
[-isis_neighbor_app_spec_attr_subtlv_te_min_max_uni_link_delay_aflag <1-16777215>]
[-isis_neighbor_app_spec_attr_subtlv_te_uni_delay_variation <1-16777215>]
[-isis_neighbor_app_spec_attr_subtlv_te_uni_link_loss <0.000003-50.331642>]
[-isis_neighbor_app_spec_attr_subtlv_te_uni_link_loss_aflag {true|false}]
[-isis_neighbor_app_spec_attr_subtlv_te_uni_residual_bw <1-4294967295>]
[-isis_neighbor_app_spec_attr_subtlv_te_uni_available_bw <1-4294967295>]
[-isis_neighbor_app_spec_attr_subtlv_te_uni_utilized_bw <1-4294967295>]
[-isis_capability_tlv_flags <string>]
[-isis_capability_tlv_router_id <a.b.c.d>]
[-isis_capability_tlv_router_id_step <a.b.c.d>]
[-isis_capability_tlv_count <integer>]
[-isis_capability_router_subtlv_options <string>]
[-isis_capability_srv6_subtlv_flags <string>]
[-isis_capability_sr_subtlv_flags <string>]
[-isis_capability_sr_msd_subtlv_count <integer>]
[-isis_capability_sr_msd_subtlv_flags <string>]
[-isis_capability_sr_msd_subtlv_max_end_d <integer>]
[-isis_capability_sr_msd_subtlv_max_end_pop <integer>]
[-isis_capability_sr_msd_subtlv_max_seg_left <integer>]
[-isis_capability_sr_msd_subtlv_max_hencap <integer>]
[-isis_capability_trees_subtlv_max_computable_count <integer>]
[-isis_capability_trees_subtlv_compute_count <integer>]
[-isis_capability_trees_subtlv_use_count <integer>]
[-isis_capability_tree_root_id_subtlv_nick_name_list <integer>]
[-isis_capability_tree_root_id_subtlv_start_root_id <integer>]
[-isis_capability_srms_preference_subtlv <integer>]
[-isis_capability_sr_algorithm_subtlv <string>]
[-isis_capability_sr_algorithm_subtlv_count <integer>]
[-isis_capability_sr_local_block_subtlv_count <integer>]
[-isis_capability_sr_local_block_subtlv_flags <integer>]
[-isis_capability_sr_local_block_subtlv_range <1-16777215>]
[-isis_capability_root_pri_subtlv_bcast_pri <integer>]
[-isis_capability_root_pri_subtlv_multi_dst_tree_count <integer>]
[-isis_capability_root_id_subtlv_bcast_sys_id <aa:bb:cc:dd:ee:ff>]
[-isis_capability_root_id_subtlv_mcast_sys_id <aa:bb:cc:dd:ee:ff>]
[-isis_capability_vlan_subtlv_end_vlan_id <0-4095>]
[-isis_capability_vlan_subtlv_lost_count <integer>]
[-isis_capability_vlan_subtlv_start_vlan_id <0-4095>]
[-isis_capability_vlan_subtlv_options <string>]
[-isis_capability_vlan_subtlv_reserved_options <integer>]
[-isis_capability_vlan_subtlv_tree_root_list <aa:bb:cc:dd:ee:ff>]
[-isis_capability_ftag_subtlv <integer>]
[-isis_capability_ftag_subtlv_graph_count <integer>]
[-isis_capability_ftag_subtlv_graph_root_id <aa:bb:cc:dd:ee:ff>]
[-isis_capability_device_id_subtlv <integer>]
[-isis_capability_device_id_subtlv_pri <integer>]
[-isis_capability_device_id_subtlv_reserved1 <integer>]
[-isis_capability_device_id_subtlv_reserved2 <integer>]
[-isis_capability_sr_fad_subtlv_cal_type <0-127>]
[-isis_capability_sr_fad_subtlv_cal_definition_flags <integer>]
[-isis_capability_sr_fad_subtlv_cal_exclude_admin_groups <integer>]
[-isis_capability_sr_fad_subtlv_cal_flex_algorithm <128-255>]
[-isis_capability_sr_fad_subtlv_cal_flex_algorithm_step <integer>]
[-isis_capability_sr_fad_subtlv_cal_include_all_admin_groups <integer>]
[-isis_capability_sr_fad_subtlv_cal_include_any_admin_groups <integer>]
[-isis_capability_sr_fad_subtlv_metric_type <integer>]
[-isis_capability_sr_fad_subtlv_option <integer>]
[-isis_capability_sr_fad_subtlv_priority <0-255>]
[-isis_capability_sr_fad_subtlv_count <integer>]
[-isis_srv6_locator_tlv_mt_id <integer>]
[-isis_srv6_locator_tlv_metric <integer>]
[-isis_srv6_locator_tlv_flags <string>]
[-isis_srv6_locator_tlv_algorithm <integer>]
[-isis_srv6_locator_tlv_algorithm_step <integer>]
[-isis_srv6_locator_tlv_locator_size <1-128>]
[-isis_srv6_locator_tlv <aaaa:bbbb:cccc:dddd:eeee:ffff:gggg:hhhh>]
[-isis_srv6_locator_tlv_step <aaaa:bbbb:cccc:dddd:eeee:ffff:gggg:hhhh>]
[-isis_srv6_locator_custom_subtlv_sub_type <integer>]
[-isis_srv6_locator_custom_subtlv_value <integer>]
[-isis_srv6_end_sid_subtlv_custom_end_point_fn <integer>]
[-isis_srv6_end_sid_subtlv_enable_custom_end_point_fn {true|false}]
[-isis_srv6_end_sid_subtlv_end_point_func <string>]
[-isis_srv6_end_sid_subtlv_flags <string>]
[-isis_srv6_end_sid_subtlv_sid <aaaa:bbbb:cccc:dddd:eeee:ffff:gggg:hhhh>]
[-isis_srv6_end_sid_subtlv_sid_step <aaaa:bbbb:cccc:dddd:eeee:ffff:gggg:hhhh>]
[-isis_srv6_end_sid_subtlv_step <aaaa:bbbb:cccc:dddd:eeee:ffff:gggg:hhhh>]
[-isis_srv6_end_sid_subtlv_count <integer>]
[-isis_srv6_locator_tlv_count <integer>]
[-isis_srv6_end_sid_custom_subtlv_sub_type <integer>]
[-isis_srv6_end_sid_custom_subtlv_sub_value <integer>]
[-ipv6_addr_end <0:0:0:0:0:0:0:0>]
[-ipv6_addr_start <0:0:0:0:0:0:0:0>]
[-ipv6_isis_prefix_sid_tlv_algorithm <0:0:0:0:0:0:0:0>]
[-ipv6_isis_prefix_sid_tlv_sid_label_index <0:0:0:0:0:0:0:0>]
[-ipv6_isis_prefix_sid_tlv_flags {NONE | RBIT | NBIT | PBIT | EBIT
| VBIT | LBIT}]
[-ipv6_isis_prefix_sid_tlv_algorithm_step <integer>]
[-ipv6_isis_prefix_sid_tlv_sid_label_index_step <integer>]
[-ipv6_router_id_start <aaaa:bbbb:cccc:dddd:eeee:ffff:gggg:hhhh>]
[-ipv6_router_id_step <aaaa:bbbb:cccc:dddd:eeee:ffff:gggg:hhhh>]
[-host_name <string>]
[-ring_num_routers <1-10000>]
[-isis_level <LEVEL1|LEVEL2|LEVEL1_AND_2>]
[-router_id_start <a.b.c.d>]
[-router_id_step <0-0xFFFFFFFF>]
[-system_id_start <000000000000-FFFFFFFFFFFF>]
[-system_id_step <000000000000-FFFFFFFFFFFF>]
[-traffic_engineered_enabled <false|true>]
[-traffic_engineered_band_width_unit <BITS_PER_SEC|BYTES_PER_SEC
|MBYTES_PER_SEC>]
[-traffic_engineered_group <1-4294967295>]
[-traffic_engineered_max_bw <1-4294967295>]
[-traffic_engineered_max_resv_bw <1-4294967295>]
[-traffic_engineered_ip_addr <a.b.c.d>]
[-traffic_engineered_remote_ip_addr <a.b.c.d>]
[-traffic_engineered_unresv_bw_priority0 <1-4294967295>]
[-traffic_engineered_unresv_bw_priority1 <1-4294967295>]
[-traffic_engineered_unresv_bw_priority2 <1-4294967295>]
[-traffic_engineered_unresv_bw_priority3 <1-4294967295>]
[-traffic_engineered_unresv_bw_priority4 <1-4294967295>]
[-traffic_engineered_unresv_bw_priority5 <1-4294967295>]
[-traffic_engineered_unresv_bw_priority6 <1-4294967295>]
[-traffic_engineered_unresv_bw_priority7 <1-4294967295>]
[-handle <isis_session_handle>]
[-type <fullmesh|grid|hubspoke|ring|tree|none>]
[-hubspoke_num_routers <1-100>]
[-hubspoke_emulated_router_pos <ATTACHED_TO_HUB|ATTACHED_TO_SPOKE
|MEMBER_HUB|MEMBER_SPOKE>]
[-fullmesh_num_routers <1-100>]
[-fullmesh_emulated_router_pos <ATTACHED_TO_MESH|MEMBER_OF_MESH>]
[-ring_num_routers <1-10000>]
[-ring_emulated_router_pos <ATTACHED_TO_RING|MEMBER_OF_RING>]
[-tree_if_type <POINT_TO_POINT|BROADCAST>]
[-tree_max_if_per_router <0-100>]
[-tree_max_routers_per_transit_network <2-10000>]
[-tree_num_simulated_routers <1-10000>]
[-grid_attach_column_index <1-10000>]
[-grid_attach_row_index <1-10000>]
[-grid_columns <1-10000>]
[-grid_rows <1-10000>]
[-grid_emulated_router_pos <ATTACHED_TO_GRID|MEMBER_OF_GRID>]
IPv4 Internal Route Generation Parameters
[-ipv4_internal_count <integer>]
[-ipv4_internal_disable_route_aggr {false | true}]
[-ipv4_internal_dup_percent <0-100>]
[-ipv4_internal_emulated_routers {NONE | ALL}]
[-ipv4_internal_enable_ip_addr_override {false | true}]
[-ipv4_internal_ip_addr_end <a.b.c.d>]
[-ipv4_internal_ip_addr_incr <integer>]
[-ipv4_internal_ip_addr_start <a.b.c.d>]
[-ipv4_internal_prefix_len_dist <0-100....>]
[-ipv4_internal_prefix_len_dist_type {FIXED | LINEAR | EXPONENTIAL
| INTERNET | CUSTOM}]
[-ipv4_internal_prefix_len_end <1-32>]
[-ipv4_internal_prefix_len_start <1-32>]
[-ipv4_internal_simulated_routers {NONE | ALL | EDGE}]
[-ipv4_internal_use_ip_addr_incr {false | true}]
[-ipv4_internal_weight_route_assign {BYPORTS | BYSPEED | BYROUTERS}]
[-ipv4_internal_primary_metric <1-16777215>]
[-ipv4_internal_secondary_metric <1-16777215>]
[-ipv4_internal_network_count <integer>]
IPv4 External Route Generation Parameters
[-ipv4_external_count <integer>]
[-ipv4_external_disable_route_aggr {false | true}]
[-ipv4_external_dup_percent <0-100>]
[-ipv4_external_emulated_routers {NONE | ALL}]
[-ipv4_external_enable_ip_addr_override {false | true}]
[-ipv4_external_ip_addr_end <a.b.c.d>]
[-ipv4_external_ip_addr_incr <integer>]
[-ipv4_external_ip_addr_start <a.b.c.d>]
[-ipv4_external_prefix_len_dist <0-100....>]
[-ipv4_external_prefix_len_dist_type {FIXED | LINEAR | EXPONENTIAL
| INTERNET | CUSTOM}]
[-ipv4_external_prefix_len_end <1-32>]
[-ipv4_external_prefix_len_start <1-32>]
[-ipv4_external_simulated_routers {NONE | ALL | EDGE}]
[-ipv4_external_use_ip_addr_incr {false | true}]
[-ipv4_external_weight_route_assign {BYPORTS | BYSPEED | BYROUTERS}]
[-ipv4_external_primary_metric <1-16777215>]
[-ipv4_external_secondary_metric <1-16777215>]
[-ipv4_external_network_count <integer>]
IPv6 Internal Route Generation Parameters
[-ipv6_internal_count <integer>]
[-ipv6_internal_disable_route_aggr {false | true}]
[-ipv6_internal_dup_percent <0-100>]
[-ipv6_internal_emulated_routers {NONE | ALL}]
[-ipv6_internal_enable_ip_addr_override {false | true}]
[-ipv6_internal_ip_addr_end <aaaa:bbbb:cccc:dddd:eeee:ffff:gggg:hhhh>]
[-ipv6_internal_ip_addr_incr <integer>]
[-ipv6_internal_ip_addr_start <aaaa:bbbb:cccc:dddd:eeee:ffff:gggg:hhhh>]
[-ipv6_internal_prefix_len_dist <0-100....>]
[-ipv6_internal_prefix_len_dist_type {FIXED | LINEAR | EXPONENTIAL
| INTERNET | CUSTOM}]
[-ipv6_internal_prefix_len_end <1-128>]
[-ipv6_internal_prefix_len_start <1-128>]
[-ipv6_internal_simulated_routers {NONE | ALL | EDGE}]
[-ipv6_internal_use_ip_addr_incr {false | true}]
[-ipv6_internal_weight_route_assign {BYPORTS | BYSPEED | BYROUTERS}]
[-ipv6_internal_primary_metric <1-16777215>]
[-ipv6_internal_secondary_metric <1-16777215>]
[-ipv6_internal_network_count <integer>]
IPv6 External Route Generation Parameters
[-ipv6_external_count <integer>]
[-ipv6_external_disable_route_aggr {false | true}]
[-ipv6_external_dup_percent <0-100>]
[-ipv6_external_emulated_routers {NONE | ALL}]
[-ipv6_external_enable_ip_addr_override {false | true}]
[-ipv6_external_ip_addr_end <aaaa:bbbb:cccc:dddd:eeee:ffff:gggg:hhhh>]
[-ipv6_external_ip_addr_incr <integer>]
[-ipv6_external_ip_addr_start <aaaa:bbbb:cccc:dddd:eeee:ffff:gggg:hhhh>]
[-ipv6_external_prefix_len_dist <0-100....>]
[-ipv6_external_prefix_len_dist_type {FIXED | LINEAR | EXPONENTIAL
| INTERNET | CUSTOM}]
[-ipv6_external_prefix_len_end <1-128>]
[-ipv6_external_prefix_len_start <1-128>]
[-ipv6_external_simulated_routers {NONE | ALL | EDGE}]
[-ipv6_external_use_ip_addr_incr {false | true}]
[-ipv6_external_weight_route_assign {BYPORTS | BYSPEED | BYROUTERS}]
[-ipv6_external_primary_metric <1-16777215>]
[-ipv6_external_secondary_metric <1-16777215>]
[-ipv6_external_network_count <integer>]
[-segment_routing_enabled <true|false>]
[-sr_adj_sid_enabled <true|false>]
[-sr_adj_flags { bbit | vbit | lbit | sbit } ]
[-sr_adj_value <integer>]
[-sr_adj_value_step <integer>]
[-sr_adj_weight <0-255>]
[-sr_algorithms <string>]
[-sr_cap_range <0-16777215>]
[-sr_cap_value <integer>]
[-sr_cap_value_type {label | sid}]
[-sr_cap_flags {IPV4 |IPV6 |SRV6}]
[-sr_config_prefix_sid_route_enabled {true | false}]
[-sr_mapping_server_enabled {true | false}]
[-sr_sid <integer>]
[-sr_sid_step <integer>]
[-sr_v6_route_enable {true | false}]
[-sr_sid_flags {rbit | nbit | pbit | ebit | vbit | lbit}]
[-sr_sid_prefix_step <1-4294967295>]
[-sr_sid_prefix <1-4294967295>]
[-sr_sid_prefix_ipv6_route {true | false}]
[-sr_anycast_enable {true | false}]
[-sr_algorithm <0-255>]
[-sr_anycast_sid <integer>]
[-sr_anycast_range <1-16777215>]
[-sr_anycast_prefix_sid_flags {rbit | nbit | pbit | ebit | vbit | lbit}]
[-sr_anycast_ipv4_addr <a.b.c.d>]
[-sr_anycast_ipv6_addr <aaaa:bbbb:cccc:dddd:eeee:ffff:gggg:hhhh>]
[-sr_anycast_base <0-4294967295>]
The following options for internal/external routes generation will be
DEPRECATED in future releases. Instead, we recommend you use the
equivalent options prepended with ipv4_internal_xxxx, ipv6_internal_xxx,
ipv4_external_xxxx, or ipv6_external_xxx.
[-internal_count <0-0xFFFFFFFF>]
[-internal_disable_route_aggregation <false|true>]
[-internal_duplication_percentage <0-100>]
[-internal_emulated_routers <NONE|ALL>]
[-internal_enable_ip_addr_override <0-100>]
[-internal_iproute_ip_addr_end <a.b.c.d>]
[-internal_iproute_ipv6_addr_end <0:0:0:0:0:0:0:0>]
[-internal_ip_addr_increment <0-0xFFFFFFFF>]
[-internal_iproute_ip_addr_start <a.b.c.d>]
[-internal_iproute_ipv6_addr_start <0:0:0:0:0:0:0:0>]
[-internal_prefix_length_dist <0-100....>]
[-internal_prefix_length_dist_type <FIXED LINEAR|EXPONENTIAL|INTERNET|CUSTOM>]
[-internal_prefix_length_end <1-32>]
[-internal_prefix_length_start <1-32>]
[-internal_prefix_v6_length_end <1-128>]
[-internal_prefix_v6_length_start <1-128>]
[-internal_simulated_routers <NONE|ALL|EDGE>]
[-internal_use_ip_addr_increment <false|true>]
[-internal_weight_route_assignment <BYPORTS|BYSPEED|BYROUTERS>]
[-internal_primary_metric <1-65535>]
[-internal_route_type {INTERNAL|EXTERNAL}]
[-internal_secondary_metric <1-65535>]
[-external_count <0-0xFFFFFFFF>]
[-external_disable_route_aggregation <false|true>]
[-external_duplication_percentage <0-100>]
[-external_emulated_routers <NONE|ALL>]
[-external_enable_ip_addr_override <0-100>]
[-external_iproute_ip_addr_end <a.b.c.d>]
[-external_iproute_ipv6_addr_end <0:0:0:0:0:0:0:0>]
[-external_ip_addr_increment <0-0xFFFFFFFF>]
[-external_iproute_ip_addr_start <a.b.c.d>]
[-external_iproute_ipv6_addr_start <0:0:0:0:0:0:0:0>]
[-external_prefix_length_dist <0-100....>]
[-external_prefix_length_dist_type <FIXED LINEAR|EXPONENTIAL|INTERNET|CUSTOM>]
[-external_prefix_length_end <1-32>]
[-external_prefix_length_start <1-32>]
[-external_prefix_v6_length_end <1-128>]
[-external_prefix_v6_length_start <1-128>]
[-external_simulated_routers <NONE|ALL|EDGE>]
[-external_use_ip_addr_increment <false|true>]
[-external_weight_route_assignment <BYPORTS|BYSPEED|BYROUTERS>]
[-external_primary_metric <1-65535>]
[-external_route_type {INTERNAL|EXTERNAL}]
[-external_secondary_metric <1-65535>]
Arguments¶
-
-elem_handle¶ Specifies which topology element to modify or delete. You must specify this argument if the mode is modify or delete (see description for -mode).
-
-loopback_adver_enable¶ Generates a 32-bit internal route that is equal to the LSP TE router ID TLV. This enables a simulated ISIS router to advertise its router ID (loopback address) as a 32-bit route in a self-originated LSP, as required for MPLS, Martini, and TE tests. The default value is false.
-
-lsp_life_time¶ Specifies the remaining lifetime (in seconds) of the LSP. Possible values range from 1 to 65535. The default is 1200.
-
-ipv4_addr_end¶ Specifies the global/default ending IPv4 address value used for routes and interface addresses. The default value is 223.255.255.255.
-
-ipv4_addr_start¶ Specifies the global/default starting IPv4 address value used for routes and interface addresses. The default value is 1.0.0.0.
-
-delete_existing_routes¶ Specifies how to handle pre-existing routes when route/topology generator parameters are applied. Possible values are:
true Delete pre-existing routes false Keep pre-existing routes
The default value is false
-
-ipv4_isis_prefix_sid_tlv_flags¶ Spirent Extension (for Spirent HLTAPI only).
Specifies the required octet fields defined in the Prefix-SID TLV of IPv4 ISIS routes. Possible values are described below:
nbit Node-SID flag npbit No-PHP flag mbit Mapping Server flag ebit Explicit-Null flag vbit Value/Index flag lbit Local/Global flag
Use | to specify multiple flags.
-
-ipv4_isis_prefix_sid_tlv_sid_label_index¶ Specifies the value of the first index defining the offset in the SID/Label space advertised by the IPv4 route. The default value is 0.
-
-ipv4_isis_prefix_sid_tlv_algorithm¶ Specifies the algorithm value to use to calculate reachability to other nodes or to prefixes attached to the nodes. The default value is 0.
-
-ipv4_isis_prefix_sid_tlv_algorithm_step¶ Defines the step size in which the IPv4 Prefix SID Sub-TLV algorithm (-ipv4_isis_prefix_sid_tlv_algorithm) is incremented.
-
-ipv4_isis_prefix_sid_tlv_sid_label_index_step¶ Defines the step size in which the IPv4 Prefix SID Sub-TLV first index defining the offset in the SID/Label space (-ipv4_isis_prefix_sid_tlv_sid_label_index) is incremented.
-
-ipv6_isis_prefix_sid_tlv_algorithm¶ Specifies the algorithm value to use to calculate reachability to other nodes or to prefixes attached to the nodes. The default value is 0.
-
-ipv6_isis_prefix_sid_tlv_sid_label_index¶ Specifies the value of the first index defining the offset in the SID/Label space advertised by the IPv6 route. The default value is 0.
-
-ipv4_isis_prefix_attribute_sub_tlv_flags¶ Specifies the required octet fields defined in the Prefix Attribute Sub-TLV of IPv4 ISIS routes. Possible values are described below:
XBIT External Prefix Flag RBIT Re-advertisement Flag NBIT Node Flag
Use | to specify multiple flags. This argument is only available for the modify mode.
-
-ipv6_isis_prefix_attribute_sub_tlv_flags¶ Specifies the required octet fields defined in the Prefix Attribute Sub-TLV of IPv6 ISIS routes. Possible values are described below:
XBIT External Prefix Flag RBIT Re-advertisement Flag NBIT Node Flag
Use | to specify multiple flags. This argument is only available for the modify mode.
-
-ipv4_isis_source_router_id_sub_tlv¶ Specifies the IPv4 source router ID. The default value is 192.0.1.0. This argument is only available for the modify mode.
-
-ipv6_isis_source_router_id_sub_tlv¶ Specifies the IPv6 source router ID. The default value is 192.0.1.0. This argument is only available for the modify mode.
-
-ipv6_isis_srv6_prefix_sid_sub_tlv_flags¶ Specifies the required octet fields defined in the SR Prefix-SID Sub-TLV of IPv6 ISIS routes. The default value is 0. This argument is only available for the modify mode.
-
-ipv6_isis_srv6_prefix_sid_sub_tlv_algorithm¶ Specifies the value of segment routing algorithm. The default value is 0. This argument is only available for the modify mode.
-
-ipv4_isis_bier_label_binding_tlv_bfr_id¶ Specifies the value of the bit-forwarding router ID. Possible values are 1-65535. The default value is 1. This argument is only available for the modify mode.
-
-ipv4_isis_bier_label_binding_tlv_sub_domain_id¶ Specifies the value of the sub-domain ID. Possible values are 0-255. The default value is 1. This argument is only available for the modify mode.
-
-ipv4_isis_bier_label_binding_tlv_igp_algorithm¶ Specifies the value of the Interior gateway protocol routing algorithm. Possible values are 0-255. The default value is 0. This argument is only available for the modify mode.
-
-ipv4_isis_bier_label_binding_tlv_bier_algorithm¶ Specifies the value of the Bit index explicit replication algorithm. Possible values are 0-255. The default value is 0. This argument is only available for the modify mode.
-
-ipv4_isis_bier_label_binding_tlv_type¶ Specifies the value of the TLV type identifier. Possible values are 0-255. The default value is 7. This argument is only available for the modify mode.
-
-ipv4_isis_bier_mpls_sub_tlv_encap_type¶ Specifies the value of the Bier MPLS Encap Tlv Type. Possible values are 0-255. The default value is 1. This argument is only available for the modify mode.
-
-ipv4_isis_bier_mpls_sub_tlv_bs_len¶ Specifies the value of Encoded bitstring length. Possible values are 0-255. The default value is 1. This argument is only available for the modify mode.
-
-ipv4_isis_bier_mpls_subtlv_label¶ Specifies the value of MPLS label. Possible values are 0-4294967295. The default value is 100. This argument is only available for the modify mode.
-
-ipv4_isis_bier_mpls_subtlv_max_set_id¶ Specifies the maximum set ID value. Possible values are 0-255. The default value is 1. This argument is only available for the modify mode.
-
-isis_lsp_neighbor_config_sys_id¶ Specifies the ISIS LSP neighbor system ID. Default value is 00:00:00:00:00:00.
-
-isis_lsp_neighbor_config_sys_id_step¶ Defines the step size in which the neighbor system ID (-isis_lsp_neighbor_config_sys_id) is incremented. You can use this argument if the value of -isis_lsp_neighbor_config_count is larger than 1.
-
-isis_lsp_neighbor_config_node_id¶ Specifies the ID of the simulated routers interface. Possible values are 0 to 255. The default is 0.
-
-isis_lsp_neighbor_config_wide_metric¶ Specifies the wide metric which is used for traffic engineering. Disabled if metric mode is set to narrow. Possible values are 0 to 16777215. The default is 1.
-
-isis_lsp_neighbor_config_metric¶ Specifies the ISIS metric value. Disabled if metric mode is set to wide. Possible values are 0 to 63. The default is 1.
-
-isis_lsp_neighbor_config_enable_srlg_tlv¶ Enables or disables SRLG (Shared Risk Link Groups) TLV. Possible values are true or false. The default value is false.
-
-isis_lsp_neighbor_config_ipv4_addr¶ Specifies the IPv4 Interface Address or Link Local Identifier.
-
-isis_lsp_neighbor_config_ipv4_addr_step¶ Defines the step size in which the IPv4 interface address (-isis_lsp_neighbor_config_ipv4_addr) is incremented. You can use this argument if the value of -isis_lsp_neighbor_config_count is larger than 1.
-
-isis_lsp_neighbor_config_ipv4_nbr_addr_step¶ Defines the step size in which the IPv4 neighbor address (-isis_lsp_neighbor_config_ipv4_nbr_addr) is incremented. You can use this argument if the value of -isis_lsp_neighbor_config_count is larger than 1.
-
-isis_lsp_neighbor_config_ipv4_nbr_addr¶ Specifies the IPv4 Neighbor Address or Link Remote Identifier.
-
-isis_lsp_neighbor_config_srlg_flags¶ Specifies the SRLG flags. The default value is UBIT. Possible values are:
Value Description UBIT Interface is Unnumbered(set to 0) NBIT Interface is Numbered(set to 1)
-
-isis_lsp_neighbor_config_srlg_values¶ Specifies the list of SRLG Values. The default value is 0.
-
-isis_lsp_neighbor_config_count¶ Specifies the number of ISIS LSP neighbor objects to create under the LSP.
-
-isis_lsp_neighbor_config_te_params¶ Specifies the Traffic engineering sub-TLV type of information about resources of routed links. The default value is NONE. Possible values are:
Value Description NONE No sub-TLV is used GROUP Mask value assigned by the network administrator Each bit corresponds to one administrative group assigned to the interface MAX_BW Maximum bandwidth that can be used on the link from the emulated router MAX_RSV_BW Maximum bandwidth that can be reserved on the link UNRESERVED Amount of bandwidth not yet reserved LOCAL_IP IP address of the interface corresponding to the current link REMOTE_IP IP address of the neighbor's interface corresponding to the current link DEFAULT_METRIC Default Metric IPV6_LOCAL_IP IPv6 address of the interface corresponding to the current link IPV6_REMOTE_IP IPv6 address of the neighbor's interface corresponding to the current link UNIDIRECTIONAL_LINK_DELAY Unidirectional Link Delay MIN_MAX_UNIDIRECTIONAL_LINK_DELAY Min/Max Unidirectional Link Delay UNIDIRECTIONAL_DELAY_VARIATION Unidirectional Delay Variation UNIDIRECTIONAL_LINK_LOSS Unidirectional Link Loss UNIDIRECTIONAL_RESIDUAL_BANDWIDTH Unidirectional Residual Bandwidth UNIDIRECTIONAL_AVAILABLE_BANDWIDTH Unidirectional Available Bandwidth UNIDIRECTIONAL_UTILIZED_BANDWIDTH Unidirectional Utilized Bandwidth
-
-isis_lsp_neighbor_config_te_bw_unit¶ Specifies the bandwidth units of measurement. The default value is BYTES_PER_SEC. Possible values are:
Value Description BITS_PER_SEC Bandwidths are in bits per second BYTES_PER_SEC Bandwidths are in bytes per second MBYTES_PER_SEC Bandwidths are in megabytes per second
-
-isis_lsp_neighbor_config_te_local_ipv4¶ Specifies the IP address of the interface corresponding to the current link. The default value is 0.0.0.0.
-
-isis_lsp_neighbor_config_te_local_ipv4_step¶ Defines the step size in which the IPv4 interface address (-isis_lsp_neighbor_config_te_local_ipv4) is incremented. You can use this argument if the value of -isis_lsp_neighbor_config_count is larger than 1.
-
-isis_lsp_neighbor_config_te_remote_ipv4¶ Specifies the IP address of the neighbor’s interface corresponding to the current link. The default value is 0.0.0.0.
-
-isis_lsp_neighbor_config_te_remote_ipv4_step¶ Defines the step size in which the IPv4 interface address (-isis_lsp_neighbor_config_te_remote_ipv4) is incremented. You can use this argument if the value of -isis_lsp_neighbor_config_count is larger than 1.
-
-isis_lsp_neighbor_config_te_local_ipv6_step¶ Defines the step size in which the IPv6 interface address (-isis_lsp_neighbor_config_te_local_ipv6) is incremented. You can use this argument if the value of -isis_lsp_neighbor_config_count is larger than 1.
-
-isis_lsp_neighbor_config_te_remote_ipv6_step¶ Defines the step size in which the IPv6 interface address (-isis_lsp_neighbor_config_te_remote_ipv6) is incremented. You can use this argument if the value of -isis_lsp_neighbor_config_count is larger than 1.
-
-isis_lsp_neighbor_config_te_local_ipv6¶ Specifies the local IPv6 address. The default value is 2000::.
-
-isis_lsp_neighbor_config_te_remote_ipv6¶ Specifies the remote IPv6 address. The default value is 2000::.
-
-isis_lsp_neighbor_config_te_group¶ Specifies the mask assigned by the network administrator. Possible values are 1 to 4294967295. The default value is 1.
-
-isis_lsp_neighbor_config_te_group_step¶ Defines the step size in which the group value of traffic engineering (-isis_lsp_neighbor_config_te_group) is incremented. You can use this argument if the value of -isis_lsp_neighbor_config_count is larger than 1.
-
-isis_lsp_neighbor_tlv_config_te_group_step¶ Defines the step size in which the group value of traffic engineering (-isis_lsp_neighbor_config_te_group) is incremented between the LSP neighbor TLVs.
-
-isis_lsp_neighbor_config_te_max_bw¶ Specifies the maximum bandwidth that can be used on the link from the emulated router. Possible values are 1 to 4294967295. The default value is 100000.
-
-isis_lsp_neighbor_config_te_rsvr_bw¶ Specifies the maximum bandwidth that can be reserved on the link from the emulated router. Possible values are 1 to 4294967295. The default value is 100000.
-
-isis_lsp_neighbor_config_te_unrsvr_bw0¶ Specifies the amount of bandwidth not yet reserved at priority level 0. Possible values are 1 to 4294967295. The default value is 100000.
-
-isis_lsp_neighbor_config_te_unrsvr_bw1¶ Specifies the amount of bandwidth not yet reserved at priority level 1. Possible values are 1 to 4294967295. The default value is 100000.
-
-isis_lsp_neighbor_config_te_unrsvr_bw2¶ Specifies the amount of bandwidth not yet reserved at priority level 2. Possible values are 1 to 4294967295. The default value is 100000.
-
-isis_lsp_neighbor_config_te_unrsvr_bw3¶ Specifies the amount of bandwidth not yet reserved at priority level 3. Possible values are 1 to 4294967295. The default value is 100000.
-
-isis_lsp_neighbor_config_te_unrsvr_bw4¶ Specifies the amount of bandwidth not yet reserved at priority level 4. Possible values are 1 to 4294967295. The default value is 100000.
-
-isis_lsp_neighbor_config_te_unrsvr_bw5¶ Specifies the amount of bandwidth not yet reserved at priority level 5. Possible values are 1 to 4294967295. The default value is 100000.
-
-isis_lsp_neighbor_config_te_unrsvr_bw6¶ - Specifies the amount of bandwidth not yet reserved
- at priority level 6. Possible values are 1 to 4294967295. The default value is 100000.
-
-isis_lsp_neighbor_config_te_unrsvr_bw7¶ Specifies the amount of bandwidth not yet reserved at priority level 7. Possible values are 1 to 4294967295. The default value is 100000.
-
-isis_lsp_neighbor_config_te_default_metric¶ Specifies the TE default metric. The default value is 0.
-
-isis_lsp_neighbor_config_te_ext_admin_group¶ Specifies the extended administrative group value of ISIS LSP Neighbor TLV TE parameters.
-
-isis_lsp_neighbor_config_te_unilink_delay¶ Specifies the Unidirectional Link Delay. Possible values are 1 to 16777215. The default value is 100000.
-
-isis_lsp_neighbor_config_te_unilink_delay_aflag¶ Specifies the A flag. The default value is false. Possible values are true or false.
-
-isis_lsp_neighbor_config_te_min_max_uni_link_min_delay¶ Specifies the Min/Max Unidirectional Link Min Delay. Possible values are 1 to 16777215. The default value is 100000.
-
-isis_lsp_neighbor_config_te_min_max_uni_link_max_delay¶ Specifies the Min/Max Unidirectional Link Max Delay. Possible values are 1 to 16777215. The default value is 100000.
-
-isis_lsp_neighbor_config_te_min_max_uni_link_delay_aflag¶ Specifies the Min/Max Unidirectional Link Delay A flag. Possible values are true or false. The default value is false.
-
-isis_lsp_neighbor_config_te_uni_delay_variation¶ Specifies the Unidirectional Delay Variation. Possible values are 1 to 16777215. The default value is 100000.
-
-isis_lsp_neighbor_config_te_uni_link_loss¶ Specifies the Unidirectional Link Loss. Possible values are 0.000003 to 50.331642. The default value is 3.
-
-isis_lsp_neighbor_config_te_uni_link_loss_aflag¶ Specifies the Unidirectional Link Loss A flag. Possible values are true or false. The default value is false.
-
-isis_lsp_neighbor_config_te_uni_residual_bw¶ Specifies the Unidirectional Residual Bandwidth. Possible values are 1 to 4294967295. The default value is 100000.
-
-isis_lsp_neighbor_config_te_uni_available_bw¶ Specifies the Unidirectional Available Bandwidth. Possible values are 1 to 4294967295. The default value is 100000.
-
-isis_lsp_neighbor_config_te_uni_utilized_bw¶ Specifies the Unidirectional Utilized Bandwidth. Possible values are 1 to 4294967295. The default value is 100000.
-
-isis_neighbor_srv6_end_x_sid_subtlv_custom_end_point_fn¶ Specifies the ISIS SRv6 End X SID Sub TLV Custom Endpoint Function. The default value is 0.
-
-isis_neighbor_srv6_end_x_sid_subtlv_enable_custom_end_point_fn¶ Enables or disables ISIS SRv6 End X SID Sub TLV Custom Endpoint Function. Possible values are true or false. The default value is false.
-
-isis_neighbor_srv6_end_x_sid_subtlv_end_point_func¶ Specifies the ISIS SRv6 End X SID Sub TLV Endpoint Function. The default value is ENDWOPSP_USP. Possible values are:
Value Description ENDWOPSP_USP Endpoint function without Penultimate Segment Pop (PSP) and Ultimate Segment Pop (USP) ENDWPSP Endpoint function with Penultimate Segment Pop (PSP) ENDWUSP Endpoint function with Ultimate Segment Pop (USP) ENDWPSP_USP Endpoint function with Penultimate Segment Pop (PSP) and Ultimate Segment Pop (USP) ENDXWOPSP_USP End.X function without Penultimate Segment Pop (PSP) and Ultimate Segment Pop (USP) ENDXW_PSP End.X function with Penultimate Segment Pop (PSP) ENDXW_USP End.X function with Ultimate Segment Pop (USP) ENDXWPSP_USP End.X function with Penultimate Segment Pop (PSP) and Ultimate Segment Pop (USP) ENDTWOPSP_USP End.T function without Penultimate Segment Pop (PSP) and Ultimate Segment Pop (USP) ENDTWPSP End.T function with Penultimate Segment Pop (PSP) ENDTWUSP End.T function with Ultimate Segment Pop (USP) ENDTWPSP_USP End.T function with Penultimate Segment Pop (PSP) and Ultimate Segment Pop (USP) ENDB6 Endpoint bound to an SRv6 policy ENDB6ENCAPS Endpoint bound to an SRv6 encapsulation Policy ENDBM Endpoint bound to an SR-MPLS Policy ENDDX6 Endpoint with decapsulation and IPv6 cross connect ENDDX4 Endpoint with decapsulation and IPv6 cross connect ENDDT6 Endpoint with decapsulation and IPv6 table lookup ENDDT4 Endpoint with decapsulation and IPv4 table lookup ENDDT46 The Endpoint with decapsulation and specific IP table lookup function is a variant of the End.DT4 and End.DT6 functions ENDDX2 Endpoint with decapsulation and Layer2 cross connect. Used for L2VPN use cases ENDDX2V The Endpoint with decapsulation and specific VLAN table lookup function is a variant of the endpoint function ENDDT2U The Endpoint with decapsulation and specific unicast MAC L2 table lookup function is a variant of the endpoint function ENDDT2M The Endpoint with decapsulation and specific L2 table flooding function is a variant of the endpoint function ENDOTP Advertise only ENDS Endpoint in search of a target in table T
-
-isis_neighbor_srv6_end_x_sid_subtlv_flags¶ Specifies the ISIS SRv6 End X SID Sub TLV flags. The default value is 0. Possible values are:
Value Description BBIT B bit SBIT S bit PBIT P bit UNUSED3 UNUSED3 UNUSED4 UNUSED4 UNUSED5 UNUSED5 UNUSED6 UNUSED6 UNUSED7 UNUSED7
-
-isis_neighbor_srv6_end_x_sid_subtlv_sid¶ Specifies the ISIS SRv6 End X SID Sub TLV SID value. The default value is aaaa:1:1:1::1.
-
-isis_neighbor_srv6_end_x_sid_subtlv_algorithm¶ Specifies the ISIS SRv6 End X SID Sub TLV algorithm. The default value is 0.
-
-isis_neighbor_srv6_end_x_sid_subtlv_sid_step¶ Defines the step size in which the SID (-isis_neighbor_srv6_end_x_sid_subtlv_sid) is incremented. You can use this argument if the value of -isis_neighbor_srv6_end_x_sid_subtlv_count is larger than 1.
-
-isis_neighbor_srv6_end_x_sid_subtlv_algorithm_step¶ Defines the step size in which the algorithm (-isis_neighbor_srv6_end_x_sid_subtlv_algorithm) is incremented. You can use this argument if the value of -isis_neighbor_srv6_end_x_sid_subtlv_count is larger than 1.
-
-isis_neighbor_srv6_end_x_sid_subtlv_weight¶ Specifies the ISIS SRv6 End X SID Sub TLV weight. The default value is 100.
-
-isis_neighbor_srv6_end_x_sid_custom_subtlv_sub_type¶ Specifies the Sub Type value of ISIS Custom Sub TLV. The default value is 0.
-
-isis_neighbor_srv6_end_x_sid_custom_subtlv_value¶ Specifies the Sub Value of ISIS Custom Sub TLV. The default value is 0.
-
-isis_neighbor_srv6_end_x_sid_subtlv_count¶ Specifies the number of ISIS SRv6 End X SID Sub TLV to create under the LSP.
-
-isis_neighbor_srv6_lan_end_x_sid_subtlv_count¶ Specifies the number of ISIS SRv6 LAN End X SID Sub TLV to create under the LSP.
-
-isis_neighbor_srv6_lan_end_x_sid_subtlv_algorithm¶ Specifies the ISIS SRv6 LAN End X SID Sub TLV algorithm. The default value is 0.
-
-isis_neighbor_srv6_lan_end_x_sid_subtlv_algorithm_step¶ Defines the step size in which the algorithm (-isis_neighbor_srv6_lan_end_x_sid_subtlv_algorithm) is incremented. You can use this argument if the value of -isis_neighbor_srv6_lan_end_x_sid_subtlv_count is larger than 1.
-
-isis_neighbor_srv6_lan_end_x_sid_subtlv_custom_end_point_fn¶ Specifies the ISIS SRv6 LAN End X SID Sub TLV Custom Endpoint Function. The default value is 0.
-
-isis_neighbor_srv6_lan_end_x_sid_subtlv_enable_custom_end_point_fn¶ Enables or disables ISIS SRv6 LAN End X SID Sub TLV Custom Endpoint Function. Possible values are true or false. The default value is false.
-
-isis_neighbor_srv6_lan_end_x_sid_subtlv_end_point_func¶ Specifies the ISIS SRv6 LAN End X SID Sub TLV Endpoint Function. The default value is ENDWOPSP_USP. Possible values are:
Value Description ENDWOPSP_USP Endpoint function without Penultimate Segment Pop (PSP) and Ultimate Segment Pop (USP) ENDWPSP Endpoint function with Penultimate Segment Pop (PSP) ENDWUSP Endpoint function with Ultimate Segment Pop (USP) ENDWPSP_USP Endpoint function with Penultimate Segment Pop (PSP) and Ultimate Segment Pop (USP) ENDXWOPSP_USP End.X function without Penultimate Segment Pop (PSP) and Ultimate Segment Pop (USP) ENDXW_PSP End.X function with Penultimate Segment Pop (PSP) ENDXW_USP End.X function with Ultimate Segment Pop (USP) ENDXWPSP_USP End.X function with Penultimate Segment Pop (PSP) and Ultimate Segment Pop (USP) ENDTWOPSP_USP End.T function without Penultimate Segment Pop (PSP) and Ultimate Segment Pop (USP) ENDTWPSP End.T function with Penultimate Segment Pop (PSP) ENDTWUSP End.T function with Ultimate Segment Pop (USP) ENDTWPSP_USP End.T function with Penultimate Segment Pop (PSP) and Ultimate Segment Pop (USP) ENDB6 Endpoint bound to an SRv6 policy ENDB6ENCAPS Endpoint bound to an SRv6 encapsulation Policy ENDBM Endpoint bound to an SR-MPLS Policy ENDDX6 Endpoint with decapsulation and IPv6 cross connect ENDDX4 Endpoint with decapsulation and IPv6 cross connect ENDDT6 Endpoint with decapsulation and IPv6 table lookup ENDDT4 Endpoint with decapsulation and IPv4 table lookup ENDDT46 The Endpoint with decapsulation and specific IP table lookup function is a variant of the End.DT4 and End.DT6 functions ENDDX2 Endpoint with decapsulation and Layer2 cross connect. Used for L2VPN use cases ENDDX2V The Endpoint with decapsulation and specific VLAN table lookup function is a variant of the endpoint function ENDDT2U The Endpoint with decapsulation and specific unicast MAC L2 table lookup function is a variant of the endpoint function ENDDT2M The Endpoint with decapsulation and specific L2 table flooding function is a variant of the endpoint function ENDOTP Advertise only ENDS Endpoint in search of a target in table T
-
-isis_neighbor_srv6_lan_end_x_sid_subtlv_flags¶ Specifies the ISIS SRv6 LAN End X SID Sub TLV flags. The default value is 0. Possible values are:
Value Description BBIT B bit SBIT S bit PBIT P bit UNUSED3 UNUSED3 UNUSED4 UNUSED4 UNUSED5 UNUSED5 UNUSED6 UNUSED6 UNUSED7 UNUSED7
-
-isis_neighbor_srv6_lan_end_x_sid_subtlv_sid¶ Specifies the ISIS SRv6 LAN End X SID Sub TLV SID value. The default value is aaaa:1:1:1::1.
-
-isis_neighbor_srv6_lan_end_x_sid_subtlv_sid_step¶ Defines the step size in which the SID (-isis_neighbor_srv6_lan_end_x_sid_subtlv_sid) is incremented. You can use this argument if the value of -isis_neighbor_srv6_lan_end_x_sid_subtlv_count is larger than 1.
-
-isis_neighbor_srv6_lan_end_x_sid_subtlv_weight¶ Specifies the ISIS SRv6 LAN End X SID Sub TLV weight. The default value is 100.
-
-isis_neighbor_srv6_lan_end_x_sid_subtlv_system_id¶ Specifies the ISIS SRv6 LAN End X SID Sub TLV system ID. The default value is 00:10:94:00:00:01.
-
-isis_neighbor_srv6_lan_end_x_sid_subtlv_system_id_step¶ Defines the step size in which the system ID (-isis_neighbor_srv6_lan_end_x_sid_subtlv_system_id) is incremented. You can use this argument if the value of -isis_neighbor_srv6_lan_end_x_sid_subtlv_count is larger than 1.
-
-isis_neighbor_srv6_lan_end_x_sid_custom_subtlv_sub_type¶ Specifies the Sub Type value of ISIS Custom Sub TLV. The default value is 0.
-
-isis_neighbor_srv6_lan_end_x_sid_custom_subtlv_value¶ Specifies the Sub Value of ISIS Custom Sub TLV. The default value is 0.
-
-isis_neighbor_lan_adj_sid_subtlv_flags¶ Specifies the ISIS LAN Adj SID Sub TLV flags. The default value is VBIT|LBIT. Possible values are:
Value Description FBIT Address Family flag BBIT Backup flag VBIT Value flag LBIT Local flag SBIT Set flag PBIT Persistent flag
-
-isis_neighbor_lan_adj_sid_subtlv_system_id¶ Specifies the ISIS LAN Adj SID Sub TLV system ID. The default value is 00:00:00:00:00:00.
-
-isis_neighbor_lan_adj_sid_subtlv_system_id_step¶ Defines the step size in which the system ID (-isis_neighbor_lan_adj_sid_subtlv_system_id) is incremented. You can use this argument if the value of -isis_neighbor_lan_adj_sid_subtlv_count is larger than 1.
-
-isis_neighbor_lan_adj_sid_subtlv_weight¶ Specifies the ISIS LAN Adj SID Sub TLV weight. The default value is 1.
-
-isis_neighbor_lan_adj_sid_subtlv_count¶ Specifies the number of ISIS LAN Adj SID Sub TLV to create under the LSP.
-
-isis_neighbor_plsb_link_metric_subtlv_link_attributes¶ Specifies the PLSB instance link attributes. Possible values are 0 to 16777215. The default value is 0.
-
-isis_neighbor_plsb_link_metric_subtlv_link_metric¶ Specifies the PLSB instance link metric. Possible values are 0 to 16777215. The default value is 8388608.
-
-isis_neighbor_plsb_link_metric_subtlv_instance¶ Specifies the PLSB instance value. Possible values are 0 to 255. The default value is 0.
-
-isis_neighbor_spb_link_metric_subtlv_link_metric¶ Specifies the link metric value of ISIS SPB link metric sub-TLV. Possible values are 0 to 16777215. The default value is 10.
-
-isis_neighbor_spb_link_metric_subtlv_ports¶ Specifies the number of ports in ISIS SPB link metric sub-TLV. Possible values are 1 to 255. The default value is 1.
-
-isis_neighbor_spb_link_metric_subtlv_port_id¶ Specifies the port ID of ISIS SPB link metric sub-TLV. Possible values are 0 to 65535. The default value is 0.
-
-isis_neighbor_sr_msd_subtlv_flags¶ Specifies the MSD Sub TLVs. The default value is 0. Possible values are:
Value Description MAXIMUMSEGMENTSLEFT Specifies the maximum value of the SL field in the SRH of a received packet before applying the Endpoint behavior associated with a SID MAXIMUMENDPOP Specifies the maximum number of SIDs in the SRH to which the router can apply PSP or USP behavior MAXIMUMTINSERTSRH Specifies the maximum number of SIDs in the SRH included as part of the T.Insert behavior MAXIMUMTENCAPSRH Specifies the maximum number of SIDs that can be included as part of the T.Encaps behavior MAXIMUMENDDSRH Specifies the maximum number of SIDs in an SRH when performing decapsulation associated with End.Dx behaviors
-
-isis_neighbor_sr_msd_subtlv_max_end_d¶ Specifies the maximum End D SRH. The default value is 8.
-
-isis_neighbor_sr_msd_subtlv_max_end_pop¶ Specifies the maximum End Pop. The default value is 8.
-
-isis_neighbor_sr_msd_subtlv_max_seg_left¶ Specifies the maximum Segments Left. The default value is 8.
-
-isis_neighbor_sr_msd_subtlv_max_hencap¶ Specifies the maximum T.Encap SRH. The default value is 8.
-
-isis_neighbor_sr_msd_subtlv_count¶ Specifies the number of SR MSD Sub TLV to create under the LSP.
-
-isis_neighbor_sr_msd_subtlv_sub_type¶ Specifies the Sub Type value of ISIS Custom Sub TLV. The default value is 0.
-
-isis_neighbor_sr_msd_subtlv_value¶ Specifies the Sub Value of ISIS Custom Sub TLV. The default value is 0.
-
-isis_neighbor_app_spec_attr_subtlv_lflag¶ Enables or disables Use Legacy TE Parameters. Possible values are true or false. The default value is false.
-
-isis_neighbor_app_spec_attr_subtlv_sa_bit_mask¶ Specifies the Standard Application Bit Mask. The default value is 0. Possible values are:
Value Description RSVP_TE RSVP-TE (R-bit) SR_TE Segment Routing Traffic Engineering (S-bit) LOOP_FREE_ALTERNATE Loop Free Alternate (F-bit) FLEX_ALGO Flex Algorithm (X-bit)
-
-isis_neighbor_app_spec_attr_subtlv_sa_len¶ Specifies the Standard Application Length. Possible values are 0 to 127. The default value is 1.
-
-isis_neighbor_app_spec_attr_subtlv_uda_bit_mask¶ Specifies the User Defined Application Bit Mask. The default value is 0.
-
-isis_neighbor_app_spec_attr_subtlv_uda_len¶ Specifies the User Defined Application Length. Possible values are 0 to 127. The default value is 1.
-
-isis_neighbor_app_spec_attr_subtlv_count¶ Specifies the number of ISIS Application Specific Attribute Sub TLV to create under the LSP.
-
-isis_neighbor_app_spec_attr_subtlv_te_params¶ Specifies the Traffic engineering sub-TLV type of information about resources of routed links. The default value is NONE. Possible values are:
Value Description NONE No sub-TLV is used GROUP Mask value assigned by the network administrator Each bit corresponds to one administrative group assigned to the interface MAX_BW Maximum bandwidth that can be used on the link from the emulated router MAX_RSV_BW Maximum bandwidth that can be reserved on the link UNRESERVED Amount of bandwidth not yet reserved LOCAL_IP IP address of the interface corresponding to the current link REMOTE_IP IP address of the neighbor's interface corresponding to the current link DEFAULT_METRIC Default Metric IPV6_LOCAL_IP IPv6 address of the interface corresponding to the current link IPV6_REMOTE_IP IP address of the neighbor's interface corresponding to the current link UNIDIRECTIONAL_LINK_DELAY Unidirectional Link Delay MIN_MAX_UNIDIRECTIONAL_LINK_DELAY Min/Max Unidirectional Link Delay UNIDIRECTIONAL_DELAY_VARIATION Unidirectional Delay Variation UNIDIRECTIONAL_LINK_LOSS Unidirectional Link Loss UNIDIRECTIONAL_RESIDUAL_BANDWIDTH Unidirectional Residual Bandwidth UNIDIRECTIONAL_AVAILABLE_BANDWIDTH Unidirectional Available Bandwidth UNIDIRECTIONAL_UTILIZED_BANDWIDTH Unidirectional Utilized Bandwidth
-
-isis_neighbor_app_spec_attr_subtlv_te_bw_unit¶ Specifies the bandwidth units of measurement. The default value is BYTES_PER_SEC. Possible values are:
Value Description BITS_PER_SEC Bandwidths are in bits per second BYTES_PER_SEC Bandwidths are in bytes per second MBYTES_PER_SEC Bandwidths are in megabytes per second
-
-isis_neighbor_app_spec_attr_subtlv_te_local_ipv4¶ Specifies the IP address of the interface corresponding to the current link. The default value is 0.0.0.0.
-
-isis_neighbor_app_spec_attr_subtlv_te_remote_ipv4¶ Specifies the IP address of the neighbor’s interface corresponding to the current link. The default value is 0.0.0.0.
-
-isis_neighbor_app_spec_attr_subtlv_te_local_ipv4_step¶ Defines the step size in which the IPv4 interface address (-isis_neighbor_app_spec_attr_subtlv_te_local_ipv4) is incremented. You can use this argument if the value of -isis_neighbor_app_spec_attr_subtlv_count is larger than 1.
-
-isis_neighbor_app_spec_attr_subtlv_te_remote_ipv4_step¶ Defines the step size in which the IPv4 interface address (-isis_neighbor_app_spec_attr_subtlv_te_remote_ipv4) is incremented. You can use this argument if the value of -isis_neighbor_app_spec_attr_subtlv_count is larger than 1.
-
-isis_neighbor_app_spec_attr_subtlv_te_remote_ipv6_step¶ Defines the step size in which the IPv6 interface address (-isis_neighbor_app_spec_attr_subtlv_te_remote_ipv6) is incremented. You can use this argument if the value of -isis_neighbor_app_spec_attr_subtlv_count is larger than 1.
-
-isis_neighbor_app_spec_attr_subtlv_te_local_ipv6_step¶ Defines the step size in which the IPv6 interface address (-isis_neighbor_app_spec_attr_subtlv_te_local_ipv6) is incremented. You can use this argument if the value of -isis_neighbor_app_spec_attr_subtlv_count is larger than 1.
-
-isis_neighbor_app_spec_attr_subtlv_te_local_ipv6¶ Specifies the local IPv6 address. The default value is 2000::.
-
-isis_neighbor_app_spec_attr_subtlv_te_remote_ipv6¶ Specifies the remote IPv6 address. The default value is 2000::.
-
-isis_neighbor_app_spec_attr_subtlv_te_group¶ Specifies the mask assigned by the network administrator. Possible values are 1 to 4294967295. The default value is 1.
-
-isis_neighbor_app_spec_attr_subtlv_te_group_step¶ Defines the step size in which the group value of traffic engineering (-isis_neighbor_app_spec_attr_subtlv_te_group) is incremented. You can use this argument if the value of -isis_neighbor_app_spec_attr_subtlv_count is larger than 1.
-
-isis_neighbor_app_spec_attr_tlv_config_te_group_step¶ Defines the step size in which the group value of traffic engineering (-isis_neighbor_app_spec_attr_subtlv_te_group) is incremented between the LSP neighbor TLVs.
-
-isis_neighbor_app_spec_attr_subtlv_te_max_bw¶ Specifies the maximum bandwidth that can be used on the link from the emulated router. Possible values are 1 to 4294967295. The default value is 100000.
-
-isis_neighbor_app_spec_attr_subtlv_te_rsvr_bw¶ Specifies the maximum bandwidth that can be reserved on the link from the emulated router. Possible values are 1 to 4294967295. The default value is 100000.
-
-isis_neighbor_app_spec_attr_subtlv_te_unrsvr_bw0¶ Specifies the amount of bandwidth not yet reserved at priority level 0. Possible values are 1 to 4294967295. The default value is 100000.
-
-isis_neighbor_app_spec_attr_subtlv_te_unrsvr_bw1¶ Specifies the amount of bandwidth not yet reserved at priority level 1. Possible values are 1 to 4294967295. The default value is 100000.
-
-isis_neighbor_app_spec_attr_subtlv_te_unrsvr_bw2¶ Specifies the amount of bandwidth not yet reserved at priority level 2. Possible values are 1 to 4294967295. The default value is 100000.
-
-isis_neighbor_app_spec_attr_subtlv_te_unrsvr_bw3¶ Specifies the amount of bandwidth not yet reserved at priority level 3. Possible values are 1 to 4294967295. The default value is 100000.
-
-isis_neighbor_app_spec_attr_subtlv_te_unrsvr_bw4¶ Specifies the amount of bandwidth not yet reserved at priority level 4. Possible values are 1 to 4294967295. The default value is 100000.
-
-isis_neighbor_app_spec_attr_subtlv_te_unrsvr_bw5¶ Specifies the amount of bandwidth not yet reserved at priority level 5. Possible values are 1 to 4294967295. The default value is 100000.
-
-isis_neighbor_app_spec_attr_subtlv_te_unrsvr_bw6¶ - Specifies the amount of bandwidth not yet reserved
- at priority level 6. Possible values are 1 to 4294967295. The default value is 100000.
-
-isis_neighbor_app_spec_attr_subtlv_te_unrsvr_bw7¶ Specifies the amount of bandwidth not yet reserved at priority level 7. Possible values are 1 to 4294967295. The default value is 100000.
-
-isis_neighbor_app_spec_attr_subtlv_te_default_metric¶ Specifies the TE default metric. The default value is 0.
-
-isis_neighbor_app_spec_attr_subtlv_te_ext_admin_group¶ Specifies the extended administrative group value of ISIS App Specific Sub-TLV TE parameters.
-
-isis_neighbor_app_spec_attr_subtlv_te_unilink_delay¶ Specifies the Unidirectional Link Delay. Possible values are 1 to 16777215. The default value is 100000.
-
-isis_neighbor_app_spec_attr_subtlv_te_unilink_delay_aflag¶ Specifies the A flag. The default value is false. Possible values are true or false.
-
-isis_neighbor_app_spec_attr_subtlv_te_min_max_uni_link_min_delay¶ Specifies the Min/Max Unidirectional Link Min Delay. Possible values are 1 to 16777215. The default value is 100000.
-
-isis_neighbor_app_spec_attr_subtlv_te_min_max_uni_link_max_delay¶ Specifies the Min/Max Unidirectional Link Max Delay. Possible values are 1 to 16777215. The default value is 100000.
-
-isis_neighbor_app_spec_attr_subtlv_te_min_max_uni_link_delay_aflag¶ Specifies the Min/Max Unidirectional Link Delay A flag. Possible values are true or false. The default value is false.
-
-isis_neighbor_app_spec_attr_subtlv_te_uni_delay_variation¶ Specifies the Unidirectional Delay Variation. Possible values are 1 to 16777215. The default value is 100000.
-
-isis_neighbor_app_spec_attr_subtlv_te_uni_link_loss¶ Specifies the Unidirectional Link Loss. Possible values are 0.000003 to 50.331642. The default value is 3.
-
-isis_neighbor_app_spec_attr_subtlv_te_uni_link_loss_aflag¶ Specifies the Unidirectional Link Loss A flag. Possible values are true or false. The default value is false.
-
-isis_neighbor_app_spec_attr_subtlv_te_uni_residual_bw¶ Specifies the Unidirectional Residual Bandwidth. Possible values are 1 to 4294967295. The default value is 100000.
-
-isis_neighbor_app_spec_attr_subtlv_te_uni_available_bw¶ Specifies the Unidirectional Available Bandwidth. Possible values are 1 to 4294967295. The default value is 100000.
-
-isis_neighbor_app_spec_attr_subtlv_te_uni_utilized_bw¶ Specifies the Unidirectional Utilized Bandwidth. Possible values are 1 to 4294967295. The default value is 100000.
-
-isis_capability_tlv_flags¶ Specifies the ISIS capability TLV options. The default value is SBIT. Possible values are:
Value Description SBIT S bit DBIT D bit Reserved1 Reserved part one Reserved2 Reserved part two Reserved3 Reserved part three Reserved4 Reserved part four Reserved5 Reserved part five Reserved6 Reserved part six
-
-isis_capability_tlv_router_id¶ Specifies the router ID of ISIS capability TLV. The default value is 0.0.0.0.
-
-isis_capability_tlv_router_id_step¶ Defines the step size in which the router ID (-isis_capability_tlv_router_id) is incremented. You can use this argument if the value of -isis_capability_tlv_count is larger than 1.
-
-isis_capability_tlv_count¶ Specifies the number of ISIS capability TLV to create under the LSP
-
-isis_capability_router_subtlv_options¶ Specifies router capability Sub TLV options. The default value is BBIT. Possible values are:
Value Description BBIT B bit EBIT E bit MBIT M bit PBIT P bit UNUSED5 Unused bit 5 UNUSED6 Unused bit 6 UNUSED7 Unused bit 7
-
-isis_capability_srv6_subtlv_flags¶ Specifies ISIS SRv6 Capability Sub TLV flags. The default value is 0. Possible values are:
Value Description UNUSED0 Unused0 OBIT O bit UNUSED2 Unused2 UNUSED3 Unused3 UNUSED4 Unused4 UNUSED5 Unused5 UNUSED6 Unused6 UNUSED7 Unused7 UNUSED8 Unused8 UNUSED9 Unused9 UNUSED10 Unused10 UNUSED11 Unused11 UNUSED12 Unused12 UNUSED13 Unused13 UNUSED14 Unused14 UNUSED15 Unused15
-
-isis_capability_sr_subtlv_flags¶ Specifies ISIS SR Capability Sub TLV flags. The default value is IPv4. Possible values are:
Value Description IPV4 IPv4 Segment Routing Capability IPV6 IPv6 Segment Routing Capability SRV6 Segment Routing Over IPv6 Capability
-
-isis_capability_sr_msd_subtlv_count¶ Specifies the number of ISIS SR MSD Sub TLV to create under the LSP
-
-isis_capability_sr_msd_subtlv_flags¶ Specifies MSD Sub TLVs. The default value is 0. Possible values are:
Value Description MAXIMUMSEGMENTSLEFT Specifies the maximum value of the SL field in the SRH of a received packet before applying the Endpoint behavior associated with a SID MAXIMUMENDPOP Specifies the maximum number of SIDs in the SRH to which the router can apply PSP or USP behavior MAXIMUMTINSERTSRH Specifies the maximum number of SIDs in the SRH included as part of the T.Insert behavior MAXIMUMTENCAPSRH Specifies the maximum number of SIDs that can be included as part of the T.Encaps behavior MAXIMUMENDDSRH Specifies the maximum number of SIDs in an SRH when performing decapsulation associated with End.Dx behaviors
-
-isis_capability_sr_msd_subtlv_max_end_d¶ Specifies the maximum End D SRH of ISIS SR MSD Sub TLV. The default value is 8.
-
-isis_capability_sr_msd_subtlv_max_end_pop¶ Specifies the maximum End Pop of ISIS SR MSD Sub TLV. The default value is 8.
-
-isis_capability_sr_msd_subtlv_max_seg_left¶ Specifies the maximum Segments Left value of ISIS SR MSD Sub TLV. The default value is 8.
-
-isis_capability_sr_msd_subtlv_max_hencap¶ Specifies the maximum T.Encap SRH value of ISIS SR MSD Sub TLV. The default value is 8.
-
-isis_capability_trees_subtlv_max_computable_count¶ Specifies the maximum computable trees count of ISIS tree sub-TLV. The default value is 0.
-
-isis_capability_trees_subtlv_compute_count¶ Specifies the count of trees to compute in ISIS tree sub-TLV. The default value is 0.
-
-isis_capability_trees_subtlv_use_count¶ Specifies the count of trees to use in ISIS tree sub-TLV. The default value is 0.
-
-isis_capability_tree_root_id_subtlv_nick_name_list¶ Specifies the nickname list of ISIS tree root ID sub-TLV. The default value is 0.
-
-isis_capability_tree_root_id_subtlv_start_root_id¶ Specifies the start tree root ID of ISIS tree root ID sub-TLV. The default value is 1.
-
-isis_capability_srms_preference_subtlv¶ Specifies the preference value which is used to identify a SRMS advertisement from a particular source. The default value is 1.
-
-isis_capability_sr_algorithm_subtlv¶ Specifies the algorithm value of ISIS SR Algorithm Sub TLV. The default value is METRIC_BASED_SPF.
-
-isis_capability_sr_algorithm_subtlv_count¶ Specifies the number of ISIS SR Algorithm Sub TLV to create under the LSP.
-
-isis_capability_sr_local_block_subtlv_count¶ Specifies the number of ISIS SR Local Block Sub TLV to create under the LSP.
-
-isis_capability_sr_local_block_subtlv_flags¶ Specifies the ISIS SR Local Block Sub TLV flags. The default value is 0.
-
-isis_capability_sr_local_block_subtlv_range¶ Specifies the number of SRLB elements. Possible values are 1 to 16777215. The default value is 100.
-
-isis_capability_root_pri_subtlv_bcast_pri¶ Specifies the broadcast root priority of ISIS Root Priority Sub TLV. The default value is 0.
-
-isis_capability_root_pri_subtlv_multi_dst_tree_count¶ Specifies the multi destination tree count of ISIS Root Priority Sub TLV. The default value is 0.
-
-isis_capability_root_id_subtlv_bcast_sys_id¶ Specifies the broadcast root system ID of ISIS root ID Sub TLV. The default value is 00:00:00:00:00:00.
-
-isis_capability_root_id_subtlv_mcast_sys_id¶ Specifies the multicast root system ID of ISIS root ID Sub TLV. The default value is 00:00:00:00:00:00.
-
-isis_capability_vlan_subtlv_end_vlan_id¶ Specifies the end VLAN ID of Interested VLANS Sub TLV. Possible values are 0 to 4095. The default value is 0.
-
-isis_capability_vlan_subtlv_lost_count¶ Specifies the forwarder status of lost count. The default value is 0.
-
-isis_capability_vlan_subtlv_start_vlan_id¶ Specifies the starting VLAN ID of Interested VLANS Sub TLV. Possible values are 0 to 4095. The default value is 0.
-
-isis_capability_vlan_subtlv_options¶ Specifies the sub-TLV options of Interested VLANS Sub TLV. The default value is M4. Possible values are:
Value Description R Reserved OM RBridge requests that all non-IP derived multicast traffic in the indicated VLAN range be sent to it M6 IPv6 multicast router on a link for which the originating RBridge is appointed forwarder M4 IPv4 multicast router on a link for which the originating RBridge is appointed forwarder
-
-isis_capability_vlan_subtlv_reserved_options¶ Specifies the option for sub-TLV reserved field. The default value is NONE. Possible values are:
Value Description NONE None RESERVED1 Reserved bit 1 RESERVED2 Reserved bit 2 RESERVED3 Reserved bit 3 RESERVED4 Reserved bit 4
-
-isis_capability_vlan_subtlv_tree_root_list¶ Specifies the Interested VLANS Sub TLV tree root list. The default value is 00:00:00:00:00:01.
-
-isis_capability_ftag_subtlv¶ Specifies the F tag value of ISIS FTag Sub TLV. The default value is 0.
-
-isis_capability_ftag_subtlv_graph_count¶ Specifies the graph count of ISIS FTag Sub TLV. The default value is 0.
-
-isis_capability_ftag_subtlv_graph_root_id¶ Specifies the graph root ID of ISIS FTag Sub TLV. The default value is 0.
-
-isis_capability_device_id_subtlv¶ Specifies the device ID of ISIS Device ID Sub TLV. The default value is 0.
-
-isis_capability_device_id_subtlv_pri¶ Specifies the priority of ISIS Device ID Sub TLV. The default value is 0.
-
-isis_capability_device_id_subtlv_reserved1¶ Specifies the reserved bit of ISIS Device ID Sub TLV. The default value is 0.
-
-isis_capability_device_id_subtlv_reserved2¶ Specifies the reserved bit of ISIS Device ID Sub TLV. The default value is 0.
-
-isis_capability_sr_fad_subtlv_cal_type¶ Specifies the client access license (CAL) type value of ISIS SR FAD Sub TLV. Possible values are 0 to 127. The default value is 0.
-
-isis_capability_sr_fad_subtlv_cal_definition_flags¶ Specifies the definition flags. The default value is 80.
-
-isis_capability_sr_fad_subtlv_cal_exclude_admin_groups¶ Specifies the exclude admin groups value. The default value is 0.
-
-isis_capability_sr_fad_subtlv_cal_flex_algorithm¶ Specifies the value of the flex algorithm. Possible values are 128 to 255. The default value is 128.
-
-isis_capability_sr_fad_subtlv_cal_flex_algorithm_step¶ Defines the step size in which the algorithm (-isis_capability_sr_fad_subtlv_cal_flex_algorithm) is incremented. You can use this argument if the value of -isis_capability_sr_fad_subtlv_count is larger than 1.
-
-isis_capability_sr_fad_subtlv_cal_include_all_admin_groups¶ Specifies to include all admin groups value. The default value is 0.
-
-isis_capability_sr_fad_subtlv_cal_include_any_admin_groups¶ Specifies to include any admin groups value. The default value is 0.
-
-isis_capability_sr_fad_subtlv_metric_type¶ Specifies the metric type of ISIS SR FAD Sub TLV. The default value is IGP_METRIC. Possible values are:
Value Description IGP_METRIC IGP metric value MIN_UNIDIRECTIONAL_LINK_DELAY Advertises the minimum delay values between two directly connected IS-IS neighbors TE_DEFAULT_METRIC Used to present a differently weighted topology to traffic engineering SPF calculations
-
-isis_capability_sr_fad_subtlv_option¶ Specifies the Flex Algorithm Sub TLVs. The default value is 0. Possible values are:
Value Description EXCLUDE_ADMIN_GROUP Specify colors that are used by the operator to exclude links during the Flex Algorithm path computation INCLUDE_ANY_ADMIN_GROUP Used to advertise include any rule that is used during the Flex Algorithm path calculation INCLUDE_ALL_ADMIN_GROUP Used to advertise include all rule that is used during the Flex Algorithm path calculation DEFINITION_FLAGS Used to advertise the definition of the Flex Algorithm
-
-isis_capability_sr_fad_subtlv_priority¶ Specifies the priority of ISIS SR FAD Sub TLV. Possible value are 0 to 255. The default value is 0.
-
-isis_capability_sr_fad_subtlv_count¶ Specifies the number of ISIS SR FAD Sub TLV to create under the LSP.
-
-isis_srv6_locator_tlv_mt_id¶ Specifies the MT ID of ISIS SRv6 Locator TLV options. Possible values are 0 to 4095. The default value is 0.
-
-isis_srv6_locator_tlv_metric¶ Specifies the metric of ISIS SRv6 Locator TLV options. Possible values are 0 to 4261412864. The default value is 10.
-
-isis_srv6_locator_tlv_flags¶ Specifies the flags of ISIS SRv6 Locator TLV options. The default value is 0. Possible values are:
Value Description DBIT D Bit UNUSED1 Unused1 UNUSED2 Unused2 UNUSED3 Unused3 UNUSED4 Unused4 UNUSED5 Unused5 UNUSED6 Unused6 UNUSED7 Unused7
-
-isis_srv6_locator_tlv_algorithm¶ Specifies the algorithm value of ISIS SRv6 Locator TLV to create. The default value is 0.
-
-isis_srv6_locator_tlv_algorithm_step¶ Defines the step size in which the algorithm (-isis_srv6_locator_tlv_algorithm) is incremented. You can use this argument if the value of -isis_srv6_locator_tlv_count is larger than 1.
-
-isis_srv6_locator_tlv_locator_size¶ Specifies the size of the locator in ISIS SRv6 Locator TLV to create. Possible values are from 1 to 128. The default value is 64.
-
-isis_srv6_locator_tlv¶ Specifies the locator value of ISIS SRv6 Locator TLV to create. The default value is aaaa:1:1:1::.
-
-isis_srv6_locator_tlv_step¶ Defines the step size in which the locator (-isis_srv6_locator_tlv) is incremented. You can use this argument if the value of -isis_srv6_locator_tlv_count is larger than 1.
-
-isis_srv6_locator_custom_subtlv_sub_type¶ Specifies the Sub Type value of ISIS Custom Sub TLV. The default value is 0.
-
-isis_srv6_locator_custom_subtlv_value¶ Specifies the Sub Value of ISIS Custom Sub TLV. The default value is 0.
-
-isis_srv6_end_sid_subtlv_custom_end_point_fn¶ Specifies the ISIS SRv6 End SID Sub TLV Custom Endpoint Function. The default value is 0.
-
-isis_srv6_end_sid_subtlv_enable_custom_end_point_fn¶ Enables or disables ISIS SRv6 End SID Sub TLV Custom Endpoint Function. Possible values are true or false. The default value is false.
-
-isis_srv6_end_sid_subtlv_end_point_func¶ Specifies the ISIS SRv6 End SID Sub TLV Endpoint Function. The default value is ENDWOPSP_USP. Possible values are:
Value Description ENDWOPSP_USP Endpoint function without Penultimate Segment Pop (PSP) and Ultimate Segment Pop (USP) ENDWPSP Endpoint function with Penultimate Segment Pop (PSP) ENDWUSP Endpoint function with Ultimate Segment Pop (USP) ENDWPSP_USP Endpoint function with Penultimate Segment Pop (PSP) and Ultimate Segment Pop (USP) ENDXWOPSP_USP End.X function without Penultimate Segment Pop (PSP) and Ultimate Segment Pop (USP) ENDXW_PSP End.X function with Penultimate Segment Pop (PSP) ENDXW_USP End.X function with Ultimate Segment Pop (USP) ENDXWPSP_USP End.X function with Penultimate Segment Pop (PSP) and Ultimate Segment Pop (USP) ENDTWOPSP_USP End.T function without Penultimate Segment Pop (PSP) and Ultimate Segment Pop (USP) ENDTWPSP End.T function with Penultimate Segment Pop (PSP) ENDTWUSP End.T function with Ultimate Segment Pop (USP) ENDTWPSP_USP End.T function with Penultimate Segment Pop (PSP) and Ultimate Segment Pop (USP) ENDB6 Endpoint bound to an SRv6 policy ENDB6ENCAPS Endpoint bound to an SRv6 encapsulation Policy ENDBM Endpoint bound to an SR-MPLS Policy ENDDX6 Endpoint with decapsulation and IPv6 cross connect ENDDX4 Endpoint with decapsulation and IPv6 cross connect ENDDT6 Endpoint with decapsulation and IPv6 table lookup ENDDT4 Endpoint with decapsulation and IPv4 table lookup ENDDT46 The Endpoint with decapsulation and specific IP table lookup function is a variant of the End.DT4 and End.DT6 functions ENDDX2 Endpoint with decapsulation and Layer2 cross connect. Used for L2VPN use cases ENDDX2V The Endpoint with decapsulation and specific VLAN table lookup function is a variant of the endpoint function ENDDT2U The Endpoint with decapsulation and specific unicast MAC L2 table lookup function is a variant of the endpoint function ENDDT2M The Endpoint with decapsulation and specific L2 table flooding function is a variant of the endpoint function ENDOTP Advertise only ENDS Endpoint in search of a target in table T
-
-isis_srv6_end_sid_subtlv_flags¶ Specifies the flags of ISIS SRv6 End SID sub TLV. The default value is 0. Possible values are:
Value Description UNUSED0 UNUSED0 UNUSED1 UNUSED1 UNUSED2 UNUSED2 UNUSED3 UNUSED3 UNUSED4 UNUSED4 UNUSED5 UNUSED5 UNUSED6 UNUSED6 UNUSED7 UNUSED7
-
-isis_srv6_end_sid_subtlv_sid¶ Specifies the SID value of ISIS SRv6 End SID sub TLV. The default value is aaaa:1:1:1::1.
-
-isis_srv6_end_sid_subtlv_sid_step¶ Defines the step size in which the SID (-isis_srv6_end_sid_subtlv_sid) is incremented. You can use this argument if the value of -isis_srv6_end_sid_subtlv_count is larger than 1.
-
-isis_srv6_end_sid_subtlv_step¶ Defines the step size in which the SID is incremented between the TLVs. You can use this argument if the value of -isis_srv6_locator_tlv_count is larger than 1.
-
-isis_srv6_end_sid_subtlv_count¶ Specifies the number of ISIS SRv6 End SID Sub TLV to create under the LSP.
-
-isis_srv6_locator_tlv_count¶ Specifies the number of ISIS SRv6 Locator Sub TLV to create under the LSP.
-
-isis_srv6_end_sid_custom_subtlv_sub_type¶ Specifies the Sub Type value of ISIS Custom Sub TLV. The default value is 0.
-
-isis_srv6_end_sid_custom_subtlv_sub_value¶ Specifies the Sub Value of ISIS Custom Sub TLV. The default value is 0.
-
-tlv_handle¶ Specifies which sub-TLV configuration to modify or delete. You must specify this argument if the mode is modify or delete.
-
-ipv6_addr_end¶ Specifies the global/default ending IPv6 address value used for routes and interface addresses. The default value is 3ffe::.
-
-ipv6_addr_start¶ Specifies the global/default starting IPv6 address value used for routes and interface addresses. The default value is 2000::.
-
-ipv6_isis_prefix_sid_tlv_flags¶ Spirent Extension (for Spirent HLTAPI only).
Specifies the required octet fields defined in the Prefix-SID TLV of IPv6 ISIS routes. Possible values are described below:
nbit Node-SID flag npbit No-PHP flag mbit Mapping Server flag ebit Explicit-Null flag vbit Value/Index flag lbit Local/Global flag
Use | to specify multiple flags.
-
-ipv6_isis_prefix_sid_tlv_algorithm_step¶ Defines the step size in which the IPv6 Prefix SID Sub-TLV algorithm (-ipv6_isis_prefix_sid_tlv_algorithm) is incremented.
-
-ipv6_isis_prefix_sid_tlv_sid_label_index_step¶ Defines the step size in which the IPv6 Prefix SID Sub-TLV first index defining the offset in the SID/Label space (-ipv6_isis_prefix_sid_tlv_sid_label_index) is incremented.
-
-get_return_handles¶ Determines whether to get LSP handles. Possible values are true and false. Set it to false if LSP handles are not required. The default value is true. It is recommended you set it to false for large
Scalingscenarios involving large number of LSPs.
-
-get_tlv_handles¶ Determines whether to get TLV handles. Possible values are true and false. Set it to true if TLV handles are required. The default value is false.
-
-ipv6_router_id_start¶ Specifies the IPv6 router ID to be used. The value must be in IPv6 format. The default value is 2000::.
-
-ipv6_router_id_step¶ Specifies the step applied to the IPv6 router ID for each subsequent router. The value must be in IPv6 format. The default value is 2000::1.
-
-host_name¶ Specifies the host name of the LSP, in string format. The default value is Spirent-1.
-
-isis_level¶ Specifies the ISIS levels on which LSPs are created. The default value is LEVEL2.
-
-router_id_start¶ Specifies the first 32-bit router ID to be used. The default value is 1.0.0.1.
-
-router_id_step¶ Specifies the step applied to the router ID for each subsequent router. The default value is 0.0.0.1.
-
-system_id_start¶ Specifies the first system ID to be used. The default value is 10:00:00:00:00:01.
-
-system_id_step¶ Specifies the step applied to the system ID for each subsequent router. The default value is 00:00:00:00:00:01.
-
-traffic_engineered_enabled¶ Enables or disables traffic engineering on the link. Possible values are 1 (enable) and 0 (disable). The default is 0.
-
-traffic_engineered_band_width_unit¶ Specifies bandwidth units of measurement in traffic engineering configurations. Possible values are BITS_PER_SEC,BYTES_PER_SEC and MBYTES_PER_SEC. The default is BYTES_PER_SEC.
-
-traffic_engineered_group¶ Specifies the link’s administrative group membership, expressed as the decimal equivalent of a 32-bit bit mask. Each set bit corresponds to one administrative group assigned to the interface. A link can belong to multiple groups. By convention, the least significant bit is referred to as “group 0”, and the most significant bit is referred to as “group 31”. Possible values range from 1 to 4294967295. The Administrative Group sub-TLV is TLV type 9.
-
-traffic_engineered_max_bw¶ Specifies the maximum bandwidth that can be used on this traffic engineering link in this direction (from the originating router to its neighbor). Possible values range from 1 to 4294967295.
-
-traffic_engineered_max_resv_bw¶ Specifies the maximum reservable bandwidth sub-TLV (type 7), in bytes per second, that you can reserve on this link in this direction. Possible values range from 1 to 4294967295.
-
-traffic_engineered_ip_addr¶ Specifies the interface IP address sub-TLV (type 4). The The default is 0.0.0.0.
-
-traffic_engineered_remote_ip_addr¶ Specifies the remote interface IP address sub-TLV (type 4). The The default is 0.0.0.0.
-
-traffic_engineered_unresv_bw_priority0¶ Specifies the amount of bandwidth not yet reserved at priority level 0. The values correspond to the bandwidth that can be reserved with a setup priority of 0 through 7. Arranged in ascending order, priority 0 occurs at the start of the sub-TLV and priority 7 at the end. The initial values, before any bandwidth is reserved, are all set to the value specified for the maximum reservable bandwidth (-traffic_engineered_max_resv_bw). Each value will be less than or equal to the maximum reservable bandwidth. Possible values, in bytes per second, range from 1 to 4294967295.
-
-traffic_engineered_unresv_bw_priority1¶ Specifies the amount of bandwidth not yet reserved at priority level 1. Possible values, in bytes per second, are 1 to 4294967295.
-
-traffic_engineered_unresv_bw_priority2¶ Specifies the amount of bandwidth not yet reserved at priority level 2. Possible values, in bytes per second, are 1 to 4294967295.
-
-traffic_engineered_unresv_bw_priority3¶ Specifies the amount of bandwidth not yet reserved at priority level 3. Possible values, in bytes per second, are 1 to 4294967295.
-
-traffic_engineered_unresv_bw_priority4¶ Specifies the amount of bandwidth not yet reserved at priority level 4. Possible values, in bytes per second, are 1 to 4294967295.
-
-traffic_engineered_unresv_bw_priority5¶ Specifies the amount of bandwidth not yet reserved at priority level 5. Possible values, in bytes per second, are 1 to 4294967295.
-
-traffic_engineered_unresv_bw_priority6¶ Specifies the amount of bandwidth not yet reserved at priority level 6. Possible values, in bytes per second, are 1 to 4294967295.
-
-traffic_engineered_unresv_bw_priority7¶ Specifies the amount of bandwidth not yet reserved at priority level 7. Possible values, in bytes per second, are 1 to 4294967295.
-
-type¶ Specifies the type of topology element to be created. Possible values are fullmesh, grid, hubspoke, ring, tree, and none. The default value is tree.
Note
This argument cannot be used with mode modify. If you want to modify, delete the IsisLspHandle and create it again with new configurations.
-
-handle¶ Identifies the router on which to create, modify, or delete a topology element, or a list of devices with LSPs created on them. This argument is required for modes create and modify.
-
-hubspoke_num_routers¶ Specifies the total number of routers in the hub and spoke topology. This argument is only valid when -type is set to hubspoke. Possible values range from 1 to 100. The default value is 10.
Note
This argument cannot be used for mode modify. If you want to modify, you should delete the IsisLspHandle and create it again with new configurations.
-
-hubspoke_emulated_router_pos¶ Specifies the location of the emulated router in the hub and spoke topology. This argument is only valid when -type is set to hubspoke. Possible values are described below:
ATTACHED_TO_HUB - The emulated router is attached to a hub simulated router ATTACHED_TO_SPOKE - The emulated router is attached to a spoke simulated router MEMBER_HUB - The emulated router is a member as a hub MEMBER_SPOKE - The emulated router is a member as a spokeNote
This argument cannot be used for mode modify. If you want to modify, you should delete the IsisLspHandle and create it again with new configurations.
-
-fullmesh_num_routers¶ Specifies the total number of routers in the full mesh. This argument is only valid when -type is set to fullmesh. Possible values range from 1 to 100. The default value is 10.
Note
This argument cannot be used for mode modify. If you want to modify, you should delete the IsisLspHandle and create it again with new configuration s.
-
-fullmesh_emulated_router_pos¶ Specifies the location of the emulated router in the full mesh topology. This argument is only valid when -type is set to fullmesh. Possible values are described below:
ATTACHED_TO_MESH - The emulated router is attached to one of the simulated routers in the full mesh MEMBER_OF_MESH - The emulated router is a member of the full meshNote
This argument cannot be used for mode modify. If you want to modify, you should delete the IsisLspHandle and create it again with new configurations.
-
-ring_num_routers¶ Specifies the total number of routers in the ring topology This argument is only valid when -type is set to ring. Possible values range from 1 to 10000. The default value is 10.
Note
This argument cannot be used for mode modify. If you want to modify, you should delete the IsisLspHandle and create it again with new configurations.
-
-ring_emulated_router_pos¶ Specifies the location of the emulated router in the ring topology This argument is only valid when -type is set to ring. Possible values are described below:
ATTACHED_TO_RING - The emulated router is attached to a ring simulated router MEMBER_OF_RING - The emulated router is a member as a ringThe default is ATTACHED_TO_RING.
Note
This argument cannot be used for mode modify. If you want to modify, you should delete the IsisLspHandle and create it again with new configurations.
-
-tree_if_type¶ Specifies the interface type used to connect simulated routers. This argument is only valid when -type is tree. Possible values are POINT_TO_POINT and BROADCAST. The default value is POINT_TO_POINT.
Note
- This argument cannot be used for mode modify. If you want to modify, you should delete the IsisLspHandle and create it again with new configurations.
- Only tree topologies support broadcast/transit networks. Other topologies only support point-to-point links.
-
-tree_max_if_per_router¶ Specifies the maximum number of interfaces per router This argument is only valid when -type is tree Possible values range from 0 to 100. The default value is 4
Note
This argument cannot be used for mode modify. If you want to modify, you should delete the IsisLspHandle and create it again with new configurations.
-
-tree_max_routers_per_transit_network¶ Specifies the maximum number of routers per transit network. This argument is only valid when -type is tree and -tree_if_type is BROADCAST. Possible values range from 2 to 10000. The default value is 5.
Note
This argument cannot be used for mode modify. If you want to modify, you should delete the IsisLspHandle and create it again with new configurations.
-
-tree_num_simulated_routers¶ Specifies the total number of simulated routers that will be created on all emulated routers. Possible values range from 1 to 10000. The default value is 50.
Note
This argument cannot be used for mode modify. If you want to modify, you should delete the IsisLspHandle and create it again with new configurations.
-
-grid_attach_column_index¶ For an emulated router attached to a simulated router, specifies the column 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, specifies the column index in the grid where the emulated router is located.
This argument is only valid when -type is grid. Possible values range from 1 to 10000. The default value is 1.
Note
This argument cannot be used for mode modify. If you want to modify, you should delete the IsisLspHandle and create it again with new configurations.
-
-grid_attach_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. valid when type is grid.
This argument is only valid when -type is grid. Possible values range from 1 to 10000. The default value is 1.
Note
This argument cannot be used for mode modify. If you want to modify, you should delete the IsisLspHandle and create it again with new configurations.
-
-grid_columns¶ Specifies the number of columns in the grid. This argument is only valid when -type is grid.
Possible values range from 1 to 10000. The default value is 4.
Note
This argument cannot be used for mode modify. If you want to modify, you should delete the IsisLspHandle and create it again with new configurations.
-
-grid_rows¶ Specifies the number of rows in the grid. This argument is only valid when -type is grid. Possible values range from 1 to 10000. The default value is 4.
Note
This argument cannot be used for mode modify. If you want to modify, you should delete the IsisLspHandle and create it again with new configurations.
-
-grid_emulated_router_pos¶ Specifies the location of the emulated router in the grid topology Possible values are:
ATTACHED_TO_GRID - The emulated router is attached to a grid simulated router MEMBER_OF_GRID - The emulated router is a member as a gridThe default is ATTACHED_TO_GRID.
Note
This argument cannot be used for mode modify. If you want to modify, you should delete the IsisLspHandle and create it again with new configurations.
IPv4 Internal Route Generation Parameters
-
-ipv4_internal_count¶ Spirent Extension (for Spirent HLTAPI only).
Specifies the total number of internal routes to generate. The value must be an integer. The default value is 0.
-
-ipv4_internal_disable_route_aggr¶ Spirent Extension (for Spirent HLTAPI only).
Once enabled, Spirent HLTAPI will prevent route aggregation by distributing routes to the ports non-sequentially. Possible values are true (enable) and false (disable). The default value is false.
-
-ipv4_internal_dup_percent¶ Spirent Extension (for Spirent HLTAPI only).
Determines the percentage of routes of this type that will be duplicated to another port (advertised by another port). Possible values range from 0 to 100. The default value is 0.
-
-ipv4_internal_emulated_routers¶ Spirent Extension (for Spirent HLTAPI only).
Specifies the type of emulated router locations where routes will be added. Possible values are:
NONE Do not add routes to any emulated routers ALL Add routes to all emulated routers
The default value is NONE.
-
-ipv4_internal_enable_ip_addr_override¶ Spirent Extension (for Spirent HLTAPI only).
Once enabled, the starting/ending IP address values or default values will be used. Possible values are true and false. The default value is false.
-
-ipv4_internal_ip_addr_end¶ Spirent Extension (for Spirent HLTAPI only).
Specifies the ending IPv4 address to use for generating the routes. If there are not enough addresses between the starting and the ending IP address to generate the specified number of routes, the route generator will generate as many routes as possible. This attribute is only valid when -ipv4_internal_enable_ip_addr_override is set to true. The default value is 223.255.255.255.
-
-ipv4_internal_ip_addr_incr¶ Spirent Extension (for Spirent HLTAPI only).
Specifies the increment for IPv4 addresses. The value must be an integer. The default value is 1.
-
-ipv4_internal_ip_addr_start¶ Spirent Extension (for Spirent HLTAPI only).
Specifies the starting IPv4 address to use for generating the routes. If multiple IPv4 route generation parameters are used, the route generator will skip addresses it has already used, but will generate the specified number of routes, if possible. This argument is only valid when -ipv4_internal_enable_ip_addr_override is set to true. The default value is 1.0.0.0.
-
-ipv4_internal_prefix_len_dist¶ Spirent Extension (for Spirent HLTAPI only).
Specifies the percentage of routes to create for each prefix length. This argument is valid when -ipv4_internal_prefix_len_dist_type is CUSTOM. You can specify a maximum of 32 values, the sum of which must be equal to 100. The default value is 0. For example:
-ipv4_internal_prefix_len_dist "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" \ -ipv4_internal_prefix_len_dist_type "CUSTOM" \
-
-ipv4_internal_prefix_len_dist_type¶ Spirent Extension (for Spirent HLTAPI only).
Specifies the type of prefix length distribution to use to generate the routes. The prefix length distribution determines how many routes are created for each prefix length.
Possible values are described below:
FIXED All routes are generated with the prefix length specified by -ipv4_internal_prefix_len_start LINEAR Routes are distributed equally across prefix lengths From -ipv4_internal_prefix_len_start to -ipv4_internal_prefix_len_end. If the number of routes cannot be divided equally over the specified prefix range, remaining routes are distributed on prefix 24 EXPONENTIAL Routes are distributed across prefix lengths using an exponential algorithm. The algorithm starts by placing half the total number of routes you enter on the specified ending prefix length, and then taking half the remaining routes and placing those on the next prefix length up, and so on. This exponentially distributes routes up toward the starting prefix length in a ratio of 1:2:4:8, etc. Remaining routes are distributed on the ending prefix length INTERNET Routes are distributed across prefix lengths in a manner typical of the Internet's default-free router prefix distribution CUSTOM Custom prefix length distribution allows you to define the percentage of routes for each prefix lengthThe default value is FIXED.
-
-ipv4_internal_prefix_len_end¶ Spirent Extension (for Spirent HLTAPI only).
Specifies the maximum prefix length for the generated routes. This attribute is valid when -ipv4_internal_prefix_len_dist_type is FIXED, LINEAR, or EXPONENTIAL. Possible values range from 1 to 32. The default value is 24.
-
-ipv4_internal_prefix_len_start¶ Spirent Extension (for Spirent HLTAPI only).
Specifies the minimum prefix length for the generated routes. This attribute is valid when -ipv4_internal_prefix_len_dist_type is FIXED, LINEAR, or EXPONENTIAL. Possible values range from 1 to 32. The default value is 24.
-
-ipv4_internal_simulated_routers¶ Spirent Extension (for Spirent HLTAPI only).
Specifies the type of simulated router locations where routes will be added. This argument is only available for protocols that are capable of advertising topologies (OSPF, ISIS) and when topology generation parameters are specified. Possible values are described below:
NONE Do not add routes to any simulated routers ALL Add routes to all simulated routers EDGE Add routes to all simulated routers at the edge of the generated topology. This option is only available for tree topologiesThe default value is ALL.
-
-ipv4_internal_use_ip_addr_incr¶ Spirent Extension (for Spirent HLTAPI only).
Enables or disables the increment of IPv4 addresses. Possible values are true (enable) and false (disable). The default value is false.
-
-ipv4_internal_weight_route_assign¶ Spirent Extension (for Spirent HLTAPI only).
Determines how the total number of routes will be distributed. Possible values are:
BYPORTS Equal number of routes are assigned to each port BYSPEED Number of routes assigned to each port is proportional to the speed (line rate) of the port. For example, a port with a speed of 100 Mbps will receive 10 times more routes than a port with a speed of 10 Mbps BYROUTERS Equal number of routes are assigned to each router.The default value is BYROUTERS.
-
-ipv4_internal_primary_metric¶ Spirent Extension (for Spirent HLTAPI only).
Specifies the ISIS route metric for primary routes. Possible values range from 1 to 16777215. The default value is 1.
-
-ipv4_internal_secondary_metric¶ Spirent Extension (for Spirent HLTAPI only).
Specifies the ISIS route metric for secondary routes. Possible values range from 1 to 16777215. The default value is 2.
-
-ipv4_internal_network_count¶ - Specifies the number of internal IPv4 routes in the LSP block. The default value is 1.
IPv4 External Route Generation Parameters
-
-ipv4_external_count¶ Spirent Extension (for Spirent HLTAPI only).
Specifies the total number of external routes to generate. The value must be an integer. The default value is 0.
-
-ipv4_external_disable_route_aggr¶ Spirent Extension (for Spirent HLTAPI only).
Once enabled, Spirent HLTAPI will prevent route aggregation by distributing routes to the ports non-sequentially. Possible values are true (enable) and false (disable). The default value is false.
-
-ipv4_external_dup_percent¶ Spirent Extension (for Spirent HLTAPI only).
Determines the percentage of routes of this type that will be duplicated to another port (advertised by another port). Possible values range from 0 to 100. The default value is 0.
-
-ipv4_external_emulated_routers¶ Spirent Extension (for Spirent HLTAPI only).
Specifies the type of emulated router locations where routes will be added. Possible values are:
NONE Do not add routes to any emulated routers ALL Add routes to all emulated routers
The default value is NONE.
-
-ipv4_external_enable_ip_addr_override¶ Spirent Extension (for Spirent HLTAPI only).
Once enabled, the starting/ending IP address values or default values will be used. Possible values are true (enable) and false (disable). The default value is false.
-
-ipv4_external_ip_addr_end¶ Spirent Extension (for Spirent HLTAPI only).
Specifies the ending IPv4 address to use for generating the routes. If there are not enough addresses between the starting and the ending IP address to generate the specified number of routes, the route generator will generate as many routes as possible. This attribute is only valid when -ipv4_external_enable_ip_addr_override is set to true. The default value is 223.255.255.255.
-
-ipv4_external_ip_addr_incr¶ Spirent Extension (for Spirent HLTAPI only).
Specifies the increment for IPv4 addresses. The value must be an integer. The default value is 1.
-
-ipv4_external_ip_addr_start¶ Spirent Extension (for Spirent HLTAPI only).
Specifies the starting IPv4 address to use for generating the routes. If multiple IPv4 route generation parameters are used, the route generator will skip addresses it has already used, but will generate the specified number of routes, if possible. This argument is only valid when -ipv4_external_enable_ip_addr_override is set to true. The default value is 1.0.0.0.
-
-ipv4_external_prefix_len_dist¶ Spirent Extension (for Spirent HLTAPI only).
Specifies the percentage of routes to create for each prefix length. This argument is valid when -ipv4_external_prefix_len_dist_type is CUSTOM. You can specify a maximum of 32 values, the sum of which must be equal to 100. The default value is 0. For example:
-ipv4_external_prefix_len_dist "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" \ -ipv4_external_prefix_len_dist_type "CUSTOM" \
-
-ipv4_external_prefix_len_dist_type¶ Spirent Extension (for Spirent HLTAPI only).
Specifies the type of prefix length distribution to use to generate the routes. The prefix length distribution determines how many routes are created for each prefix length.
Possible values are described below:
FIXED All routes are generated with the prefix length specified by -ipv4_external_prefix_len_start LINEAR Routes are distributed equally across prefix lengths from -ipv4_external_prefix_len_start to -ipv4_external_prefix_len_end. If the number of routes cannot be divided equally over the specified prefix range, remaining routes are distributed on prefix 24 EXPONENTIAL Routes are distributed across prefix lengths using an exponential algorithm. The algorithm starts by placing half the total number of routes you enter on the specified ending prefix length, and then taking half the remaining routes and placing those on the next prefix length up, and so on. This exponentially distributes routes up toward the starting prefix length in a ratio of 1:2:4:8, etc. Remaining routes are distributed on the ending prefix length INTERNET Routes are distributed across prefix lengths in a manner typical of the Internet's default-free router prefix distribution CUSTOM Custom prefix length distribution allows you to define the percentage of routes for each prefix lengthThe default value is FIXED.
-
-ipv4_external_prefix_len_end¶ Spirent Extension (for Spirent HLTAPI only).
Specifies the maximum prefix length for the generated routes. This attribute is valid when -ipv4_external_prefix_len_dist_type is FIXED, LINEAR, or EXPONENTIAL. Possible values range from 1 to 32. The default value is 24.
-
-ipv4_external_prefix_len_start¶ Spirent Extension (for Spirent HLTAPI only).
Specifies the minimum prefix length for the generated routes. This attribute is valid when -ipv4_external_prefix_len_dist_type is FIXED, LINEAR, or EXPONENTIAL. Possible values range from 1 to 32. The default value is 24.
-
-ipv4_external_simulated_routers¶ Spirent Extension (for Spirent HLTAPI only).
Specifies the type of simulated router locations where routes will be added. This argument is only available for protocols that are capable of advertising topologies (OSPF, ISIS) and when topology generation parameters are specified. Possible values are described below:
NONE Do not add routes to any simulated routers ALL Add routes to all simulated routers EDGE Add routes to all simulated routers at the edge of the generated topology. This option is only available for tree topologiesThe default value is ALL.
-
-ipv4_external_use_ip_addr_incr¶ Spirent Extension (for Spirent HLTAPI only).
Enables or disables the increment of IPv4 addresses. Possible values are true (enable) and false (disable). The default value is false.
-
-ipv4_external_weight_route_assign¶ Spirent Extension (for Spirent HLTAPI only).
Determines how the total number of routes will be distributed. Possible values are:
BYPORTS Equal number of routes are assigned to each port BYSPEED Number of routes assigned to each port is proportional to the speed (line rate) of the port. For example, a port with a speed of 100 Mbps will receive 10 times more routes than a port with a speed of 10 Mbps BYROUTERS Equal number of routes are assigned to each routerThe default value is BYROUTERS.
-
-ipv4_external_primary_metric¶ Spirent Extension (for Spirent HLTAPI only).
Specifies the ISIS route metric for primary routes. Possible values range from 1 to 16777215. The default value is 1.
-
-ipv4_external_secondary_metric¶ Spirent Extension (for Spirent HLTAPI only).
Specifies the ISIS route metric for secondary routes. Possible values range from 1 to 16777215. The default value is 2.
-
-ipv4_external_network_count¶ Specifies the number of external IPv4 routes in the LSP block. The default value is 1.
IPv6 Internal Route Generation Parameters
-
-ipv6_internal_count¶ Spirent Extension (for Spirent HLTAPI only).
Specifies the total number of internal routes to generate. The value must be an integer. The default value is 0.
-
-ipv6_internal_disable_route_aggr¶ Spirent Extension (for Spirent HLTAPI only).
Once enabled, Spirent HLTAPI will prevent route aggregation by distributing routes to the ports non-sequentially. Possible values are true (enable) and false (disable). The default value is false.
-
-ipv6_internal_dup_percent¶ Spirent Extension (for Spirent HLTAPI only).
Determines the percentage of routes of this type that will be duplicated to another port (advertised by another port). Possible values range from 0 to 100. The default value is 0.
-
-ipv6_internal_emulated_routers¶ Spirent Extension (for Spirent HLTAPI only).
Specifies the type of emulated router locations where routes will be added. Possible values are:
NONE Do not add routes to any emulated routers ALL Add routes to all emulated routers
The default value is NONE.
-
-ipv6_internal_enable_ip_addr_override¶ Spirent Extension (for Spirent HLTAPI only).
Once enabled, the starting/ending IPv6 address values or default values will be used. Possible values are true and false. The default value is false.
-
-ipv6_internal_ip_addr_end¶ Spirent Extension (for Spirent HLTAPI only).
Specifies the ending IPv6 address to use for generating the routes. If there are not enough addresses between the starting and the ending IPv6 address to generate the specified number of routes, the route generator will generate as many routes as possible. This attribute is only valid when -ipv6_internal_enable_ip_addr_override is set to true. The default value is 3ffe::.
-
-ipv6_internal_ip_addr_incr¶ Spirent Extension (for Spirent HLTAPI only).
Specifies the increment for IPv6 addresses. The value must be an integer. The default value is 1.
-
-ipv6_internal_ip_addr_start¶ Spirent Extension (for Spirent HLTAPI only).
Specifies the starting IPv6 address to use for generating the routes. If multiple IPv6 route generation parameters are used, the route generator will skip addresses it has already used, but will generate the specified number of routes, if possible. This argument is only valid when -ipv6_internal_enable_ip_addr_override is set to true. The default value is 2000::.
-
-ipv6_internal_prefix_len_dist¶ Spirent Extension (for Spirent HLTAPI only).
Specifies the percentage of routes to create for each prefix length. This argument is valid when -ipv6_internal_prefix_len_dist_type is CUSTOM. You can specify a maximum of 32 values, the sum of which must be equal to 100. The default value is 0. For example:
-ipv6_internal_prefix_len_dist "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" \ -ipv6_internal_prefix_len_dist_type "CUSTOM" \
-
-ipv6_internal_prefix_len_dist_type¶ Spirent Extension (for Spirent HLTAPI only).
Specifies the type of prefix length distribution to use to generate the routes. The prefix length distribution determines how many routes are created for each prefix length. Possible values are described below:
FIXED All routes are generated with the prefix length specified by -ipv6_internal_prefix_len_start LINEAR Routes are distributed equally across prefix lengths from -ipv6_internal_prefix_len_start to -ipv6_internal_prefix_len_end. If the number of routes cannot be divided equally over the specified prefix range, remaining routes are distributed on prefix 24 EXPONENTIAL Routes are distributed across prefix lengths using an exponential algorithm. The algorithm starts by placing half the total number of routes you enter on the specified ending prefix length, and then taking half the remaining routes and placing those on the next prefix length up, and so on. This exponentially distributes routes up toward the starting prefix length in a ratio of 1:2:4:8, etc. Remaining routes are distributed on the ending prefix length INTERNET Routes are distributed across prefix lengths in a manner typical of the Internet's default-free router prefix distribution CUSTOM Custom prefix length distribution allows you to define the percentage of routes for each prefix lengthThe default value is FIXED.
-
-ipv6_internal_prefix_len_end¶ Spirent Extension (for Spirent HLTAPI only).
Specifies the maximum prefix length for the generated routes. This attribute is valid when -ipv6_internal_prefix_len_dist_type is FIXED, LINEAR, or EXPONENTIAL. Possible values range from 1 to 128. The default value is 64.
-
-ipv6_internal_prefix_len_start¶ Spirent Extension (for Spirent HLTAPI only).
Specifies the minimum prefix length for the generated routes. This attribute is valid when -ipv6_internal_prefix_len_dist_type is FIXED, LINEAR, or EXPONENTIAL. Possible values range from 1 to 128. The default value is 64.
-
-ipv6_internal_simulated_routers¶ Spirent Extension (for Spirent HLTAPI only).
Specifies the type of simulated router locations where routes will be added. This argument is only available for protocols that are capable of advertising topologies (OSPF, ISIS) and when topology generation parameters are specified. Possible values are described below:
NONE Do not add routes to any simulated routers ALL Add routes to all simulated routers EDGE Add routes to all simulated routers at the edge of the generated topology. This option is only available for tree topologiesThe default value is ALL.
-
-ipv6_internal_use_ip_addr_incr¶ Spirent Extension (for Spirent HLTAPI only).
Enables or disables the increment of IPv6 addresses. Possible values are true (enable) and false (disable). The default value is false.
-
-ipv6_internal_weight_route_assign¶ Spirent Extension (for Spirent HLTAPI only).
Determines how the total number of routes will be distributed. Possible values are:
BYPORTS Equal number of routes are assigned to each port BYSPEED Number of routes assigned to each port is proportional to the speed (line rate) of the port. For example, a port with a speed of 100 Mbps will receive 10 times more routes than a port with a speed of 10 Mbps BYROUTERS Equal number of routes are assigned to each routerThe default value is BYROUTERS.
-
-ipv6_internal_primary_metric¶ Spirent Extension (for Spirent HLTAPI only).
Specifies the ISIS route metric for primary routes. Possible values range from 1 to 16777215. The default value is 1.
-
-ipv6_internal_secondary_metric¶ Spirent Extension (for Spirent HLTAPI only).
Specifies the ISIS route metric for secondary routes. Possible values range from 1 to 16777215. The default value is 2.
-
-ipv6_internal_network_count¶ Specifies the number of internal IPv6 routes in the LSP block. The default value is 1.
IPv6 External Route Generation Parameters
-
-ipv6_external_count¶ Spirent Extension (for Spirent HLTAPI only).
Specifies the total number of external routes to generate. The value must be an integer. The default value is 0.
-
-ipv6_external_disable_route_aggr¶ Spirent Extension (for Spirent HLTAPI only).
Once enabled, Spirent HLTAPI will prevent route aggregation by distributing routes to the ports non-sequentially. Possible values are true (enable) and false (disable). The default value is false.
-
-ipv6_external_dup_percent¶ Spirent Extension (for Spirent HLTAPI only).
Determines the percentage of routes of this type that will be duplicated to another port (advertised by another port). Possible values range from 0 to 100. The default value is 0.
-
-ipv6_external_emulated_routers¶ Spirent Extension (for Spirent HLTAPI only).
Specifies the type of emulated router locations where routes will be added. Possible values are:
NONE Do not add routes to any emulated routers ALL Add routes to all emulated routers
The default value is NONE.
-
-ipv6_external_enable_ip_addr_override¶ Spirent Extension (for Spirent HLTAPI only).
Once enabled, the starting/ending IPv6 address values or default values will be used. Possible values are true (enable) and false (disable). The default value is false.
-
-ipv6_external_ip_addr_end¶ Spirent Extension (for Spirent HLTAPI only).
Specifies the ending IPv6 address to use for generating the routes. If there are not enough addresses between the starting and the ending IPv6 address to generate the specified number of routes, the route generator will generate as many routes as possible. This attribute is only valid when -ipv6_external_enable_ip_addr_override is set to true. The default value is 3ffe::.
-
-ipv6_external_ip_addr_incr¶ Spirent Extension (for Spirent HLTAPI only).
Specifies the increment for IPv6 addresses. The value must be an integer. The default value is 1.
-
-ipv6_external_ip_addr_start¶ Spirent Extension (for Spirent HLTAPI only).
Specifies the starting IPv6 address to use for generating the routes. If multiple IPv6 route generation parameters are used, the route generator will skip addresses it has already used, but will generate the specified number of routes, if possible. This argument is only valid when -ipv6_external_enable_ip_addr_override is set to true. The default value is 2000::.
-
-ipv6_external_prefix_len_dist¶ Spirent Extension (for Spirent HLTAPI only).
Specifies the percentage of routes to create for each prefix length. This argument is valid when -ipv6_external_prefix_len_dist_type is CUSTOM. You can specify a maximum of 32 values, the sum of which must be equal to 100. The default value is 0. For example:
-ipv6_external_prefix_len_dist "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" \ -ipv6_external_prefix_len_dist_type "CUSTOM" \
-
-ipv6_external_prefix_len_dist_type¶ Spirent Extension (for Spirent HLTAPI only).
Specifies the type of prefix length distribution to use to generate the routes. The prefix length distribution determines how many routes are created for each prefix length. Possible values are described below:
FIXED All routes are generated with the prefix length specified by -ipv6_external_prefix_len_start LINEAR Routes are distributed equally across prefix lengths from -ipv6_external_prefix_len_start to -ipv6_external_prefix_len_end. If the number of routes cannot be divided equally over the specified prefix range, remaining routes are distributed on prefix 24 EXPONENTIAL Routes are distributed across prefix lengths using an exponential algorithm. The algorithm starts by placing half the total number of routes you enter on the specified ending prefix length, and then taking half the remaining routes and placing those on the next prefix length up, and so on. This exponentially distributes routes up toward the starting prefix length in a ratio of 1:2:4:8, etc. Remaining routes are distributed on the ending prefix length INTERNET Routes are distributed across prefix lengths in a manner typical of the Internet's default-free router prefix distribution CUSTOM Custom prefix length distribution allows you to define the percentage of routes for each prefix lengthThe default value is FIXED.
-
-ipv6_external_prefix_len_end¶ Spirent Extension (for Spirent HLTAPI only).
Specifies the maximum prefix length for the generated routes. This attribute is valid when -ipv6_external_prefix_len_dist_type is FIXED, LINEAR, or EXPONENTIAL. Possible values range from 1 to 128. The default value is 64.
-
-ipv6_external_prefix_len_start¶ Spirent Extension (for Spirent HLTAPI only).
Specifies the minimum prefix length for the generated routes. This attribute is valid when -ipv6_external_prefix_len_dist_type is FIXED, LINEAR, or EXPONENTIAL. Possible values range from 1 to 128. The default value is 64.
-
-ipv6_external_simulated_routers¶ Spirent Extension (for Spirent HLTAPI only).
Specifies the type of simulated router locations where routes will be added. This argument is only available for protocols that are capable of advertising topologies (OSPF, ISIS) and when topology generation parameters are specified. Possible values are described below:
NONE Do not add routes to any simulated routers ALL Add routes to all simulated routers EDGE Add routes to all simulated routers at the edge of the generated topology. This option is only available for tree topologiesThe default value is ALL.
-
-ipv6_external_use_ip_addr_incr¶ Spirent Extension (for Spirent HLTAPI only).
Enables or disables the increment of IPv6 addresses. Possible values are true (enable) and false (disable). The default value is false.
-
-ipv6_external_weight_route_assign¶ Spirent Extension (for Spirent HLTAPI only).
Determines how the total number of routes will be distributed. Possible values are:
BYPORTS Equal number of routes are assigned to each port BYSPEED The number of routes assigned to each port is proportional to the speed (line rate) of the port. For example, a port with a speed of 100 Mbps will receive 10 times more routes than a port with a speed of 10 Mbps BYROUTERS Equal number of routes are assigned to each routerThe default value is BYROUTERS.
-
-ipv6_external_primary_metric¶ Spirent Extension (for Spirent HLTAPI only).
Specifies the ISIS route metric for primary routes. Possible values range from 1 to 16777215. The default value is 1.
-
-ipv6_external_secondary_metric¶ Spirent Extension (for Spirent HLTAPI only).
Specifies the ISIS route metric for secondary routes. Possible values range from 1 to 16777215. The default value is 2.
-
-ipv6_external_network_count¶ Specifies the number of external IPv6 routes in the LSP block. The default value is 1.
Use the following arguments to configure Segment Routing (SR) on ISIS routes. You must set -loopback_adver_enable to true.
-
-segment_routing_enabled¶ Spirent Extension (for Spirent HLTAPI only).
Enables/disables Segment Routing (SR) on ISIS routes. Possible values are true (enable) and false (disable). The default is false.
-
-sr_adj_sid_enabled¶ Spirent Extension (for Spirent HLTAPI only).
Enables/disables the SR Adjacent Segment ID (Adj-SID) sub-TLV to carry the SR IGP-Adjacency-SID. Possible values are true (enable) and false (disable). The default is false.
-
-sr_adj_flags¶ Spirent Extension (for Spirent HLTAPI only).
Specifies the required octet fields for the SR Adj-SID sub-TLV. Possible values are described below:
bbit Backup flag. Set if the Adj-SID refers to an adjacency being protected. vbit Value/Index flag. If set, the Prefix-SID carries an absolute value. If not set, the Prefix-SID carries an index. lbit Local/Global flag. If set, the value/index carried by the Prefix-SID has local significance. If not set, the value/index carried by this sub-TLV has global significance. sbit Set Flag. If set, it indicates that the Adj-SID refers to a set of adjacencies
Use | to specify multiple flags. The default value is vbit|lbit.
-
-sr_adj_value¶ Spirent Extension (for Spirent HLTAPI only).
Specifies the SID value for the SR Adj-SID sub-TLV. The value must be an integer. The default value is 16.
-
-sr_adj_value_step¶ Spirent Extension (for Spirent HLTAPI only).
Specifies the step applied to the -sr_adj_value for subsequent routes. The value must be an integer. The default value is 1.
-
-sr_adj_weight¶ Spirent Extension (for Spirent HLTAPI only).
Specifies the weight to be used for load balancing purposes. Possible values range from 1 to 255. The default value is 1.
-
-sr_algorithms¶ Spirent Extension (for Spirent HLTAPI only).
Specifies the algorithm to use to calculate reachability. The available value is 0. The default value is 0.
-
-sr_cap_range¶ Spirent Extension (for Spirent HLTAPI only).
Specifies the ending value that, along with the starting value set by -sr_cap_value, defines the range of the SR Capabilities sub-TLV. The default value is 100.
-
-sr_cap_value¶ Spirent Extension (for Spirent HLTAPI only).
Specifies the starting SID for the SR Capabilities sub-TLV. The value must be an integer. The default value is 100.
-
-sr_cap_flags¶ Specifies the values of the I-Flag, the V-Flag, and the H-Flag. Possible values are:
IPV4 Router is capable of outgoing IPv4 encapsulation on all interfaces IPV6 Router is capable of outgoing IPv6 encapsulation on all interfaces SRV6 Router is capable of outgoing SR-IPv6 encapsulation on all interfaces
-
-sr_cap_value_type¶ Spirent Extension (for Spirent HLTAPI only).
Type of the segment identifier. Possible values are:
label 20-bit label sid 32-bit SID
The default value is label.
-
-sr_config_prefix_sid_route_enabled¶ Spirent Extension (for Spirent HLTAPI only).
Enables/disables Prefix-SID sub-TLV to preserve the IP Reachability TLV while propagating across level boundaries. Possible values are true (enable) and false (disable). The default value is false.
-
-sr_mapping_server_enabled¶ Spirent Extension (for Spirent HLTAPI only).
Enables/disables Prefix-SID sub-TLV under mapping server nodes instead of IPv4 nodes. Possible values are true (enable) and false (disable). The default value is false.
-
-sr_sid¶ Spirent Extension (for Spirent HLTAPI only).
Specifies the global index for the Prefix-SID TLV. The value must be an integer. The default value is 0.
-
-sr_sid_step¶ Spirent Extension (for Spirent HLTAPI only).
Specifies the step applied to -sr_sid for subsequent routes. The value must be an integer. The default value is 1.
-
-sr_v6_route_enable¶ Determines whether to enable segment routing over IPv6. Possible values are true and false. The default value is false.
-
-sr_sid_flags¶ Specifies the value of SR SID flags. Possible values are described below:
rbit Re-advertisement Flag nbit Node-SID Flag pbit No-PHP Flag ebit Explicit Null Flag vbit Value Flag lbit Local Flag
-
-sr_sid_prefix_step¶ Specifies the increment value to create subsequent SIDs or indexes. The default value is 1.
-
-sr_sid_prefix¶ Specifies the value of the first SID or index. The default value is 11000.
-
-sr_sid_prefix_ipv6_route¶ Determines whether to enable Prefix SID Sub TLV for IPv6 Route. Possible values are true and false. The default value is false.
-
-sr_anycast_enable¶ Determines whether to enable or disable the anycast function. Possible values are true and false. The default value is false.
-
-sr_algorithm¶ Specifies the algorithm to use to calculate reachability to other nodes or to prefixes attached to these nodes. The default value is 0.
-
-sr_anycast_sid¶ Specifies the value of the first index defining the offset in the SID/Label space advertised by the route. The default value is 100.
-
-sr_anycast_range¶ Specifies the number of segment routing global blocks. The default value is 80000.
-
-sr_anycast_prefix_sid_flags¶ Specifies the value of flags used to control the anycast prefix SID related attributes. Possible values are described below:
rbit Re-advertisement Flag nbit Node-SID Flag pbit No-PHP Flag ebit Explicit Null Flag vbit Value Flag lbit Local Flag
-
-sr_anycast_ipv6_addr¶ Specifies the value of the advertising IPv6 router ID. The default value is 3000::1.
-
-sr_anycast_ipv4_addr¶ Specifies the value of the advertising IPv4 router ID. The default value is 192.1.1.1.
-
-sr_anycast_base¶ Specifies the value of the first segment routing global block. The default value is 800000.
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):
elem_handle The handle that identifies ISIS LSP generator parameters.
Can be used for modes delete or modify as elem_handle.
status Success (1) or failure (0) of the operation.
log An error message (if the operation failed).
ipv4_lsp_handle List of IPv4 ISIS LSP handles under the specified ISIS router.
Can be used to create IPv4 traffic
ipv6_lsp_handle List of IPv6 ISIS LSP handles under the specified ISIS router.
Can be used to create IPv6 traffic
Description¶
Each emulated IS-IS router simulates a topology of inter-connected routers behind itself. It accomplishes this by advertising Link State Protocol Data Units (LSPs), with the IS Neighbors TLV (Type/Length/Value) or the Extended Reachability TLV, to the SUT.
The sth::emulation_isis_lsp_generator function creates and configures IP routes
for the IS-IS protocol. Use the -handle/elem_handle argument to identify the
router for which to create, modify, or delete a route. (The router handle value
is contained in the keyed list returned by the emulation_isis_config function.)
Use the -mode argument to specify the action to perform. See the -mode argument
for a description of the actions.
Examples¶
The following example creates a route tree topology for each IS-IS router specified by [lindex $hSession1($i) 0]:
##Creates lsp topology:grid
set lspStatus [sth::emulation_isis_lsp_generator \
-mode create \
-handle [lindex $hIsisRouter($port,$i) $r] \
-type grid \
-router_id_start $ipAddr \
-ipv4_addr_start $ipPrefix \
-system_id_start $isisSystemId \
-level LEVEL2\
-enable_loopback_adver false\
]
# Output lspStatus
{elem_handle isislspgenparams1}
{status 1}
{lsp_handle ipv4networkblock1 ipv4networkblock2 ...}
set lspGenHandle [keylget lspStatus elem_handle]
The following example modifies any parameter under elem_handle:
set lspStatus [HLTCRS sth::emulation_isis_lsp_generator \
-mode modify \
-elem_handle $lspGenHandle \
-internal_count 1000\
-external_count 2000\
]
The following example deletes the elem_handle:
set lspStatus [HLTCRS sth::emulation_isis_lsp_generator \
-mode delete \
-elem_handle $lspGenHandle \
]
The following example configures Segment Routing on ISIS routes:
set lspStatus [sth::emulation_isis_lsp_generator \
-mode create \
-handle $isis_hnd1 \
-type tree \
-loopback_adver_enable true\
-tree_if_type POINT_TO_POINT\
-internal_emulated_routers NONE\
-internal_simulated_routers ALL\
-internal_count 0 \
-tree_max_if_per_router 1\
-tree_num_simulated_routers 2\
-router_id_start 3.0.0.1 \
-ipv4_addr_start 3.0.0.0 \
-system_id_start 100000000001 \
-isis_level LEVEL2\
-segment_routing_enabled true\
-sr_algorithms 0\
-sr_cap_range 100\
-sr_cap_value 100\
-sr_cap_value_type label]
Sample Output:
{elem_handle isislspgenparams1} {status 1} {lsp_handle {ipv4networkblock1
ipv4networkblock2}}
The following example generates LSP routes for IPv4 and IPv6 devices (dual stack):
# Handle retrieved from the return list of sth::emulation_isis_config
set isis_hnd1 [keylget device_ret0 handle]
set lspStatus [sth::emulation_isis_lsp_generator \
-mode create \
-get_return_handles true\
-handle $isis_hnd1 \
-isis_level LEVEL2\
-type ring \
-ring_num_routers 5\
-ring_emulated_router_pos ATTACHED_TO_RING\
-ipv4_addr_start 14.14.14.1\
-ipv4_addr_end 223.255.255.255\
-ipv6_addr_start "abcd::14:14:14:1"\
-ipv6_addr_end "eeee::"\
-segment_routing_enabled true\
-loopback_adver_enable true\
-sr_algorithms 0\
-sr_cap_range 16000\
-sr_cap_value 100\
-sr_cap_value_type label\
-sr_adj_sid_enabled true\
-sr_adj_flags "vbit|lbit"\
-sr_adj_value 9001\
-sr_adj_value_step 1\
-sr_adj_weight 100\
-system_id_start 500000868601 \
-system_id_step 000000000001 \
-router_id_start 44.44.1.1\
-router_id_step 0.0.0.1\
-ipv4_internal_emulated_routers NONE\
-ipv4_internal_simulated_routers NONE\
-ipv4_internal_count 0 \
-ipv4_internal_disable_route_aggr false\
-ipv4_internal_prefix_len_dist_type FIXED\
-ipv4_external_count 5\
-ipv4_external_emulated_routers ALL\
-ipv4_external_simulated_routers NONE\
-ipv4_external_disable_route_aggr true\
-ipv4_external_dup_percent 0\
-ipv4_external_enable_ip_addr_override true\
-ipv4_external_weight_route_assign BYROUTERS\
-ipv4_internal_primary_metric 1\
-ipv4_internal_secondary_metric 2\
-ipv4_external_primary_metric 10\
-ipv4_external_secondary_metric 20\
-ipv6_internal_emulated_routers NONE\
-ipv6_internal_simulated_routers NONE\
-ipv6_internal_count 0 \
-ipv6_internal_disable_route_aggr false\
-ipv6_internal_prefix_len_dist_type FIXED\
-ipv6_external_count 5\
-ipv6_external_emulated_routers ALL\
-ipv6_external_simulated_routers NONE\
-ipv6_external_disable_route_aggr true\
-ipv6_external_dup_percent 0\
-ipv6_external_enable_ip_addr_override true\
-ipv6_external_weight_route_assign BYROUTERS\
-ipv6_internal_primary_metric 1\
-ipv6_internal_secondary_metric 2\
-ipv6_external_primary_metric 10\
-ipv6_external_secondary_metric 20\
]
Sample Output:
# (with get_return_handles set to true)
{elem_handle | isislspgenparams2} {status | 1} {ipv4_lsp_handle
{ipv4networkblock13 ipv4networkblock14 ipv4networkblock15 ipv4networkblock16
ipv4networkblock17 ipv4networkblock18 ipv4networkblock19}} {ipv6_lsp_handle
{ipv6networkblock1 ipv6networkblock2 ipv6networkblock3 ipv6networkblock4
ipv6networkblock5 ipv6networkblock6 ipv6networkblock7}} {lsp_handle
{ipv4networkblock13 ipv4networkblock14 ipv4networkblock15 ipv4networkblock16
ipv4networkblock17 ipv4networkblock18 ipv4networkblock19 ipv6networkblock1
ipv6networkblock2 ipv6networkblock3 ipv6networkblock4 ipv6networkblock5
ipv6networkblock6 ipv6networkblock7}}
# (with get_return_handles set to false)
{elem_handle isislspgenparams2} {status 1}
The following examples modify prefix SID flags of specific IPv4 and IPv6 LSP routes. You must fetch and pass the specific IPv4/IPv6 LSP handle to modify:
# Key lspStatus contains the output of sth::emulation_isis_lsp_generator.
set ipv4HndList [keylget lspStatus ipv4_lsp_handle]
set ipv4Hnd [lindex $ipv4HndList 0]
set ret [sth::emulation_isis_lsp_generator -mode modify\
-handle $ipv4Hnd\
-ipv4_isis_prefix_sid_tlv_flags none]
set ipv6HndList [keylget lspStatus ipv6_lsp_handle]
set ipv6Hnd [lindex $ipv6HndList 1]
set ret [sth::emulation_isis_lsp_generator -mode modify\
-handle $ipv6Hnd\
-ipv6_isis_prefix_sid_tlv_flags none]
Sample Output:
{status 1}
End of Procedure Header
sth::emulation_isis_info¶
Purpose¶
Retrieves statistics for the ISIS router configured on the specified test port.
Synopsis¶
Note
M indicates that the argument is Mandatory .
sth::emulation_isis_info [-mode {stats|clear_stats} M] [-handle <isis_router_handle|all>]
Arguments¶
-
-handle¶ The router for which you want the information. Use “all” to pass all device handles. If nothing is specified, all devices under all ports will be passed.
-
-mode¶ Specifies the action to perform. Possible values are stats and clear_stats. The default value is stats. The modes are described below:
stats - Returns transmitted and received statistics of the specified ISIS router. clear_stats - Clears all statistics (transmitted and received counters) of the specified ISIS router.
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
- Retrieves a value indicating the success (1) or failure (0) of the operation.
The following keys are returned when you specify -mode stats:
- aggregated_l1_csnp_rx
- Number of L1 Complete Sequence Number PDUs (CSNPs) received from the SUT
- aggregated_l1_lan_hello_rx
- Number of L1 Local Area Network (LAN) hellos received from the SUT
- aggregated_l1_lsp_rx
- Number of L1 LSPs received from the SUT
- aggregated_l1_psnp_rx
- Number of L1 Partial Sequence Number PDUs(PSNPs) received from the SUT
- aggregated_l2_csnp_rx
- Number of L2 CSNPs received from the SUT
- aggregated_l2_lan_hello_rx
- Number of L2 LAN hellos received from the SUT
- aggregated_l2_lsp_rx
- Number of L2 Layered Service Providers (LSPs) received from the SUT
- aggregated_l2_psnp_rx
- Number of L2 PSNPs received from the SUT
- aggregated_p2p_hello_rx
- Number of point-to-point hellos received from the SUT
- aggregated_l1_csnp_tx
- Number of L1 CSNPs sent to the SUT
- aggregated_l1_lan_hello_tx
- Number of L1 LAN hellos sent to the SUT
- aggregated_l1_lsp_tx
- Number of L1 LSPs sent to the SUT
- aggregated_l1_psnp_tx
- Number of L1 PSNPs sent to the SUT
- aggregated_l2_csnp_txf
- Number of L2 CSNPs sent to the SUT
- aggregated_l2_lan_hello_tx
- Number of L2 LAN hellos sent to the SUT
- aggregated_l2_lsp_tx
- Number of L2 LSPs sent to the SUT
- aggregated_l2_psnp_tx
- Number of L2 PSNPs sent to the SUT
- aggregated_p2p_hello_tx N
- umber of point-to-point hellos sent to the SUT
Description¶
The sth::emulation_isis_info function provides information about
the routers specified for the ISIS configuration.
This function returns the requested data and a status value (1 for success). If there is an error, the function returns the status value (0). Function return values are formatted as a keyed list (supported by the Tcl extension software - TclX). Use the TclX function keylget to retrieve data from the keyed list. (See Return Values for a description of each key.)
Examples¶
#### HLTAPI for Tcl ####
To retrieve statistics from one ISIS device:
puts "-------------ISIS info-----------------"
set isis_stats [sth::emulation_isis_info -handle $isis_handle ]
puts "stats: $isis_stats "
set isis_stats [sth::emulation_isis_info -handle $isis_handle -mode
clear_stats] puts "clear_stats: $isis_stats "
Sample Output:
# stats
{status 1} {router1 {{aggregated_l1_psnp_rx 0} {aggregated_p2p_hello_rx 0}
{aggregated_l2_lsp_tx 0} {aggregated_l2_psnp_rx 0} {aggregated_p2p_hello_tx 0}
{aggregated_l1_psnp_tx 0} {aggregated_l2_psnp_tx 0} {aggregated_l1_csnp_rx 0}
{aggregated_l2_csnp_rx 0} {aggregated_l1_csnp_tx 0} {aggregated_l2_csnp_tx 0}
{aggregated_l1_lsp_rx 0} {aggregated_l2_lan_hello_rx 0}
{aggregated_l2_lan_hello_tx 0} {aggregated_l1_lsp_tx 0}
{aggregated_l1_lan_hello_rx 0} {aggregated_l1_lan_hello_tx 0}
{aggregated_l2_lsp_rx 0}}} {aggregated_l1_psnp_rx 0} {aggregated_p2p_hello_rx 0}
{aggregated_l2_lsp_tx 0} {aggregated_l2_psnp_rx 0} {aggregated_p2p_hello_tx 0}
{aggregated_l1_psnp_tx 0} {aggregated_l2_psnp_tx 0} {aggregated_l1_csnp_rx 0}
{aggregated_l2_csnp_rx 0} {aggregated_l1_csnp_tx 0} {aggregated_l2_csnp_tx 0}
{aggregated_l1_lsp_rx 0} {aggregated_l2_lan_hello_rx 0}
{aggregated_l2_lan_hello_tx 0} {aggregated_l1_lsp_tx 0}
{aggregated_l1_lan_hello_rx 0} {aggregated_l1_lan_hello_tx 0}
{aggregated_l2_lsp_rx 0} {procName emulation_isis_info} {handles router1}
#clear_stats
{status 1} {procName emulation_isis_info} {handles router1}
To retrieve statistics from multiple ISIS devices:
[sth::emulation_isis_info -handle all ]
Sample Output:
{status 1} {router1 {{aggregated_l1_psnp_rx 0} {aggregated_p2p_hello_rx 0}
{aggregated_l2_lsp_tx 0} {aggregated_l2_psnp_rx 0} {aggregated_p2p_hello_tx 0}
{aggregated_l1_psnp_tx 0} {aggregated_l2_psnp_tx 0} {aggregated_l1_csnp_rx 0}
{aggregated_l2_csnp_rx 0} {aggregated_l1_csnp_tx 0} {aggregated_l2_csnp_tx 0}
{aggregated_l1_lsp_rx 0} {aggregated_l2_lan_hello_rx 0}
{aggregated_l2_lan_hello_tx 0} {aggregated_l1_lsp_tx 0}
{aggregated_l1_lan_hello_rx 0} {aggregated_l1_lan_hello_tx 0}
{aggregated_l2_lsp_rx 0}}} {router2 {{aggregated_l1_psnp_rx 0}
{aggregated_p2p_hello_rx 0} {aggregated_l2_lsp_tx 0} {aggregated_l2_psnp_rx 0}
{aggregated_p2p_hello_tx 0} {aggregated_l1_psnp_tx 0} {aggregated_l2_psnp_tx 0}
{aggregated_l1_csnp_rx 0} {aggregated_l2_csnp_rx 0} {aggregated_l1_csnp_tx 0}
{aggregated_l2_csnp_tx 0} {aggregated_l1_lsp_rx 0} {aggregated_l2_lan_hello_rx 0}
{aggregated_l2_lan_hello_tx 0} {aggregated_l1_lsp_tx 0}
{aggregated_l1_lan_hello_rx 0} {aggregated_l1_lan_hello_tx 0}
{aggregated_l2_lsp_rx 0}}} {procName emulation_isis_info} {handles {router1 router2}}
#### HLTAPI for Python ####
Sample Input:
results_ret1 = sth.emulation_isis_info (
handle = device,
mode = 'stats');
Sample Output:
{'status': '1', 'aggregated_l1_lsp_rx': '0', 'aggregated_l2_lan_hello_tx': '0',
'aggregated_l2_csnp_tx': '0', 'aggregated_l1_lsp_tx': '0',
'aggregated_l2_lsp_tx': '0', 'aggregated_l2_lsp_rx': '0',
'procName': 'emulation_isis_info', 'aggregated_l1_psnp_rx': '0',
'aggregated_l2_psnp_rx': '0', 'aggregated_p2p_hello_tx': '0',
'aggregated_l1_psnp_tx': '0', 'handles': 'router1',
'aggregated_l2_psnp_tx': '0', 'aggregated_l1_csnp_rx': '0',
'aggregated_l1_csnp_tx': '0', 'aggregated_p2p_hello_rx': '0',
'aggregated_l1_lan_hello_tx': '0', 'aggregated_l2_lan_hello_rx': '0',
'aggregated_l1_lan_hello_rx': '0', 'aggregated_l2_csnp_rx': '0'}
#### HLTAPI for Perl ####
Sample Input:
my %results_ret1 = sth::emulation_isis_info (
handle => "$device",
mode => 'stats');
Sample Output:
$VAR1 = 'aggregated_l1_lsp_rx';
$VAR2 = '0';
$VAR3 = 'aggregated_l1_csnp_tx';
$VAR4 = '0';
$VAR5 = 'status';
$VAR6 = '1';
$VAR7 = 'aggregated_l2_lsp_rx';
$VAR8 = '0';
$VAR9 = 'aggregated_l2_psnp_tx';
$VAR10 = '0';
$VAR11 = 'procName';
$VAR12 = 'emulation_isis_info';
$VAR13 = 'aggregated_l1_lan_hello_rx';
$VAR14 = '0';
$VAR15 = 'aggregated_l1_csnp_rx';
$VAR16 = '0';
$VAR17 = 'handles';
$VAR18 = 'router2';
$VAR19 = 'aggregated_l2_csnp_tx';
$VAR20 = '0';
$VAR21 = 'aggregated_l2_lsp_tx';
$VAR22 = '0';
$VAR23 = 'aggregated_l2_csnp_rx';
$VAR24 = '0';
...
End of Procedure Header
sth::emulation_isis_route_custom_sub_tlv¶
Purpose¶
Creates, modifies or deletes ISIS custom sub-tlv under the specified ISIS IPv4 route.
Synopsis¶
Note
M indicates that the argument is Mandatory .
sth::emulation_isis_route_custom_sub_tlv [-mode {add|modify|delete } M] [-handle <isis_ipv4_route_handle | lsp_handle> ] [-custom_handle <isis_custom_sub_tlv_handle> ] [-ipv4_custom_tlv_sub_type <integer> ] [-ipv4_custom_tlv_sub_type_selector <string> ] [-ipv4_custom_tlv_value <hexadecimal>]
Arguments¶
-
-handle¶ Specifies the IPv4 route handle or LSP handle API under which to add custom sub-tlv objects. Here LSP handle is the handle returned by emulation_isis_lsp_generator API. This argument is Mandatory when -mode is set to add.
-
-mode¶ Specifies the action to perform. Possible values are add,modify and delete. This argument is Mandatory . The modes are described below:
add Creates ISIS custom sub-tlv under the ISIS IPv4 routes specified by -handle. Modify Modify ISIS custom sub-tlv configuration specified by -custom_handle. delete Deletes ISIS custom sub-tlv configuration specified by -custom_handle.
-
-custom_handle¶ Specifies a list of custom sub-tlv object handles to be modified or deleted. This argument is Mandatory when -mode is set to modify or delete.
-
-ipv4_custom_tlv_sub_type¶ Specifies the type of IP Reachability Sub-Tlv. The default value is 0.
-
-ipv4_custom_tlv_sub_type_selector¶ Specifies the list of IP Reachability Sub-Tlv that are supported. The default value is custom.
-
-ipv4_custom_tlv_value¶ Specifies the value of IP Reachability Sub-Tlv. The default value is 0.
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):
custom_subtlv_handle The ISIS custom sub-tlv handle returned by
the function when you use -mode add
status Success (1) or failure (0) of the operation
log An error message (if the operation failed)
Description¶
The sth::emulation_isis_route_custom_sub_tlv function creates, modifies or deletes ISIS
custom sub-tlv under the specified ISIS IPv4 route. Use the -mode argument to
specify the action to perform. (See the -mode argument description for
information about the actions.)
Examples¶
To create ISIS IPv4 Custom Sub-TLVs
sth::emulation_isis_route_custom_sub_tlv\
-handle "ipv4isisroutesconfig1 ipv4isisroutesconfig3\
-mode add\
-ipv4_custom_tlv_sub_type 14\
-ipv4_custom_tlv_sub_type_selector custom\
-ipv4_custom_tlv_value 0xae ]
Sample Output:
{custom_subtlv_handle {{ipv4isisroutesconfig1 isisipcustomsubtlv1}
{ipv4isisroutesconfig3 isisipcustomsubtlv5}}} {status 1}
End of Procedure Header