Welcome to Spirent TestCenter Automation HLTAPI Command Reference

The Spirent TestCenter Automation HLTAPI Command Reference provides basic information about Spirent High Level Test Application Programming Interface (HLTAPI) functions. It also provides descriptions of how to use these functions along with examples of creating and running test configurations. The target audience is test specialists who run automation tests using Spirent TestCenter hardware and software. Users of this manual should have the following knowledge and experience:

• Familiarity with the operating system on your PC or workstation (Microsoft® Windows® or Linux®).
• Moderate familiarity with test equipment.
• Working knowledge of data communications theory and practice.
• Ability to program with the the Tcl, Python, or Perl scripting languages

Contents

• 40G/100G Functions
  • sth::pcs_error_config
  • sth::pcs_error_control
  • sth::random_error_config
  • sth::random_error_control
  • sth::forty_hundred_gig_l1_results
• 6PE/6VPE Functions
  • sth::emulation_6pe_6vpe_provider_port_config
  • sth::emulation_6pe_6vpe_cust_port_config
  • sth::emulation_6pe_6vpe_config
  • sth::emulation_6pe_6vpe_control
  • sth::emulation_6pe_6vpe_info
• 802.1x Functions
  • sth::emulation_dot1x_config
  • sth::emulation_dot1x_control
  • sth::emulation_dot1x_stats
• ANCP Functions
  • sth::emulation_ancp_config
  • sth::emulation_ancp_subscriber_lines_config
  • sth::emulation_ancp_control
  • sth::emulation_ancp_stats
• ARP/ND Functions
  • sth::arp_nd_config
• ALARM Functions
  • sth::alarms_control
  • sth::alarms_stats
• BFD Functions
  • sth::emulation_bfd_config
  • sth::emulation_bfd_control
  • sth::emulation_bfd_info
• BGP Functions
  • sth::emulation_bgp_config
  • sth::emulation_bgp_control
  • sth::emulation_bgp_route_config
  • sth::emulation_bgp_route_element_config
  • sth::emulation_bgp_info
  • sth::emulation_bgp_route_info
  • sth::emulation_bgp_route_generator
  • sth::emulation_bgp_custom_attribute_config
• Break/Restore Link Functions
  • sth::interface_control
• Convergence Functions
  • sth::emulation_convergence_config
  • sth::emulation_convergence_control
  • sth::emulation_convergence_info
• DHCP Server Functions
  • sth::emulation_dhcp_server_config
  • sth::emulation_dhcp_server_relay_agent_config
  • sth::emulation_dhcp_server_control
  • sth::emulation_dhcp_server_stats
• DHCP Functions
  • sth::emulation_dhcp_config
  • sth::emulation_dhcp_group_config
  • sth::emulation_dhcp_control
  • sth::emulation_dhcp_stats
• Device Configuration Functions
  • sth::emulation_device_config
• Ethernet EFM Functions
  • sth::emulation_efm_config
  • sth::emulation_efm_control
  • sth::emulation_efm_stat
• Ethernet OAM Functions
  • sth::emulation_oam_port_config
  • sth::emulation_oam_config_msg
  • sth::emulation_oam_config_ma_meg
  • sth::emulation_oam_config_topology
  • sth::emulation_oam_control
  • sth::emulation_oam_info
• EVPN MPLS Wizard Functions
  • sth::emulation_evpnmpls_provider_port_config
  • sth::emulation_evpnmpls_cust_port_config
  • sth::emulation_evpnmpls_config
• EVPN Wizard Functions
  • sth::emulation_evpn_provider_port_config
  • sth::emulation_evpn_cust_port_config
  • sth::emulation_evpn_wizard_config
  • sth::emulation_evpn_control
  • sth::emulation_evpn_info
• EVPN Functions
  • sth::emulation_evpn_config
• FC Functions
  • sth::fc_config
  • sth::fc_control
  • sth::fc_stats
• FCoE Functions
  • sth::fcoe_config
  • sth::fcoe_control
  • sth::fcoe_stats
  • sth::fip_traffic_config
  • sth::fcoe_traffic_config
• GRE Functions
  • sth::emulation_gre_config
