8.2. High-Level API
HL-API uses the classes defined in LL-API and lets you quickly develop scripts or program in an object-oriented fashion with explicit definition of commands of different tester, module, port types. In addition, the HL-API layer provides functionalities such as:
The HL-API are categorized into:
- 8.2.1. Summary
- 8.2.2. Tester
- 8.2.3. Module
- 8.2.3.1. Capabilities
- 8.2.3.2. Identification
- 8.2.3.3. Impairment
- 8.2.3.4. Media
- 8.2.3.5. Obtain
- 8.2.3.6. Reservation
- 8.2.3.7. Status
- 8.2.3.8. Time and Clock
- 8.2.3.9. Advanced Timing
- 8.2.3.10. L47
- 8.2.4. Port
- 8.2.4.1. Obtain
- 8.2.4.2. General
- 8.2.4.3. Traffic Generation
- 8.2.4.3.1. Port Address
- 8.2.4.3.2. Capture
- 8.2.4.3.3. Latency
- 8.2.4.3.4. Multicast
- 8.2.4.3.5. Payload
- 8.2.4.3.6. Preamble
- 8.2.4.3.7. Runt
- 8.2.4.3.8. Speed
- 8.2.4.3.9. Status
- 8.2.4.3.10. Traffic Control
- 8.2.4.3.11. TX Profile
- 8.2.4.3.12. Unavailable Time
- 8.2.4.3.13. Filter
- 8.2.4.3.14. Histogram
- 8.2.4.3.15. Statistics
- 8.2.4.3.15.1. Error Counter
- 8.2.4.3.15.2. RX Statistics
- 8.2.4.3.15.2.1. Clear Counter
- 8.2.4.3.15.2.2. Calibrate
- 8.2.4.3.15.2.3. Total Counter
- 8.2.4.3.15.2.4. Non-TPLD Counter
- 8.2.4.3.15.2.5. PFC Counter
- 8.2.4.3.15.2.6. Extra Counter
- 8.2.4.3.15.2.7. Received TPLDs
- 8.2.4.3.15.2.8. TPLD - Error Counter
- 8.2.4.3.15.2.9. TPLD - Latency Counter
- 8.2.4.3.15.2.10. TPLD - Jitter Counter
- 8.2.4.3.15.2.11. TPLD - Traffic Counter
- 8.2.4.3.15.2.12. Filter Statistics
- 8.2.4.3.15.2.13. UAT Status
- 8.2.4.3.15.2.14. UAT Time
- 8.2.4.3.15.3. TX Statistics
- 8.2.4.4. Layer 1 (Thor, Loki, Odin)
- 8.2.4.4.1. Energy Efficiency Ethernet
- 8.2.4.4.2. Fault
- 8.2.4.4.3. Link Flap
- 8.2.4.4.4. Transceiver
- 8.2.4.4.5. ANLT
- 8.2.4.4.6. Medium
- 8.2.4.4.7. PCS
- 8.2.4.4.8. PMA
- 8.2.4.4.9. PRBS
- 8.2.4.5. Layer 1 (Freya)
- 8.2.4.5.1. Link Flap
- 8.2.4.5.2. Transceiver
- 8.2.4.5.3. ANLT
- 8.2.4.5.3.1. Auto-Negotiation
- 8.2.4.5.3.2. Autorestart
- 8.2.4.5.3.3. Control
- 8.2.4.5.3.4. Log
- 8.2.4.5.3.5. Link Training
- 8.2.4.5.4. Medium
- 8.2.4.5.5. PCS
- 8.2.4.5.6. PMA
- 8.2.4.5.7. PRBS
- 8.2.4.6. Impairment
- 8.2.4.6.1. Impairment Configuration
- 8.2.4.6.2. Filter
- 8.2.4.6.3. Drop
- 8.2.4.6.3.1. Drop Distribution
- 8.2.4.6.3.1.1. Enable/Disable
- 8.2.4.6.3.1.2. Off Distribution
- 8.2.4.6.3.1.3. Fixed Rate Distribution
- 8.2.4.6.3.1.4. Random Rate Distribution
- 8.2.4.6.3.1.5. Bit Error Rate Distribution
- 8.2.4.6.3.1.6. Fixed Burst Distribution
- 8.2.4.6.3.1.7. Random Burst Distribution
- 8.2.4.6.3.1.8. Gilbert Elliott Distribution
- 8.2.4.6.3.1.9. Uniform Distribution
- 8.2.4.6.3.1.10. Gaussian Distribution
- 8.2.4.6.3.1.11. Poisson Distribution
- 8.2.4.6.3.1.12. Gamma Distribution
- 8.2.4.6.3.1.13. Custom Distribution
- 8.2.4.6.3.2. Drop Scheduling
- 8.2.4.6.3.1. Drop Distribution
- 8.2.4.6.4. Misordering
- 8.2.4.6.5. Latency/Jitter
- 8.2.4.6.5.1. Latency & Jitter Configuration
- 8.2.4.6.5.2. Latency & Jitter Distribution
- 8.2.4.6.5.2.1. Enable/Disable
- 8.2.4.6.5.2.2. Off Distribution
- 8.2.4.6.5.2.3. Constant
- 8.2.4.6.5.2.4. Accumulative Burst Distribution
- 8.2.4.6.5.2.5. Step Distribution
- 8.2.4.6.5.2.6. Uniform Distribution
- 8.2.4.6.5.2.7. Gaussian Distribution
- 8.2.4.6.5.2.8. Poisson Distribution
- 8.2.4.6.5.2.9. Gamma Distribution
- 8.2.4.6.5.2.10. Custom Distribution
- 8.2.4.6.5.3. Latency & Jitter Scheduling
- 8.2.4.6.6. Duplication
- 8.2.4.6.6.1. Duplication Distribution
- 8.2.4.6.6.1.1. Enable/Disable
- 8.2.4.6.6.1.2. Off Distribution
- 8.2.4.6.6.1.3. Fixed Rate Distribution
- 8.2.4.6.6.1.4. Random Rate Distribution
- 8.2.4.6.6.1.5. Bit Error Rate Distribution
- 8.2.4.6.6.1.6. Fixed Burst Distribution
- 8.2.4.6.6.1.7. Random Burst Distribution
- 8.2.4.6.6.1.8. Gilbert Elliott Distribution
- 8.2.4.6.6.1.9. Uniform Distribution
- 8.2.4.6.6.1.10. Gaussian Distribution
- 8.2.4.6.6.1.11. Poisson Distribution
- 8.2.4.6.6.1.12. Gamma Distribution
- 8.2.4.6.6.1.13. Custom Distribution
- 8.2.4.6.6.2. Duplication Scheduling
- 8.2.4.6.6.1. Duplication Distribution
- 8.2.4.6.7. Corruption
- 8.2.4.6.7.1. Corruption Configuration
- 8.2.4.6.7.2. Corruption Distribution
- 8.2.4.6.7.2.1. Enable/Disable
- 8.2.4.6.7.2.2. Off Distribution
- 8.2.4.6.7.2.3. Fixed Rate Distribution
- 8.2.4.6.7.2.4. Random Rate Distribution
- 8.2.4.6.7.2.5. Bit Error Rate Distribution
- 8.2.4.6.7.2.6. Fixed Burst Distribution
- 8.2.4.6.7.2.7. Random Burst Distribution
- 8.2.4.6.7.2.8. Gilbert Elliott Distribution
- 8.2.4.6.7.2.9. Uniform Distribution
- 8.2.4.6.7.2.10. Gaussian Distribution
- 8.2.4.6.7.2.11. Poisson Distribution
- 8.2.4.6.7.2.12. Gamma Distribution
- 8.2.4.6.7.2.13. Custom Distribution
- 8.2.4.6.7.2.14. Scheduling
- 8.2.4.6.7.3. Corruption Scheduling
- 8.2.4.6.8. Policer
- 8.2.4.6.9. Shaper
- 8.2.4.6.10. Statistics
- 8.2.4.7. L47
- 8.2.4.7.1. Port Address
- 8.2.4.7.2. Capabilities & Aptitudes
- 8.2.4.7.3. Capture
- 8.2.4.7.4. Clear All
- 8.2.4.7.5. Identification
- 8.2.4.7.6. Max Packet Rate
- 8.2.4.7.7. Counter
- 8.2.4.7.7.1. Port Counters
- 8.2.4.7.7.2. Connection Group Counters
- 8.2.4.7.8. Connection Group
- 8.2.4.7.8.1. Clear Counters
- 8.2.4.7.8.2. Create, Obtain, Remove
- 8.2.4.7.8.3. Description
- 8.2.4.7.8.4. Histogram
- 8.2.4.7.8.5. L2
- 8.2.4.7.8.6. L3
- 8.2.4.7.8.7. Load Profile
- 8.2.4.7.8.8. Role
- 8.2.4.7.8.9. Status
- 8.2.4.7.8.10. TLS
- 8.2.4.7.8.11. L4
- 8.2.4.7.8.11.1. L4 Protocol
- 8.2.4.7.8.11.1.1. TCP
- 8.2.4.7.8.11.1.1.1. ACK Configuration
- 8.2.4.7.8.11.1.1.2. Congestion Control
- 8.2.4.7.8.11.1.1.3. Initial CWND
- 8.2.4.7.8.11.1.1.4. Initial Slow Slart
- 8.2.4.7.8.11.1.1.5. Max Segment Size - Fixed
- 8.2.4.7.8.11.1.1.6. Max Segment Size - Varying
- 8.2.4.7.8.11.1.1.7. RWND Scaling
- 8.2.4.7.8.11.1.1.8. RWND Size
- 8.2.4.7.8.11.1.1.9. Retransmission Timeout Prolonged Mode
- 8.2.4.7.8.11.1.1.10. Retransmission Timeout Range
- 8.2.4.7.8.11.1.1.11. SYN Retransmission Timeout
- 8.2.4.7.8.11.1.2. UDP
- 8.2.4.7.8.11.1.1. TCP
- 8.2.4.7.8.11.1. L4 Protocol
- 8.2.4.7.8.12. Test Application
- 8.2.4.7.8.12.1. Type
- 8.2.4.7.8.12.1.1. Raw
- 8.2.4.7.8.12.1.1.1. Test Scenario
- 8.2.4.7.8.12.1.1.2. Utilization
- 8.2.4.7.8.12.1.1.3. Transmission Config
- 8.2.4.7.8.12.1.1.4. Burst Config
- 8.2.4.7.8.12.1.1.5. Connection Close
- 8.2.4.7.8.12.1.1.6. Connection Incarnation
- 8.2.4.7.8.12.1.1.7. Connection Lifetime
- 8.2.4.7.8.12.1.1.8. Connection Repetition
- 8.2.4.7.8.12.1.1.9. Download Request Content
- 8.2.4.7.8.12.1.1.10. Download Request Server Wait
- 8.2.4.7.8.12.1.1.11. Download Request Transaction Limit
- 8.2.4.7.8.12.1.1.12. Payload Type
- 8.2.4.7.8.12.1.1.13. Payload Content
- 8.2.4.7.8.12.1.1.14. Payload Repeat Length
- 8.2.4.7.8.12.1.1.15. Payload Total Length
- 8.2.4.7.8.12.1.1.16. Payload RX Length
- 8.2.4.7.8.12.1.2. Replay
- 8.2.4.7.8.12.1.2.1. Utilization
- 8.2.4.7.8.12.1.2.2. Replay File
- 8.2.4.7.8.12.1.2.3. User Incarnation
- 8.2.4.7.8.12.1.2.4. User Repetition
- 8.2.4.7.8.12.1.2.5. Connection Incarnation
- 8.2.4.7.8.12.1.2.6. Connection Lifetime
- 8.2.4.7.8.12.1.2.7. Connection Repetition
- 8.2.4.7.8.12.1.2.8. Download Request Content
- 8.2.4.7.8.12.1.2.9. Download Request Server Wait
- 8.2.4.7.8.12.1.2.10. Download Request Transaction Limit
- 8.2.4.7.8.12.1.2.11. Payload Type
- 8.2.4.7.8.12.1.2.12. Payload Content
- 8.2.4.7.8.12.1.2.13. Payload Repeat Length
- 8.2.4.7.8.12.1.2.14. Payload Total Length
- 8.2.4.7.8.12.1.2.15. Payload RX Length
- 8.2.4.7.8.12.1.1. Raw
- 8.2.4.7.8.12.1. Type
- 8.2.5. Stream
- 8.2.6. Exception
RepeatedRequestID
TransporterException
WrongModuleError
WrongTesterError
WrongTesterPasswordError
XmpBadCommandError
XmpBadHeaderError
XmpBadIndexError
XmpBadModuleError
XmpBadParameterError
XmpBadPortError
XmpBadSizeError
XmpBadValueError
XmpFailedError
XmpMemoryFailureError
XmpModuleOperationNotSupportedByChassisError
XmpNoConnectionError
XmpNoFreePortLicenseError
XmpNoLoggedOnError
XmpNoPeLicenseError
XmpNotReadableError
XmpNotReservedError
XmpNotSupportedError
XmpNotValidError
XmpNotWritableError
XmpPendingError
XmpStatusException
XmpXlsDeniedError
XmpXlsFailedError
XmpXlsInvalidError
XoaConnectionError
XoaConnectionTimeoutError
XoaException
XoaLostFuture
- 8.2.7. Enum
AlgorithmMethod
AlignLockStatus
AnLtLogControl
ApplicationLayerBehavior
AutoNegFECOption
AutoNegFECStatus
AutoNegFECType
AutoNegMode
AutoNegStatus
AutoNegTecAbility
BAM_100G_CR2_KR2
BAM_100G_CR4_KR4
BAM_200G_CR2_KR2
BAM_400G_CR8_KR8
BAM_50G_CR1_KR1
BAM_50G_CR2_KR2
DEFAULT_TECH_MODE
EC_25GBASE_CR1
EC_25GBASE_KR1
EC_400GBASE_KR8
EC_50GBASE_CR2
EC_50GBASE_KR2
EC_50G_CR1_KR1
EC_800GBASE_KR8
IEEE_100GBASE_CR2_KR2
IEEE_100GBASE_KR1
IEEE_100G_CR4
IEEE_100G_KR4
IEEE_10G_KR
IEEE_200GBASE_CR4_KR4
IEEE_200GBASE_KR2
IEEE_25GBASE_CRS_KRS
IEEE_25GBASE_CR_KR
IEEE_400GBASE_KR4
IEEE_40G_CR4
IEEE_50GBASE_CR_KR
AutoOrManual
BRRMode
CaptureSize
ChassisModelName
ChassisModelNumber
ChassisSessionType
ChassisShutdownAction
CongestionType
CorruptionType
CustomDefaultCommand
CustomDefaultScope
DhcpState
DhcpVlanState
EmbedIP
Endianness
ErrorOnOff
FECMode
FaultSignaling
FecCodewordBitErrorMaskMode
FilterMode
FilterType
FilterUse
FilterVlanType
FreyaAutonegMode
FreyaAutorestartMode
FreyaFECAbility
FreyaLinkTrainingMode
FreyaLinkTrainingRangeResponse
FreyaOutOfSyncPreset
FreyaPCSVariant
FreyaPauseAbility
FreyaPresetIndex
FreyaPresetResponse
FreyaTapIndex
FreyaTecAbility
ETC_25G_CR
ETC_25G_KR
ETC_400G_CR8_KR8
ETC_50G_CR2
ETC_50G_KR2
ETC_800G_CR8_KR8
IEEE_1000BASE_KX
IEEE_100GBASE_CR10
IEEE_100GBASE_CR1_KR1
IEEE_100GBASE_CR2_KR2
IEEE_100GBASE_CR4
IEEE_100GBASE_KP4
IEEE_100GBASE_KR4
IEEE_10GBASE_KR
IEEE_10GBASE_KX4
IEEE_1_6TBASE_CR8_KR8
IEEE_200GBASE_CR1_KR1
IEEE_200GBASE_CR2_KR2
IEEE_200GBASE_CR4_KR4
IEEE_25GBASE_CR_KR
IEEE_25GBASE_CR_S_KR_S
IEEE_2_5GBASE_KX
IEEE_400GBASE_CR2_KR2
IEEE_400GBASE_CR4_KR4
IEEE_40GBASE_CR4
IEEE_40GBASE_KR4
IEEE_50GBASE_CR_KR
IEEE_5GBASE_KR
IEEE_800GBASE_CR4_KR4
IEEE_800GBASE_CR8_KR8
FreyaTecAbilityHCD
ETC_25G_CR
ETC_25G_KR
ETC_400G_CR8_KR8
ETC_50G_CR2
ETC_50G_KR2
ETC_800G_CR8_KR8
IEEE_1000BASE_KX
IEEE_100GBASE_CR10
IEEE_100GBASE_CR1_KR1
IEEE_100GBASE_CR2_KR2
IEEE_100GBASE_CR4
IEEE_100GBASE_KP4
IEEE_100GBASE_KR4
IEEE_10GBASE_KR
IEEE_10GBASE_KX4
IEEE_1_6TBASE_CR8_KR8
IEEE_200GBASE_CR1_KR1
IEEE_200GBASE_CR2_KR2
IEEE_200GBASE_CR4_KR4
IEEE_25GBASE_CR_KR
IEEE_25GBASE_CR_S_KR_S
IEEE_2_5GBASE_KX
IEEE_400GBASE_CR2_KR2
IEEE_400GBASE_CR4_KR4
IEEE_40GBASE_CR4
IEEE_40GBASE_KR4
IEEE_50GBASE_CR_KR
IEEE_5GBASE_KR
IEEE_800GBASE_CR4_KR4
IEEE_800GBASE_CR8_KR8
FreyaTechAbilityHCDStatus
GrayCodingMode
HasDemo
HeaderLockStatus
IGMPVersion
ImpairmentLatencyMode
ImpairmentTypeIndex
InfiniteOrFinite
InfoAction
InjectErrorType
IsEnabled
IsOnline
IsPermanent
IsPresent
IsValid
L2PlusPresent
L3Present
L47IPVersion
L47PortSpeed
L47PortState
L47ProtocolType
L47TrafficState
LatencyMode
LatencyTypeCustomDist
Layer1ConfigType
Layer1Control
Layer1LogType
Layer1Opcode
LengthCheckType
LengthType
LicenseSpeed
LifecycleMode
LinkState
LinkTrainAlgorithm
LinkTrainAnnounce
LinkTrainCmd
LinkTrainCmdFlags
LinkTrainCmdResults
LinkTrainCoeffs
LinkTrainEncoding
LinkTrainFrameLock
LinkTrainPresets
LinkTrainingFailureType
LinkTrainingInitCondition
LinkTrainingMode
LinkTrainingStatus
LinkTrainingStatusMode
LocalFaultStatus
LoopBandwidth
LoopbackMode
MDIXMode
MSSType
MediaCFPState
MediaCFPType
CFP4_1X100_ER4
CFP4_1X100_LR4
CFP4_1X100_SR4
CFP4_UNKNOWN
CFP_1X100_LR4
CFP_1X100_SR10
CFP_1X40_LR4
CFP_1X40_SR4
CFP_2X40_SR4
CFP_4X10_SFPP
CFP_INVALID
CFP_UNKNOWN
CXP_AOC
CXP_SR10
CXP_UNKNOWN
QSFP28P_CR4
QSFP28P_ER4
QSFP28P_ISM4
QSFP28P_LR4
QSFP28P_SR4
QSFP28P_UNKNOWN
QSFP28_ACC
QSFP28_AOC
QSFP28_CR4
QSFP28_CWDM4
QSFP28_CWDM4_FEC
QSFP28_ER4
QSFP28_LR4
QSFP28_PSM4
QSFP28_SR4
QSFP28_UNKNOWN
QSFP_EMPTY
QSFP_ER
QSFP_LR
QSFP_SR
QSFP_UNKNOWN
TCVR_UNKNOWN
MediaConfigurationType
ModifierAction
ModuleModelName
MulticastExtOperation
MulticastHeaderFormat
MulticastOperation
NRZPreset
OnOff
OnOffDefault
OnOffWithSuppress
PAM4FrameSize
PFCMode
PHYSignalStatus
PPMSweepMode
PPMSweepStatus
PRBSInsertedType
PRBSInvertState
PRBSLockStatus
PRBSOnOff
PRBSPattern
PRBSPolynomial
PRBSStatisticsMode
PacketDetailSelection
PacketType
PauseMode
PayloadGenerationMethod
PayloadMode
PayloadType
PolicerMode
PortSpeedMode
PreCodingMode
ProtocolOption
ARP
DHCPV4
ECPRI
ETHERNET
ETHERNET_8023
ETHERTYPE
FC
FCOE
FCOETAIL
GENEVE
GRE_CHECK
GRE_NOCHECK
GTP
GTPV1L0
GTPV1L1
GTPV2L0
GTPV2L1
ICMP
IGMPV1
IGMPV2
IGMPV3L0
IGMPV3L1
IP
IPV6
LLC
MACCTRL
MACCTRLPFC
MPLS
MPLS_TP_OAM
NVGRE
PBBTAG
PWETHCTRL
ROE
RTCP
RTP
SCTP
SNAP
STP
TCP
TCPCHECK
UDP
UDPCHECK
VLAN
VXLAN
RESTControlAction
RTOType
RXCState
RXHState
ReconciliationSublayerSupport
RemoteFaultStatus
ReplayParserState
ReplaySchedulingMode
ReplaySyncBasedOn
ReservedAction
ReservedStatus
ResourceAllocationMode
Role
RxEqExtCap
AGC
CDR
CTLE_HIGH
CTLE_LOW
DFE
OC
POST_FFE_1
POST_FFE_10
POST_FFE_11
POST_FFE_12
POST_FFE_13
POST_FFE_14
POST_FFE_15
POST_FFE_16
POST_FFE_17
POST_FFE_18
POST_FFE_19
POST_FFE_2
POST_FFE_20
POST_FFE_21
POST_FFE_22
POST_FFE_23
POST_FFE_3
POST_FFE_4
POST_FFE_5
POST_FFE_6
POST_FFE_7
POST_FFE_8
POST_FFE_9
PRE_FFE_1
PRE_FFE_2
PRE_FFE_3
PRE_FFE_4
PRE_FFE_5
PRE_FFE_6
PRE_FFE_7
PRE_FFE_8
RxEqExtCapMode
SMAInputFunction
SMAOutputFunction
SMAStatus
SerdesStatus
ServiceStatus
ShadowWorkingSelection
SourceType
StartOrStop
StartTrigger
StopTrigger
StreamOption
SyncStatus
SystemUpdateStatus
TLSVersion
TPLDMode
TSNConfigProfile
TSNDeviationMode
TSNHistogramSource
TSNPortRole
TSNStatisticsTypes
TSNTimeSource
TXCState
TXClockSource
TXClockStatus
TXHState
TXMode
TimeKeeperLicenseError
TimeKeeperLicenseFileState
TimeKeeperLicenseType
TimeKeeperServiceAction
TimeKeeperServiceStatus
TimeoutMode
Timescale
TimingSource
TrafficEngine
TrafficError
TrafficOnOff
TrafficScenario
UpdateState
VlanType
WhoClose
YesNo