• HTTP Functions
  • sth::emulation_http_profile_config
  • sth::emulation_http_config
  • sth::emulation_http_phase_config
  • sth::emulation_http_control
  • sth::emulation_http_stats
• IGMP Querier Functions
  • sth::emulation_igmp_querier_config
  • sth::emulation_igmp_querier_control
  • sth::emulation_igmp_querier_info
• IGMP Functions
  • sth::emulation_igmp_config
  • sth::emulation_igmp_control
  • sth::emulation_igmp_group_config
  • sth::emulation_igmp_info
• IPTV Functions
  • sth::emulation_iptv_config
  • sth::emulation_iptv_channel_block_config
  • sth::emulation_iptv_channel_viewing_profile_config
  • sth::emulation_iptv_viewing_behavior_profile_config
  • sth::emulation_iptv_control
  • sth::emulation_iptv_stats
• IPv6 Auto-configuration Functions
  • sth::emulation_ipv6_autoconfig
  • sth::emulation_ipv6_autoconfig_control
  • sth::emulation_ipv6_autoconfig_stats
• ISIS Functions
  • sth::emulation_isis_config
  • sth::emulation_isis_control
  • sth::emulation_isis_topology_route_config
  • sth::emulation_isis_iih_config
  • sth::emulation_isis_lsp_generator
  • sth::emulation_isis_info
  • sth::emulation_isis_route_custom_sub_tlv
• L1 Functions
  • sth::l1_config
  • sth::l1_control
  • sth::l1_results
• L2TP Functions
  • sth::l2tp_config
  • sth::l2tp_control
  • sth::l2tp_stats
• L2TPv3 Functions
  • sth::l2tpv3_config
  • sth::l2tpv3_control
  • sth::l2tpv3_stats
• LACP Functions
  • sth::emulation_lacp_config
  • sth::emulation_lacp_control
  • sth::emulation_lacp_info
  • sth::emulation_lag_config
• LDP Functions
  • sth::emulation_ldp_config
  • sth::emulation_ldp_control
  • sth::emulation_ldp_info
  • sth::emulation_ldp_route_config
  • sth::emulation_ldp_route_element_config
  • sth::emulation_lsp_switching_point_tlvs_config
• LLDP and DCBX Functions
  • sth::emulation_lldp_config
  • sth::emulation_lldp_optional_tlv_config
  • sth::emulation_lldp_dcbx_tlv_config
  • sth::emulation_lldp_control
  • sth::emulation_lldp_info
• Device Configuration Functions
  • sth::emulation_macsec_config
  • sth::emulation_macsec_control
  • sth::emulation_macsec_stats
• MLD Querier Functions
  • sth::emulation_mld_querier_config
  • sth::emulation_mld_querier_control
  • sth::emulation_mld_querier_info
• MLD Functions
  • sth::emulation_mld_config
  • sth::emulation_mld_group_config
  • sth::emulation_mld_control
  • sth::emulation_mld_info
• MPLS TP Functions
  • sth::emulation_mpls_tp_config
  • sth::emulation_mpls_tp_port_config
  • sth::emulation_mpls_tp_control
  • sth::emulation_lsp_ping_info
  • sth::emulation_mplstp_y1731_oam_control
  • sth::emulation_mplstp_y1731_oam_stats
• MPLS IP VPN Functions
  • sth::emulation_mpls_ip_vpn_provider_port_config
  • sth::emulation_mpls_ip_vpn_cust_port_config
  • sth::emulation_mpls_ip_vpn_config
  • sth::emulation_mpls_ip_vpn_control
  • sth::emulation_mpls_ip_vpn_info
• MPLS VPN Functions
  • sth::emulation_mpls_l2vpn_pe_config
  • sth::emulation_mpls_l2vpn_site_config
  • sth::emulation_mpls_l3vpn_pe_config
  • sth::emulation_mpls_l3vpn_site_config
• MVPN Functions
  • sth::emulation_mvpn_provider_port_config
  • sth::emulation_mvpn_customer_port_config
  • sth::emulation_mvpn_config
  • sth::emulation_mvpn_control
  • sth::emulation_mvpn_info
• Micro BFD Functions
  • sth::emulation_micro_bfd_config
  • sth::emulation_micro_bfd_control
  • sth::emulation_micro_bfd_info
• Multicast API Functions
  • sth::emulation_multicast_group_config
  • sth::emulation_multicast_source_config
  • sth::emulation_mcast_wizard_config
• OSPF Functions
  • sth::emulation_ospf_config
  • sth::emulation_ospf_control
  • sth::emulation_ospf_lsa_config
  • sth::emulation_ospf_lsa_generator
  • sth::emulation_ospf_tlv_config
  • sth::emulation_ospf_topology_route_config
  • sth::emulation_ospfv2_info
  • sth::emulation_ospfv3_info
  • sth::emulation_ospf_route_info
• OpenFlow Functions
  • sth::emulation_openflow_config
  • sth::emulation_openflow_control
  • sth::emulation_openflow_stats
  • sth::emulation_openflow_switch_config
  • sth::emulation_openflow_switch_control
  • sth::emulation_openflow_switch_stats
• PCEP Functions
  • sth::emulation_pcep_config
  • sth::emulation_pcep_control
• PIM Functions
  • sth::emulation_pim_config
  • sth::emulation_pim_control
  • sth::emulation_pim_group_config
  • sth::emulation_pim_info
• PING Functions
  • sth::emulation_ping
• PPPoE Functions
  • sth::pppox_config
  • sth::pppox_control
  • sth::pppox_stats
• PPP Functions
  • sth::ppp_config
  • sth::ppp_stats
• PPPoX Server Functions
  • sth::pppox_server_config
  • sth::pppox_server_control
  • sth::pppox_server_stats
• PTP Functions
  • sth::emulation_ptp_config
  • sth::emulation_ptp_control
  • sth::emulation_ptp_stats
• Packet Capture Functions
  • sth::packet_config_buffers
  • sth::packet_config_triggers
  • sth::packet_config_filter
  • sth::packet_config_pattern
  • sth::packet_control
  • sth::packet_info
  • sth::packet_stats
• Packet Decoding Functions
  • sth::packet_decode
• RFC 2544 Functions
  • sth::test_rfc2544_config
  • sth::test_rfc2544_control
  • sth::test_rfc2544_info
  • sth::rfc2544_asymmetric_config
  • sth::rfc2544_asymmetric_control
  • sth::rfc2544_asymmetric_profile
  • sth::rfc2544_asymmetric_stats
• RFC 2889 Functions
  • sth::test_rfc2889_config
  • sth::test_rfc2889_control
  • sth::test_rfc2889_info
• RFC 3918 Functions
  • sth::test_rfc3918_config
  • sth::test_rfc3918_control
  • sth::test_rfc3918_info
• RFC 8239 Functions
  • sth::test_rfc8239_config
  • sth::test_rfc8239_control
  • sth::test_rfc8239_info
• RIP Functions
  • sth::emulation_rip_config
  • sth::emulation_rip_control
  • sth::emulation_rip_route_config
  • sth::emulation_rip_info
• RSVP TE Wizard Functions
  • sth::emulation_rsvp_te_wizard_port_config
  • sth::emulation_rsvp_te_wizard_config
• RSVP Functions
  • sth::emulation_rsvp_config
  • sth::emulation_rsvp_custom_object_config
  • sth::emulation_rsvp_control
  • sth::emulation_rsvp_info
  • sth::emulation_rsvp_tunnel_config
  • sth::emulation_rsvpte_tunnel_control
  • sth::emulation_rsvp_tunnel_info
• RoCEv2 Configuration Functions
  • sth::emulation_rocev2_port_config
  • sth::emulation_rocev2_profile_config
  • sth::emulation_rocev2_server_config
  • sth::emulation_rocev2_wizard_config
  • sth::emulation_rocev2_wizard_traffic_config
• Routing Convergence Wizard Functions
  • sth::emulation_rtgconvergence_ingress_port_config
  • sth::emulation_rtgconvergence_egress_port_config
  • sth::emulation_rtgconvergence_config
  • sth::emulation_rtgconvergence_control
  • sth::emulation_rtgconvergence_info
• Save as HLTAPI Commands
  • Purpose
  • Synopsis
  • Arguments
  • Return Values
  • Description
  • Examples
• SIP Functions
  • sth::emulation_sip_config
  • sth::emulation_sip_control
  • sth::emulation_sip_stats
• STP Functions
  • sth::emulation_stp_config
  • sth::emulation_mstp_region_config
  • sth::emulation_msti_config
  • sth::emulation_stp_control
  • sth::emulation_stp_stats
• Session Functions
  • sth::arp_control
  • sth::connect
  • sth::device_info
  • sth::interface_config
  • sth::interface_control
  • sth::interface_stats
  • sth::cleanup_session
  • sth::labserver_connect
  • sth::labserver_disconnect
  • sth::aion_license_server_connect
  • sth::link_config
  • sth::save_xml
  • sth::load_xml
  • sth::start_devices
  • sth::stop_devices
  • sth::get_handles
  • sth::reserve_ports
  • sth::system_settings
  • sth::sequencer_control
  • sth::save_results
  • sth::link_fault_signalling
• SyncE Functions
  • sth::emulation_synce_config
  • sth::emulation_synce_control
  • sth::emulation_synce_stats
• TWAMP Functions
  • sth::emulation_twamp_config
  • sth::emulation_twamp_session_config
  • sth::emulation_twamp_control
  • sth::emulation_twamp_stats
• Traffic Functions
  • sth::traffic_config
  • sth::traffic_config_ospf
  • sth::imix_config
  • sth::traffic_control
  • sth::traffic_stats
  • sth::drv_stats
  • sth::create_csv_file
• Utility Functions
  • sth::duplicate
  • sth::fill_custom
• Testing Utility Functions
  • sth::test_config
  • sth::test_control
• VPLS Functions
  • sth::emulation_l2vpn_pe_config
  • sth::emulation_vpls_site_config
• VQA Functions
  • sth::emulation_vqa_host_config
  • sth::emulation_vqa_config
  • sth::emulation_vqa_port_config
  • sth::emulation_vqa_global_config
  • sth::emulation_vqa_control
  • sth::emulation_vqa_stats
• VXLAN EVPN Overlay Functions
  • sth::emulation_vxlan_evpn_overlay_port_config
  • sth::emulation_nonvxlan_evpn_overlay_port_config
  • sth::emulation_vxlan_evpn_overlay_wizard_config
  • sth::emulation_vxlan_evpn_overlay_control
  • sth::emulation_vxlan_evpn_overlay_stats
• VXLAN OVSDB Functions
  • sth::emulation_vxlan_ovsdb_port_config
  • sth::emulation_nonvxlan_ovsdb_port_config
  • sth::emulation_vxlan_ovsdb_wizard_config
  • sth::emulation_vxlan_ovsdb_control
  • sth::emulation_vxlan_ovsdb_stats
• VXLAN Functions
  • sth::emulation_vxlan_config
  • sth::emulation_vxlan_control
  • sth::emulation_vxlan_stats
  • sth::emulation_vxlan_port_config
  • sth::emulation_nonvxlan_port_config
  • sth::emulation_vxlan_wizard_config
  • sth::emulation_vxlanvm_wizard_config
  • sth::emulation_vxlan_global_config
  • sth::emulation_vxlan_macmobility_wizard_config
  • sth::vxlan_gpe_link_config
• Video Functions
  • sth::emulation_video_config
  • sth::emulation_video_server_streams_config
  • sth::emulation_profile_config
  • sth::emulation_client_load_phase_config
  • sth::emulation_video_control
  • sth::emulation_video_clips_manage
  • sth::emulation_video_stats
• WLAN Functions
  • sth::emulation_wlan_client_config
  • sth::emulation_wlan_accesspoint_config
  • sth::emulation_wlan_client_profile_config
  • sth::emulation_wlan_accesspoint_profile_config
  • sth::emulation_wlan_port_config
  • sth::emulation_wlan_client_control
  • sth::emulation_wlan_accesspoint_control
  • sth::radar_signal_generator_config
  • sth::emulation_radar_generator_control
  • sth::noise_generator_config
  • sth::emulation_noise_generator_control