Spirent TestCenter Automation Obj Ref

TM
Spirent TestCenter Automation

Object Reference
December 2010
P/N 71-006396 REV A
Spirent Communications, Inc.

26750 Agoura Road
Calabasas, CA
91302 USA
Copyright
2010 Spirent Communications, Inc. All Rights Reserved.
All of the company names and/or brand names and/or product names referred to in this document, in
particular, the name Spirent and its logo device, are either registered trademarks or trademarks of Spirent
plc and its subsidiaries, pending registration in accordance with relevant national laws. All other registered
trademarks or trademarks are the property of their respective owners. The information contained in this
document is subject to change without notice and does not represent a commitment on the part of Spirent
Communications. The information in this document is believed to be accurate and reliable, however, Spirent
Communications assumes no responsibility or liability for any errors or inaccuracies that may appear in the
document.
Limited Warranty
Spirent Communications, Inc. (Spirent) warrants that its Products will conform to the description on the
face of order, that it will convey good title thereto, and that the Product will be delivered free from any
lawful security interest or other lien or encumbrance.
Spirent further warrants to Customer that hardware which it supplies and the tangible media on which it
supplies software will be free from significant defects in materials and workmanship for a period of twelve
(12) months, except as otherwise noted, from the date of delivery (the Hardware Warranty Period), under
normal use and conditions.
To the extent the Product is or contains software (Software), Spirent also warrants that, if properly used
by Customer in accordance with the Software License Agreement, the Software which it supplies will
operate in material conformity with the specifications supplied by Spirent for such Software for a period
of ninety (90) days from the date of delivery (the Software Warranty Period). The Product Warranty
Period shall mean the Hardware Warranty Period or the Software Warranty Period, as applicable. Spirent
does not warrant that the functions contained in the Software will meet a specific requirement or that the
operation will be uninterrupted or error free. Spirent shall have no warranty obligations whatsoever with
respect to any Software which has been modified in any manner by Customer or any third party.
Defective Products and Software under warranty shall be, at Spirent's discretion, repaired or replaced or a
credit issued to Customer's account for an amount equal to the price paid for such Product provided that:
(a) such Product is returned to Spirent after first obtaining a return authorization number and shipping
instructions, freight prepaid, to Spirent's location in the United States; (b) Customer provides a written
explanation of the defect or Software failure claimed by Customer; and (c) the claimed defect actually exists
and was not caused by neglect, accident, misuse, improper installation, improper repair, fire, flood, lightning,
power surges, earthquake, or alteration. Spirent will ship repaired Products to Customer, freight prepaid,
based on reasonable best efforts after the receipt of defective Products. Except as otherwise stated, any
claim on account of defective materials or for any other cause whatsoever will conclusively be deemed
waived by Customer unless written notice thereof is given to Spirent within the Warranty Period. Spirent
reserves the right to change the warranty and service policy set forth above at any time, after reasonable
notice and without liability to Customer.
TO THE EXTENT PERMITTED BY APPLICABLE LAW, ALL IMPLIED WARRANTIES, INCLUDING
BUT NOT LIMITED TO IMPLIED WARRANTIES OF MERCHANTABILITY, NONINFRINGEMENT
AND FITNESS FOR A PARTICULAR PURPOSE, ARE HEREBY EXCLUDED, AND THE LIABILITY
OF SPIRENT, IF ANY, FOR DAMAGE RELATING TO ANY ALLEGEDLY DEFECTIVE PRODUCT
SHALL BE LIMITED TO THE ACTUAL PRICE PAID BY THE CUSTOMER FOR SUCH PRODUCT.
THE PROVISIONS SET FORTH ABOVE STATE SPIRENT'S ENTIRE RESPONSIBILITY AND
CUSTOMER'S SOLE AND EXCLUSIVE REMEDY WITH RESPECT TO ANY BREACH OF ANY
WARRANTY.
Contents
Contents
How to Contact Us............................................................................................................................................. 4
Test Configuration Objects Index..................................................................................................................... 5
Command Sequencer Command Objects Index........................................................................................... 15
All Command Objects Index........................................................................................................................... 10
Result Objects Index........................................................................................................................................ 18
Protocol Data Unit Objects Index................................................................................................................... 20
All Objects Index.............................................................................................................................................. 27
Common Attributes.......................................................................................................................................... 27
How to Contact Us
How to Contact Us
To obtain technical support for any Spirent Communications product, please contact our Support Services department using any of the following methods:
Americas
Email: support@spirent.com
Web: http://support.spirent.com
Toll Free: +1 800-SPIRENT (+1 800-774-7368) (North America)
Phone: +1 818-676-2616
Hours: Monday through Friday, 05:30 to 18:00 Pacific Time
Europe, Africa, Middle East

Phone: +33 (1) 6137 2270 (France)
Phone: +44 1803 546333 (UK)
Hours: Monday through Thursday 09:00 to 18:00, Friday 09:00 to 17:00, Paris Time
Asia Pacific
Phone: +86 (800) 810-9529 (toll-free mainland China only)
Phone: +86 (10) 8233 0033 (China)
Hours: Monday through Friday 09:00 to 18:00 Beijing Time
The latest versions of user manuals, application notes, and software and firmware updates are available on the Spirent Communications Customer Service
Center website at http://support.spirent.com.
Information about Spirent Communications and its products and services can be found on the main company website at http://www.spirent.com.
Company Address
Spirent Communications, Inc.
26750 Agoura Road
Calabasas, CA 91302
USA
Test Configuration Objects Index
ColumnDisplayProperties.......................................................................... 320
ContinuousTestConfig................................................................................ 341
CounterFilterProperty................................................................................. 348
CounterResultFilter.................................................................................... 349
CounterResultFilterInfo.............................................................................. 350
CounterSortProperty.................................................................................. 351
CSMachineStats........................................................................................ 371
CSProcessStats......................................................................................... 371
CSServer................................................................................................... 372
CSTestSession........................................................................................... 374
CustomLink................................................................................................ 389
DcbBackToBackTestCaseConfig............................................................... 408
DcbCongestionControlTestCaseConfig..................................................... 420
DcbErroredFramesFilteringTestCaseConfig.............................................. 427
DcbMaximumForwardingRateTestCaseConfig.......................................... 440
DcbPfcBufferingAndLatencyTestCaseConfig............................................ 450
DcbPfcBufferingTestCaseConfig................................................................ 462
DcbPfcLoadValidationTestCaseConfig...................................................... 481
DcbPfcResponseTimeTestCaseConfig...................................................... 501
DcbQueueputTestCaseConfig................................................................... 511
DcbStepTestCaseConfig............................................................................ 519
DcbTestConfig............................................................................................ 524
DcbTrafficGroupCodePointTag.................................................................. 526
DcbTrafficGroupWeightConfig................................................................... 529
DebugResultRenderer............................................................................... 541
DeviceAddrOptions.................................................................................... 547
DeviceGenAal5IfParams............................................................................ 549
DeviceGenEthIIIfParams........................................................................... 552
DeviceGenFcIfParams............................................................................... 553
DeviceGenGreIfParams............................................................................. 553
DeviceGenGroupParams........................................................................... 555
DeviceGenHdlcIfParams............................................................................ 556
DeviceGenIpv4IfParams............................................................................ 557
DeviceGenLinkedStep............................................................................... 559
DeviceGenPppIfParams............................................................................ 560
DeviceGenPppoeIfParams........................................................................ 561
DeviceGenVlanIfParams............................................................................ 561
DeviceGroup.............................................................................................. 562
DeviceRole................................................................................................. 563
Dhcpv4BlockConfig.................................................................................... 570
Dhcpv4DeviceGenProtocolParams........................................................... 576
Dhcpv4MsgOption..................................................................................... 580
Dhcpv4Options.......................................................................................... 581
Dhcpv4PortConfig...................................................................................... 581
Dhcpv4RelayAgentLink.............................................................................. 585
Dhcpv4ServerConfig.................................................................................. 588
Dhcpv4ServerDefaultPoolConfig............................................................... 589
Dhcpv4ServerDeviceGenProtocolParams................................................. 591
Dhcpv4ServerMsgOption........................................................................... 591
Dhcpv4ServerPoolConfig.......................................................................... 592
Dhcpv6BaseMsgOption............................................................................. 600
Dhcpv6DelayedAuthKey............................................................................ 609
Dhcpv6MsgOption..................................................................................... 613
Dhcpv6Options.......................................................................................... 614
Dhcpv6PdBlockConfig............................................................................... 615
Dhcpv6ServerAddrPoolConfig................................................................... 625
Dhcpv6ServerDefaultAddrPoolConfig....................................................... 628
Dhcpv6ServerDefaultPrefixPoolConfig...................................................... 629
Dhcpv6ServerPrefixPoolConfig................................................................. 633
DiffServConfig............................................................................................ 644
Dot1xDeviceGenProtocolParams.............................................................. 652
Dot1xEapFastConfig.................................................................................. 655
Dot1xEapMd5Config.................................................................................. 655
Dot1xEapTlsConfig.................................................................................... 660
Dot1xOptions............................................................................................. 661
Dot1xPortConfig......................................................................................... 662
Dot1xSupplicantBlockConfig..................................................................... 665
DynamicChartResultView.......................................................................... 680
DynamicResultView................................................................................... 681
EchoReplyErrorGeneration........................................................................ 682
EmulatedDevice......................................................................................... 697
EmulatedDeviceGenParams..................................................................... 699

Aal5If............................................................................................................ 45
AbstPppoeDeviceGenProtocolParams........................................................ 49
AccessConcentratorGenParams................................................................. 59
AccessStabilityGenParams.......................................................................... 64
AccessTestGenPortParams......................................................................... 68
AccessVplsGenCeDeviceParams............................................................... 70
AccessVplsGenParams............................................................................... 71
ActiveEvent.................................................................................................. 73
ActiveEventManager.................................................................................... 74
Analyzer....................................................................................................... 89
Analyzer16BitFilter....................................................................................... 90
AnalyzerConfig............................................................................................. 92
AnalyzerFrameConfigFilter.......................................................................... 95
AnalyzerPreloadProfile.............................................................................. 103
AncpAccessLoopBlockConfig.................................................................... 105
AncpAccessLoopGenParams.................................................................... 107
AncpAccessLoopGenSubscriberParams................................................... 108
AncpAccessNodeConfig............................................................................ 110
AncpCpeToDslamLink................................................................................ 115
AncpDeviceGenProtocolParams............................................................... 116
AncpDslLineProfile..................................................................................... 118
AncpPortConfig.......................................................................................... 121
AncpTlvConfig............................................................................................ 130
AncpWildcardModifier................................................................................ 131
ArpCache................................................................................................... 137
ArpNdConfig.............................................................................................. 137
ArpNdReport.............................................................................................. 139
AsbrSummaryLsa...................................................................................... 146
AtmIdleCell................................................................................................. 148
AtmPhy...................................................................................................... 149
AuthenticationParams................................................................................ 163
AutomationOptions.................................................................................... 164
BenchmarkEthernet10GigPortConfig........................................................ 178
BfdAuthenticationParams.......................................................................... 183
BfdDeviceGenProtocolParams.................................................................. 183
BfdIpv4ControlPlaneIndependentSession................................................. 186
BfdRouterConfig........................................................................................ 191
BfdStateSummary...................................................................................... 196
BgpAuthenticationParams......................................................................... 197
BgpCapabilityConfig.................................................................................. 198
BgpDeviceGenProtocolParams................................................................. 198
BgpGlobalConfig........................................................................................ 200
BgpImportRouteTableParams.................................................................... 202
BgpIpv4RouteConfig.................................................................................. 203
BgpIpv4VplsConfig.................................................................................... 207
BgpIpv4VpnFecInfo................................................................................... 210
BgpRouteGenParams................................................................................ 220
BgpRouteGenRouteAttrParams................................................................ 221
BgpRouterConfig....................................................................................... 223
BgpSharedSessionParams........................................................................ 229
BgpStateSummary..................................................................................... 231
BgpVplsAdConfig....................................................................................... 233
BgpVplsFecInfo.......................................................................................... 236
BgpVpnRouteConfig.................................................................................. 237
BinaryResponseHeaderConfig.................................................................. 238
BridgePortConfig........................................................................................ 239
BurstPatternDescriptor............................................................................... 244
Capture...................................................................................................... 247
CaptureAnalyzerFilter................................................................................ 250
CaptureBytePattern................................................................................... 251
CaptureFilter.............................................................................................. 253
CaptureFilterStartEvent............................................................................. 258
CaptureFilterStopEvent.............................................................................. 261
CapturePatternExpression......................................................................... 266
CaptureRangePattern................................................................................ 267
CaptureRawPacketTagsInfo...................................................................... 268
CaptureStatisticsFilter................................................................................ 271
ChartAxis................................................................................................... 285
ChartAxisMapping...................................................................................... 286
ClientLoadPhase........................................................................................ 313
ClientLoadProfile........................................................................................ 314
ClientProfile................................................................................................ 316
EndpointNode............................................................................................ 707
EoamAisCommandConfig......................................................................... 711
EoamContChkCommandConfig................................................................ 717
EoamDelayMeasurementCommandConfig............................................... 722
EoamGenConfig........................................................................................ 729
EoamGlobalConfig..................................................................................... 734
EoamLckCommandConfig......................................................................... 736
EoamLink................................................................................................... 737
EoamLinkTraceCommandConfig............................................................... 738
EoamLoopbackCommandConfig............................................................... 744
EoamLossMeasurementCommandConfig................................................. 750
EoamMaintenancePointConfig.................................................................. 754
EoamMegConfig........................................................................................ 758
EoamNodeConfig....................................................................................... 762
EoamPortConfig......................................................................................... 763
EoamRemoteMegEndPointConfig............................................................. 766
Ethernet100GigFiber.................................................................................. 783
Ethernet10GigCopper................................................................................ 789
Ethernet10GigFiber.................................................................................... 795
EthernetBridgeLink.................................................................................... 810
EthernetCopper.......................................................................................... 811
EthernetFiber............................................................................................. 817
EthernetWan.............................................................................................. 826
EthIIIf.......................................................................................................... 827
EventMessageChartSeries........................................................................ 832
ExposedConfig........................................................................................... 839
ExposedProperty....................................................................................... 839
ExternalDevice........................................................................................... 842
ExternalDeviceDummySession................................................................. 863
ExternalDeviceOption................................................................................ 865
ExternalDevicePort.................................................................................... 866
ExternalDeviceSession.............................................................................. 873
ExternalDummyDevice.............................................................................. 879
ExternalEquationResultProperty................................................................ 880
ExternalLsaBlock....................................................................................... 881
FcDeviceGenProtocolParams................................................................... 892
FcEPortConfig............................................................................................ 893
FcFcoeTrafficParams................................................................................. 895
FcFPortConfig............................................................................................ 896
FcGlobalConfig.......................................................................................... 901
FcGlobalParams........................................................................................ 902
FcHostConfig............................................................................................. 902
FcIf............................................................................................................. 904
FcLeftSidePortParams............................................................................... 907
FcLeftSideTestParams............................................................................... 908
FcoeDeviceGenProtocolParams............................................................... 913
FcoeGlobalParams.................................................................................... 915
FcoeHostConfig......................................................................................... 917
FcoeLeftSidePortParams........................................................................... 920
FcoeLeftSideTestParams........................................................................... 922
FcoeRightSidePortParams........................................................................ 924
FcoeRightSideTestParams........................................................................ 926
FcoeSideDcbxTlvConfig............................................................................ 927
FcoeTestGenParams................................................................................. 931
FcoeVePortConfig...................................................................................... 934
FcoeVfPortConfig....................................................................................... 935
FcPhy......................................................................................................... 947
FcRightSidePortParams............................................................................ 954
FcRightSideTestParams............................................................................ 955
FcTestGenParams..................................................................................... 957
FeatureLicense.......................................................................................... 963
FixedDurationTestConfig............................................................................ 976
FlatPatternDescriptor................................................................................. 985
FrameLengthDistribution............................................................................ 994
FrameLengthDistributionSlot..................................................................... 996
FrameLengthHistogram............................................................................. 997
FtpClientProtocolConfig........................................................................... 1000
FtpProtocolParams.................................................................................. 1005
FtpServerProtocolConfig.......................................................................... 1006
FtpServerProtocolProfile.......................................................................... 1007
FtpServerResponseConfig...................................................................... 1007
FullMeshTopologyGenParams................................................................. 1015
GeneralizedPseudoWireFecInfo.............................................................. 1022
GeneralizedPwidLsp................................................................................ 1024
Generator................................................................................................. 1029
GeneratorConfig...................................................................................... 1030
GreIf......................................................................................................... 1093
GridTopologyGenParams........................................................................ 1099
GroupCollection....................................................................................... 1103
GroupType............................................................................................... 1105
HdlcIf........................................................................................................ 1122
HdlcLinkConfig......................................................................................... 1124
HighResolutionSamplingPortConfig........................................................ 1148
HighResolutionSamplingStreamBlockConfig........................................... 1152
HighResolutionStreamBlockOptions........................................................ 1155
Host.......................................................................................................... 1158
HostGenParams...................................................................................... 1159
HostGroup................................................................................................ 1160
HttpClientProtocolConfig.......................................................................... 1162
HttpClientProtocolProfile.......................................................................... 1164
HttpProtocolParams................................................................................. 1167
HttpServerProtocolConfig........................................................................ 1168
HttpServerProtocolProfile........................................................................ 1169
HttpServerResponseConfig..................................................................... 1170
HubSpokeTopologyGenParams.............................................................. 1173
Ieee1588v2ClockConfig........................................................................... 1190
Ieee1588v2StateSummary...................................................................... 1195
IfManager................................................................................................. 1196
IgmpGroupMembership........................................................................... 1201
IgmpHostConfig....................................................................................... 1204
IgmpPortConfig........................................................................................ 1212
IgmpRouterConfig.................................................................................... 1216
InterarrivalTimeHistogram........................................................................ 1228
IpForwardingLink..................................................................................... 1250
IptvChannelBlock..................................................................................... 1262
IptvStbBlockConfig................................................................................... 1271
IptvViewedChannels................................................................................ 1280
IptvViewingProfileConfig.......................................................................... 1281
Ipv4EchoRequestConfig.......................................................................... 1297
Ipv4Group................................................................................................ 1298
Ipv4If........................................................................................................ 1300
Ipv4IngressPrefixLsp............................................................................... 1305
Ipv4IsisRoutesConfig............................................................................... 1306
Ipv4NetworkBlock.................................................................................... 1307
Ipv4PrefixFecInfo..................................................................................... 1309
Ipv4PrefixLsp........................................................................................... 1309
Ipv4RouteGenParams............................................................................. 1310
Ipv6Group................................................................................................ 1339
Ipv6If........................................................................................................ 1346
IsisAuthenticationParams........................................................................ 1360
IsisCapabilityTlv....................................................................................... 1361
IsisDeviceGenProtocolParams................................................................ 1362
IsisDeviceIdSubTlv.................................................................................. 1364
IsisFTagSubTlv........................................................................................ 1365
IsisGroupAddressTlv................................................................................ 1366
IsisGroupIpv4AddrSubTlv........................................................................ 1366
IsisGroupIpv4Record............................................................................... 1366
IsisGroupMacAddrSubTlv........................................................................ 1368
IsisGroupMacRecord............................................................................... 1369
IsisInterestedVlansSubTlv....................................................................... 1370
IsisLevel1PlsbLinkMetric......................................................................... 1371
IsisLevel1TeParams................................................................................. 1371
IsisLspConfig........................................................................................... 1375
IsisLspGenParams................................................................................... 1377
IsisLspGenRouteAttrParams................................................................... 1378
IsisLspNeighborConfig............................................................................. 1379
IsisLspPlsbInstanceConfig....................................................................... 1380
IsisLspPlsbIsidAddrConfig....................................................................... 1380
IsisLspPlsbIsidAddrIsidConfig................................................................. 1381
IsisMacReachabilityTlv............................................................................ 1382
IsisNicknameRecord................................................................................ 1382
IsisNicknameSubTlv................................................................................ 1383
IsisPlsbGlobalConfig................................................................................ 1383
IsisPlsbLinkMetricConfig.......................................................................... 1384
IsisRootIdSubTlv...................................................................................... 1387
IsisRootPrioritySubTlv.............................................................................. 1387
IsisRouterCapabilitySubTlv...................................................................... 1387
IsisRouterConfig...................................................................................... 1388
IsisSharedSessionParams....................................................................... 1395
IsisStateSummary.................................................................................... 1397
IsisTreeRootIdSubTlv.............................................................................. 1399
IsisTreesSubTlv....................................................................................... 1399
ItagIf......................................................................................................... 1403
ItagServiceLink........................................................................................ 1406
JitterHistogram......................................................................................... 1415
L2LearningConfig..................................................................................... 1419
L2tpPortConfig......................................................................................... 1431
L2tpv2BlockConfig................................................................................... 1438
L2tpv2DeviceGenProtocolParams........................................................... 1444
L2tpv2If.................................................................................................... 1445
L3ForwardingLink.................................................................................... 1458
L4L7GenerateTrafficConfigParams......................................................... 1460
LabelBindingGlobalConfig....................................................................... 1461
LacpGroupConfig..................................................................................... 1465
LacpPortConfig........................................................................................ 1466
LacpStateSummary................................................................................. 1470
LatencyHistogram.................................................................................... 1473
LdpAuthenticationParams........................................................................ 1478
LdpDeviceGenProtocolParams............................................................... 1478
LdpRouterConfig...................................................................................... 1488
LdpSharedSessionParams...................................................................... 1496
LdpStateSummary................................................................................... 1497
LinkOamEventNotificationConfig............................................................. 1518
LinkOamOrgSpecificConfig..................................................................... 1523
LinkOamOrgSpecificInfoConfig............................................................... 1523
LinkOamRouterConfig............................................................................. 1526
LinkOamTimersConfig............................................................................. 1539
LinkOamVariableRequestConfig.............................................................. 1540
LinkOamVariableResponseConfig........................................................... 1541
LinkRegistry............................................................................................. 1543
LinkTlv...................................................................................................... 1546
LldpDeviceGenProtocolParams............................................................... 1554
LldpNodeConfig....................................................................................... 1555
LldpStateSummary.................................................................................. 1559
LldpTlvConfig........................................................................................... 1560
LogFileQuerySet...................................................................................... 1567
LspPingProtocolConfig............................................................................ 1578
LspPingStateSummary............................................................................ 1581
MacBlock................................................................................................. 1595
MacGroup................................................................................................ 1597
ManagementDevice................................................................................. 1620
ManagementRegister............................................................................... 1621
ManualSchedule...................................................................................... 1621
ManualScheduleEntry.............................................................................. 1622
Mdio......................................................................................................... 1633
MdioPort................................................................................................... 1633
MdioRegister............................................................................................ 1634
Mii............................................................................................................ 1638
MiiRegister............................................................................................... 1638
MldGroupMembership............................................................................. 1646
MldHostConfig......................................................................................... 1649
MldPortConfig.......................................................................................... 1653
MldRouterConfig...................................................................................... 1656
MplsForwardingLink................................................................................. 1668
MplsGeneralizedPwBindInfo.................................................................... 1670
MplsHierarchicalLink................................................................................ 1671
MplsIf....................................................................................................... 1671
MplsIpv4PrefixBindInfo............................................................................ 1676
MplsIpv4VpnBindInfo............................................................................... 1677
MplsIpv4VpnCeToPeLink......................................................................... 1678
MplsL2VpnPeToPLink.............................................................................. 1683
MplsRsvpLabelLookUpEntry................................................................... 1684
MplsRsvpTunnelBindInfo......................................................................... 1686
MplsVcBindInfo........................................................................................ 1690
MplsVplsBindInfo..................................................................................... 1692
MstiConfig................................................................................................ 1695
MstpBridgePortConfig.............................................................................. 1698
MstpRegionConfig................................................................................... 1699
MulticastDeviceGenProtocolParams....................................................... 1702
MulticastHostGenProtocolParams........................................................... 1705
MulticastRouterGenProtocolParams....................................................... 1708
MultiSegmentLeftSitePortParams............................................................ 1708
MultiSegmentRightSitePortParams......................................................... 1709
MvpnGenCorePortParams...................................................................... 1709
MvpnGenCustPortParams....................................................................... 1710
MvpnGenParams..................................................................................... 1710
MVpnGreCeToPeLink.............................................................................. 1725
MVpnGrePeToPLink................................................................................ 1726
NetworkLsa.............................................................................................. 1732
NetworkLsaLink....................................................................................... 1733
Ospfv2AuthenticationParams.................................................................. 1762
Ospfv2DeviceGenProtocolParams.......................................................... 1763
Ospfv2GlobalConfig................................................................................. 1766
Ospfv2LsaGenParams............................................................................. 1768
Ospfv2LsaGenRouteAttrParams............................................................. 1770
Ospfv2RouterConfig................................................................................ 1776
Ospfv2SharedSessionParams................................................................. 1785
Ospfv2StateSummary.............................................................................. 1787
Ospfv2TeParams..................................................................................... 1790
Ospfv3AsExternalLsaBlock..................................................................... 1800
Ospfv3AttachedRouter............................................................................. 1802
Ospfv3InterAreaPrefixLsaBlk................................................................... 1805
Ospfv3InterAreaRouterLsaBlock............................................................. 1806
Ospfv3IntraAreaPrefixLsaBlk................................................................... 1808
Ospfv3LinkLsaBlk.................................................................................... 1810
Ospfv3NetworkLsa................................................................................... 1814
Ospfv3NssaLsaBlock............................................................................... 1816
Ospfv3RouterLsa..................................................................................... 1824
Ospfv3RouterLsaIf................................................................................... 1826
PacketChannel......................................................................................... 1835
PacketChannelStats................................................................................ 1836
PathDescriptor......................................................................................... 1842
Perspective.............................................................................................. 1846
PerspectiveNode...................................................................................... 1847
PfcMeasurementConfig........................................................................... 1848
PhyCompensationOptions....................................................................... 1856
PhyOptions.............................................................................................. 1856
PhysicalChassis....................................................................................... 1857
PhysicalChassisFan................................................................................. 1860
PhysicalChassisManager........................................................................ 1860
PhysicalChassisPowerSupplyStatus....................................................... 1861
PhysicalChassisSyncTopology................................................................ 1863
PhysicalChassisTempStatus.................................................................... 1863
PhysicalChassisThermal......................................................................... 1864
PhysicalPort............................................................................................. 1865
PhysicalPortGroup................................................................................... 1866
PhysicalTestModule................................................................................. 1868
PimDeviceGenProtocolParams............................................................... 1882
PimGlobalConfig...................................................................................... 1883
PimRouterConfig...................................................................................... 1887
PimSharedSessionParams...................................................................... 1893
PimStateSummary................................................................................... 1894
Pimv4GroupBlk........................................................................................ 1898
Pimv4JoinSrc........................................................................................... 1900
Pimv4PruneSrc........................................................................................ 1902
Pimv4RpMap........................................................................................... 1904
Pimv6GroupBlk........................................................................................ 1905
Pimv6JoinSrc........................................................................................... 1907
Pimv6PruneSrc........................................................................................ 1909
Pimv6RpMap........................................................................................... 1911
PingReport............................................................................................... 1911
PluginInfo................................................................................................. 1922
Port.......................................................................................................... 1923
PortGroup................................................................................................ 1932
PortLoggingConfig................................................................................... 1935
POSPhy................................................................................................... 1942
PppIf......................................................................................................... 1952
PppMsgOption......................................................................................... 1954
PppoaClientBlockConfig.......................................................................... 1955
PppoaDeviceGenProtocolParams........................................................... 1963
PppoaServerBlockConfig......................................................................... 1965
PppoeClientBlockConfig.......................................................................... 1976
PppoeDeviceGenProtocolParams........................................................... 1985
PppoeIf..................................................................................................... 1990
PppoeoaDeviceGenProtocolParams....................................................... 1993
PppoeServerBlockConfig......................................................................... 2006
PppoeServerIpv4PeerPool...................................................................... 2015
PppoL2tpv2ClientBlockConfig................................................................. 2022
PppoL2tpv2DeviceGenProtocolParams.................................................. 2026
PppoL2tpv2ServerBlockConfig................................................................ 2027
PppoxOptions.......................................................................................... 2041
PppoxPortConfig...................................................................................... 2042
PppoxServerIpv4PeerPool...................................................................... 2046
PppProtocolConfig................................................................................... 2050
PresentationResultQuery......................................................................... 2066
PreviewData............................................................................................. 2068
Probe....................................................................................................... 2075
Project...................................................................................................... 2077
PseudoWireSwitchingPointTlv................................................................. 2087
RandomModifier....................................................................................... 2091
RandomPatternDescriptor....................................................................... 2092
RangeModifier.......................................................................................... 2093
RawTcpClientProtocolConfig................................................................... 2095
RawTcpClientProtocolProfile................................................................... 2097
RawTcpProtocolParams........................................................................... 2100
RawTcpServerProtocolConfig.................................................................. 2101
RawTcpServerProtocolProfile.................................................................. 2102
RawTcpServerResponseConfig............................................................... 2102
RealtimeChartSeries................................................................................ 2116
RealTimeResultColumnDefinition............................................................ 2116
RealTimeResultGroupDefinition.............................................................. 2117
ResultChartQuerySet............................................................................... 2134
ResultDataSet.......................................................................................... 2136
ResultOptions.......................................................................................... 2141
ResultProviderRegistry............................................................................ 2143
ResultQuery............................................................................................. 2144
ResultViewData....................................................................................... 2149
Rfc2544BackToBackFramesConfig......................................................... 2196
Rfc2544BackToBackFramesProfile......................................................... 2202
Rfc2544FrameLossConfig....................................................................... 2203
Rfc2544FrameLossProfile....................................................................... 2234
Rfc2544LatencyConfig............................................................................ 2237
Rfc2544LatencyProfile............................................................................. 2272
Rfc2544ProfileRate.................................................................................. 2277
Rfc2544ThroughputConfig....................................................................... 2291
Rfc2544ThroughputPerFrameSizeResultByPort..................................... 2308
Rfc2544ThroughputPerLoadResultByPort.............................................. 2325
Rfc2544ThroughputProfile....................................................................... 2325
Rfc2544TrafficGroupWeightConfig.......................................................... 2333
Rfc2889AddrCachingCapacityConfig...................................................... 2333
Rfc2889AddrLearningRateConfig............................................................ 2362
Rfc2889BroadcastFrameForwardingConfig............................................ 2370
Rfc2889BroadcastFrameLatencyConfig.................................................. 2391
Rfc2889CongestionControlConfig........................................................... 2407
Rfc2889ErroredFramesFilteringConfig.................................................... 2429
Rfc2889ForwardingConfig....................................................................... 2446
Rfc2889ForwardPressureConfig............................................................. 2467
Rfc2889MaxForwardingRateConfig......................................................... 2480
Rfc3918AggregatedMulticastThroughputTestCaseConfig....................... 2526
Rfc3918Config......................................................................................... 2528
Rfc3918JoinLeaveLatencyTestCaseConfig............................................. 2536
Rfc3918MixedClassThroughputTestCaseConfig..................................... 2541
Rfc3918MulticastForwardingLatencyTestCaseConfig............................. 2550
Rfc3918MulticastGroupCapacityTestCaseConfig.................................... 2555
Rfc3918ScaledGroupForwardingTestCaseConfig................................... 2559
Rfc4814EthIIIfDecorator.......................................................................... 2583
RingTopologyGenParams........................................................................ 2587
RipAuthenticationParams........................................................................ 2589
RipDeviceGenProtocolParams................................................................ 2590
RipngRouteParams.................................................................................. 2592
RipngRouterConfig.................................................................................. 2593
RipngStateSummary................................................................................ 2593
RipRouteGenParams............................................................................... 2596
RipRouteGenRouteAttrParams............................................................... 2596
RipRouterConfig...................................................................................... 2597
RipSharedSessionParams....................................................................... 2599
Ripv4RouteParams.................................................................................. 2601
Ripv4RouterConfig................................................................................... 2602
Ripv4StateSummary................................................................................ 2602
Router...................................................................................................... 2608
RouterGenParams................................................................................... 2611
RouterInformationTlv............................................................................... 2612
RouterLsa................................................................................................ 2613
RouterLsaLink.......................................................................................... 2615
RouterTlv................................................................................................. 2618
RsvpCustomObject.................................................................................. 2637
RsvpDetourSubObject............................................................................. 2638
RsvpDeviceGenProtocolParams............................................................. 2638
RsvpEgressS2lSubLspParams................................................................ 2639
RsvpEgressTunnelParams...................................................................... 2640
RsvpIngressS2lSubLspParams............................................................... 2642
RsvpIngressTunnelParams...................................................................... 2642
RsvpIpv4EroObject.................................................................................. 2647
RsvpIpv4ExplicitRouteParams................................................................ 2647
RsvpIpv4LsrParams................................................................................. 2649
RsvpP2MpSubGroupParams.................................................................. 2653
RsvpRouterConfig.................................................................................... 2655
RsvpSharedSessionParams.................................................................... 2661
RsvpSharedTunnelHeadEndParams....................................................... 2664
RsvpStateSummary................................................................................. 2665
RxPacketChannelOptions........................................................................ 2676
RxPortResultFilter.................................................................................... 2685
SaaDeviceConfig..................................................................................... 2718
SaaDeviceGenProtocolParams............................................................... 2719
SaaPortConfig.......................................................................................... 2721
SawToothPatternDescriptor..................................................................... 2736
SeqDiffCheckHistogram........................................................................... 2740
SeqRunLengthHistogram........................................................................ 2741
Sequencer................................................................................................ 2742
ServerProfile............................................................................................ 2775
ServiceClass............................................................................................ 2776
ServiceClassParameterThreshold........................................................... 2776
SinusoidPatternDescriptor....................................................................... 2785
SipCalleeProtocolParams........................................................................ 2786
SipCallerProtocolParams......................................................................... 2788
SipUaProtocolConfig................................................................................ 2794
SipUaProtocolProfile................................................................................ 2797
SonetConfig............................................................................................. 2808
SonetInjectors.......................................................................................... 2813
SonetPathConfig...................................................................................... 2815
SonetPathInjectors................................................................................... 2816
StairPatternDescriptor.............................................................................. 2832
StaticChartSeries..................................................................................... 2835
StcSystem................................................................................................ 2835
StepTestConfig......................................................................................... 2836
StpBridgePortConfig................................................................................ 2840
StpDeviceGenProtocolParams................................................................ 2841
StpPortConfig........................................................................................... 2844
StpStateSummary.................................................................................... 2847
StreamBlock............................................................................................. 2850
StreamBlockLoadProfile.......................................................................... 2862
StreamBlockResultFilter.......................................................................... 2864
StreamCollectionListModifier................................................................... 2868
StreamCollectionRangeModifier.............................................................. 2869
SummaryLsaBlock................................................................................... 2877
SupportedEndpointType.......................................................................... 2878
SupportedProtocol................................................................................... 2878
SUT.......................................................................................................... 2879
SyncEthDeviceConfig.............................................................................. 2880
SyncEthPortConfig................................................................................... 2885
SyncEthStateSummary............................................................................ 2886
TableModifier............................................................................................ 2890
TeLsa....................................................................................................... 2896
TeParams................................................................................................. 2898
TestResultSetting..................................................................................... 2901
TextHtmlResponseHeaderConfig............................................................ 2903
ThroughputTestConfig.............................................................................. 2916
TimeToTestConfig.................................................................................... 2927
TrafficDescriptor....................................................................................... 2936
TrafficDescriptorGroup............................................................................. 2941
TrafficGroup............................................................................................. 2943
TrafficGroupBurstSizeProfile................................................................... 2944
TrafficGroupCodePointTag...................................................................... 2945
TrafficGroupDcbLoadSearchProfile......................................................... 2946
TrafficGroupFrameSizeProfile................................................................. 2947
TrafficGroupLoadSizeProfile.................................................................... 2949
TrafficGroupWeightProfile........................................................................ 2952
TrafficOptions........................................................................................... 2953
TrafficPathInfo.......................................................................................... 2953
TreeTopologyGenParams........................................................................ 2954
TwampClientConfig.................................................................................. 2955
TwampServerConfig................................................................................ 2962
TwampStateSummary.............................................................................. 2968
TwampTestSession.................................................................................. 2970
TxPacketChannelOptions........................................................................ 2975
UserNote.................................................................................................. 2990
ValueEventMessageChartSeries............................................................. 2994
VcFecInfo................................................................................................. 2996
VcLsp....................................................................................................... 2998
VerifyResultsValueCondition.................................................................... 3008
VicAdapterConfig..................................................................................... 3011
VicGlobalConfig....................................................................................... 3018
VideoClientProtocolConfig....................................................................... 3020
VideoProtocolParams.............................................................................. 3025
VideoServerProtocolConfig...................................................................... 3027
VideoServerSessions............................................................................... 3029
VideoServerStream.................................................................................. 3030
VifConfig.................................................................................................. 3035
VifToVicLink............................................................................................. 3038
VlanBlock................................................................................................. 3041
VlanIf........................................................................................................ 3043
VlanSwitchLink......................................................................................... 3046
VplsBgpCeToPeLink................................................................................ 3050
VplsLdpCeToPeLink................................................................................. 3051
Vpn6PeGenCorePortParams.................................................................. 3052
Vpn6PeGenCustPortParams................................................................... 3052
Vpn6PeGenParams................................................................................. 3053
Vpn6PeSiteGenParams........................................................................... 3065
VpnBgpVplsGenCorePortParams........................................................... 3067
VpnBgpVplsGenCustPortParams............................................................ 3067
VpnBgpVplsGenParams.......................................................................... 3068
VpnBgpVplsSiteGenParams.................................................................... 3078
VpnGenConfigExpandCommand............................................................ 3080
VpnGenUpdateAvailablePortsCommand................................................ 3080
VpnIdGroup.............................................................................................. 3081
VpnIgpIsisSessionParams....................................................................... 3081
VpnIgpOspfv2SessionParams................................................................. 3083
VpnInfo6Pe.............................................................................................. 3085
VpnInfoPwe3............................................................................................ 3086
VpnInfoRfc2547....................................................................................... 3086
VpnInfoVpls.............................................................................................. 3087
VpnLdpVplsGenCorePortParams............................................................ 3088
VpnLdpVplsGenCustPortParams............................................................ 3089
VpnLdpVplsGenParams.......................................................................... 3089
VpnLdpVplsSiteGenParams.................................................................... 3103
VpnLspPingGenIpv4CoreParams............................................................ 3104
VpnLspPingGenIpv4VpnParams............................................................. 3105
VpnMartiniGenCorePortParams.............................................................. 3106
VpnMartiniGenCustPortParams.............................................................. 3107
VpnMartiniGenParams............................................................................. 3107
VpnMplsLdpSessionParams.................................................................... 3120
VpnMplsRsvpSessionParams................................................................. 3122
VpnRfc2547GenCorePortParams........................................................... 3124
VpnRfc2547GenCustPortParams............................................................ 3125
VpnRfc2547GenParams.......................................................................... 3125
VpnRfc2547SiteGenParams.................................................................... 3138
VpnSiteInfo6Pe........................................................................................ 3139
VpnSiteInfoRfc2547................................................................................. 3140
VpnSiteInfoVplsBgp................................................................................. 3141
VpnSiteInfoVplsLdp................................................................................. 3143
VqAnalyzer............................................................................................... 3145
VqAnalyzerChannelIpv4GenParams....................................................... 3147
VqAnalyzerChannelMembershipGenParams.......................................... 3148
VqAnalyzerGenParams........................................................................... 3150
VqAnalyzerOptions.................................................................................. 3151
VqAnalyzerPassivePortGenParams........................................................ 3152
VqAnalyzerPortGenParams..................................................................... 3154
VqAnalyzerTunablePortGenParams........................................................ 3156
VqAnalyzerUnicastDeviceGenParams.................................................... 3157
VqDeviceChannelBlock........................................................................... 3163
VqDynamicPayloadConfig....................................................................... 3164
VqProbeChannelBlock............................................................................. 3165
VrfCustomerLink...................................................................................... 3179
VrfProviderLink........................................................................................ 3180
Wimax16dPhy.......................................................................................... 3187
WimaxIf.................................................................................................... 3191
All Command Objects Index
ChassisConnectCommand........................................................................ 288
ChassisDisconnectAllCommand................................................................ 289
ChassisDisconnectCommand.................................................................... 289
ClientLoadProfileRunStateWaitCommand................................................. 315
CloneCommand......................................................................................... 318
CollapseResultViewDataCommand........................................................... 319
ConfigBfdIlLoggingCommand.................................................................... 325
ConfigBgpIlLoggingCommand................................................................... 326
ConfigFcFcoeIlLoggingCommand............................................................. 327
ConfigIeee1588v2IlLoggingCommand...................................................... 327
ConfigIsisIlLoggingCommand.................................................................... 328
ConfigLacpIlLoggingCommand................................................................. 329
ConfigLdpIlLoggingCommand................................................................... 330
ConfigLldpIlLoggingCommand.................................................................. 331
ConfigOspfv2IlLoggingCommand.............................................................. 332
ConfigPimIlLoggingCommand................................................................... 334
ConfigPropertiesCommand....................................................................... 335
ConfigRipIlLoggingCommand.................................................................... 336
ConfigRsvpIlLoggingCommand................................................................. 337
ConfigStpIlLoggingCommand.................................................................... 337
ConfigSyncEthIlLoggingCommand............................................................ 338
ConfigureTestModuleCommand................................................................ 340
CopyCommand.......................................................................................... 347
CopyFilterToPortsCommand...................................................................... 347
CounterResultFilterLoadFromTemplateCommand.................................... 350
CounterResultFilterSaveAsTemplateCommand........................................ 351
CreateAndReservePortsCommand........................................................... 352
CreateConnectionCommand..................................................................... 352
CreateEventMessageResultQueryCommand............................................ 353
CreateFrameConfigFromPduTemplateCommand..................................... 354
CreateFrameLengthDistributionCommand................................................ 354
CreateFromTemplateCommand................................................................ 355
CreateGroupedStreamBlocksCommand................................................... 356
CreateHighResolutionStreamBlockConfigCommand................................ 357
CreateIgmpMldHostProtocolCommand..................................................... 358
CreateIgmpMldQuerierProtocolCommand................................................ 359
CreateLogicalPortsCommand.................................................................... 360
CreateMulticastIpv4GroupCommand........................................................ 361
CreateNetworkIfCommand........................................................................ 363
CreateNewMulticastGroupCommand........................................................ 363
CreateNewMulticastGroupMembershipCommand.................................... 364
CreateNewOptionCommand...................................................................... 364
CreatePimIpv4GroupsCommand............................................................... 365
CreatePimIpv4MapCommand................................................................... 366
CreatePosPhyCommand........................................................................... 369
CreatorCommand...................................................................................... 369
CSServerConnectCommand..................................................................... 373
CSServerDisconnectCommand................................................................. 373
CSSynchronizeFilesCommand.................................................................. 374
CSTestSessionConnectCommand............................................................ 375
CSTestSessionDisconnectCommand........................................................ 376
CustomPropertyCreateCommand............................................................. 391
CustomPropertyUpdateCommand............................................................. 392
DbGetCommand........................................................................................ 403
DcbExpandConfigCommand..................................................................... 430
DcbIteratePfcPauseTimeCommand.......................................................... 431
DcbIteratePfcQuantaValueCommand........................................................ 433
DcbIteratePfcResponseTimeCommand.................................................... 435
DcbUpdateConfigCommand...................................................................... 530
DefineDynamicResultViewCommand........................................................ 541
DeleteCommand........................................................................................ 542
DeleteFileCommand.................................................................................. 543
DetachPortsCommand............................................................................... 546
DetectSourceMacCommand...................................................................... 546
DeviceCreateCommand............................................................................. 548
DeviceGenConfigExpandCommand.......................................................... 550
DeviceGenConfigPreviewCommand......................................................... 551
DevicesStartAllCommand.......................................................................... 563
DevicesStopAllCommand.......................................................................... 564
DeviceStartCommand................................................................................ 564
DeviceStopCommand................................................................................ 565
Dhcpv4AbortCommand.............................................................................. 568
Dhcpv4AbortServerCommand................................................................... 568
Dhcpv4BindCommand............................................................................... 569
Dhcpv4BindWaitCommand........................................................................ 569

AccessConcentratorGenConfigExpandCommand...................................... 58
AccessConcentratorGenUpdateTrafficCommand........................................ 60
AccessTestGenConfigExpandCommand..................................................... 68
AccessTestGenUpdateAvailablePortsCommand......................................... 69
AccessTestGenUpdateTrafficCommand...................................................... 70
AddChartMarkerCommand.......................................................................... 80
AddResultChartQueryFromResultObjectCommand.................................... 84
AnalyzerFilterCreateCommand................................................................... 94
AnalyzerStartCommand............................................................................. 103
AnalyzerStopCommand............................................................................. 104
AncpAbortCommand.................................................................................. 104
AncpAccessLoopGenConfigExpandCommand......................................... 106
AncpClearStatsCommand......................................................................... 115
AncpImportSubscriberInfoCommand......................................................... 118
AncpInitiateAdjacencyCommand............................................................... 119
AncpInitiateAdjacencyWaitCommand........................................................ 120
AncpMapSubscriberCommand.................................................................. 120
AncpPortDownCommand.......................................................................... 122
AncpPortDownWaitCommand................................................................... 123
AncpPortUpCommand............................................................................... 125
AncpPortUpWaitCommand........................................................................ 126
AncpStartKeepAliveCommand.................................................................. 127
AncpStopKeepAliveCommand.................................................................. 128
AncpTerminateAdjacencyCommand.......................................................... 129
AncpTerminateAdjacencyWaitCommand................................................... 129
AncpUnMapSubscriberCommand............................................................. 131
ApplyToILCommand................................................................................... 134
ArpNdStartCommand................................................................................. 141
ArpNdStartOnAllDevicesCommand........................................................... 142
ArpNdStartOnAllStreamBlocksCommand................................................. 143
ArpNdStopCommand................................................................................. 144
ArpNdUpdateArpCacheCommand............................................................ 145
ArpNdVerifyResolvedCommand................................................................ 145
AttachPortsCommand................................................................................ 158
BfdAdminDownCommand......................................................................... 182
BfdAdminUpCommand.............................................................................. 182
BfdDisableDemandModeCommand.......................................................... 185
BfdEnableDemandModeCommand........................................................... 185
BfdInitiatePollCommand............................................................................ 186
BfdResumePdusCommand....................................................................... 191
BfdSetDiagnosticStateCommand.............................................................. 195
BfdStopPdusCommand............................................................................. 196
BgpBreakTcpSessionCommand................................................................ 197
BgpImportRouteTableCommand............................................................... 202
BgpReadvertiseRouteCommand............................................................... 218
BgpRefreshRoutesCommand.................................................................... 218
BgpRestartRouterCommand..................................................................... 219
BgpResumeKeepaliveCommand............................................................... 219
BgpResumeTcpSessionCommand............................................................ 220
BgpStopKeepaliveCommand..................................................................... 232
BgpViewRoutesCommand......................................................................... 233
BgpWithdrawRouteCommand................................................................... 237
CaptureDataSaveCommand...................................................................... 252
CaptureFilterResetCommand.................................................................... 256
CaptureFilterResetStartEventCommand................................................... 257
CaptureFilterResetStopEventCommand................................................... 257
CaptureGetFrameCommand..................................................................... 265
CaptureGetRawDataCommand................................................................. 266
CapturePktPduParserCommand............................................................... 267
CaptureReleaseCommand........................................................................ 269
CaptureStartAllCommand.......................................................................... 269
CaptureStartCommand.............................................................................. 270
CaptureStopAllCommand.......................................................................... 271
CaptureStopCommand.............................................................................. 272
CaptureViewCommand.............................................................................. 272
ChangeLacpGroupCommand.................................................................... 280
ChangeMstpRegionCommand.................................................................. 280
ChangePimGroupCommand..................................................................... 281
ChangePimRpmapCommand.................................................................... 281
ChangeStpTypeCommand........................................................................ 282
ChannelFlushRxQueueCommand............................................................. 282
ChannelReceiveCommand........................................................................ 283
ChannelResetCounterCommand............................................................... 283
ChannelSendCommand............................................................................ 284
ChannelStartCommand............................................................................. 284
ChannelStopCommand.............................................................................. 285
10
Dhcpv4CopyOptionsCommand................................................................. 576
Dhcpv4ForceRenewFromServerCommand............................................... 579
Dhcpv4RebindCommand........................................................................... 585
Dhcpv4ReleaseCommand......................................................................... 586
Dhcpv4ReleaseWaitCommand.................................................................. 587
Dhcpv4RenewCommand........................................................................... 587
Dhcpv4SessionInfoCommand................................................................... 595
Dhcpv4ShowSessionInfoCommand.......................................................... 597
Dhcpv4StartServerCommand.................................................................... 598
Dhcpv4StopServerCommand.................................................................... 598
Dhcpv6ConfirmCommand......................................................................... 608
Dhcpv6CopyAuthKeyListCommand.......................................................... 609
Dhcpv6InfoRequestCommand................................................................... 612
Dhcpv6ServerReconfigureRebindCommand............................................. 634
Dhcpv6ServerReconfigureRenewCommand............................................. 635
DistributeNetworkCountCommand............................................................ 646
Dot1xAbortAuthCommand......................................................................... 651
Dot1xDeleteAllCertificateCommand.......................................................... 652
Dot1xDownloadCertificateCommand......................................................... 654
Dot1xLogoutCommand.............................................................................. 661
Dot1xStartAuthCommand.......................................................................... 663
Dot1xWaitForAuthStateCommand............................................................. 666
DownloadFileCommand............................................................................. 667
EoamChangeAisRxEnableCommand........................................................ 713
EoamChangeInterfaceStatusCommand.................................................... 714
EoamChangeLckRxEnableCommand....................................................... 715
EoamChangePortStatusCommand........................................................... 715
EoamClearTlvsCommand.......................................................................... 716
EoamContChkRemoteResultsCommand.................................................. 722
EoamDelayMeasurementDetailedResultsCommand................................ 723
EoamGenConfigExpandCommand........................................................... 734
EoamLinkTraceDetailedResultsCommand................................................ 739
EoamLoopbackDetailedResultsCommand................................................ 746
EoamLossMeasurementDetailedResultsCommand.................................. 751
EoamRequestLinkTracePathCommand.................................................... 767
EoamResetMpsToUseDefaultLmrFrameCountValuesCommand.............. 767
EoamResetMpsToUseDefaultLossMeasurementOffsetsCommand.......... 768
EoamResetMpsToUseDefaultTlvsCommand............................................ 768
EoamSaveLinkTracePathCommand.......................................................... 769
EoamStartAisCommand............................................................................ 769
EoamStartAutoMepDiscoveryCommand................................................... 770
EoamStartContChkCommand................................................................... 770
EoamStartDelayMeasurementCommand.................................................. 770
EoamStartLckCommand............................................................................ 771
EoamStartLinkTraceCommand.................................................................. 771
EoamStartLoopbackCommand.................................................................. 772
EoamStartLossMeasurementCommand.................................................... 772
EoamStopAisCommand............................................................................. 773
EoamStopAutoMepDiscoveryCommand................................................... 773
EoamStopContChkCommand................................................................... 774
EoamStopDelayMeasurementCommand.................................................. 775
EoamStopLckCommand............................................................................ 775
EoamStopLinkTraceCommand.................................................................. 776
EoamStopLoopbackCommand.................................................................. 776
EoamStopLossMeasurementCommand.................................................... 777
EoamUpdateMpTypesCommand............................................................... 777
EOTResultsWriteDatasetCommand.......................................................... 777
EOTResultsWriteIterationCommand.......................................................... 778
ExpandBenchmarkConfigCommand......................................................... 833
ExpandCustomConfigCommand............................................................... 833
ExpandResultViewDataCommand............................................................. 834
ExportDbResultsCommand....................................................................... 835
ExportFecDetailsCommand....................................................................... 836
ExportResultsCommand............................................................................ 838
ExternalDeviceAddNewTypeCommand..................................................... 843
ExternalDeviceCustom10Command.......................................................... 843
ExternalDeviceCustom1Command............................................................ 845
ExternalDeviceCustomPollingStartCommand........................................... 861
ExternalDeviceCustomPollingStopCommand........................................... 862
ExternalDeviceDeleteTypeCommand........................................................ 862
ExternalDeviceGetAllPortsCommand........................................................ 864
ExternalDeviceLoadConfigCommand........................................................ 864
ExternalDevicePortStatsStartCommand.................................................... 868
ExternalDevicePortStatsStopCommand.................................................... 869
ExternalDeviceRefreshPortsStatusCommand........................................... 869
ExternalDeviceResetCommand................................................................. 870
ExternalDeviceRunConfigCommand......................................................... 870
ExternalDeviceSaveCommandMappingCommand................................... 872
ExternalDeviceSessionConnectCommand................................................ 874
ExternalDeviceSessionDisconnectCommand........................................... 875
ExternalDeviceSyncMapCommand........................................................... 875
ExternalDeviceWriteConfigCommand....................................................... 879
FcBaseTestGenUpdateAvailablePortsCommand...................................... 892
FcFcoeTestGenConfigExpandCommand.................................................. 894
FcLoginCommand...................................................................................... 908
FcLogoutCommand................................................................................... 909
FcoeClearVirtualLinksCommand............................................................... 913
FcoeDiscoveryCommand.......................................................................... 915
FcoeLoginCommand.................................................................................. 923
FcoeLogoutCommand............................................................................... 924
FcoeStartCommand................................................................................... 928
FcoeStopCommand................................................................................... 928
FcoeTestGenConfigExpandCommand...................................................... 930
FcoeTestGenUpdateAvailablePortsCommand.......................................... 933
FcPhyClearStatsCommand....................................................................... 952
FcTestGenUpdateAvailablePortsCommand.............................................. 958
FcWaitForAggregateSubStateCommand.................................................. 958
FilePathReplacementCommand................................................................ 965
FlapSetupCommand.................................................................................. 984
FrameLengthDistributionLoadFromTemplateCommand............................ 995
FrameLengthDistributionSaveAsTemplateCommand................................ 996
GenerateRawPacketTagsCommand....................................................... 1028
GenerateStreamBlockFromPcapCommand............................................ 1028
GeneratorStartCommand........................................................................ 1038
GeneratorStopCommand......................................................................... 1039
GeneratorUpdateCommand.................................................................... 1039
GeneratorWaitForStopCommand............................................................ 1040
GetAllEndpointCommand........................................................................ 1042
GetAllSupportedEndpointTypeCommand................................................ 1042
GetAllSupportedProtocolCommand......................................................... 1043
GetBfdLoggingConfigCommand.............................................................. 1043
GetBgpLoggingConfigCommand............................................................. 1044
GetChassisLicenseInfoCommand........................................................... 1044
GetConfigInfoCommand.......................................................................... 1045
GetEquipmentLogsCommand................................................................. 1046
GetFcFcoeLoggingConfigCommand....................................................... 1046
GetFieldOffsetCommand......................................................................... 1047
GetHighResolutionSamplingResultCommand......................................... 1047
GetIeee1588v2LoggingConfigCommand................................................ 1048
GetIsisLoggingConfigCommand.............................................................. 1049
GetLacpLoggingConfigCommand........................................................... 1049
GetLdpLoggingConfigCommand............................................................. 1050
GetLldpLoggingConfigCommand............................................................ 1050
GetObjectInfoCommand.......................................................................... 1051
GetObjectsCommand.............................................................................. 1051
GetOspfv2LoggingConfigCommand........................................................ 1052
GetPimLoggingConfigCommand............................................................. 1053
GetPluginInfoCommand........................................................................... 1053
GetPreviewDataCommand...................................................................... 1054
GetPropertyTypeMetaInfoCommand....................................................... 1055
GetRelationsMetaInfoCommand............................................................. 1056
GetRelativesCommand............................................................................ 1057
GetRipLoggingConfigCommand.............................................................. 1058
GetRsvpLoggingConfigCommand........................................................... 1058
GetStpLoggingConfigCommand.............................................................. 1059
GetSyncEthLoggingConfigCommand...................................................... 1059
GetSystemPathsCommand..................................................................... 1060
11
GetTestResultSettingPathsCommand..................................................... 1060
HdlcGetLinkConfigCommand.................................................................. 1121
HdlcSetLinkConfigCommand................................................................... 1125
HelpCommand......................................................................................... 1147
HighResolutionSamplingGetChartCommand.......................................... 1147
HighResolutionSamplingStartCommand................................................. 1150
HighResolutionSamplingStopCommand................................................. 1151
HighResolutionSamplingTriggerCommand.............................................. 1155
IfStackAddCommand............................................................................... 1197
IfStackAttachCommand........................................................................... 1198
IfStackGetCommand................................................................................ 1199
IfStackRemoveCommand........................................................................ 1199
IfStackReplaceCommand........................................................................ 1200
IgmpMldJoinGroupsCommand................................................................ 1209
IgmpMldLeaveGroupsCommand............................................................. 1210
IgmpMldRejoinGroupsCommand............................................................ 1211
IgmpMldStartQuerierCommand............................................................... 1211
IgmpMldStopQuerierCommand............................................................... 1212
InstallFirmwareCommand........................................................................ 1225
InstallRawImageCommand...................................................................... 1226
InstallTestPackageCommand.................................................................. 1227
IptvStartTestCommand............................................................................ 1268
IptvStopTestCommand............................................................................. 1279
IptvWaitForTestCompletionCommand..................................................... 1289
IsisClearOverloadBitCommand............................................................... 1362
IsisReadvertiseLspsCommand................................................................ 1385
IsisRemoveLspNeighborCommand......................................................... 1385
IsisRestartIsisRouterCommand............................................................... 1386
IsisResumeHellosCommand................................................................... 1386
IsisSetOverloadBitCommand................................................................... 1395
IsisStopHellosCommand......................................................................... 1398
IsisViewRoutesCommand........................................................................ 1400
IsisWithdrawIpRoutesCommand............................................................. 1400
IsisZeroAgeLspCommand....................................................................... 1401
IterateBurstSizeCommand....................................................................... 1407
IterateComboCommand.......................................................................... 1408
IterateFrameSizeCommand..................................................................... 1408
IterateLoadSizeCommand....................................................................... 1410
IterateMulticastGroupCountCommand.................................................... 1412
IterateThroughputCommand.................................................................... 1413
IterateTrialCommand............................................................................... 1414
L2LearningStartCommand....................................................................... 1420
L2LearningStopCommand....................................................................... 1421
L2TestBreakLinkCommand...................................................................... 1422
L2TestLoadTemplateCommand............................................................... 1422
L2TestReloadRegistersCommand........................................................... 1423
L2TestRestoreLinkCommand.................................................................. 1423
L2TestSaveTemplateCommand............................................................... 1424
L2TestStartLinkFaultSignallingCommand................................................ 1424
L2TestStopLinkFaultSignallingCommand................................................ 1425
L2tpAbortCommand................................................................................. 1426
L2tpClearStatsCommand........................................................................ 1427
L2tpConnectCommand............................................................................ 1427
L2tpConnectWaitCommand..................................................................... 1428
L2tpDisconnectCommand....................................................................... 1429
L2tpDisconnectWaitCommand................................................................ 1430
L2tpNodeInfoCommand........................................................................... 1431
L2tpSessionInfoCommand...................................................................... 1434
L2tpShowNodeInfoCommand.................................................................. 1435
L2tpShowSessionInfoCommand............................................................. 1435
L2tpShowTunnelInfoCommand............................................................... 1436
L2tpTunnelInfoCommand........................................................................ 1436
L4L7GenerateTrafficConfigCommand..................................................... 1459
LacpCreateLagCommand........................................................................ 1464
LacpResumePdusCommand................................................................... 1469
LacpStopPdusCommand......................................................................... 1471
LdpAbortRequestCommand.................................................................... 1477
LdpPseudowireGroupStatusNotificationCommand................................. 1483
LdpPseudowireStatusNotificationCommand........................................... 1484
LdpReadvertiseLspCommand................................................................. 1485
LdpReadvertisePseudowireGroupCommand.......................................... 1485
LdpRequestLabelCommand.................................................................... 1486
LdpRestartRouterCommand.................................................................... 1486
LdpResumeHellosCommand................................................................... 1487
LdpResumeKeepAlivesCommand........................................................... 1487
LdpStopHellosCommand......................................................................... 1498
LdpStopKeepAlivesCommand................................................................. 1499
LdpWithdrawLspCommand..................................................................... 1499
LdpWithdrawMacAddrCommand............................................................. 1500
LdpWithdrawPseudowireGroupCommand.............................................. 1503
LicenseCheckCommand.......................................................................... 1506
LicenseDeleteFileCommand.................................................................... 1507
LicenseDownloadFileCommand.............................................................. 1508
LicenseSetAPIVersionCommand............................................................. 1508
LicenseShowCommand........................................................................... 1509
LicenseUploadFileCommand................................................................... 1509
LinkCreateCommand............................................................................... 1511
LinkDeleteCommand............................................................................... 1511
LinkOamEventLogCommand................................................................... 1517
LinkOamGenerateVariableRequestsCommand....................................... 1520
LinkOamGenerateVariableResponsesCommand.................................... 1521
LinkOamLoadVariableResponsesCommand........................................... 1522
LinkOamResumeCommand.................................................................... 1525
LinkOamSaveVariableResponsesCommand........................................... 1529
LinkOamStartCommand.......................................................................... 1530
LinkOamStartEventNotificationCommand............................................... 1531
LinkOamStartLoopbackRequestCommand............................................. 1532
LinkOamStartOrgSpecificCommand........................................................ 1533
LinkOamStartVariableRequestCommand................................................ 1533
LinkOamStopCommand.......................................................................... 1537
LinkOamStopEventNotificationCommand............................................... 1537
LinkOamStopLoopbackRequestCommand............................................. 1538
LinkOamStopOrgSpecificCommand........................................................ 1538
LinkOamStopVariableRequestCommand................................................ 1539
LinkOamWaitOnDiscoveryCompleteCommand....................................... 1541
LinkReconnectCommand........................................................................ 1542
LinksReconnectAllCommand................................................................... 1543
LldpPauseCommand............................................................................... 1557
LldpResumeCommand............................................................................ 1558
LldpShowNeighborsInfoCommand.......................................................... 1558
LoadFilterFromLibraryCommand............................................................. 1563
LoadFromDatabaseCommand................................................................ 1563
LoadFromTemplateCommand................................................................. 1564
LoadFromXmlCommand.......................................................................... 1564
LspPingImportFecInfoFromStreamBlockCommand................................ 1575
LspPingPausePingCommand.................................................................. 1576
LspPingPauseTraceRouteCommand...................................................... 1577
LspPingResumePingCommand............................................................... 1580
LspPingResumeTraceRouteCommand................................................... 1580
ManualScheduleLoadFromTemplateCommand...................................... 1623
ManualScheduleSaveAsTemplateCommand.......................................... 1624
MapPortCommand................................................................................... 1624
ModifyTrafficGroupCommand.................................................................. 1666
MplsGeneralizedPwBindIfCreateCommand............................................ 1668
MplsIpv4PrefixBindIfCreateCommand..................................................... 1675
MplsIpv4VpnBindIfCreateCommand....................................................... 1676
MplsRsvpTunnelBindIfCreateCommand.................................................. 1685
MplsStaticBindIfCreateCommand............................................................ 1687
MplsVcBindIfCreateCommand................................................................ 1688
MplsVplsBindIfCreateCommand.............................................................. 1690
MulticastGroupCountCommand.............................................................. 1704
Ospfv2AgeAsbrLsaCommand................................................................. 1755
Ospfv2AgeExternalLsaCommand........................................................... 1756
Ospfv2AgeNetworkLsaCommand........................................................... 1757
Ospfv2AgeRouterLsaCommand.............................................................. 1758
Ospfv2AgeSummaryLsaCommand......................................................... 1759
Ospfv2AgeTeLsaCommand..................................................................... 1760
Ospfv2FloodLsasCommand.................................................................... 1765
Ospfv2PerformGracefulRestartCommand............................................... 1772
Ospfv2ReadvertiseLsaCommand............................................................ 1772
Ospfv2RemoveNetworkLsaLinkCommand.............................................. 1773
Ospfv2RemoveRouterLsaLinkCommand................................................ 1773
Ospfv2RestartRouterCommand.............................................................. 1774
Ospfv2RestoreRouterCommand............................................................. 1775
Ospfv2ResumeHellosCommand............................................................. 1775
Ospfv2ShutdownRouterCommand.......................................................... 1787
Ospfv2StopHellosCommand................................................................... 1788
Ospfv2ViewRoutesCommand.................................................................. 1792
Ospfv3AgeInterAreaPrefixLsaCommand................................................. 1793
Ospfv3AgeInterAreaRouterLsaCommand............................................... 1794
Ospfv3AgeIntraAreaPrefixLsaCommand................................................. 1795
Ospfv3AgeLinkLsaCommand.................................................................. 1796
Ospfv3AgeNssaLsaCommand................................................................ 1798
12
Ospfv3RemoveIfCommand..................................................................... 1818
Ospfv3RemoveRouterIdCommand.......................................................... 1818
Ospfv3RestoreRoutersCommand............................................................ 1819
Ospfv3ShutdownRoutersCommand........................................................ 1831
PauseDynamicResultViewCommand...................................................... 1843
PfcMeasureResponseTimeCommand..................................................... 1849
PhyVerifyLinkUpCommand...................................................................... 1871
PimIncrementGenIdCommand................................................................ 1885
PimResumeBsmsCommand.................................................................... 1885
PimResumeHellosCommand................................................................... 1886
PimResumeJoinsCommand.................................................................... 1886
PimSendBsmsCommand......................................................................... 1891
PimSendJoinsCommand......................................................................... 1892
PimSendPrunesCommand...................................................................... 1892
PimStopBsmsCommand.......................................................................... 1895
PimStopHellosCommand......................................................................... 1895
PimStopJoinsCommand.......................................................................... 1896
PimSwitchTrafficToDataMdtCommand.................................................... 1896
PimSwitchTrafficToDefaultMdtCommand................................................ 1897
PingStartCommand.................................................................................. 1912
PingStopCommand.................................................................................. 1914
PingVerifyConnectivityCommand............................................................ 1914
PortSetupGetActivePhyCommand.......................................................... 1938
PortSetupRestartAutoNegotiationCommand........................................... 1938
PortSetupSetActivePhyCommand........................................................... 1939
PppAbortCommand................................................................................. 1947
PppConnectCommand............................................................................ 1950
PppDisconnectCommand........................................................................ 1951
PppoxAbortCommand.............................................................................. 2036
PppoxClearStatsCommand..................................................................... 2037
PppoxConnectCommand......................................................................... 2037
PppoxConnectWaitCommand.................................................................. 2038
PppoxDisconnectCommand.................................................................... 2039
PppoxDisconnectWaitCommand............................................................. 2040
PppoxPauseCommand............................................................................ 2042
PppoxResumeCommand......................................................................... 2044
PppoxRetryCommand.............................................................................. 2044
PppoxRetryWaitCommand...................................................................... 2045
PppoxSessionInfoCommand................................................................... 2049
PppoxShowSessionInfoCommand.......................................................... 2050
PreviewCustomConfigCommand............................................................. 2067
ProfilesLoadFromTemplateCommand..................................................... 2076
ProfilesSaveAsTemplateCommand......................................................... 2077
ProtocolAdvertiseCommand.................................................................... 2079
ProtocolAttachCommand......................................................................... 2080
ProtocolCreateCommand........................................................................ 2080
ProtocolDetachCommand........................................................................ 2082
ProtocolEstablishCommand.................................................................... 2082
ProtocolStartCommand............................................................................ 2084
ProtocolStopCommand............................................................................ 2084
QueryResultCommand............................................................................ 2090
RebootEquipmentCommand................................................................... 2118
RefreshResultViewCommand.................................................................. 2121
ReleasePortCommand............................................................................. 2124
ReorderRelativesCommand.................................................................... 2124
ReservePortCommand............................................................................ 2132
ResetActiveEventDefaultResponseCommand........................................ 2132
ResetConfigCommand............................................................................. 2133
ResultClearAllTrafficCommand................................................................ 2136
ResultDataSetCreateCommand.............................................................. 2138
ResultDataSetPauseCommand............................................................... 2139
ResultDataSetResumeCommand............................................................ 2139
ResultDataSetSubscribeCommand......................................................... 2140
ResultDataSetUnsubscribeCommand..................................................... 2140
ResultsClearAllCommand........................................................................ 2145
ResultsClearAllProtocolCommand.......................................................... 2146
ResultsClearChartCommand................................................................... 2146
ResultsClearRoutingCommand............................................................... 2147
ResultsClearViewCommand.................................................................... 2147
ResultsSubscribeCommand.................................................................... 2148
ResumeDynamicResultViewCommand................................................... 2150
Rfc2544SetupBackToBackTestCommand............................................... 2278
Rfc2544SetupFrameLossTestCommand................................................. 2281
Rfc2544SetupLatencyTestCommand...................................................... 2284
Rfc2544SetupThroughputTestCommand................................................ 2287
Rfc2889SetupAddressCachingCapacityTestCommand.......................... 2501
Rfc2889SetupAddressLearningRateTestCommand................................ 2503
Rfc2889SetupBroadcastFrameForwardingTestCommand...................... 2505
Rfc2889SetupBroadcastFrameLatencyTestCommand............................ 2508
Rfc2889SetupCongestionControlTestCommand..................................... 2510
Rfc2889SetupErroredFramesFilteringTestCommand.............................. 2512
Rfc2889SetupForwardingTestCommand................................................. 2515
Rfc2889SetupForwardPressureTestCommand....................................... 2518
Rfc2889SetupMaxForwardingRateTestCommand.................................. 2521
Rfc3918SetupAggregatedMulticastThroughputTestCommand................ 2561
Rfc3918SetupJoinLeaveLatencyTestCommand...................................... 2565
Rfc3918SetupMixedClassThroughputTestCommand.............................. 2568
Rfc3918SetupMulticastForwardingLatencyTestCommand...................... 2573
Rfc3918SetupMulticastGroupCapacityTestCommand............................. 2576
Rfc3918SetupScaledGroupForwardingTestCommand............................ 2580
RipPauseRouteUpdateCommand........................................................... 2594
RipReadvertiseRouteCommand.............................................................. 2595
RipResumeRouteUpdateCommand........................................................ 2595
RipViewRoutesCommand........................................................................ 2603
RipWithdrawRouteCommand.................................................................. 2604
RouteGenApplyCommand....................................................................... 2605
RouteGenGetConfigurableRouteCountCommand.................................. 2606
RouteGenGetPrefixLengthDistCommand................................................ 2607
RouteGenSetDefaultsCommand............................................................. 2607
RoutingConvergenceInjectCommand...................................................... 2619
RoutingConvergenceMeasureCommand................................................ 2620
RoutingConvergenceSetupCommand..................................................... 2620
RsvpFrrNodeFailureCommand................................................................ 2641
RsvpInitiateMakeBeforeBreakCommand................................................. 2646
RsvpMoveEroHopsUnderEroObjectCommand....................................... 2651
RsvpP2mPGraftEgressSubLspCommand............................................... 2651
RsvpP2mPGraftIngressSubLspCommand.............................................. 2652
RsvpP2mPPruneEgressSubLspCommand............................................. 2652
RsvpP2mPPruneIngressSubLspCommand............................................. 2653
RsvpRestartRouterCommand.................................................................. 2654
RsvpResumeHellosCommand................................................................. 2654
RsvpStopHellosCommand....................................................................... 2666
RsvpViewCompressedEROCommand.................................................... 2668
RsvpViewSubLspResultsCommand........................................................ 2669
RsvpWaitForRerouteCommand............................................................... 2669
RunCustomCommand............................................................................. 2672
RunExternalProcessCommand............................................................... 2673
SaaBindWaitCommand............................................................................ 2717
SaaSessionInfoCommand....................................................................... 2723
SaaShowSessionInfoCommand.............................................................. 2726
SaaStartCommand.................................................................................. 2726
SaaStopCommand................................................................................... 2727
SaveAsTclCommand................................................................................ 2727
SaveAsTclWithXmlCommand.................................................................. 2728
SaveAsTemplateCommand..................................................................... 2729
SaveAsXmlCommand.............................................................................. 2730
SaveFilterToLibraryCommand................................................................. 2731
SaveFrameConfigToPduTemplateCommand.......................................... 2731
SaveResultCommand.............................................................................. 2732
SaveResultsCommand............................................................................ 2733
SaveSelectedCaptureDataCommand...................................................... 2734
SaveToTccCommand............................................................................... 2735
SequencerBreakLoopCommand............................................................. 2746
SequencerClearCommand...................................................................... 2747
SequencerComment................................................................................ 2747
SequencerContinueLoopCommand........................................................ 2748
SequencerDisableCommand................................................................... 2748
SequencerDoWhileCommand................................................................. 2749
SequencerElseCommand........................................................................ 2752
SequencerElseIfCommand...................................................................... 2754
SequencerEnableCommand.................................................................... 2757
SequencerGotoCommand....................................................................... 2757
SequencerGroupCommand..................................................................... 2758
SequencerIfCommand............................................................................. 2761
SequencerInsertBreakpointCommand..................................................... 2763
SequencerInsertCommand...................................................................... 2764
SequencerLoopCommand....................................................................... 2765
SequencerMoveCommand...................................................................... 2767
SequencerPauseCommand..................................................................... 2768
SequencerRemoveBreakpointCommand................................................ 2768
SequencerRemoveCommand................................................................. 2769
SequencerReplaceCommand.................................................................. 2770
SequencerStartCommand....................................................................... 2770
SequencerStepCommand....................................................................... 2771
SequencerStopCommand....................................................................... 2771
13
SequencerWhileCommand...................................................................... 2772
SetCounterGroupCommand.................................................................... 2778
SetDurationCommand............................................................................. 2779
SetFirmwareArchivesDirCommand......................................................... 2779
SetMstpRegionCommand........................................................................ 2780
SetRawArchivesDirCommand................................................................. 2781
SetRelationCommand.............................................................................. 2781
SetRelativesCommand............................................................................ 2782
SetupPortMappingsCommand................................................................. 2784
SetupPortsCommand............................................................................... 2784
SipCancelRegsCommand....................................................................... 2789
SipCancelRegsWaitCommand................................................................ 2790
SipCreateDataPlaneCommand............................................................... 2790
SipRegisterCommand.............................................................................. 2793
SipRegisterWaitCommand....................................................................... 2793
SipUnregisterCommand.......................................................................... 2802
SonetClearStatsCommand...................................................................... 2808
SonetGetConfigCommand....................................................................... 2811
SonetInjectOneCommand....................................................................... 2811
SonetInjectorCommand........................................................................... 2812
SonetResetAlarmsCommand.................................................................. 2818
SonetSetConfigCommand....................................................................... 2820
StpInitTopoChangeBridgePortCommand................................................. 2843
StpInitTopoChangeCistCommand........................................................... 2843
StpInitTopoChangeMstiCommand........................................................... 2844
StpStartCistCommand............................................................................. 2846
StpStartMstiCommand............................................................................. 2846
StpStopCistCommand............................................................................. 2847
StpStopMstiCommand............................................................................. 2848
StpUpdateMstiCommand......................................................................... 2848
StreamBlockActivateCommand............................................................... 2857
StreamBlockAutoSelectTunnelCommand................................................ 2858
StreamBlockClearAllTunnelCommand.................................................... 2859
StreamBlockExpandCommand................................................................ 2859
StreamBlockGetInfoCommand................................................................ 2860
StreamBlockGetOffsetReferenceCommand............................................ 2860
StreamBlockGetTunnelCommand........................................................... 2861
StreamBlockSetTrafficPatternCommand................................................. 2864
StreamBlockStartCommand.................................................................... 2865
StreamBlockStopCommand.................................................................... 2866
StreamBlockUpdateCommand................................................................ 2866
StreamBlockVerifyForwardingCommand................................................. 2867
SubscribeDynamicResultViewCommand................................................ 2873
SubscribeResultsViewCommand............................................................. 2874
SyncEthConfigChangeCommand............................................................ 2880
TimedRefreshPauseCommand................................................................ 2921
TimedRefreshResumeCommand............................................................ 2922
TimedResultLoggingStartCommand........................................................ 2922
TimedResultLoggingStopAllCommand.................................................... 2923
TrafficGroupLoadSearchCommand......................................................... 2949
TrafficGroupWeightedLoadSearchCommand.......................................... 2950
TwampPauseTestPacketsCommand....................................................... 2957
TwampRequestSessionsCommand......................................................... 2961
TwampResumeTestPacketsCommand.................................................... 2961
TwampStartHostsCommand.................................................................... 2966
TwampStartSessionsCommand.............................................................. 2967
TwampStopHostsCommand.................................................................... 2968
TwampStopSessionsCommand............................................................... 2970
UnMapPortCommand.............................................................................. 2985
UnsubscribeDynamicResultViewCommand............................................ 2986
UpdateDynamicResultViewCommand..................................................... 2986
UpdateMplsBindingsCommand............................................................... 2987
UploadFileCommand............................................................................... 2987
ValidateConfigCommand......................................................................... 2991
ValidateFilterExpressionCommand.......................................................... 2992
VerifyResultsValueCommand.................................................................. 3008
VerifyRouterUpCommand........................................................................ 3009
VicCreateRequestCommand................................................................... 3014
VicCreateVifsCommand........................................................................... 3014
VicDeleteRequestCommand.................................................................... 3015
VicDisableRequestCommand.................................................................. 3015
VicEnableRequestCommand................................................................... 3016
VicFindVicsCommand.............................................................................. 3016
VicFindVifsCommand.............................................................................. 3017
VicGetRequestCommand........................................................................ 3018
VicLinkVifsCommand............................................................................... 3019
VicOpenRequestCommand..................................................................... 3019
VicResetTlvsToDefaultsCommand.......................................................... 3019
VideoClipDeleteCommand....................................................................... 3024
VideoClipDownloadCommand................................................................. 3024
VideoClipsEnumerateCommand.............................................................. 3025
ViewControlPlaneMplsBindingCommand................................................ 3031
ViewFlappableEventsCommand.............................................................. 3033
ViewMplsBindingsCommand................................................................... 3034
ViewMplsBindingsSummaryCommand.................................................... 3034
VpnAvailableMembersCommand............................................................ 3066
VpnCreateSitesCommand....................................................................... 3079
VpnSiteGenConfigExpandCommand...................................................... 3139
VqAnalyzerClearCommand..................................................................... 3149
VqAnalyzerGenConfigExpandCommand................................................ 3149
VqAnalyzerStartCommand...................................................................... 3154
VqAnalyzerStopCommand...................................................................... 3155
WaitCommand......................................................................................... 3181
WaitForAggregateSubStateCommand.................................................... 3182
WaitForDataPlaneSamplesCommand..................................................... 3183
WaitForMplsBindingsCommand.............................................................. 3183
WaitForRouterStateCommand................................................................. 3184
WaitForRoutingEventsCommand............................................................ 3184
WaitForStorageEventsCommand............................................................ 3185
WildcardPreviewCommand..................................................................... 3186
14
Command Sequencer Command Objects Index
FcLoginCommand...................................................................................... 908
Command Sequencer Command

Objects Index
This index contains command objects that you can use with the command
sequencer (the Sequencer object).
15
16
SaaStopCommand................................................................................... 2727
WaitCommand......................................................................................... 3181
17
Result Objects Index
ExternalDeviceCustom4CommandResults................................................ 851
ExternalDeviceCustomPollingCommandResults....................................... 860
ExternalDevicePortResults........................................................................ 867
ExternalDeviceRunConfigCommandResults............................................. 871
ExternalDeviceVmwareCpuResults........................................................... 876
ExternalDeviceVmwareNicResults............................................................ 877
ExternalDeviceVmwareResults................................................................. 877
FcFPortNeighborResults............................................................................ 898
FcFPortResults.......................................................................................... 900
FcNPortResults.......................................................................................... 910
FcoeSummaryResults................................................................................ 929
FcoeVfPortNeighborResults...................................................................... 937
FcoeVfPortResults..................................................................................... 940
FcoeVnPortResults.................................................................................... 941
FcResults................................................................................................... 952
FcSummaryResults.................................................................................... 956
FilteredStreamResults............................................................................... 966
ForeignMasterClockResults....................................................................... 991
FtpClientResults....................................................................................... 1002
FtpServerResults..................................................................................... 1008
GeneratorPortResults.............................................................................. 1035
GreIfPortResults...................................................................................... 1097
GreIfResults............................................................................................. 1097
HighResolutionSamplingPortResults....................................................... 1150
HighResolutionSamplingStreamBlockResults......................................... 1154
HttpClientResults..................................................................................... 1165
HttpServerResults.................................................................................... 1171
Ieee1588v2ClockResult........................................................................... 1194
IgmpEotHostResults................................................................................ 1200
IgmpGroupMembershipResults............................................................... 1203
IgmpHostResults...................................................................................... 1207
IgmpPortResults...................................................................................... 1213
IgmpRouterResults.................................................................................. 1218
InterestingStreamsResults....................................................................... 1232
IptvChannelResults.................................................................................. 1263
IptvPortResults......................................................................................... 1267
IptvStbBlockResults................................................................................. 1273
IptvTestResults......................................................................................... 1280
IptvViewingProfileResults........................................................................ 1284
Ipv4GroupResults.................................................................................... 1299
IsisRouterResults..................................................................................... 1393
L2tpPortResults....................................................................................... 1432
L2tpv2BlockResults................................................................................. 1441
L2tpv2NodeResults.................................................................................. 1450
L2tpv2SessionResults............................................................................. 1452
L2tpv2TunnelResults............................................................................... 1454
LacpPortResults....................................................................................... 1468
LdpLspResults......................................................................................... 1481
LdpRouterResults.................................................................................... 1492
LinkOamCounterResults.......................................................................... 1515
LinkOamEventCounterResults................................................................ 1516
LinkOamEventNotificationResults........................................................... 1519
LinkOamRemoteInfoResults.................................................................... 1524
LinkOamStateResults.............................................................................. 1534
LldpDcbxFeatureResult........................................................................... 1551
LldpDcbxResult........................................................................................ 1553
LldpNeighborResults................................................................................ 1554
LldpNodeResults...................................................................................... 1556
LspPingPingResults................................................................................. 1577
LspPingProtocolResults........................................................................... 1579
LspPingTraceRouteResults..................................................................... 1582
MldEotHostResults.................................................................................. 1645
MldGroupMembershipResults................................................................. 1647
MldHostResults........................................................................................ 1651
MldPortResults......................................................................................... 1654
MldRouterResults.................................................................................... 1658
MstiResults.............................................................................................. 1697
Ospfv2RouterResults............................................................................... 1783
OverflowResults....................................................................................... 1834
ParentClockInfoResult............................................................................. 1840
PfcResults................................................................................................ 1850
PimRouterResults.................................................................................... 1890

AnalyzerPortResults.................................................................................... 95
AncpAccessNodeResults.......................................................................... 112
AncpPortResults........................................................................................ 124
ArpNdResults............................................................................................. 140
BaseBridgePortResults.............................................................................. 166
BenchmarkTrafficGroupPerIterationResult................................................ 179
BfdIpv4SessionResults.............................................................................. 187
BfdRouterResults....................................................................................... 193
BfdSessionResults..................................................................................... 193
BgpRouterResults...................................................................................... 227
BridgePortResults...................................................................................... 241
ClockSynchronizationResult...................................................................... 317
DcbBackToBackPerIterationResult............................................................ 404
DcbCongestionControlPerIterationResult.................................................. 413
DcbCongestionControlPerPortResult........................................................ 417
DcbErroredFramesFilteringPerIterationResult........................................... 423
DcbMaximumForwardingRatePerIterationResult...................................... 437
DcbPfcBufferingAndLatencyPerIterationResult......................................... 444
DcbPfcBufferingPerIterationResult............................................................ 458
DcbPfcLoadValidationPerIterationPerPortResult....................................... 469
DcbPfcLoadValidationPerIterationResult................................................... 476
DcbPfcResponseTimePerIterationPerPortResult...................................... 488
DcbPfcResponseTimePerIterationResult.................................................. 492
DcbQueueputPerIterationResult................................................................ 507
DcbStepPerIterationResult........................................................................ 515
DcbTrafficGroupPerIterationResult............................................................ 526
DcbxBandwidthAllocationResult................................................................ 530
DcbxBcnModeResult................................................................................. 531
DcbxBcnParameterResult.......................................................................... 532
DcbxFcoePriorityResult............................................................................. 534
DcbxLogicalLinkResult............................................................................... 535
DcbxNivResult........................................................................................... 535
DcbxPriorityAllocationResult...................................................................... 536
DcbxPriorityFlowControlResult.................................................................. 537
Dhcpv4BlockResults.................................................................................. 574
Dhcpv4PortResults.................................................................................... 583
Dhcpv4ServerResults................................................................................ 594
Dhcpv4SessionResults.............................................................................. 596
DiffServResults.......................................................................................... 645
Dot1xEapAuthMethodResults.................................................................... 654
Dot1xEapMethodResults........................................................................... 656
Dot1xEapolResults.................................................................................... 657
Dot1xEapPktResults.................................................................................. 659
Dot1xSupplicantAuthResults..................................................................... 663
EoamAisResults......................................................................................... 712
EoamContChkLocalResults....................................................................... 718
EoamContChkRemoteResults................................................................... 720
EoamDelayMeasurementMessageRxResults........................................... 724
EoamDelayMeasurementResponseRxResults.......................................... 725
EoamDelayMeasurementResults.............................................................. 728
EoamLckResults........................................................................................ 736
EoamLinkTraceMessageRxResults........................................................... 739
EoamLinkTraceMessageTxResults........................................................... 740
EoamLinkTracePathResults...................................................................... 741
EoamLinkTraceResponseRxResults......................................................... 742
EoamLinkTraceResponseTxResults.......................................................... 743
EoamLinkTraceResults.............................................................................. 743
EoamLoopbackMessageRxResults........................................................... 747
EoamLoopbackMessageTxResults........................................................... 747
EoamLoopbackResponseRxResults......................................................... 748
EoamLoopbackResponseTxResults.......................................................... 749
EoamLoopbackResults.............................................................................. 749
EoamLossMeasurementMessageRxResults............................................. 752
EoamLossMeasurementResponseRxResults........................................... 753
EoamLossMeasurementResults................................................................ 753
EoamMegResults....................................................................................... 761
EoamPortResults....................................................................................... 765
ExternalDeviceCustom10CommandResults.............................................. 844
18
PortAvgLatencyResults............................................................................ 1926
PppClientBlockResults............................................................................. 1948
PppoaClientBlockResults........................................................................ 1960
PppoaServerBlockResults....................................................................... 1969
PppoaSessionResults.............................................................................. 1972
PppoeClientBlockResults........................................................................ 1982
PppoeoaSessionResults.......................................................................... 1998
PppoePortResults.................................................................................... 2002
PppoeServerBlockResults....................................................................... 2012
PppoeSessionResults.............................................................................. 2017
PppoL2tpv2SessionResults..................................................................... 2031
PppProtocolResults................................................................................. 2055
PppServerBlockResults........................................................................... 2058
PppSessionResults.................................................................................. 2061
RawTcpClientResults............................................................................... 2098
RawTcpServerResults.............................................................................. 2104
Result....................................................................................................... 2134
Rfc2544AsymmetricFrameLossPerLoadResult....................................... 2150
Rfc2544AsymmetricFrameLossStreamGroupResult............................... 2156
Rfc2544AsymmetricFrameLossStreamResult......................................... 2157
Rfc2544AsymmetricLatencyPerLoadResult............................................ 2157
Rfc2544AsymmetricLatencyStreamGroupResult.................................... 2164
Rfc2544AsymmetricLatencyStreamResult.............................................. 2165
Rfc2544AsymmetricThroughputPerFrameSizeResult............................. 2167
Rfc2544AsymmetricThroughputPerLoadResult...................................... 2173
Rfc2544AsymmetricThroughputStreamGroupResult.............................. 2179
Rfc2544AsymmetricThroughputStreamResult........................................ 2179
Rfc2544Back2BackPerCoexistenceRatioResult..................................... 2180
Rfc2544Back2BackPerFrameSizeResult................................................ 2184
Rfc2544Back2BackPerIterationResult..................................................... 2187
Rfc2544Back2BackPerLoadResult.......................................................... 2190
Rfc2544Back2BackTestResult................................................................. 2193
Rfc2544FrameLossPerCoexistenceRatioResult..................................... 2210
Rfc2544FrameLossPerFrameSizeResult................................................ 2214
Rfc2544FrameLossPerIpv6ExtensionHeaderResult............................... 2219
Rfc2544FrameLossPerIterationResult..................................................... 2224
Rfc2544FrameLossPerLoadResult.......................................................... 2229
Rfc2544FrameLossTestResult................................................................. 2235
Rfc2544LatencyPerCoexistenceRatioResult........................................... 2243
Rfc2544LatencyPerFrameSizeResult...................................................... 2249
Rfc2544LatencyPerIpv6ExtensionHeaderResult..................................... 2255
Rfc2544LatencyPerIterationResult.......................................................... 2261
Rfc2544LatencyPerLoadResult............................................................... 2267
Rfc2544LatencyTestResult...................................................................... 2273
Rfc2544ThroughputPerCoexistenceRatioResult..................................... 2298
Rfc2544ThroughputPerFrameSizeResult................................................ 2303
Rfc2544ThroughputPerIpv6ExtensionHeaderResult............................... 2309
Rfc2544ThroughputPerIterationResult.................................................... 2314
Rfc2544ThroughputPerLoadResult......................................................... 2320
Rfc2544ThroughputTestResult................................................................ 2328
Rfc2544TrafficGroupPerIterationResult................................................... 2330
Rfc2889AddrCachingPerAddrResult....................................................... 2338
Rfc2889AddrCachingPerFrameSizeResult............................................. 2341
Rfc2889AddrCachingPerIterationResult.................................................. 2343
Rfc2889AddrCachingPerPortResult........................................................ 2346
Rfc2889AddrCachingTestResult.............................................................. 2349
Rfc2889AddrLearningPerFrameSizeResult............................................. 2352
Rfc2889AddrLearningPerIterationResult................................................. 2354
Rfc2889AddrLearningPerLearningRateResult........................................ 2357
Rfc2889AddrLearningPerPortResult....................................................... 2360
Rfc2889AddrLearningTestResult............................................................. 2367
Rfc2889BroadcastFrameForwardingPerBurstSizeResult........................ 2375
Rfc2889BroadcastFrameForwardingPerFrameSizeResult...................... 2378
Rfc2889BroadcastFrameForwardingPerIterationResult.......................... 2382
Rfc2889BroadcastFrameForwardingPerLoadResult............................... 2385
Rfc2889BroadcastFrameForwardingTestResult...................................... 2388
Rfc2889BroadcastFrameLatencyPerFrameSizePerPortResult............... 2395
Rfc2889BroadcastFrameLatencyPerFrameSizeResult........................... 2398
Rfc2889BroadcastFrameLatencyPerIterationResult............................... 2401
Rfc2889BroadcastFrameLatencyTestResult........................................... 2404
Rfc2889CongestionControlPerBurstSizeResult...................................... 2412
Rfc2889CongestionControlPerFrameSizeResult.................................... 2415
Rfc2889CongestionControlPerIterationResult......................................... 2418
Rfc2889CongestionControlPerLoadResult.............................................. 2421
Rfc2889CongestionControlPerPortResult............................................... 2424
Rfc2889CongestionControlTestResult..................................................... 2426
Rfc2889ErroredFramesFilteringPerErrorTypeResult............................... 2435
Rfc2889ErroredFramesFilteringPerIterationResult.................................. 2437
Rfc2889ErroredFramesFilteringPerLoadResult....................................... 2440
Rfc2889ErroredFramesFilteringTestResult.............................................. 2443
Rfc2889ForwardingPerBurstSizeResult.................................................. 2452
Rfc2889ForwardingPerFrameSizeResult................................................ 2455
Rfc2889ForwardingPerIterationResult..................................................... 2458
Rfc2889ForwardingPerLoadResult.......................................................... 2461
Rfc2889ForwardingTestResult................................................................. 2465
Rfc2889ForwardPressurePerFrameSizeResult....................................... 2471
Rfc2889ForwardPressurePerIterationResult........................................... 2474
Rfc2889ForwardPressureTestResult....................................................... 2478
Rfc2889MaxForwardingRatePerBurstSizeResult.................................... 2485
Rfc2889MaxForwardingRatePerFrameSizeResult.................................. 2489
Rfc2889MaxForwardingRatePerIterationResult...................................... 2492
Rfc2889MaxForwardingRatePerLoadResult........................................... 2495
Rfc2889MaxForwardingRateTestResult.................................................. 2498
Rfc3918AggregatedMulticastThroughputPerIterationResult................... 2523
Rfc3918JoinLeaveLatencyPerIterationResult.......................................... 2533
Rfc3918MixedClassThroughputPerIterationResult.................................. 2538
Rfc3918MulticastForwardingLatencyPerIterationResult.......................... 2546
Rfc3918MulticastGroupCapacityPerIterationResult................................ 2552
Rfc3918ScaledGroupForwardingPerIterationResult................................ 2557
RipRouterResults..................................................................................... 2598
RoutingResult.......................................................................................... 2621
RsvpLspResults....................................................................................... 2649
RsvpRouterResults.................................................................................. 2659
RsvpSubLspResults................................................................................. 2667
RxCpuPortResults................................................................................... 2674
RxPortPairResults.................................................................................... 2677
RxStreamBlockResults............................................................................ 2685
RxStreamResults..................................................................................... 2693
RxStreamSummaryResults..................................................................... 2701
RxTrafficGroupResults............................................................................. 2709
SaaDeviceResults.................................................................................... 2720
SaaPortResults........................................................................................ 2722
SaaSessionResults.................................................................................. 2724
SipPortResults......................................................................................... 2791
SipUaResults........................................................................................... 2800
SonetAlarmsResults................................................................................ 2805
SonetResults............................................................................................ 2818
StreamThresholdResults......................................................................... 2871
SyncEthDeviceResults............................................................................. 2881
SyncEthOption1Results........................................................................... 2882
SyncEthPortResults................................................................................. 2886
TimePropertiesResult.............................................................................. 2923
TrafficDescriptorResult............................................................................. 2942
TwampClientResults................................................................................ 2957
TwampPortTestSessionResults............................................................... 2958
TwampServerResults............................................................................... 2964
TwampTestSessionResults...................................................................... 2972
TxCpuPortResults.................................................................................... 2972
TxPortPairResults.................................................................................... 2976
TxStreamBlockResults............................................................................. 2977
TxStreamResults..................................................................................... 2978
TxTrafficGroupResults............................................................................. 2980
VicAdapterResults................................................................................... 3012
VideoClientResults................................................................................... 3022
VideoServerResults................................................................................. 3028
ViewControlPlaneMplsBindingResult....................................................... 3031
VifResults................................................................................................. 3036
VqAudioStreamResults............................................................................ 3158
VqVideoStreamResults............................................................................ 3167
19
PDU Objects Index
CCMTLVList............................................................................................... 275
cdb10......................................................................................................... 276
CDB10....................................................................................................... 276
cdb6........................................................................................................... 277
CDB6......................................................................................................... 277
chassisComponent.................................................................................... 287
chassisid.................................................................................................... 290
chassisid.................................................................................................... 290
ChassisIDList............................................................................................. 291
ChassisIdTlv.............................................................................................. 291
checksums................................................................................................. 291
CiscoDCE8021adSTag.............................................................................. 292
CiscoDCECiscoStag.................................................................................. 294
CiscoHDLC................................................................................................ 297
ciscostag.................................................................................................... 298
class1InterConnectPortParams................................................................. 299
classEnableVector..................................................................................... 311
classFSvcParams...................................................................................... 311
clientIdHW.................................................................................................. 312
clientIdnonHW............................................................................................ 312
CommonIdentificationData........................................................................ 321
commonSvcParams................................................................................... 322
Configuration.............................................................................................. 339
CongestionNotificationTlv.......................................................................... 340
Control....................................................................................................... 345
ControlFrame............................................................................................. 345
ControlFrameSize...................................................................................... 346
controls...................................................................................................... 346
ControlWord............................................................................................... 346
cred............................................................................................................ 370
csrc............................................................................................................ 372
CSRC......................................................................................................... 372
ctags.......................................................................................................... 377
CtrlChanCapTLV........................................................................................ 385
Custom (custom PDU library).................................................................... 387
customAddr................................................................................................ 388
customOption............................................................................................. 390
customPayload.......................................................................................... 391
customSubTlvType.................................................................................... 393
customTlv................................................................................................... 393
CustomTlv.................................................................................................. 393
CustomTlv.................................................................................................. 394
CustomTlv.................................................................................................. 395
CustomTLV................................................................................................ 395
CustomTlvType.......................................................................................... 396
cVlan.......................................................................................................... 396
cvlans......................................................................................................... 397
daId............................................................................................................ 397
DaId........................................................................................................... 397
Data........................................................................................................... 398
Data........................................................................................................... 398
DataFrame................................................................................................. 399
dataMin...................................................................................................... 399
DataTLV..................................................................................................... 401
dcbxCtlTlv.................................................................................................. 533
DcbxSubTlvt1............................................................................................. 538
DcbxSubTlvt2............................................................................................. 538
DcbxTlvt1................................................................................................... 539
DcbxTlvt2................................................................................................... 539
ddOptions................................................................................................... 540
ddSpecificOptions...................................................................................... 540
Dhcpclientmsg........................................................................................... 566
DHCPOption.............................................................................................. 567
Dhcpservermsg.......................................................................................... 567
DiaAcc........................................................................................................ 641
diaAccept................................................................................................... 641
DiaReq....................................................................................................... 642
diaRequest................................................................................................. 642
DL.............................................................................................................. 646
DL-Choice.................................................................................................. 647
DMM.......................................................................................................... 647
DMM.......................................................................................................... 648
DMR........................................................................................................... 648
DMR........................................................................................................... 649
downstreamInterfaceAddress.................................................................... 668
Protocol Data Unit Objects Index

Aal5.............................................................................................................. 45
AcceptedReply............................................................................................. 53
AccessAggregationCircuitIdAsciiTlv............................................................ 54
AccessAggregationCircuitIdBinaryAtmTlv................................................... 55
AccessAggregationCircuitIdBinaryVlanTlv.................................................. 57
AccessLoopCircuitIdTlv............................................................................... 61
AccessLoopEncapsulationTlv...................................................................... 62
AccessLoopRemoteIdTlv............................................................................. 63
acCookie...................................................................................................... 71
acName........................................................................................................ 72
acSystemError............................................................................................. 72
ActualInterleavingDelayDownstreamTlv...................................................... 75
ActualInterleavingDelayUpstreamTlv........................................................... 76
ActualNetDataRateDownstreamTlv............................................................. 78
ActualNetDataRateUpstreamTlv.................................................................. 79
AddrArrayTLV.............................................................................................. 81
AddrCustom................................................................................................. 81
Address........................................................................................................ 82
Address........................................................................................................ 82
addresses.................................................................................................... 82
Addresses.................................................................................................... 83
AddressType................................................................................................ 84
AddrEthMac................................................................................................. 85
addrExt......................................................................................................... 86
aggregationStatus........................................................................................ 89
app............................................................................................................. 132
ApplicationPriorityTlv................................................................................. 132
AppPriority................................................................................................. 134
AppStruct................................................................................................... 135
appTable.................................................................................................... 135
ARP............................................................................................................ 136
ATM............................................................................................................ 147
AttachedPortDescriptor.............................................................................. 153
AttachedPortEntry...................................................................................... 156
attachedRouters......................................................................................... 158
AttainableNetDataRateDownstreamTlv..................................................... 159
AttainableNetDataRateUpstreamTlv.......................................................... 160
authSelect.................................................................................................. 164
autoNegotiationAdvertisedCapability......................................................... 165
autoNegotiationSupportAndStatus............................................................ 166
bcnMode.................................................................................................... 172
bcnMode0.................................................................................................. 173
bcnMode1.................................................................................................. 173
bcnMode2.................................................................................................. 174
bcnMode3.................................................................................................. 174
bcnMode4.................................................................................................. 175
bcnMode5.................................................................................................. 175
bcnMode6.................................................................................................. 176
bcnMode7.................................................................................................. 177
bcnTlv........................................................................................................ 177
BFD............................................................................................................ 181
BFDCryptoAuth.......................................................................................... 183
BFDSimpleAuth......................................................................................... 195
bgpLabeledIpv4PrefixSubTlv..................................................................... 217
body........................................................................................................... 239
bTag........................................................................................................... 243
bVlanTag.................................................................................................... 244
bwg_percentage........................................................................................ 245
CallBody..................................................................................................... 245
CapabilityFlags.......................................................................................... 246
CCM........................................................................................................... 273
CCM........................................................................................................... 274
CCMTLVList............................................................................................... 275
20
PDU Objects Index
downstreamIpAddress............................................................................... 668
downstreamLabelList................................................................................. 669
DownstreamLabels.................................................................................... 669
downstreamMappingTlv............................................................................. 669
dpall........................................................................................................... 670
Dpall........................................................................................................... 671
dpl.............................................................................................................. 671
Dpl.............................................................................................................. 672
dplm........................................................................................................... 672
Dplm........................................................................................................... 673
dpln............................................................................................................ 673
Dpln............................................................................................................ 674
drPriority..................................................................................................... 674
dsFlag........................................................................................................ 674
DslLineAttributesCustomTlv....................................................................... 675
DslTypeTlv................................................................................................. 676
DslTypeTlv................................................................................................. 677
dtag............................................................................................................ 678
DvsNameTlv.............................................................................................. 679
DvsPortNameTlv........................................................................................ 679
DvsPortSetNameTlv.................................................................................. 679
DvsUuidTlv................................................................................................. 680
EfpAcc........................................................................................................ 683
efpAccept................................................................................................... 683
EfpDomainIdRecord................................................................................... 684
EfpMulticastIdRecord................................................................................. 685
EfpReq....................................................................................................... 686
efpRequest................................................................................................. 686
Egress_Port_ID.......................................................................................... 687
Egress_Port_ID_Length............................................................................. 687
Egress_Port_ID_Subtype.......................................................................... 688
elp.............................................................................................................. 689
elpAccept................................................................................................... 690
elpRequest................................................................................................. 692
elpRequestAccept...................................................................................... 692
elprjt........................................................................................................... 693
ELSFLOGI................................................................................................. 694
ELSFLOGILSACC..................................................................................... 694
ELSLOGO.................................................................................................. 695
ELSLOGOLSACC...................................................................................... 695
ELSLSRJT................................................................................................. 695
ELSPLOGI................................................................................................. 696
ELSReserved............................................................................................. 696
ELSSvcAvailabilityAndLoginExtDataLength.............................................. 697
enabledCapabilities.................................................................................... 701
EncapEthernet8022................................................................................... 702
EncapEthernet8023Raw............................................................................ 702
EncapEthernetII......................................................................................... 703
EncapEthernetSnap................................................................................... 704
EncapMAC-in-MAC.................................................................................... 705
endOfList.................................................................................................... 706
endOfOptions............................................................................................. 706
endOfOptlist............................................................................................... 706
EndTlv........................................................................................................ 708
EndTLV...................................................................................................... 708
EntropyLabel.............................................................................................. 711
erroredTlv................................................................................................... 779
errorestimate.............................................................................................. 780
EscAcc....................................................................................................... 780
escAccept.................................................................................................. 781
EscReq...................................................................................................... 782
escRequest................................................................................................ 783
Ethernet8022 (ethernet PDU library)......................................................... 808
Ethernet8022 (mimethernet PDU library).................................................. 808
Ethernet8023Raw (ethernet PDU library).................................................. 809
Ethernet8023Raw (mimethernet PDU library)........................................... 809
EthernetCapTLV........................................................................................ 810
EthernetII (ethernet PDU library)............................................................... 822
EthernetII (mimethernet PDU library)........................................................ 823
EthernetPause........................................................................................... 824
EthernetSnap (ethernet PDU library)......................................................... 824
EthernetSnap (mimethernet PDU library).................................................. 825
EthernetSSM.............................................................................................. 825
ETSConfigurationTlv.................................................................................. 830
ETSRecommendationTlv........................................................................... 831
EventNoteOAMPDU.................................................................................. 832
EventOAMPDUTLVList.............................................................................. 832
EventTLV................................................................................................... 833
extendedControl......................................................................................... 840
extendedHeader........................................................................................ 840
ExtendHeaderSize..................................................................................... 841
externalAdditionalMetrics........................................................................... 841
externalLsaOptions.................................................................................... 883
EXTHDR.................................................................................................... 884
extSecurity................................................................................................. 884
fabricLogoAccept....................................................................................... 885
fabricLogoReject........................................................................................ 885
fabricLogoRequest..................................................................................... 886
fabricName................................................................................................. 886
FairnessFrame........................................................................................... 887
FairnessHeader......................................................................................... 887
FC.............................................................................................................. 891
FC.............................................................................................................. 892
fcMap......................................................................................................... 909
FCoE.......................................................................................................... 911
FcoeCapTLV.............................................................................................. 913
FCoEHeader.............................................................................................. 916
FCPayload-Choice..................................................................................... 944
fcPayloads................................................................................................. 944
fcpCdb........................................................................................................ 945
fcpCmnd..................................................................................................... 945
FcpCmnd................................................................................................... 946
FcpCmndDl................................................................................................ 946
FcSofEof.................................................................................................... 956
fdisc............................................................................................................ 959
fdiscAcc...................................................................................................... 960
fdiscAccept................................................................................................. 960
fdiscReject................................................................................................. 961
fdiscRequest.............................................................................................. 962
fdiscRjt....................................................................................................... 962
fec128PseudowireSubTlv.......................................................................... 964
FIP............................................................................................................. 975
Fixed.......................................................................................................... 976
FixedSubTlvList......................................................................................... 980
fkaAdvPeriod.............................................................................................. 981
FLAGS....................................................................................................... 982
flogi............................................................................................................ 985
flogiAcc...................................................................................................... 986
flogiRjt........................................................................................................ 990
fpng............................................................................................................ 992
Fpng........................................................................................................... 993
fpngAccept................................................................................................. 993
FpngAccept................................................................................................ 994
fs................................................................................................................ 998
ftr.............................................................................................................. 1012
Ftr............................................................................................................. 1013
ftrAccept................................................................................................... 1014
FtrAccept.................................................................................................. 1014
FxPortClkSyncQos................................................................................... 1015
gaNxtAccept............................................................................................. 1016
GaNxtAccept............................................................................................ 1017
gapnlAccept............................................................................................. 1019
GapnlAccept............................................................................................ 1019
gatin......................................................................................................... 1019
Gatin........................................................................................................ 1020
gatinAccept.............................................................................................. 1020
GatinAccept............................................................................................. 1020
gcsIdAccept............................................................................................. 1021
GcsIdAccept............................................................................................. 1021
gdidAccept............................................................................................... 1021
GdidAccept.............................................................................................. 1022
generationID............................................................................................ 1029
genericError............................................................................................. 1040
genericIpv4PrefixSubTlv.......................................................................... 1041
gffIdAccept............................................................................................... 1061
GffIdAccept.............................................................................................. 1061
gfnAccept................................................................................................. 1062
GfnAccept................................................................................................ 1062
gfpnIdAccept............................................................................................ 1062
GfpnIdAccept........................................................................................... 1063
gftIdAccept............................................................................................... 1063
GftIdAccept.............................................................................................. 1063
gidFtAccept.............................................................................................. 1064
21
PDU Objects Index
GidFtAccept............................................................................................. 1064
gidNnAccept............................................................................................. 1064
GidNnAccept............................................................................................ 1064
gidPnAccept............................................................................................. 1065
GidPnAccept............................................................................................ 1065
gidPtAccept.............................................................................................. 1066
GidPtAccept............................................................................................. 1066
gieilAccept................................................................................................ 1066
GieilAccept............................................................................................... 1067
giel........................................................................................................... 1067
Giel........................................................................................................... 1068
gielAccept................................................................................................ 1068
GielAccept................................................................................................ 1068
gielnAccept.............................................................................................. 1069
GielnAccept.............................................................................................. 1069
gietAccept................................................................................................ 1070
GietAccept............................................................................................... 1070
globalFlags............................................................................................... 1071
gmalAccept.............................................................................................. 1071
GmalAccept............................................................................................. 1072
gmidAccept.............................................................................................. 1072
GmidAccept............................................................................................. 1073
gnid.......................................................................................................... 1073
Gnid......................................................................................................... 1073
gnidAccept............................................................................................... 1074
GnidAccept.............................................................................................. 1074
gnnFtAccept............................................................................................. 1075
GnnFtAccept............................................................................................ 1075
gnnIdAccept............................................................................................. 1076
GnnIdAccept............................................................................................ 1076
gnpl.......................................................................................................... 1076
Gnpl......................................................................................................... 1077
gnplAccept............................................................................................... 1077
GnplAccept.............................................................................................. 1077
gpabAccept.............................................................................................. 1078
GpabAccept............................................................................................. 1078
gpfcpAccept............................................................................................. 1079
GpfcpAccept............................................................................................ 1079
gplAccept................................................................................................. 1079
GplAccept................................................................................................ 1080
gpliAccept................................................................................................ 1080
GpliAccept................................................................................................ 1080
gplmlAccept............................................................................................. 1081
GplmlAccept............................................................................................. 1081
gplnlAccept.............................................................................................. 1082
GplnlAccept.............................................................................................. 1082
gpltAccept................................................................................................ 1082
GpltAccept............................................................................................... 1083
gpnFtAccept............................................................................................. 1083
GpnFtAccept............................................................................................ 1083
gpnIdAccept............................................................................................. 1084
GpnIdAccept............................................................................................ 1084
gpnl.......................................................................................................... 1084
Gpnl......................................................................................................... 1085
gpnlAccept............................................................................................... 1085
GpnlAccept.............................................................................................. 1085
gppnAccept.............................................................................................. 1086
GppnAccept............................................................................................. 1086
gpsAccept................................................................................................ 1086
GpsAccept............................................................................................... 1087
gpscAccept.............................................................................................. 1088
GpscAccept.............................................................................................. 1088
gptAccept................................................................................................. 1089
GptAccept................................................................................................ 1089
gptIdAccept.............................................................................................. 1090
GptIdAccept............................................................................................. 1091
Gre........................................................................................................... 1091
GreChecksum.......................................................................................... 1093
GreKey..................................................................................................... 1098
GreSeqNum............................................................................................. 1098
GroupRecord........................................................................................... 1103
gsAccept.................................................................................................. 1106
GsAccept................................................................................................. 1107
gsDeregisterWithPlatformName.............................................................. 1107
GsDeregisterWithPlatformName............................................................. 1107
gsesAccept.............................................................................................. 1108
GsesAccept.............................................................................................. 1108
gsnnNnAccept.......................................................................................... 1109
GsnnNnAccept......................................................................................... 1109
gspnIdAccept........................................................................................... 1110
GspnIdAccept.......................................................................................... 1110
gsReject................................................................................................... 1110
GsReject.................................................................................................. 1111
gsRequestWithFc4Type........................................................................... 1111
GsRequestWithFc4Type.......................................................................... 1112
gsRequestWithInterconnectElementName.............................................. 1112
GsRequestWithInterconnectElementName............................................. 1112
gsRequestWithNodeName...................................................................... 1113
GsRequestWithNodeName..................................................................... 1113
gsRequestWithPlatformName................................................................. 1113
GsRequestWithPlatformName................................................................. 1114
gsRequestWithPortIdentifier.................................................................... 1114
GsRequestWithPortIdentifier................................................................... 1115
gsRequestWithPortName........................................................................ 1115
GsRequestWithPortName........................................................................ 1116
gsRequestWithPortType.......................................................................... 1116
GsRequestWithPortType......................................................................... 1117
gtin........................................................................................................... 1117
Gtin.......................................................................................................... 1118
gtinAccept................................................................................................ 1118
GtinAccept............................................................................................... 1119
GTPv1...................................................................................................... 1119
GTPv1Ext................................................................................................. 1121
hdrAuthSelectCrypto................................................................................ 1126
hdrAuthSelectNone.................................................................................. 1126
hdrAuthSelectPassword........................................................................... 1127
hdrAuthSelectUserDef............................................................................. 1127
helloOptions............................................................................................. 1146
HloReq..................................................................................................... 1156
hloRequest............................................................................................... 1157
holdTime.................................................................................................. 1157
hostName................................................................................................. 1161
hostUniq................................................................................................... 1161
HostUuidTlv............................................................................................. 1162
IcmpDestUnreach.................................................................................... 1174
IcmpEchoReply........................................................................................ 1175
IcmpEchoRequest.................................................................................... 1176
IcmpInfoReply.......................................................................................... 1177
IcmpInfoRequest...................................................................................... 1178
IcmpParameterProblem........................................................................... 1179
IcmpRedirect............................................................................................ 1180
IcmpSourceQuench................................................................................. 1181
IcmpTimeExceeded................................................................................. 1182
IcmpTimestampReply.............................................................................. 1182
IcmpTimestampRequest.......................................................................... 1183
Icmpv6DestUnreach................................................................................ 1184
Icmpv6EchoReply.................................................................................... 1185
Icmpv6EchoRequest................................................................................ 1186
Icmpv6PacketTooBig............................................................................... 1187
Icmpv6ParameterProblem....................................................................... 1188
Icmpv6TimeExceeded............................................................................. 1189
IdleFrame................................................................................................. 1190
Igmpv1..................................................................................................... 1219
Igmpv2..................................................................................................... 1220
Igmpv2Query........................................................................................... 1221
Igmpv2Report.......................................................................................... 1221
Igmpv3Query........................................................................................... 1222
Igmpv3Report.......................................................................................... 1222
IncarnationNumTlv................................................................................... 1223
Info........................................................................................................... 1223
InfoOAMPDU........................................................................................... 1224
InfoOAMPDUTLVList............................................................................... 1224
Ingress_Port_ID....................................................................................... 1224
Ingress_Port_ID_Length.......................................................................... 1225
Ingress_Port_ID_Subtype........................................................................ 1225
InterConnectElementDomainId................................................................ 1229
InterconnectElementEntry....................................................................... 1231
interface................................................................................................... 1241
interfaceAlias........................................................................................... 1242
interfaceAlias........................................................................................... 1242
interfaceAndLabelStackTlv...................................................................... 1243
interfaceName.......................................................................................... 1244
interfaceName.......................................................................................... 1244
IntStat....................................................................................................... 1247
IP.............................................................................................................. 1248
ipAddress................................................................................................. 1249
22
PDU Objects Index
IPv4.......................................................................................................... 1289
ipv4Addr................................................................................................... 1294
Ipv4Addr (igmp PDU library).................................................................... 1295
Ipv4Addr (ipv4 PDU library)..................................................................... 1296
Ipv4Addr (pim PDU library)...................................................................... 1296
IPv4HeaderOption................................................................................... 1300
Ipv4OptionMtuReply................................................................................ 1308
IPv6.......................................................................................................... 1313
ipv6Addr................................................................................................... 1318
Ipv6Addr (icmpv6 PDU library)................................................................ 1318
Ipv6AuthenticationHeader....................................................................... 1320
Ipv6DestinationHeader............................................................................ 1324
Ipv6DestinationOption.............................................................................. 1329
Ipv6EncapsulationHeader........................................................................ 1330
Ipv6FragmentHeader............................................................................... 1335
Ipv6HopByHopHeader............................................................................. 1341
Ipv6HopByHopOption.............................................................................. 1345
IPv6LL...................................................................................................... 1352
Ipv6RoutingHeader.................................................................................. 1356
islFlowControl.......................................................................................... 1402
iTag.......................................................................................................... 1402
JoinPrunev4GroupRecord....................................................................... 1417
jumbo....................................................................................................... 1418
jumboMax................................................................................................ 1418
keys.......................................................................................................... 1419
L2TPv2..................................................................................................... 1437
l2VpnEndpointSubTlv.............................................................................. 1458
LACP........................................................................................................ 1462
lanPruneDelay......................................................................................... 1471
LBM.......................................................................................................... 1474
LBM.......................................................................................................... 1475
LBMTLVList.............................................................................................. 1475
LBMTLVList.............................................................................................. 1475
LBR.......................................................................................................... 1476
LBR.......................................................................................................... 1476
LBRTLVList.............................................................................................. 1477
ldpIpv4PrefixSubTlv................................................................................. 1480
LE............................................................................................................. 1504
leaseTime................................................................................................ 1505
Length...................................................................................................... 1505
lengths..................................................................................................... 1505
LI.............................................................................................................. 1506
LinkAggregationTlv.................................................................................. 1510
LinkDescriptor.......................................................................................... 1512
LinkDescriptor.......................................................................................... 1512
LinkLayerAddress.................................................................................... 1514
linkLayerOption........................................................................................ 1514
LinkStateHeader...................................................................................... 1543
LinkStateRecord...................................................................................... 1545
llc.............................................................................................................. 1547
LlcBridgedEth8023................................................................................... 1548
llcheader.................................................................................................. 1548
LlcRoutedNlpid......................................................................................... 1549
LlcRoutedSnap........................................................................................ 1550
LlcSnapIana............................................................................................. 1550
LMM......................................................................................................... 1560
LMM......................................................................................................... 1561
LMR......................................................................................................... 1561
LMR......................................................................................................... 1562
locallyAssigned........................................................................................ 1565
logicLinkDownTlv..................................................................................... 1568
logo.......................................................................................................... 1568
logoAcc.................................................................................................... 1569
logoAccept............................................................................................... 1569
logoReject................................................................................................ 1570
logoRequest............................................................................................. 1570
logoRjt...................................................................................................... 1571
LoopbackControlOAMPDU...................................................................... 1571
looseSrcRoute......................................................................................... 1572
lsaHdrOptions.......................................................................................... 1573
lsaHeaders............................................................................................... 1574
LsaReq..................................................................................................... 1574
lsaRequest............................................................................................... 1574
LspPing.................................................................................................... 1575
LspPingTlvs............................................................................................. 1581
LsuReq..................................................................................................... 1585
lsuRequest............................................................................................... 1585
LTM.......................................................................................................... 1586
LTM.......................................................................................................... 1586
LTMEgrID................................................................................................. 1588
LTMTLVList.............................................................................................. 1589
LTMTLVList.............................................................................................. 1589
LTR.......................................................................................................... 1589
LTR.......................................................................................................... 1590
LTREgrID................................................................................................. 1592
LTRTLVList............................................................................................... 1593
LTRTLVList............................................................................................... 1593
macAddr................................................................................................... 1594
macAddress............................................................................................. 1594
macAddress............................................................................................. 1595
MacControl............................................................................................... 1596
MAC-in-MAC............................................................................................ 1597
MacPhyConfigStatusTlv........................................................................... 1598
MACPreamble.......................................................................................... 1600
MADCustom............................................................................................. 1601
MADList................................................................................................... 1601
MADsI802................................................................................................ 1602
MADtDL................................................................................................... 1602
MADtDS4................................................................................................. 1602
MADtDS4z............................................................................................... 1603
MADtDS6................................................................................................. 1603
MADtDS6z............................................................................................... 1604
MADtDT4................................................................................................. 1604
MADtDT4z............................................................................................... 1605
MADtDT6................................................................................................. 1605
MADtDT6z............................................................................................... 1606
MADtDU................................................................................................... 1606
MADtDU4................................................................................................. 1607
MADtDU4z............................................................................................... 1607
MADtDU6................................................................................................. 1607
MADtDU6z............................................................................................... 1608
MADtSU................................................................................................... 1608
MADtTU................................................................................................... 1609
MaintenanceDomainName...................................................................... 1611
managementAddr.................................................................................... 1617
ManagementAddressEntry...................................................................... 1618
ManagementAddrTlv................................................................................ 1619
Marker...................................................................................................... 1625
MaxFrameSizeTlv.................................................................................... 1626
MaximumInterleavingDelayDownstreamTlv............................................ 1627
MaximumInterleavingDelayUpstreamTlv................................................. 1628
MaximumNetDataRateDownstreamTlv................................................... 1630
MaximumNetDataRateUpstreamTlv........................................................ 1631
maxRcvSize............................................................................................. 1632
mdiPowerSupport.................................................................................... 1634
MDN_Length............................................................................................ 1635
MDN_Length............................................................................................ 1635
mergeRequest......................................................................................... 1636
mergeRequestAcc................................................................................... 1636
message.................................................................................................. 1636
messageSize........................................................................................... 1637
messageType........................................................................................... 1637
MinimumNetDataRateDownstreamTlv.................................................... 1639
MinimumNetDataRateUpstreamTlv......................................................... 1641
MinimumNetLowPowerDataRateDownstreamTlv.................................... 1642
MinimumNetLowPowerDataRateUpstreamTlv........................................ 1643
MismatchInfo............................................................................................ 1645
MLDv1...................................................................................................... 1660
MLDv2GroupRecord................................................................................ 1660
MLDv2Query............................................................................................ 1661
MLDv2Report........................................................................................... 1662
23
PDU Objects Index
modeSense10.......................................................................................... 1663
ModeSense10.......................................................................................... 1664
modeSense6............................................................................................ 1665
ModeSense6............................................................................................ 1665
Mpls......................................................................................................... 1667
MReq....................................................................................................... 1692
MReqAcc................................................................................................. 1693
MRPayloadChoice................................................................................... 1693
Msg.......................................................................................................... 1694
Msgs........................................................................................................ 1694
MsgTypeArrayTLV................................................................................... 1695
MTU......................................................................................................... 1700
mtuOption................................................................................................ 1701
mtuProbe................................................................................................. 1701
nameId..................................................................................................... 1727
NeighborAdvertisement........................................................................... 1727
neighbors................................................................................................. 1728
NeighborSolicitation................................................................................. 1728
networkAddress4..................................................................................... 1729
networkAddress4..................................................................................... 1730
networkAddress6..................................................................................... 1731
networkAddress6..................................................................................... 1731
nilFecSubTlv............................................................................................ 1735
NivSupportTlv.......................................................................................... 1735
nivTlv........................................................................................................ 1736
NodeName............................................................................................... 1737
NodeName............................................................................................... 1738
nodes....................................................................................................... 1739
nop........................................................................................................... 1740
npivFdiscAccept....................................................................................... 1740
npivFdiscReject........................................................................................ 1741
npivFdiscRequest.................................................................................... 1741
NPortClkSyncQos.................................................................................... 1742
Nr............................................................................................................. 1742
nrList........................................................................................................ 1742
Ns............................................................................................................. 1743
nsList........................................................................................................ 1743
OAMBH.................................................................................................... 1743
OAMPDUConfiguration............................................................................ 1744
offset........................................................................................................ 1744
OffsetPadding.......................................................................................... 1745
OffsetSize................................................................................................ 1745
optionOverload......................................................................................... 1745
OrganizationallySpecificTlv...................................................................... 1749
OrgSpec................................................................................................... 1749
OrgSpecOAMPDU................................................................................... 1750
OS............................................................................................................ 1751
OsLunMapEntry....................................................................................... 1753
OsLunMapEntry....................................................................................... 1754
ospfv2AsExternalLsa............................................................................... 1761
Ospfv2DatabaseDescription.................................................................... 1762
Ospfv2ExternalLsaTosMetric................................................................... 1764
Ospfv2Hello............................................................................................. 1767
Ospfv2LinkStateAcknowledge................................................................. 1767
Ospfv2LinkStateRequest......................................................................... 1767
Ospfv2LinkStateUpdate........................................................................... 1768
Ospfv2Lsa................................................................................................ 1768
Ospfv2Neighbor....................................................................................... 1771
ospfv2NetworkLsa................................................................................... 1771
Ospfv2RequestedLsa.............................................................................. 1774
ospfv2RouterLsa...................................................................................... 1781
Ospfv2RouterLsaLink.............................................................................. 1782
Ospfv2RouterLsaTosMetric..................................................................... 1783
ospfv2SummaryAsbrLsa.......................................................................... 1788
ospfv2SummaryLsa................................................................................. 1789
Ospfv2SummaryLsaTosMetric................................................................. 1789
Ospfv2Unknown....................................................................................... 1792
outerdamac.............................................................................................. 1832
outersamac.............................................................................................. 1833
pad1......................................................................................................... 1837
PadData................................................................................................... 1837
padding (l2tpv2 PDU library).................................................................... 1838
Padding (EOAM PDU library).................................................................. 1838
Padding.................................................................................................... 1838
padN........................................................................................................ 1839
padTlv...................................................................................................... 1839
paramReqList........................................................................................... 1840
Password................................................................................................. 1842
PauseMacControl.................................................................................... 1844
PbbTeMip................................................................................................. 1845
PbbTeMipTLV........................................................................................... 1846
PFC.......................................................................................................... 1847
pgAllocation............................................................................................. 1854
pidAgentCircuitID..................................................................................... 1872
pidCustom................................................................................................ 1873
pidCustom................................................................................................ 1873
pidInterfaceAlias...................................................................................... 1874
pidInterfaceName..................................................................................... 1875
pidLocallyAssigned.................................................................................. 1876
pidMacAddress........................................................................................ 1877
pidMacAddress........................................................................................ 1878
pidNetworkAddress4................................................................................ 1879
pidPortComponent................................................................................... 1881
Pimv4Assert............................................................................................. 1898
Pimv4Hello............................................................................................... 1899
Pimv4HelloOption.................................................................................... 1899
Pimv4JoinPrune....................................................................................... 1900
Pimv4NullRegister................................................................................... 1902
Pimv4Register.......................................................................................... 1903
Pimv4RegisterStop.................................................................................. 1904
Pimv6Assert............................................................................................. 1905
Pimv6Hello............................................................................................... 1906
Pimv6JoinPrune....................................................................................... 1907
Pimv6Register.......................................................................................... 1910
PlatformAttributeEntry.............................................................................. 1916
PlatformNameEntry.................................................................................. 1918
PlatformNodeNameEntry......................................................................... 1920
plogiAccept.............................................................................................. 1921
plogiReject............................................................................................... 1921
plogiRequest............................................................................................ 1922
PortAndProtocolVlanIdTlv........................................................................ 1925
portComponent........................................................................................ 1926
portComponent........................................................................................ 1927
PortDescriptionTlv.................................................................................... 1928
PortEntry.................................................................................................. 1929
PortEntry.................................................................................................. 1930
portid........................................................................................................ 1932
PortIdentifier............................................................................................. 1932
PortIdentifier............................................................................................. 1933
PortIDList................................................................................................. 1934
PortIdTlv................................................................................................... 1935
PortIndexTlv............................................................................................. 1935
PortName................................................................................................. 1936
PortName................................................................................................. 1937
PortVlanIdTlv........................................................................................... 1941
POS......................................................................................................... 1941
PowerViaMdiTlv....................................................................................... 1946
PPP.......................................................................................................... 1946
PPPoEDiscovery...................................................................................... 1989
PPPoESession......................................................................................... 2016
PPPoETag................................................................................................ 2021
PrefixInformation...................................................................................... 2065
prefixOption.............................................................................................. 2065
prioAllocation........................................................................................... 2068
priority...................................................................................................... 2069
priority0Allocation..................................................................................... 2069
24
PDU Objects Index
priorityAssign........................................................................................... 2073
PriorityBasedFlowControlTlv................................................................... 2074
ProtocolDescriptor................................................................................... 2081
ProtocolIdentityTlv................................................................................... 2083
ProvisioningInfoTLV................................................................................. 2085
ProvList.................................................................................................... 2085
PrtStat...................................................................................................... 2085
QlTlv......................................................................................................... 2089
RARP....................................................................................................... 2094
rch............................................................................................................ 2105
rcsId......................................................................................................... 2106
RcsId........................................................................................................ 2106
Rdi............................................................................................................ 2107
rdiAccept.................................................................................................. 2107
RdiDomainId............................................................................................ 2108
RdiDomainId............................................................................................ 2108
rdiRequest................................................................................................ 2108
read10...................................................................................................... 2109
Read10.................................................................................................... 2110
read6........................................................................................................ 2111
Read6...................................................................................................... 2111
readBuffer................................................................................................ 2112
ReadBuffer............................................................................................... 2112
readCapacity10........................................................................................ 2113
ReadCapacity10...................................................................................... 2114
readLong10.............................................................................................. 2114
ReadLong10............................................................................................ 2115
recordRoute............................................................................................. 2119
Redirect.................................................................................................... 2119
redirectedHdrOption................................................................................. 2120
RedirectedHeader.................................................................................... 2121
regMax..................................................................................................... 2122
RejectedReply.......................................................................................... 2122
RejectedReplyAuthStat............................................................................ 2123
relaySessionId......................................................................................... 2123
ReplyBody................................................................................................ 2125
replyTOSByteTlv...................................................................................... 2129
reportLUNs............................................................................................... 2129
ReportLUNs............................................................................................. 2130
reqAddr.................................................................................................... 2130
requestedLsas......................................................................................... 2131
ReservedData.......................................................................................... 2131
ResourceLimitCapTLV............................................................................. 2133
rffId........................................................................................................... 2584
RffId......................................................................................................... 2584
rftId........................................................................................................... 2585
RftId......................................................................................................... 2585
RI............................................................................................................. 2585
rieln.......................................................................................................... 2586
Rieln......................................................................................................... 2586
rip1Entries................................................................................................ 2588
Rip1Entry................................................................................................. 2588
rip2Entries................................................................................................ 2588
Rip2Entry................................................................................................. 2589
Ripng........................................................................................................ 2591
ripngEntries.............................................................................................. 2591
RipngEntry............................................................................................... 2592
Ripv1........................................................................................................ 2600
Ripv2........................................................................................................ 2600
rnnId......................................................................................................... 2604
RnnId....................................................................................................... 2605
RouterAdvertisement............................................................................... 2609
routerAlert................................................................................................ 2610
routerLsaLinks......................................................................................... 2616
routerLsaOptions..................................................................................... 2616
routerLsaTosMetrics................................................................................. 2617
RouterSolicitation..................................................................................... 2617
rpab.......................................................................................................... 2622
Rpab........................................................................................................ 2622
RpcMsg.................................................................................................... 2623
rpfcp......................................................................................................... 2624
Rpfcp........................................................................................................ 2624
rpl............................................................................................................. 2625
Rpl............................................................................................................ 2626
rpli............................................................................................................ 2626
Rpli........................................................................................................... 2626
rplm.......................................................................................................... 2627
Rplm......................................................................................................... 2627
rpln........................................................................................................... 2628
Rpln.......................................................................................................... 2629
rplt............................................................................................................ 2629
Rplt........................................................................................................... 2630
RplyEgr.................................................................................................... 2630
RplyIng..................................................................................................... 2631
rpnId......................................................................................................... 2631
RpnId....................................................................................................... 2632
rptId.......................................................................................................... 2632
RptId........................................................................................................ 2633
rrdy........................................................................................................... 2634
rsnnNn..................................................................................................... 2634
RsnnNn.................................................................................................... 2635
rspnId....................................................................................................... 2635
RspnId...................................................................................................... 2636
rspvIpv6LspSubTlv.................................................................................. 2636
rsvpIpv4LspSubTlv.................................................................................. 2648
RtpHeader................................................................................................ 2670
rtrAlert...................................................................................................... 2671
security..................................................................................................... 2737
selBrdcast................................................................................................ 2737
seqNums.................................................................................................. 2741
serverId.................................................................................................... 2774
serviceName............................................................................................ 2777
serviceNameError.................................................................................... 2778
simplePassword....................................................................................... 2785
snap......................................................................................................... 2802
snapheader.............................................................................................. 2803
SndrID...................................................................................................... 2804
SpecificIdentificationData......................................................................... 2829
sTag......................................................................................................... 2830
stag8021ad.............................................................................................. 2831
stags........................................................................................................ 2831
startStopUnit............................................................................................ 2833
StartStopUnit............................................................................................ 2833
State......................................................................................................... 2834
streamId................................................................................................... 2870
strictSrcRoute.......................................................................................... 2873
summaryAdditionalMetrics....................................................................... 2876
svlans....................................................................................................... 2879
systemCapabilities................................................................................... 2887
SystemCapabilitiesTlv.............................................................................. 2888
SystemDescriptionTlv.............................................................................. 2889
SystemNameTlv....................................................................................... 2889
TagList...................................................................................................... 2891
tags.......................................................................................................... 2891
targetFecSubTlvs..................................................................................... 2891
TargetFecSubTlvs.................................................................................... 2891
targetFecTlv............................................................................................. 2892
tcgBandwidth........................................................................................... 2892
Tcp........................................................................................................... 2893
Test.......................................................................................................... 2900
TestPattern............................................................................................... 2900
TestTLV.................................................................................................... 2902
TestTLV.................................................................................................... 2902
theEPIDL.................................................................................................. 2906
theEPIDLS............................................................................................... 2906
theIPIDL................................................................................................... 2908
theIPIDLS................................................................................................. 2908
theLBRTLVs............................................................................................. 2909
theManagementAddressDomain............................................................. 2911
thepadData.............................................................................................. 2914
theReservedDataSelect........................................................................... 2914
theTags.................................................................................................... 2915
timestamp................................................................................................ 2925
TimeToLiveTlv.......................................................................................... 2926
TLV........................................................................................................... 2927
tlvs............................................................................................................ 2928
tracert....................................................................................................... 2934
TrafficClassesSupportedTlv..................................................................... 2935
TwampAcceptSession.............................................................................. 2955
TwampReflectorPackets.......................................................................... 2959
TwampRequestSession........................................................................... 2960
TwampSenderPackets............................................................................. 2962
TwampServerGreeting............................................................................. 2963
TwampServerStart................................................................................... 2965
TwampSetupResponse............................................................................ 2965
TwampStartSession................................................................................. 2966
25
PDU Objects Index
TwampStartSessionAcknowledge........................................................... 2967
TwampStopSession................................................................................. 2969
txerrorestimate......................................................................................... 2975
Udp.......................................................................................................... 2981
updatedLsas............................................................................................ 2986
Value........................................................................................................ 2993
Value........................................................................................................ 2994
VarDescTLV............................................................................................. 2994
VariableContainer.................................................................................... 2995
VariableDescriptor.................................................................................... 2995
VariableRequestOAMPDU....................................................................... 2995
VariableResponseOAMPDU.................................................................... 2996
VarRepoTLV............................................................................................. 2996
VcMuxBridgedEth8023............................................................................ 3001
vendorEnterpriseNumberTlv.................................................................... 3002
vendorSpecific......................................................................................... 3005
verf........................................................................................................... 3005
verify10.................................................................................................... 3006
Verify10.................................................................................................... 3007
VFT.......................................................................................................... 3010
VifIdTLV.................................................................................................... 3036
VifStateTLV.............................................................................................. 3037
VirtualMachineMacTlv.............................................................................. 3039
VirtualMachineNameTlv........................................................................... 3039
VirtualMachineUuidTlv............................................................................. 3040
Vlan (ethernet PDU library)...................................................................... 3040
vlanDescriptor.......................................................................................... 3042
VlanNameTlv........................................................................................... 3045
vlans......................................................................................................... 3046
VmWare................................................................................................... 3047
VmWareSubTlvList.................................................................................. 3048
vNicUuidTlv.............................................................................................. 3048
VNTag...................................................................................................... 3048
vntags...................................................................................................... 3049
vpnIpv4PrefixSubTlv................................................................................ 3087
vxPortId.................................................................................................... 3180
write10..................................................................................................... 3194
Write10..................................................................................................... 3194
write6....................................................................................................... 3195
Write6....................................................................................................... 3196
writeAndVerify10...................................................................................... 3196
WriteAndVerify10..................................................................................... 3197
writeBuffer................................................................................................ 3198
WriteBuffer............................................................................................... 3199
writeLong10............................................................................................. 3199
WriteLong10............................................................................................. 3200
xdRead10................................................................................................. 3201
XDRead10............................................................................................... 3202
xdWrite10................................................................................................. 3202
XDWrite10................................................................................................ 3203
xpWrite10................................................................................................. 3204
XPWrite10................................................................................................ 3205
ZoningEnforcementStatusObject............................................................. 3206
26
All Objects Index
AncpPortConfig.......................................................................................... 121
AncpPortResults........................................................................................ 124
AncpTlvConfig............................................................................................ 130
AncpWildcardModifier................................................................................ 131
app............................................................................................................. 132
ApplicationPriorityTlv................................................................................. 132
applicatonTlv.............................................................................................. 133
ApplyToILCommand................................................................................... 134
AppPriority................................................................................................. 134
AppStruct................................................................................................... 135
appTable.................................................................................................... 135
ARP............................................................................................................ 136
ArpCache................................................................................................... 137
ArpNdConfig.............................................................................................. 137
ArpNdReport.............................................................................................. 139
ArpNdResults............................................................................................. 140
ArpNdUpdateArpCacheCommand............................................................ 145
AsbrSummaryLsa...................................................................................... 146
ATM............................................................................................................ 147
AtmIdleCell................................................................................................. 148
AtmPhy...................................................................................................... 149
attachedPortDescriptors............................................................................ 154
attachedPortEntries................................................................................... 155
attachedRouters......................................................................................... 158
AttachPortsCommand................................................................................ 158
auth............................................................................................................ 162
AuthenticationParams................................................................................ 163
authSelect.................................................................................................. 164
AutomationOptions.................................................................................... 164
autoNegotiationAdvertisedCapability......................................................... 165
autoNegotiationSupportAndStatus............................................................ 166
BaseBridgePortResults.............................................................................. 166
baseControl................................................................................................ 168
basicZoning................................................................................................ 171
bcnMode.................................................................................................... 172
bcnMode0.................................................................................................. 173
bcnMode1.................................................................................................. 173
bcnMode2.................................................................................................. 174
bcnMode3.................................................................................................. 174
bcnMode4.................................................................................................. 175
bcnMode5.................................................................................................. 175
bcnMode6.................................................................................................. 176
bcnMode7.................................................................................................. 177
bcnTlv........................................................................................................ 177
BenchmarkEthernet10GigPortConfig........................................................ 178
BenchmarkTrafficGroupPerIterationResult................................................ 179
BFD............................................................................................................ 181
BfdAuthenticationParams.......................................................................... 183
BFDCryptoAuth.......................................................................................... 183
BfdDeviceGenProtocolParams.................................................................. 183
All Objects Index

Aal5.............................................................................................................. 45
Aal5If............................................................................................................ 45
AbstPppoeDeviceGenProtocolParams........................................................ 49
AcceptedReply............................................................................................. 53
AccessConcentratorGenConfigExpandCommand...................................... 58
AccessConcentratorGenParams................................................................. 59
AccessConcentratorGenUpdateTrafficCommand........................................ 60
AccessLoopEncapsulationTlv...................................................................... 62
AccessLoopRemoteIdTlv............................................................................. 63
AccessStabilityGenParams.......................................................................... 64
AccessTestGenConfigExpandCommand..................................................... 68
AccessTestGenPortParams......................................................................... 68
AccessTestGenUpdateAvailablePortsCommand......................................... 69
AccessTestGenUpdateTrafficCommand...................................................... 70
AccessVplsGenCeDeviceParams............................................................... 70
AccessVplsGenParams............................................................................... 71
acCookie...................................................................................................... 71
acName........................................................................................................ 72
acSystemError............................................................................................. 72
ActiveEvent.................................................................................................. 73
ActiveEventManager.................................................................................... 74
AddrArrayTLV.............................................................................................. 81
AddrCustom................................................................................................. 81
Address........................................................................................................ 82
Address........................................................................................................ 82
addresses.................................................................................................... 82
Addresses.................................................................................................... 83
addressList................................................................................................... 83
AddressType................................................................................................ 84
AddResultChartQueryFromResultObjectCommand.................................... 84
AddrEthMac................................................................................................. 85
addrExt......................................................................................................... 86
addrList........................................................................................................ 86
aggregationStatus........................................................................................ 89
Analyzer....................................................................................................... 89
AnalyzerConfig............................................................................................. 92
AnalyzerFilterCreateCommand................................................................... 94
AnalyzerFrameConfigFilter.......................................................................... 95
AnalyzerPortResults.................................................................................... 95
AnalyzerPreloadProfile.............................................................................. 103
AncpAccessLoopBlockConfig.................................................................... 105
AncpAccessLoopGenConfigExpandCommand......................................... 106
AncpAccessLoopGenParams.................................................................... 107
AncpAccessLoopGenSubscriberParams................................................... 108
AncpAccessNodeConfig............................................................................ 110
AncpAccessNodeResults.......................................................................... 112
AncpCpeToDslamLink................................................................................ 115
AncpDeviceGenProtocolParams............................................................... 116
AncpDslLineProfile..................................................................................... 118
AncpImportSubscriberInfoCommand......................................................... 118
27
All Objects Index
BfdRouterConfig........................................................................................ 191
BfdRouterResults....................................................................................... 193
BfdSessionResults..................................................................................... 193
BFDSimpleAuth......................................................................................... 195
BfdStateSummary...................................................................................... 196
BgpAuthenticationParams......................................................................... 197
BgpCapabilityConfig.................................................................................. 198
BgpDeviceGenProtocolParams................................................................. 198
BgpGlobalConfig........................................................................................ 200
BgpImportRouteTableCommand............................................................... 202
BgpImportRouteTableParams.................................................................... 202
BgpIpv4VpnFecInfo................................................................................... 210
BgpRouteGenParams................................................................................ 220
BgpRouteGenRouteAttrParams................................................................ 221
BgpRouterConfig....................................................................................... 223
BgpRouterResults...................................................................................... 227
BgpSharedSessionParams........................................................................ 229
BgpStateSummary..................................................................................... 231
BgpViewRoutesCommand......................................................................... 233
BgpVplsAdConfig....................................................................................... 233
BgpVplsFecInfo.......................................................................................... 236
BgpVpnRouteConfig.................................................................................. 237
BinaryResponseHeaderConfig.................................................................. 238
body........................................................................................................... 239
BridgePortConfig........................................................................................ 239
BridgePortResults...................................................................................... 241
bTag........................................................................................................... 243
BurstPatternDescriptor............................................................................... 244
bVlanTag.................................................................................................... 244
bwg_percentage........................................................................................ 245
CallBody..................................................................................................... 245
CapabilityFlags.......................................................................................... 246
Capture...................................................................................................... 247
CaptureAnalyzerFilter................................................................................ 250
CaptureBytePattern................................................................................... 251
CaptureFilter.............................................................................................. 253
CaptureFilterResetCommand.................................................................... 256
CaptureFilterResetStartEventCommand................................................... 257
CaptureFilterResetStopEventCommand................................................... 257
CaptureFilterStartEvent............................................................................. 258
CaptureFilterStopEvent.............................................................................. 261
CaptureGetFrameCommand..................................................................... 265
CaptureGetRawDataCommand................................................................. 266
CapturePatternExpression......................................................................... 266
CapturePktPduParserCommand............................................................... 267
CaptureRangePattern................................................................................ 267
CaptureRawPacketTagsInfo...................................................................... 268
CaptureStartAllCommand.......................................................................... 269
CaptureStatisticsFilter................................................................................ 271
CaptureStopAllCommand.......................................................................... 271
CaptureViewCommand.............................................................................. 272
CCM........................................................................................................... 273
CCM........................................................................................................... 274
CCMTLVList............................................................................................... 275
CCMTLVList............................................................................................... 275
cdb10......................................................................................................... 276
CDB10....................................................................................................... 276
cdb6........................................................................................................... 277
CDB6......................................................................................................... 277
cfmHeader................................................................................................. 278
ChangeLacpGroupCommand.................................................................... 280
ChangeMstpRegionCommand.................................................................. 280
ChangePimGroupCommand..................................................................... 281
ChangePimRpmapCommand.................................................................... 281
ChangeStpTypeCommand........................................................................ 282
ChartAxis................................................................................................... 285
ChartAxisMapping...................................................................................... 286
ChassisConnectCommand........................................................................ 288
ChassisDisconnectAllCommand................................................................ 289
ChassisDisconnectCommand.................................................................... 289
chassisid.................................................................................................... 290
chassisid.................................................................................................... 290
ChassisIDList............................................................................................. 291
ChassisIdTlv.............................................................................................. 291
checksums................................................................................................. 291
CiscoDCE8021adSTag.............................................................................. 292
CiscoDCECiscoStag.................................................................................. 294
CiscoHDLC................................................................................................ 297
ciscostag.................................................................................................... 298
class1SvcParams...................................................................................... 299
class2SvcParams...................................................................................... 303
class3SvcParams...................................................................................... 307
classEnableVector..................................................................................... 311
classFSvcParams...................................................................................... 311
clientIdHW.................................................................................................. 312
clientIdnonHW............................................................................................ 312
ClientLoadPhase........................................................................................ 313
ClientLoadProfile........................................................................................ 314
ClientProfile................................................................................................ 316
ClockSynchronizationResult...................................................................... 317
CloneCommand......................................................................................... 318
CollapseResultViewDataCommand........................................................... 319
ColumnDisplayProperties.......................................................................... 320
commonIdentificationData......................................................................... 320
commonSvcParams................................................................................... 322
commSvcParams....................................................................................... 323
ConfigBfdIlLoggingCommand.................................................................... 325
ConfigBgpIlLoggingCommand................................................................... 326
ConfigFcFcoeIlLoggingCommand............................................................. 327
ConfigIeee1588v2IlLoggingCommand...................................................... 327
ConfigIsisIlLoggingCommand.................................................................... 328
ConfigLacpIlLoggingCommand................................................................. 329
ConfigLdpIlLoggingCommand................................................................... 330
ConfigLldpIlLoggingCommand.................................................................. 331
ConfigPimIlLoggingCommand................................................................... 334
ConfigPropertiesCommand....................................................................... 335
ConfigRipIlLoggingCommand.................................................................... 336
ConfigRsvpIlLoggingCommand................................................................. 337
ConfigStpIlLoggingCommand.................................................................... 337
ConfigSyncEthIlLoggingCommand............................................................ 338
Configuration.............................................................................................. 339
ConfigureTestModuleCommand................................................................ 340
CongestionNotificationTlv.......................................................................... 340
ContinuousTestConfig................................................................................ 341
Control....................................................................................................... 345
ControlFrame............................................................................................. 345
ControlFrameSize...................................................................................... 346
controls...................................................................................................... 346
ControlWord............................................................................................... 346
28
All Objects Index
CopyCommand.......................................................................................... 347
CopyFilterToPortsCommand...................................................................... 347
CounterFilterProperty................................................................................. 348
CounterResultFilter.................................................................................... 349
CounterResultFilterInfo.............................................................................. 350
CounterResultFilterLoadFromTemplateCommand.................................... 350
CounterResultFilterSaveAsTemplateCommand........................................ 351
CounterSortProperty.................................................................................. 351
CreateAndReservePortsCommand........................................................... 352
CreateConnectionCommand..................................................................... 352
CreateEventMessageResultQueryCommand............................................ 353
CreateFrameConfigFromPduTemplateCommand..................................... 354
CreateFrameLengthDistributionCommand................................................ 354
CreateFromTemplateCommand................................................................ 355
CreateGroupedStreamBlocksCommand................................................... 356
CreateHighResolutionStreamBlockConfigCommand................................ 357
CreateIgmpMldHostProtocolCommand..................................................... 358
CreateIgmpMldQuerierProtocolCommand................................................ 359
CreateLogicalPortsCommand.................................................................... 360
CreateNetworkIfCommand........................................................................ 363
CreateNewMulticastGroupCommand........................................................ 363
CreateNewMulticastGroupMembershipCommand.................................... 364
CreateNewOptionCommand...................................................................... 364
CreatePosPhyCommand........................................................................... 369
CreatorCommand...................................................................................... 369
cred............................................................................................................ 370
CSMachineStats........................................................................................ 371
CSProcessStats......................................................................................... 371
csrc............................................................................................................ 372
CSRC......................................................................................................... 372
CSServer................................................................................................... 372
CSServerConnectCommand..................................................................... 373
CSServerDisconnectCommand................................................................. 373
CSSynchronizeFilesCommand.................................................................. 374
CSTestSession........................................................................................... 374
CSTestSessionConnectCommand............................................................ 375
CSTestSessionDisconnectCommand........................................................ 376
ctags.......................................................................................................... 377
ctIuPreamble.............................................................................................. 377
CtrlChanCapTLV........................................................................................ 385
custom....................................................................................................... 386
Custom (custom PDU library).................................................................... 387
Custom....................................................................................................... 387
customAddr................................................................................................ 388
CustomLink................................................................................................ 389
customOption............................................................................................. 390
customPayload.......................................................................................... 391
CustomPropertyCreateCommand............................................................. 391
CustomPropertyUpdateCommand............................................................. 392
customSubTlvType.................................................................................... 393
customTlv................................................................................................... 393
CustomTlv.................................................................................................. 393
CustomTlv.................................................................................................. 394
CustomTlv.................................................................................................. 395
CustomTLV................................................................................................ 395
CustomTlvType.......................................................................................... 396
cVlan.......................................................................................................... 396
cvlans......................................................................................................... 397
daId............................................................................................................ 397
DaId........................................................................................................... 397
Data........................................................................................................... 398
Data........................................................................................................... 398
DataFrame................................................................................................. 399
dataMin...................................................................................................... 399
DataPad..................................................................................................... 399
DataTLV..................................................................................................... 401
DataTLV..................................................................................................... 402
DbGetCommand........................................................................................ 403
DcbBackToBackPerIterationResult............................................................ 404
DcbBackToBackTestCaseConfig............................................................... 408
DcbCongestionControlPerIterationResult.................................................. 413
DcbCongestionControlPerPortResult........................................................ 417
DcbCongestionControlTestCaseConfig..................................................... 420
DcbErroredFramesFilteringPerIterationResult........................................... 423
DcbErroredFramesFilteringTestCaseConfig.............................................. 427
DcbExpandConfigCommand..................................................................... 430
DcbMaximumForwardingRatePerIterationResult...................................... 437
DcbMaximumForwardingRateTestCaseConfig.......................................... 440
DcbPfcBufferingAndLatencyPerIterationResult......................................... 444
DcbPfcBufferingAndLatencyTestCaseConfig............................................ 450
DcbPfcBufferingPerIterationResult............................................................ 458
DcbPfcBufferingTestCaseConfig................................................................ 462
DcbPfcLoadValidationPerIterationPerPortResult....................................... 469
DcbPfcLoadValidationPerIterationResult................................................... 476
DcbPfcLoadValidationTestCaseConfig...................................................... 481
DcbPfcResponseTimePerIterationPerPortResult...................................... 488
DcbPfcResponseTimePerIterationResult.................................................. 492
DcbPfcResponseTimeTestCaseConfig...................................................... 501
DcbQueueputPerIterationResult................................................................ 507
DcbQueueputTestCaseConfig................................................................... 511
DcbStepPerIterationResult........................................................................ 515
DcbStepTestCaseConfig............................................................................ 519
DcbTestConfig............................................................................................ 524
DcbTrafficGroupCodePointTag.................................................................. 526
DcbTrafficGroupPerIterationResult............................................................ 526
DcbTrafficGroupWeightConfig................................................................... 529
DcbUpdateConfigCommand...................................................................... 530
DcbxBandwidthAllocationResult................................................................ 530
DcbxBcnModeResult................................................................................. 531
DcbxBcnParameterResult.......................................................................... 532
dcbxCtlTlv.................................................................................................. 533
DcbxFcoePriorityResult............................................................................. 534
DcbxLogicalLinkResult............................................................................... 535
DcbxNivResult........................................................................................... 535
DcbxPriorityAllocationResult...................................................................... 536
DcbxPriorityFlowControlResult.................................................................. 537
DcbxSubTlvt1............................................................................................. 538
DcbxSubTlvt2............................................................................................. 538
DcbxTlvt1................................................................................................... 539
DcbxTlvt2................................................................................................... 539
ddOptions................................................................................................... 540
ddSpecificOptions...................................................................................... 540
DebugResultRenderer............................................................................... 541
DefineDynamicResultViewCommand........................................................ 541
DeleteCommand........................................................................................ 542
DeleteFileCommand.................................................................................. 543
destinationPortsFabricEgressPathInformation.......................................... 543
destinationPortsFabricIngressPathInformation.......................................... 544
DetachPortsCommand............................................................................... 546
DeviceAddrOptions.................................................................................... 547
DeviceCreateCommand............................................................................. 548
DeviceGenAal5IfParams............................................................................ 549
DeviceGenConfigExpandCommand.......................................................... 550
DeviceGenConfigPreviewCommand......................................................... 551
DeviceGenEthIIIfParams........................................................................... 552
DeviceGenFcIfParams............................................................................... 553
DeviceGenGreIfParams............................................................................. 553
DeviceGenGroupParams........................................................................... 555
DeviceGenHdlcIfParams............................................................................ 556
DeviceGenLinkedStep............................................................................... 559
DeviceGenPppIfParams............................................................................ 560
DeviceGenPppoeIfParams........................................................................ 561
DeviceGenVlanIfParams............................................................................ 561
DeviceGroup.............................................................................................. 562
DeviceRole................................................................................................. 563
Dhcpclientmsg........................................................................................... 566
DHCPOption.............................................................................................. 567
Dhcpservermsg.......................................................................................... 567
29
All Objects Index
Dhcpv4CopyOptionsCommand................................................................. 576
Dhcpv4MsgOption..................................................................................... 580
Dhcpv4Options.......................................................................................... 581
Dhcpv4RelayAgentLink.............................................................................. 585
Dhcpv4ServerDefaultPoolConfig............................................................... 589
Dhcpv4ServerPoolConfig.......................................................................... 592
Dhcpv6BaseMsgOption............................................................................. 600
Dhcpv6CopyAuthKeyListCommand.......................................................... 609
Dhcpv6DelayedAuthKey............................................................................ 609
Dhcpv6MsgOption..................................................................................... 613
Dhcpv6Options.......................................................................................... 614
Dhcpv6PdBlockConfig............................................................................... 615
Dhcpv6ServerAddrPoolConfig................................................................... 625
Dhcpv6ServerDefaultAddrPoolConfig....................................................... 628
Dhcpv6ServerDefaultPrefixPoolConfig...................................................... 629
Dhcpv6ServerPrefixPoolConfig................................................................. 633
DiaAcc........................................................................................................ 641
diaAccept................................................................................................... 641
DiaReq....................................................................................................... 642
diaRequest................................................................................................. 642
diffServ....................................................................................................... 643
DiffServConfig............................................................................................ 644
DiffServResults.......................................................................................... 645
DistributeNetworkCountCommand............................................................ 646
DL.............................................................................................................. 646
DL-Choice.................................................................................................. 647
DMM.......................................................................................................... 647
DMM.......................................................................................................... 648
DMR........................................................................................................... 648
DMR........................................................................................................... 649
domainID.................................................................................................... 650
domainIDs.................................................................................................. 651
Dot1xDeviceGenProtocolParams.............................................................. 652
Dot1xEapAuthMethodResults.................................................................... 654
Dot1xEapFastConfig.................................................................................. 655
Dot1xEapMd5Config.................................................................................. 655
Dot1xEapMethodResults........................................................................... 656
Dot1xEapolResults.................................................................................... 657
Dot1xEapPktResults.................................................................................. 659
Dot1xEapTlsConfig.................................................................................... 660
Dot1xOptions............................................................................................. 661
Dot1xPortConfig......................................................................................... 662
Dot1xSupplicantAuthResults..................................................................... 663
Dot1xSupplicantBlockConfig..................................................................... 665
DownloadFileCommand............................................................................. 667
downstreamInterfaceAddress.................................................................... 668
downstreamIpAddress............................................................................... 668
downstreamLabelList................................................................................. 669
DownstreamLabels.................................................................................... 669
downstreamMappingTlv............................................................................. 669
dpall........................................................................................................... 670
Dpall........................................................................................................... 671
dpl.............................................................................................................. 671
Dpl.............................................................................................................. 672
dplm........................................................................................................... 672
Dplm........................................................................................................... 673
dpln............................................................................................................ 673
Dpln............................................................................................................ 674
drPriority..................................................................................................... 674
dsFlag........................................................................................................ 674
DslTypeTlv................................................................................................. 676
DslTypeTlv................................................................................................. 677
dtag............................................................................................................ 678
DvsNameTlv.............................................................................................. 679
DvsPortNameTlv........................................................................................ 679
DvsPortSetNameTlv.................................................................................. 679
DvsUuidTlv................................................................................................. 680
DynamicChartResultView.......................................................................... 680
DynamicResultView................................................................................... 681
EchoReplyErrorGeneration........................................................................ 682
EfpAcc........................................................................................................ 683
efpAccept................................................................................................... 683
EfpReq....................................................................................................... 686
efpRequest................................................................................................. 686
Egress_Port_ID.......................................................................................... 687
Egress_Port_ID_Length............................................................................. 687
Egress_Port_ID_Subtype.......................................................................... 688
EgressIdent................................................................................................ 688
elp.............................................................................................................. 689
elpAccept................................................................................................... 690
elpReject.................................................................................................... 690
elpRequest................................................................................................. 692
elpRequestAccept...................................................................................... 692
elprjt........................................................................................................... 693
ELSFLOGI................................................................................................. 694
ELSFLOGILSACC..................................................................................... 694
ELSLOGO.................................................................................................. 695
ELSLOGOLSACC...................................................................................... 695
ELSLSRJT................................................................................................. 695
ELSPLOGI................................................................................................. 696
ELSReserved............................................................................................. 696
ELSSvcAvailabilityAndLoginExtDataLength.............................................. 697
EmulatedDevice......................................................................................... 697
EmulatedDeviceGenParams..................................................................... 699
enabledCapabilities.................................................................................... 701
EncapEthernet8022................................................................................... 702
EncapEthernet8023Raw............................................................................ 702
EncapEthernetII......................................................................................... 703
EncapEthernetSnap................................................................................... 704
EncapMAC-in-MAC.................................................................................... 705
endOfList.................................................................................................... 706
30
All Objects Index
endOfOptions............................................................................................. 706
endOfOptlist............................................................................................... 706
EndpointNode............................................................................................ 707
EndTlv........................................................................................................ 708
EndTLV...................................................................................................... 708
EndTLV...................................................................................................... 708
enhancedZoning........................................................................................ 710
EntropyLabel.............................................................................................. 711
EoamAisCommandConfig......................................................................... 711
EoamAisResults......................................................................................... 712
EoamClearTlvsCommand.......................................................................... 716
EoamContChkCommandConfig................................................................ 717
EoamContChkLocalResults....................................................................... 718
EoamContChkRemoteResults................................................................... 720
EoamContChkRemoteResultsCommand.................................................. 722
EoamDelayMeasurementCommandConfig............................................... 722
EoamDelayMeasurementDetailedResultsCommand................................ 723
EoamDelayMeasurementMessageRxResults........................................... 724
EoamDelayMeasurementResponseRxResults.......................................... 725
EoamDelayMeasurementResults.............................................................. 728
EoamGenConfig........................................................................................ 729
EoamGenConfigExpandCommand........................................................... 734
EoamGlobalConfig..................................................................................... 734
EoamLckCommandConfig......................................................................... 736
EoamLckResults........................................................................................ 736
EoamLink................................................................................................... 737
EoamLinkTraceCommandConfig............................................................... 738
EoamLinkTraceDetailedResultsCommand................................................ 739
EoamLinkTraceMessageRxResults........................................................... 739
EoamLinkTraceMessageTxResults........................................................... 740
EoamLinkTracePathResults...................................................................... 741
EoamLinkTraceResponseRxResults......................................................... 742
EoamLinkTraceResponseTxResults.......................................................... 743
EoamLinkTraceResults.............................................................................. 743
EoamLoopbackCommandConfig............................................................... 744
EoamLoopbackDetailedResultsCommand................................................ 746
EoamLoopbackMessageRxResults........................................................... 747
EoamLoopbackMessageTxResults........................................................... 747
EoamLoopbackResponseRxResults......................................................... 748
EoamLoopbackResponseTxResults.......................................................... 749
EoamLoopbackResults.............................................................................. 749
EoamLossMeasurementCommandConfig................................................. 750
EoamLossMeasurementDetailedResultsCommand.................................. 751
EoamLossMeasurementMessageRxResults............................................. 752
EoamLossMeasurementResponseRxResults........................................... 753
EoamLossMeasurementResults................................................................ 753
EoamMaintenancePointConfig.................................................................. 754
EoamMegConfig........................................................................................ 758
EoamMegResults....................................................................................... 761
EoamNodeConfig....................................................................................... 762
EoamPortConfig......................................................................................... 763
EoamPortResults....................................................................................... 765
EoamRemoteMegEndPointConfig............................................................. 766
EoamRequestLinkTracePathCommand.................................................... 767
EoamResetMpsToUseDefaultLmrFrameCountValuesCommand.............. 767
EoamResetMpsToUseDefaultLossMeasurementOffsetsCommand.......... 768
EoamResetMpsToUseDefaultTlvsCommand............................................ 768
EoamSaveLinkTracePathCommand.......................................................... 769
EoamUpdateMpTypesCommand............................................................... 777
EOTResultsWriteDatasetCommand.......................................................... 777
erroredTlv................................................................................................... 779
errorestimate.............................................................................................. 780
EscAcc....................................................................................................... 780
escAccept.................................................................................................. 781
escProtocolDescriptors.............................................................................. 781
EscReq...................................................................................................... 782
escRequest................................................................................................ 783
Ethernet100GigFiber.................................................................................. 783
Ethernet10GigCopper................................................................................ 789
Ethernet8022 (ethernet PDU library)......................................................... 808
Ethernet8022 (mimethernet PDU library).................................................. 808
Ethernet8023Raw (ethernet PDU library).................................................. 809
Ethernet8023Raw (mimethernet PDU library)........................................... 809
EthernetBridgeLink.................................................................................... 810
EthernetCapTLV........................................................................................ 810
EthernetCopper.......................................................................................... 811
EthernetFiber............................................................................................. 817
EthernetII (ethernet PDU library)............................................................... 822
EthernetII (mimethernet PDU library)........................................................ 823
EthernetPause........................................................................................... 824
EthernetSnap (ethernet PDU library)......................................................... 824
EthernetSnap (mimethernet PDU library).................................................. 825
EthernetSSM.............................................................................................. 825
EthernetWan.............................................................................................. 826
EthIIIf.......................................................................................................... 827
ETSConfigurationTlv.................................................................................. 830
ETSRecommendationTlv........................................................................... 831
EventMessageChartSeries........................................................................ 832
EventNoteOAMPDU.................................................................................. 832
EventOAMPDUTLVList.............................................................................. 832
EventTLV................................................................................................... 833
ExpandBenchmarkConfigCommand......................................................... 833
ExpandCustomConfigCommand............................................................... 833
ExpandResultViewDataCommand............................................................. 834
ExportDbResultsCommand....................................................................... 835
ExposedConfig........................................................................................... 839
ExposedProperty....................................................................................... 839
extendedControl......................................................................................... 840
extendedHeader........................................................................................ 840
ExtendHeaderSize..................................................................................... 841
externalAdditionalMetrics........................................................................... 841
ExternalDevice........................................................................................... 842
ExternalDeviceAddNewTypeCommand..................................................... 843
ExternalDeviceCustom10CommandResults.............................................. 844
ExternalDeviceCustomPollingCommandResults....................................... 860
ExternalDeviceDeleteTypeCommand........................................................ 862
ExternalDeviceDummySession................................................................. 863
ExternalDeviceGetAllPortsCommand........................................................ 864
ExternalDeviceOption................................................................................ 865
ExternalDevicePort.................................................................................... 866
ExternalDevicePortResults........................................................................ 867
31
All Objects Index
ExternalDeviceRefreshPortsStatusCommand........................................... 869
ExternalDeviceRunConfigCommandResults............................................. 871
ExternalDeviceSaveCommandMappingCommand................................... 872
ExternalDeviceSession.............................................................................. 873
ExternalDeviceVmwareCpuResults........................................................... 876
ExternalDeviceVmwareNicResults............................................................ 877
ExternalDeviceVmwareResults................................................................. 877
ExternalDummyDevice.............................................................................. 879
ExternalEquationResultProperty................................................................ 880
ExternalLsaBlock....................................................................................... 881
externalLsaOptions.................................................................................... 883
EXTHDR.................................................................................................... 884
extSecurity................................................................................................. 884
fabricLogoAccept....................................................................................... 885
fabricLogoReject........................................................................................ 885
fabricLogoRequest..................................................................................... 886
fabricName................................................................................................. 886
FairnessFrame........................................................................................... 887
FairnessHeader......................................................................................... 887
fc................................................................................................................ 888
FC.............................................................................................................. 891
FC.............................................................................................................. 892
FcBaseTestGenUpdateAvailablePortsCommand...................................... 892
FcDeviceGenProtocolParams................................................................... 892
FcEPortConfig............................................................................................ 893
FcFcoeTestGenConfigExpandCommand.................................................. 894
FcFcoeTrafficParams................................................................................. 895
FcFPortConfig............................................................................................ 896
FcFPortNeighborResults............................................................................ 898
FcFPortResults.......................................................................................... 900
FcGlobalConfig.......................................................................................... 901
FcGlobalParams........................................................................................ 902
FcHostConfig............................................................................................. 902
FcIf............................................................................................................. 904
FcLeftSidePortParams............................................................................... 907
FcLeftSideTestParams............................................................................... 908
FcLoginCommand...................................................................................... 908
fcMap......................................................................................................... 909
FcNPortResults.......................................................................................... 910
FCoE.......................................................................................................... 911
FcoeCapTLV.............................................................................................. 913
FcoeDeviceGenProtocolParams............................................................... 913
FcoeGlobalParams.................................................................................... 915
FCoEHeader.............................................................................................. 916
FcoeHostConfig......................................................................................... 917
FcoeLeftSidePortParams........................................................................... 920
FcoeLeftSideTestParams........................................................................... 922
FcoeRightSidePortParams........................................................................ 924
FcoeRightSideTestParams........................................................................ 926
FcoeSideDcbxTlvConfig............................................................................ 927
FcoeSummaryResults................................................................................ 929
FcoeTestGenConfigExpandCommand...................................................... 930
FcoeTestGenParams................................................................................. 931
FcoeTestGenUpdateAvailablePortsCommand.......................................... 933
FcoeVePortConfig...................................................................................... 934
FcoeVfPortConfig....................................................................................... 935
FcoeVfPortNeighborResults...................................................................... 937
FcoeVfPortResults..................................................................................... 940
FcoeVnPortResults.................................................................................... 941
FCPayload-Choice..................................................................................... 944
fcPayloads................................................................................................. 944
fcpCdb........................................................................................................ 945
fcpCmnd..................................................................................................... 945
FcpCmnd................................................................................................... 946
FcpCmndDl................................................................................................ 946
FcPhy......................................................................................................... 947
FcPhyClearStatsCommand....................................................................... 952
FcResults................................................................................................... 952
FcRightSidePortParams............................................................................ 954
FcRightSideTestParams............................................................................ 955
FcSofEof.................................................................................................... 956
FcSummaryResults.................................................................................... 956
FcTestGenParams..................................................................................... 957
FcTestGenUpdateAvailablePortsCommand.............................................. 958
fdisc............................................................................................................ 959
fdiscAcc...................................................................................................... 960
fdiscAccept................................................................................................. 960
fdiscReject................................................................................................. 961
fdiscRequest.............................................................................................. 962
fdiscRjt....................................................................................................... 962
FeatureLicense.......................................................................................... 963
FilePathReplacementCommand................................................................ 965
FilteredStreamResults............................................................................... 966
FIP............................................................................................................. 975
Fixed.......................................................................................................... 976
FixedDurationTestConfig............................................................................ 976
FixedSubTlvList......................................................................................... 980
fkaAdvPeriod.............................................................................................. 981
flags........................................................................................................... 981
FLAGS....................................................................................................... 982
FlapSetupCommand.................................................................................. 984
FlatPatternDescriptor................................................................................. 985
flogi............................................................................................................ 985
flogiAcc...................................................................................................... 986
flogiAccept................................................................................................. 986
flogiReject.................................................................................................. 988
flogiRequest............................................................................................... 989
flogiRjt........................................................................................................ 990
ForeignMasterClockResults....................................................................... 991
fpng............................................................................................................ 992
Fpng........................................................................................................... 993
fpngAccept................................................................................................. 993
FpngAccept................................................................................................ 994
FrameLengthDistribution............................................................................ 994
FrameLengthDistributionLoadFromTemplateCommand............................ 995
FrameLengthDistributionSaveAsTemplateCommand................................ 996
FrameLengthDistributionSlot..................................................................... 996
FrameLengthHistogram............................................................................. 997
fs................................................................................................................ 998
fspfHeader................................................................................................. 998
FtpClientProtocolConfig........................................................................... 1000
FtpClientResults....................................................................................... 1002
FtpProtocolParams.................................................................................. 1005
FtpServerProtocolConfig.......................................................................... 1006
FtpServerProtocolProfile.......................................................................... 1007
FtpServerResponseConfig...................................................................... 1007
FtpServerResults..................................................................................... 1008
ftr.............................................................................................................. 1012
Ftr............................................................................................................. 1013
ftrAccept................................................................................................... 1014
FtrAccept.................................................................................................. 1014
FullMeshTopologyGenParams................................................................. 1015
FxPortClkSyncQos................................................................................... 1015
gaNxtAccept............................................................................................. 1016
GaNxtAccept............................................................................................ 1017
gapnlAccept............................................................................................. 1019
GapnlAccept............................................................................................ 1019
gatin......................................................................................................... 1019
Gatin........................................................................................................ 1020
gatinAccept.............................................................................................. 1020
GatinAccept............................................................................................. 1020
gcsIdAccept............................................................................................. 1021
GcsIdAccept............................................................................................. 1021
gdidAccept............................................................................................... 1021
GdidAccept.............................................................................................. 1022
GeneralizedPseudoWireFecInfo.............................................................. 1022
GeneralizedPwidLsp................................................................................ 1024
GenerateRawPacketTagsCommand....................................................... 1028
generationID............................................................................................ 1029
32
All Objects Index
Generator................................................................................................. 1029
GeneratorConfig...................................................................................... 1030
GeneratorPortResults.............................................................................. 1035
GeneratorUpdateCommand.................................................................... 1039
genericError............................................................................................. 1040
GetAllEndpointCommand........................................................................ 1042
GetAllSupportedEndpointTypeCommand................................................ 1042
GetAllSupportedProtocolCommand......................................................... 1043
GetBfdLoggingConfigCommand.............................................................. 1043
GetBgpLoggingConfigCommand............................................................. 1044
GetChassisLicenseInfoCommand........................................................... 1044
GetConfigInfoCommand.......................................................................... 1045
GetFcFcoeLoggingConfigCommand....................................................... 1046
GetFieldOffsetCommand......................................................................... 1047
GetHighResolutionSamplingResultCommand......................................... 1047
GetIeee1588v2LoggingConfigCommand................................................ 1048
GetIsisLoggingConfigCommand.............................................................. 1049
GetLacpLoggingConfigCommand........................................................... 1049
GetLdpLoggingConfigCommand............................................................. 1050
GetLldpLoggingConfigCommand............................................................ 1050
GetObjectInfoCommand.......................................................................... 1051
GetObjectsCommand.............................................................................. 1051
GetPimLoggingConfigCommand............................................................. 1053
GetPluginInfoCommand........................................................................... 1053
GetPreviewDataCommand...................................................................... 1054
GetPropertyTypeMetaInfoCommand....................................................... 1055
GetRelationsMetaInfoCommand............................................................. 1056
GetRelativesCommand............................................................................ 1057
GetRipLoggingConfigCommand.............................................................. 1058
GetRsvpLoggingConfigCommand........................................................... 1058
GetStpLoggingConfigCommand.............................................................. 1059
GetSyncEthLoggingConfigCommand...................................................... 1059
GetSystemPathsCommand..................................................................... 1060
GetTestResultSettingPathsCommand..................................................... 1060
gffIdAccept............................................................................................... 1061
GffIdAccept.............................................................................................. 1061
gfnAccept................................................................................................. 1062
GfnAccept................................................................................................ 1062
gfpnIdAccept............................................................................................ 1062
GfpnIdAccept........................................................................................... 1063
gftIdAccept............................................................................................... 1063
GftIdAccept.............................................................................................. 1063
gidFtAccept.............................................................................................. 1064
GidFtAccept............................................................................................. 1064
gidNnAccept............................................................................................. 1064
GidNnAccept............................................................................................ 1064
gidPnAccept............................................................................................. 1065
GidPnAccept............................................................................................ 1065
gidPtAccept.............................................................................................. 1066
GidPtAccept............................................................................................. 1066
gieilAccept................................................................................................ 1066
GieilAccept............................................................................................... 1067
giel........................................................................................................... 1067
Giel........................................................................................................... 1068
gielAccept................................................................................................ 1068
GielAccept................................................................................................ 1068
gielnAccept.............................................................................................. 1069
GielnAccept.............................................................................................. 1069
gietAccept................................................................................................ 1070
GietAccept............................................................................................... 1070
globalFlags............................................................................................... 1071
gmalAccept.............................................................................................. 1071
GmalAccept............................................................................................. 1072
gmidAccept.............................................................................................. 1072
GmidAccept............................................................................................. 1073
gnid.......................................................................................................... 1073
Gnid......................................................................................................... 1073
gnidAccept............................................................................................... 1074
GnidAccept.............................................................................................. 1074
gnnFtAccept............................................................................................. 1075
GnnFtAccept............................................................................................ 1075
gnnIdAccept............................................................................................. 1076
GnnIdAccept............................................................................................ 1076
gnpl.......................................................................................................... 1076
Gnpl......................................................................................................... 1077
gnplAccept............................................................................................... 1077
GnplAccept.............................................................................................. 1077
gpabAccept.............................................................................................. 1078
GpabAccept............................................................................................. 1078
gpfcpAccept............................................................................................. 1079
GpfcpAccept............................................................................................ 1079
gplAccept................................................................................................. 1079
GplAccept................................................................................................ 1080
gpliAccept................................................................................................ 1080
GpliAccept................................................................................................ 1080
gplmlAccept............................................................................................. 1081
GplmlAccept............................................................................................. 1081
gplnlAccept.............................................................................................. 1082
GplnlAccept.............................................................................................. 1082
gpltAccept................................................................................................ 1082
GpltAccept............................................................................................... 1083
gpnFtAccept............................................................................................. 1083
GpnFtAccept............................................................................................ 1083
gpnIdAccept............................................................................................. 1084
GpnIdAccept............................................................................................ 1084
gpnl.......................................................................................................... 1084
Gpnl......................................................................................................... 1085
gpnlAccept............................................................................................... 1085
GpnlAccept.............................................................................................. 1085
gppnAccept.............................................................................................. 1086
GppnAccept............................................................................................. 1086
gpsAccept................................................................................................ 1086
GpsAccept............................................................................................... 1087
gpscAccept.............................................................................................. 1088
GpscAccept.............................................................................................. 1088
gptAccept................................................................................................. 1089
GptAccept................................................................................................ 1089
gptIdAccept.............................................................................................. 1090
GptIdAccept............................................................................................. 1091
Gre........................................................................................................... 1091
GreChecksum.......................................................................................... 1093
GreIf......................................................................................................... 1093
GreIfPortResults...................................................................................... 1097
GreIfResults............................................................................................. 1097
GreKey..................................................................................................... 1098
GreSeqNum............................................................................................. 1098
GridTopologyGenParams........................................................................ 1099
groupAddr................................................................................................ 1100
GroupCollection....................................................................................... 1103
GroupRecord........................................................................................... 1103
groupRecords.......................................................................................... 1104
GroupType............................................................................................... 1105
grpRecords.............................................................................................. 1105
gsAccept.................................................................................................. 1106
GsAccept................................................................................................. 1107
gsDeregisterWithPlatformName.............................................................. 1107
GsDeregisterWithPlatformName............................................................. 1107
gsesAccept.............................................................................................. 1108
GsesAccept.............................................................................................. 1108
gsnnNnAccept.......................................................................................... 1109
GsnnNnAccept......................................................................................... 1109
gspnIdAccept........................................................................................... 1110
GspnIdAccept.......................................................................................... 1110
gsReject................................................................................................... 1110
GsReject.................................................................................................. 1111
gsRequestWithFc4Type........................................................................... 1111
GsRequestWithFc4Type.......................................................................... 1112
gsRequestWithInterconnectElementName.............................................. 1112
GsRequestWithInterconnectElementName............................................. 1112
gsRequestWithNodeName...................................................................... 1113
GsRequestWithNodeName..................................................................... 1113
gsRequestWithPlatformName................................................................. 1113
GsRequestWithPlatformName................................................................. 1114
gsRequestWithPortIdentifier.................................................................... 1114
GsRequestWithPortIdentifier................................................................... 1115
gsRequestWithPortName........................................................................ 1115
GsRequestWithPortName........................................................................ 1116
gsRequestWithPortType.......................................................................... 1116
GsRequestWithPortType......................................................................... 1117
gtin........................................................................................................... 1117
33
All Objects Index
Gtin.......................................................................................................... 1118
gtinAccept................................................................................................ 1118
GtinAccept............................................................................................... 1119
GTPv1...................................................................................................... 1119
GTPv1Ext................................................................................................. 1121
HdlcGetLinkConfigCommand.................................................................. 1121
HdlcIf........................................................................................................ 1122
HdlcLinkConfig......................................................................................... 1124
HdlcSetLinkConfigCommand................................................................... 1125
hdrAuthSelectCrypto................................................................................ 1126
hdrAuthSelectNone.................................................................................. 1126
hdrAuthSelectPassword........................................................................... 1127
hdrAuthSelectUserDef............................................................................. 1127
header...................................................................................................... 1127
helloOptions............................................................................................. 1146
HelpCommand......................................................................................... 1147
HighResolutionSamplingGetChartCommand.......................................... 1147
HighResolutionSamplingPortConfig........................................................ 1148
HighResolutionSamplingPortResults....................................................... 1150
HighResolutionSamplingStreamBlockConfig........................................... 1152
HighResolutionSamplingStreamBlockResults......................................... 1154
HighResolutionStreamBlockOptions........................................................ 1155
HloReq..................................................................................................... 1156
hloRequest............................................................................................... 1157
holdTime.................................................................................................. 1157
Host.......................................................................................................... 1158
HostGenParams...................................................................................... 1159
HostGroup................................................................................................ 1160
hostName................................................................................................. 1161
hostUniq................................................................................................... 1161
HostUuidTlv............................................................................................. 1162
HttpClientProtocolConfig.......................................................................... 1162
HttpClientProtocolProfile.......................................................................... 1164
HttpClientResults..................................................................................... 1165
HttpProtocolParams................................................................................. 1167
HttpServerProtocolConfig........................................................................ 1168
HttpServerProtocolProfile........................................................................ 1169
HttpServerResponseConfig..................................................................... 1170
HttpServerResults.................................................................................... 1171
HubSpokeTopologyGenParams.............................................................. 1173
IcmpDestUnreach.................................................................................... 1174
IcmpEchoReply........................................................................................ 1175
IcmpEchoRequest.................................................................................... 1176
IcmpInfoReply.......................................................................................... 1177
IcmpInfoRequest...................................................................................... 1178
IcmpParameterProblem........................................................................... 1179
IcmpRedirect............................................................................................ 1180
IcmpSourceQuench................................................................................. 1181
IcmpTimeExceeded................................................................................. 1182
IcmpTimestampReply.............................................................................. 1182
IcmpTimestampRequest.......................................................................... 1183
Icmpv6DestUnreach................................................................................ 1184
Icmpv6EchoReply.................................................................................... 1185
Icmpv6EchoRequest................................................................................ 1186
Icmpv6PacketTooBig............................................................................... 1187
Icmpv6ParameterProblem....................................................................... 1188
Icmpv6TimeExceeded............................................................................. 1189
IdleFrame................................................................................................. 1190
Ieee1588v2ClockConfig........................................................................... 1190
Ieee1588v2ClockResult........................................................................... 1194
Ieee1588v2StateSummary...................................................................... 1195
IfManager................................................................................................. 1196
IfStackAddCommand............................................................................... 1197
IfStackAttachCommand........................................................................... 1198
IfStackGetCommand................................................................................ 1199
IfStackRemoveCommand........................................................................ 1199
IfStackReplaceCommand........................................................................ 1200
IgmpEotHostResults................................................................................ 1200
IgmpGroupMembership........................................................................... 1201
IgmpGroupMembershipResults............................................................... 1203
IgmpHostConfig....................................................................................... 1204
IgmpHostResults...................................................................................... 1207
IgmpPortConfig........................................................................................ 1212
IgmpPortResults...................................................................................... 1213
IgmpRouterConfig.................................................................................... 1216
IgmpRouterResults.................................................................................. 1218
Igmpv1..................................................................................................... 1219
Igmpv2..................................................................................................... 1220
Igmpv2Query........................................................................................... 1221
Igmpv2Report.......................................................................................... 1221
Igmpv3Query........................................................................................... 1222
Igmpv3Report.......................................................................................... 1222
IncarnationNumTlv................................................................................... 1223
Info........................................................................................................... 1223
InfoOAMPDU........................................................................................... 1224
InfoOAMPDUTLVList............................................................................... 1224
Ingress_Port_ID....................................................................................... 1224
Ingress_Port_ID_Length.......................................................................... 1225
Ingress_Port_ID_Subtype........................................................................ 1225
InterarrivalTimeHistogram........................................................................ 1228
interconnectElementDomainIds............................................................... 1229
interconnectElementEntries..................................................................... 1230
InterestingStreamsResults....................................................................... 1232
interface................................................................................................... 1241
interfaceAlias........................................................................................... 1242
interfaceAlias........................................................................................... 1242
interfaceAndLabelStackTlv...................................................................... 1243
interfaceName.......................................................................................... 1244
interfaceName.......................................................................................... 1244
InterfaceStatusTLV.................................................................................. 1245
intermediateSwitchsPathInformation....................................................... 1246
IntStat....................................................................................................... 1247
IP.............................................................................................................. 1248
ipAddress................................................................................................. 1249
ipData....................................................................................................... 1249
IpForwardingLink..................................................................................... 1250
ipHdr........................................................................................................ 1251
IptvChannelBlock..................................................................................... 1262
IptvChannelResults.................................................................................. 1263
IptvPortResults......................................................................................... 1267
IptvStbBlockConfig................................................................................... 1271
IptvStbBlockResults................................................................................. 1273
IptvTestResults......................................................................................... 1280
IptvViewedChannels................................................................................ 1280
IptvViewingProfileConfig.......................................................................... 1281
IptvViewingProfileResults........................................................................ 1284
IPv4.......................................................................................................... 1289
ipv4Addr................................................................................................... 1294
Ipv4Addr (igmp PDU library).................................................................... 1295
Ipv4EchoRequestConfig.......................................................................... 1297
Ipv4Group................................................................................................ 1298
IPv4HeaderOption................................................................................... 1300
Ipv4If........................................................................................................ 1300
Ipv4IngressPrefixLsp............................................................................... 1305
Ipv4OptionMtuReply................................................................................ 1308
Ipv4PrefixFecInfo..................................................................................... 1309
Ipv4PrefixLsp........................................................................................... 1309
IPv6.......................................................................................................... 1313
ipv6Addr................................................................................................... 1318
Ipv6Addr (icmpv6 PDU library)................................................................ 1318
Ipv6AuthenticationHeader....................................................................... 1320
Ipv6DestinationHeader............................................................................ 1324
34
All Objects Index
Ipv6DestinationOption.............................................................................. 1329
Ipv6EncapsulationHeader........................................................................ 1330
Ipv6FragmentHeader............................................................................... 1335
Ipv6Group................................................................................................ 1339
Ipv6HopByHopHeader............................................................................. 1341
Ipv6HopByHopOption.............................................................................. 1345
Ipv6If........................................................................................................ 1346
IPv6LL...................................................................................................... 1352
Ipv6RoutingHeader.................................................................................. 1356
IsisAuthenticationParams........................................................................ 1360
IsisCapabilityTlv....................................................................................... 1361
IsisDeviceGenProtocolParams................................................................ 1362
IsisDeviceIdSubTlv.................................................................................. 1364
IsisFTagSubTlv........................................................................................ 1365
IsisGroupAddressTlv................................................................................ 1366
IsisGroupMacAddrSubTlv........................................................................ 1368
IsisGroupMacRecord............................................................................... 1369
IsisInterestedVlansSubTlv....................................................................... 1370
IsisLspConfig........................................................................................... 1375
IsisLspGenParams................................................................................... 1377
IsisLspGenRouteAttrParams................................................................... 1378
IsisLspNeighborConfig............................................................................. 1379
IsisLspPlsbInstanceConfig....................................................................... 1380
IsisLspPlsbIsidAddrConfig....................................................................... 1380
IsisLspPlsbIsidAddrIsidConfig................................................................. 1381
IsisMacReachabilityTlv............................................................................ 1382
IsisNicknameRecord................................................................................ 1382
IsisNicknameSubTlv................................................................................ 1383
IsisPlsbGlobalConfig................................................................................ 1383
IsisPlsbLinkMetricConfig.......................................................................... 1384
IsisRootIdSubTlv...................................................................................... 1387
IsisRootPrioritySubTlv.............................................................................. 1387
IsisRouterCapabilitySubTlv...................................................................... 1387
IsisRouterConfig...................................................................................... 1388
IsisRouterResults..................................................................................... 1393
IsisSharedSessionParams....................................................................... 1395
IsisStateSummary.................................................................................... 1397
IsisTreeRootIdSubTlv.............................................................................. 1399
IsisTreesSubTlv....................................................................................... 1399
IsisViewRoutesCommand........................................................................ 1400
islFlowControl.......................................................................................... 1402
iTag.......................................................................................................... 1402
ItagIf......................................................................................................... 1403
ItagServiceLink........................................................................................ 1406
JitterHistogram......................................................................................... 1415
joinedSources.......................................................................................... 1416
jumbo....................................................................................................... 1418
jumboMax................................................................................................ 1418
keys.......................................................................................................... 1419
L2LearningConfig..................................................................................... 1419
L2TestReloadRegistersCommand........................................................... 1423
L2tpPortConfig......................................................................................... 1431
L2tpPortResults....................................................................................... 1432
L2tpShowNodeInfoCommand.................................................................. 1435
L2tpShowSessionInfoCommand............................................................. 1435
L2tpShowTunnelInfoCommand............................................................... 1436
L2TPv2..................................................................................................... 1437
L2tpv2BlockConfig................................................................................... 1438
L2tpv2BlockResults................................................................................. 1441
L2tpv2DeviceGenProtocolParams........................................................... 1444
L2tpv2If.................................................................................................... 1445
L2tpv2NodeResults.................................................................................. 1450
L2tpv2SessionResults............................................................................. 1452
L2tpv2TunnelResults............................................................................... 1454
l2VpnEndpointSubTlv.............................................................................. 1458
L3ForwardingLink.................................................................................... 1458
L4L7GenerateTrafficConfigCommand..................................................... 1459
L4L7GenerateTrafficConfigParams......................................................... 1460
LabelBindingGlobalConfig....................................................................... 1461
LACP........................................................................................................ 1462
LacpCreateLagCommand........................................................................ 1464
LacpGroupConfig..................................................................................... 1465
LacpPortConfig........................................................................................ 1466
LacpPortResults....................................................................................... 1468
LacpStateSummary................................................................................. 1470
lanPruneDelay......................................................................................... 1471
LastEgressIdent....................................................................................... 1472
LatencyHistogram.................................................................................... 1473
LBM.......................................................................................................... 1474
LBM.......................................................................................................... 1475
LBMTLVList.............................................................................................. 1475
LBMTLVList.............................................................................................. 1475
LBR.......................................................................................................... 1476
LBR.......................................................................................................... 1476
LBRTLVList.............................................................................................. 1477
LdpAuthenticationParams........................................................................ 1478
LdpDeviceGenProtocolParams............................................................... 1478
LdpLspResults......................................................................................... 1481
LdpRouterConfig...................................................................................... 1488
LdpRouterResults.................................................................................... 1492
LdpSharedSessionParams...................................................................... 1496
LdpStateSummary................................................................................... 1497
LE............................................................................................................. 1504
35
All Objects Index
leaseTime................................................................................................ 1505
Length...................................................................................................... 1505
lengths..................................................................................................... 1505
LI.............................................................................................................. 1506
LicenseCheckCommand.......................................................................... 1506
LicenseDeleteFileCommand.................................................................... 1507
LicenseDownloadFileCommand.............................................................. 1508
LicenseSetAPIVersionCommand............................................................. 1508
LicenseShowCommand........................................................................... 1509
LicenseUploadFileCommand................................................................... 1509
LinkAggregationTlv.................................................................................. 1510
LinkCreateCommand............................................................................... 1511
LinkDeleteCommand............................................................................... 1511
LinkDescriptor.......................................................................................... 1512
LinkDescriptor.......................................................................................... 1512
linkDescriptors......................................................................................... 1513
LinkLayerAddress.................................................................................... 1514
linkLayerOption........................................................................................ 1514
LinkOamCounterResults.......................................................................... 1515
LinkOamEventCounterResults................................................................ 1516
LinkOamEventLogCommand................................................................... 1517
LinkOamEventNotificationConfig............................................................. 1518
LinkOamEventNotificationResults........................................................... 1519
LinkOamGenerateVariableRequestsCommand....................................... 1520
LinkOamGenerateVariableResponsesCommand.................................... 1521
LinkOamLoadVariableResponsesCommand........................................... 1522
LinkOamOrgSpecificConfig..................................................................... 1523
LinkOamOrgSpecificInfoConfig............................................................... 1523
LinkOamRemoteInfoResults.................................................................... 1524
LinkOamRouterConfig............................................................................. 1526
LinkOamSaveVariableResponsesCommand........................................... 1529
LinkOamStateResults.............................................................................. 1534
LinkOamTimersConfig............................................................................. 1539
LinkOamVariableRequestConfig.............................................................. 1540
LinkOamVariableResponseConfig........................................................... 1541
LinkReconnectCommand........................................................................ 1542
LinkRegistry............................................................................................. 1543
LinksReconnectAllCommand................................................................... 1543
LinkTlv...................................................................................................... 1546
llc.............................................................................................................. 1547
LlcBridgedEth8023................................................................................... 1548
llcheader.................................................................................................. 1548
LlcRoutedNlpid......................................................................................... 1549
LlcRoutedSnap........................................................................................ 1550
LlcSnapIana............................................................................................. 1550
LldpDcbxFeatureResult........................................................................... 1551
LldpDcbxResult........................................................................................ 1553
LldpDeviceGenProtocolParams............................................................... 1554
LldpNeighborResults................................................................................ 1554
LldpNodeConfig....................................................................................... 1555
LldpNodeResults...................................................................................... 1556
LldpShowNeighborsInfoCommand.......................................................... 1558
LldpStateSummary.................................................................................. 1559
LldpTlvConfig........................................................................................... 1560
LMM......................................................................................................... 1560
LMM......................................................................................................... 1561
LMR......................................................................................................... 1561
LMR......................................................................................................... 1562
LoadFilterFromLibraryCommand............................................................. 1563
LoadFromDatabaseCommand................................................................ 1563
LoadFromTemplateCommand................................................................. 1564
LoadFromXmlCommand.......................................................................... 1564
LogFileQuerySet...................................................................................... 1567
logicLinkDownTlv..................................................................................... 1568
logo.......................................................................................................... 1568
logoAcc.................................................................................................... 1569
logoAccept............................................................................................... 1569
logoReject................................................................................................ 1570
logoRequest............................................................................................. 1570
logoRjt...................................................................................................... 1571
LoopbackControlOAMPDU...................................................................... 1571
looseSrcRoute......................................................................................... 1572
lsaHdrOptions.......................................................................................... 1573
lsaHeaders............................................................................................... 1574
LsaReq..................................................................................................... 1574
lsaRequest............................................................................................... 1574
LspPing.................................................................................................... 1575
LspPingImportFecInfoFromStreamBlockCommand................................ 1575
LspPingPingResults................................................................................. 1577
LspPingProtocolConfig............................................................................ 1578
LspPingProtocolResults........................................................................... 1579
LspPingStateSummary............................................................................ 1581
LspPingTlvs............................................................................................. 1581
LspPingTraceRouteResults..................................................................... 1582
lsrs........................................................................................................... 1583
LsuReq..................................................................................................... 1585
lsuRequest............................................................................................... 1585
LTM.......................................................................................................... 1586
LTM.......................................................................................................... 1586
LTMEgressIdentTLV................................................................................ 1587
LTMEgrID................................................................................................. 1588
LTMTLVList.............................................................................................. 1589
LTMTLVList.............................................................................................. 1589
LTR.......................................................................................................... 1589
LTR.......................................................................................................... 1590
LTREgressIdentTLV................................................................................. 1591
LTREgrID................................................................................................. 1592
LTRTLVList............................................................................................... 1593
LTRTLVList............................................................................................... 1593
macAddr................................................................................................... 1594
macAddress............................................................................................. 1594
macAddress............................................................................................. 1595
MacBlock................................................................................................. 1595
MacControl............................................................................................... 1596
MacGroup................................................................................................ 1597
MAC-in-MAC............................................................................................ 1597
MacPhyConfigStatusTlv........................................................................... 1598
MACPreamble.......................................................................................... 1600
MADCustom............................................................................................. 1601
MADList................................................................................................... 1601
MADsI802................................................................................................ 1602
MADtDL................................................................................................... 1602
MADtDS4................................................................................................. 1602
MADtDS4z............................................................................................... 1603
MADtDS6................................................................................................. 1603
MADtDS6z............................................................................................... 1604
MADtDT4................................................................................................. 1604
MADtDT4z............................................................................................... 1605
MADtDT6................................................................................................. 1605
MADtDT6z............................................................................................... 1606
MADtDU................................................................................................... 1606
MADtDU4................................................................................................. 1607
MADtDU4z............................................................................................... 1607
MADtDU6................................................................................................. 1607
MADtDU6z............................................................................................... 1608
MADtSU................................................................................................... 1608
MADtTU................................................................................................... 1609
MAID........................................................................................................ 1609
ManAdd.................................................................................................... 1612
managementAddr.................................................................................... 1617
managementAddressEntries................................................................... 1617
36
All Objects Index
ManagementAddrTlv................................................................................ 1619
ManagementDevice................................................................................. 1620
ManagementRegister............................................................................... 1621
ManualSchedule...................................................................................... 1621
ManualScheduleEntry.............................................................................. 1622
ManualScheduleLoadFromTemplateCommand...................................... 1623
ManualScheduleSaveAsTemplateCommand.......................................... 1624
MapPortCommand................................................................................... 1624
Marker...................................................................................................... 1625
MaxFrameSizeTlv.................................................................................... 1626
maxRcvSize............................................................................................. 1632
Mdio......................................................................................................... 1633
MdioPort................................................................................................... 1633
MdioRegister............................................................................................ 1634
mdiPowerSupport.................................................................................... 1634
MDN_Length............................................................................................ 1635
MDN_Length............................................................................................ 1635
mergeRequest......................................................................................... 1636
mergeRequestAcc................................................................................... 1636
message.................................................................................................. 1636
messageSize........................................................................................... 1637
messageType........................................................................................... 1637
Mii............................................................................................................ 1638
MiiRegister............................................................................................... 1638
MismatchInfo............................................................................................ 1645
MldEotHostResults.................................................................................. 1645
MldGroupMembership............................................................................. 1646
MldGroupMembershipResults................................................................. 1647
MldHostConfig......................................................................................... 1649
MldHostResults........................................................................................ 1651
MldPortConfig.......................................................................................... 1653
MldPortResults......................................................................................... 1654
MldRouterConfig...................................................................................... 1656
MldRouterResults.................................................................................... 1658
MLDv1...................................................................................................... 1660
MLDv2GroupRecord................................................................................ 1660
MLDv2Query............................................................................................ 1661
MLDv2Report........................................................................................... 1662
modeSense10.......................................................................................... 1663
ModeSense10.......................................................................................... 1664
modeSense6............................................................................................ 1665
ModeSense6............................................................................................ 1665
ModifyTrafficGroupCommand.................................................................. 1666
Mpls......................................................................................................... 1667
MplsForwardingLink................................................................................. 1668
MplsGeneralizedPwBindIfCreateCommand............................................ 1668
MplsGeneralizedPwBindInfo.................................................................... 1670
MplsHierarchicalLink................................................................................ 1671
MplsIf....................................................................................................... 1671
MplsRsvpLabelLookUpEntry................................................................... 1684
MplsRsvpTunnelBindIfCreateCommand.................................................. 1685
MplsRsvpTunnelBindInfo......................................................................... 1686
MplsStaticBindIfCreateCommand............................................................ 1687
MplsVcBindIfCreateCommand................................................................ 1688
MplsVcBindInfo........................................................................................ 1690
MplsVplsBindIfCreateCommand.............................................................. 1690
MplsVplsBindInfo..................................................................................... 1692
MReq....................................................................................................... 1692
MReqAcc................................................................................................. 1693
Msg.......................................................................................................... 1694
Msgs........................................................................................................ 1694
MsgTypeArrayTLV................................................................................... 1695
MstiConfig................................................................................................ 1695
MstiResults.............................................................................................. 1697
MstpBridgePortConfig.............................................................................. 1698
MstpRegionConfig................................................................................... 1699
MTU......................................................................................................... 1700
mtuOption................................................................................................ 1701
mtuProbe................................................................................................. 1701
MulticastDeviceGenProtocolParams....................................................... 1702
MulticastGroupCountCommand.............................................................. 1704
MulticastHostGenProtocolParams........................................................... 1705
multicastIDs............................................................................................. 1707
MulticastRouterGenProtocolParams....................................................... 1708
MultiSegmentLeftSitePortParams............................................................ 1708
MultiSegmentRightSitePortParams......................................................... 1709
MvpnGenCorePortParams...................................................................... 1709
MvpnGenCustPortParams....................................................................... 1710
MvpnGenParams..................................................................................... 1710
MVpnGreCeToPeLink.............................................................................. 1725
MVpnGrePeToPLink................................................................................ 1726
nameId..................................................................................................... 1727
NeighborAdvertisement........................................................................... 1727
neighbors................................................................................................. 1728
NeighborSolicitation................................................................................. 1728
networkAddress4..................................................................................... 1729
networkAddress4..................................................................................... 1730
networkAddress6..................................................................................... 1731
networkAddress6..................................................................................... 1731
NetworkLsa.............................................................................................. 1732
NetworkLsaLink....................................................................................... 1733
NextEgressIdent...................................................................................... 1734
nilFecSubTlv............................................................................................ 1735
NivSupportTlv.......................................................................................... 1735
nivTlv........................................................................................................ 1736
nni............................................................................................................ 1736
NodeName............................................................................................... 1737
NodeName............................................................................................... 1738
nodeNames.............................................................................................. 1738
nodes....................................................................................................... 1739
nop........................................................................................................... 1740
npivFdiscAccept....................................................................................... 1740
npivFdiscReject........................................................................................ 1741
npivFdiscRequest.................................................................................... 1741
NPortClkSyncQos.................................................................................... 1742
Nr............................................................................................................. 1742
nrList........................................................................................................ 1742
Ns............................................................................................................. 1743
nsList........................................................................................................ 1743
OAMBH.................................................................................................... 1743
OAMPDUConfiguration............................................................................ 1744
offset........................................................................................................ 1744
OffsetPadding.......................................................................................... 1745
OffsetSize................................................................................................ 1745
optionOverload......................................................................................... 1745
options..................................................................................................... 1746
OrganizationallySpecificTlv...................................................................... 1749
OrgSpec................................................................................................... 1749
OrgSpecOAMPDU................................................................................... 1750
OrgSpecTLV............................................................................................ 1750
OS............................................................................................................ 1751
osLunMapEntries..................................................................................... 1752
OsLunMapEntry....................................................................................... 1753
OsLunMapEntry....................................................................................... 1754
37
All Objects Index
ospfv2AsExternalLsa............................................................................... 1761
Ospfv2AuthenticationParams.................................................................. 1762
Ospfv2DatabaseDescription.................................................................... 1762
Ospfv2ExternalLsaTosMetric................................................................... 1764
Ospfv2Hello............................................................................................. 1767
Ospfv2LinkStateAcknowledge................................................................. 1767
Ospfv2LinkStateRequest......................................................................... 1767
Ospfv2LinkStateUpdate........................................................................... 1768
Ospfv2Lsa................................................................................................ 1768
Ospfv2Neighbor....................................................................................... 1771
ospfv2NetworkLsa................................................................................... 1771
Ospfv2RequestedLsa.............................................................................. 1774
ospfv2RouterLsa...................................................................................... 1781
Ospfv2RouterLsaLink.............................................................................. 1782
Ospfv2RouterLsaTosMetric..................................................................... 1783
ospfv2SummaryAsbrLsa.......................................................................... 1788
ospfv2SummaryLsa................................................................................. 1789
Ospfv2SummaryLsaTosMetric................................................................. 1789
Ospfv2TeParams..................................................................................... 1790
Ospfv2Unknown....................................................................................... 1792
Ospfv2ViewRoutesCommand.................................................................. 1792
Ospfv3AsExternalLsaBlock..................................................................... 1800
Ospfv3InterAreaPrefixLsaBlk................................................................... 1805
Ospfv3InterAreaRouterLsaBlock............................................................. 1806
Ospfv3IntraAreaPrefixLsaBlk................................................................... 1808
Ospfv3LinkLsaBlk.................................................................................... 1810
Ospfv3NetworkLsa................................................................................... 1814
Ospfv3NssaLsaBlock............................................................................... 1816
Ospfv3RouterLsa..................................................................................... 1824
Ospfv3RouterLsaIf................................................................................... 1826
outerdamac.............................................................................................. 1832
outersamac.............................................................................................. 1833
OverflowResults....................................................................................... 1834
PacketChannel......................................................................................... 1835
PacketChannelStats................................................................................ 1836
pad1......................................................................................................... 1837
PadData................................................................................................... 1837
padding (l2tpv2 PDU library).................................................................... 1838
Padding (EOAM PDU library).................................................................. 1838
Padding.................................................................................................... 1838
padN........................................................................................................ 1839
padTlv...................................................................................................... 1839
paramReqList........................................................................................... 1840
ParentClockInfoResult............................................................................. 1840
Password................................................................................................. 1842
PathDescriptor......................................................................................... 1842
PauseDynamicResultViewCommand...................................................... 1843
PauseMacControl.................................................................................... 1844
payload.................................................................................................... 1844
PbbTeMip................................................................................................. 1845
PbbTeMipTLV........................................................................................... 1846
Perspective.............................................................................................. 1846
PerspectiveNode...................................................................................... 1847
PFC.......................................................................................................... 1847
PfcMeasurementConfig........................................................................... 1848
PfcResults................................................................................................ 1850
pfcTlv....................................................................................................... 1852
pgAllocation............................................................................................. 1854
pgTlv........................................................................................................ 1855
PhyCompensationOptions....................................................................... 1856
PhyOptions.............................................................................................. 1856
PhysicalChassis....................................................................................... 1857
PhysicalChassisFan................................................................................. 1860
PhysicalChassisManager........................................................................ 1860
PhysicalChassisPowerSupplyStatus....................................................... 1861
PhysicalChassisSyncTopology................................................................ 1863
PhysicalChassisTempStatus.................................................................... 1863
PhysicalChassisThermal......................................................................... 1864
PhysicalPort............................................................................................. 1865
PhysicalPortGroup................................................................................... 1866
PhysicalTestModule................................................................................. 1868
pidCustom................................................................................................ 1873
pidCustom................................................................................................ 1873
pidMacAddress........................................................................................ 1877
pidMacAddress........................................................................................ 1878
PimDeviceGenProtocolParams............................................................... 1882
PimGlobalConfig...................................................................................... 1883
PimRouterConfig...................................................................................... 1887
PimRouterResults.................................................................................... 1890
PimSharedSessionParams...................................................................... 1893
PimStateSummary................................................................................... 1894
Pimv4Assert............................................................................................. 1898
Pimv4GroupBlk........................................................................................ 1898
Pimv4Hello............................................................................................... 1899
38
All Objects Index
Pimv4JoinPrune....................................................................................... 1900
Pimv4JoinSrc........................................................................................... 1900
Pimv4NullRegister................................................................................... 1902
Pimv4PruneSrc........................................................................................ 1902
Pimv4Register.......................................................................................... 1903
Pimv4RpMap........................................................................................... 1904
Pimv6Assert............................................................................................. 1905
Pimv6GroupBlk........................................................................................ 1905
Pimv6Hello............................................................................................... 1906
Pimv6JoinPrune....................................................................................... 1907
Pimv6JoinSrc........................................................................................... 1907
Pimv6PruneSrc........................................................................................ 1909
Pimv6Register.......................................................................................... 1910
Pimv6RpMap........................................................................................... 1911
PingReport............................................................................................... 1911
PingStartCommand.................................................................................. 1912
PingStopCommand.................................................................................. 1914
platformAttributeEntries........................................................................... 1915
platformNameEntries............................................................................... 1917
platformNodeNameEntries...................................................................... 1919
plogiAccept.............................................................................................. 1921
plogiReject............................................................................................... 1921
plogiRequest............................................................................................ 1922
PluginInfo................................................................................................. 1922
Port.......................................................................................................... 1923
PortAndProtocolVlanIdTlv........................................................................ 1925
PortAvgLatencyResults............................................................................ 1926
portComponent........................................................................................ 1926
portComponent........................................................................................ 1927
PortDescriptionTlv.................................................................................... 1928
portEntries................................................................................................ 1928
PortEntry.................................................................................................. 1929
PortEntry.................................................................................................. 1930
PortGroup................................................................................................ 1932
portid........................................................................................................ 1932
PortIdentifier............................................................................................. 1932
PortIdentifier............................................................................................. 1933
portIdentifiers........................................................................................... 1933
PortIDList................................................................................................. 1934
PortIdTlv................................................................................................... 1935
PortIndexTlv............................................................................................. 1935
PortLoggingConfig................................................................................... 1935
PortName................................................................................................. 1936
PortName................................................................................................. 1937
portNames............................................................................................... 1937
PortSetupGetActivePhyCommand.......................................................... 1938
PortSetupSetActivePhyCommand........................................................... 1939
PortStatusTLV.......................................................................................... 1939
PortVlanIdTlv........................................................................................... 1941
POS......................................................................................................... 1941
POSPhy................................................................................................... 1942
PowerViaMdiTlv....................................................................................... 1946
PPP.......................................................................................................... 1946
PppClientBlockResults............................................................................. 1948
PppIf......................................................................................................... 1952
PppMsgOption......................................................................................... 1954
PppoaClientBlockConfig.......................................................................... 1955
PppoaClientBlockResults........................................................................ 1960
PppoaDeviceGenProtocolParams........................................................... 1963
PppoaServerBlockConfig......................................................................... 1965
PppoaServerBlockResults....................................................................... 1969
PppoaSessionResults.............................................................................. 1972
PppoeClientBlockConfig.......................................................................... 1976
PppoeClientBlockResults........................................................................ 1982
PppoeDeviceGenProtocolParams........................................................... 1985
PPPoEDiscovery...................................................................................... 1989
PppoeIf..................................................................................................... 1990
PppoeoaDeviceGenProtocolParams....................................................... 1993
PppoeoaSessionResults.......................................................................... 1998
PppoePortResults.................................................................................... 2002
PppoeServerBlockConfig......................................................................... 2006
PppoeServerBlockResults....................................................................... 2012
PppoeServerIpv4PeerPool...................................................................... 2015
PPPoESession......................................................................................... 2016
PppoeSessionResults.............................................................................. 2017
PPPoETag................................................................................................ 2021
PppoL2tpv2ClientBlockConfig................................................................. 2022
PppoL2tpv2DeviceGenProtocolParams.................................................. 2026
PppoL2tpv2ServerBlockConfig................................................................ 2027
PppoL2tpv2SessionResults..................................................................... 2031
PppoxOptions.......................................................................................... 2041
PppoxPortConfig...................................................................................... 2042
PppoxShowSessionInfoCommand.......................................................... 2050
PppProtocolConfig................................................................................... 2050
PppProtocolResults................................................................................. 2055
PppServerBlockResults........................................................................... 2058
PppSessionResults.................................................................................. 2061
PrefixInformation...................................................................................... 2065
prefixOption.............................................................................................. 2065
PresentationResultQuery......................................................................... 2066
PreviewCustomConfigCommand............................................................. 2067
PreviewData............................................................................................. 2068
prioAllocation........................................................................................... 2068
priority...................................................................................................... 2069
priorityAssign........................................................................................... 2073
PriorityBasedFlowControlTlv................................................................... 2074
Probe....................................................................................................... 2075
ProfileNameTlv........................................................................................ 2075
ProfilesLoadFromTemplateCommand..................................................... 2076
ProfilesSaveAsTemplateCommand......................................................... 2077
Project...................................................................................................... 2077
ProtocolAttachCommand......................................................................... 2080
ProtocolCreateCommand........................................................................ 2080
ProtocolDetachCommand........................................................................ 2082
ProtocolIdentityTlv................................................................................... 2083
ProvisioningInfoTLV................................................................................. 2085
ProvList.................................................................................................... 2085
PrtStat...................................................................................................... 2085
prunedSources......................................................................................... 2086
PseudoWireSwitchingPointTlv................................................................. 2087
QlTlv......................................................................................................... 2089
QueryResultCommand............................................................................ 2090
RandomModifier....................................................................................... 2091
RandomPatternDescriptor....................................................................... 2092
RangeModifier.......................................................................................... 2093
RARP....................................................................................................... 2094
39
All Objects Index
RawTcpClientProtocolConfig................................................................... 2095
RawTcpClientProtocolProfile................................................................... 2097
RawTcpClientResults............................................................................... 2098
RawTcpProtocolParams........................................................................... 2100
RawTcpServerProtocolConfig.................................................................. 2101
RawTcpServerProtocolProfile.................................................................. 2102
RawTcpServerResponseConfig............................................................... 2102
RawTcpServerResults.............................................................................. 2104
rch............................................................................................................ 2105
rcsId......................................................................................................... 2106
RcsId........................................................................................................ 2106
Rdi............................................................................................................ 2107
rdiAccept.................................................................................................. 2107
RdiDomainId............................................................................................ 2108
RdiDomainId............................................................................................ 2108
rdiRequest................................................................................................ 2108
read10...................................................................................................... 2109
Read10.................................................................................................... 2110
read6........................................................................................................ 2111
Read6...................................................................................................... 2111
readBuffer................................................................................................ 2112
ReadBuffer............................................................................................... 2112
readCapacity10........................................................................................ 2113
ReadCapacity10...................................................................................... 2114
readLong10.............................................................................................. 2114
ReadLong10............................................................................................ 2115
RealtimeChartSeries................................................................................ 2116
RealTimeResultColumnDefinition............................................................ 2116
RealTimeResultGroupDefinition.............................................................. 2117
recordRoute............................................................................................. 2119
Redirect.................................................................................................... 2119
redirectedHdrOption................................................................................. 2120
RedirectedHeader.................................................................................... 2121
RefreshResultViewCommand.................................................................. 2121
regMax..................................................................................................... 2122
RejectedReply.......................................................................................... 2122
RejectedReplyAuthStat............................................................................ 2123
relaySessionId......................................................................................... 2123
ReleasePortCommand............................................................................. 2124
ReorderRelativesCommand.................................................................... 2124
ReplyBody................................................................................................ 2125
ReplyEgressTLVFormatTLV.................................................................... 2126
ReplyIngressTLVFormatTLV.................................................................... 2127
replyTOSByteTlv...................................................................................... 2129
reportLUNs............................................................................................... 2129
ReportLUNs............................................................................................. 2130
reqAddr.................................................................................................... 2130
requestedLsas......................................................................................... 2131
ReservedData.......................................................................................... 2131
ReservePortCommand............................................................................ 2132
ResetActiveEventDefaultResponseCommand........................................ 2132
ResetConfigCommand............................................................................. 2133
ResourceLimitCapTLV............................................................................. 2133
Result....................................................................................................... 2134
ResultChartQuerySet............................................................................... 2134
ResultDataSet.......................................................................................... 2136
ResultDataSetCreateCommand.............................................................. 2138
ResultDataSetPauseCommand............................................................... 2139
ResultDataSetResumeCommand............................................................ 2139
ResultDataSetSubscribeCommand......................................................... 2140
ResultDataSetUnsubscribeCommand..................................................... 2140
ResultOptions.......................................................................................... 2141
ResultProviderRegistry............................................................................ 2143
ResultQuery............................................................................................. 2144
ResultsClearViewCommand.................................................................... 2147
ResultsSubscribeCommand.................................................................... 2148
ResultViewData....................................................................................... 2149
ResumeDynamicResultViewCommand................................................... 2150
Rfc2544AsymmetricFrameLossPerLoadResult....................................... 2150
Rfc2544AsymmetricFrameLossStreamGroupResult............................... 2156
Rfc2544AsymmetricFrameLossStreamResult......................................... 2157
Rfc2544AsymmetricLatencyPerLoadResult............................................ 2157
Rfc2544AsymmetricLatencyStreamGroupResult.................................... 2164
Rfc2544AsymmetricLatencyStreamResult.............................................. 2165
Rfc2544AsymmetricThroughputPerFrameSizeResult............................. 2167
Rfc2544AsymmetricThroughputPerLoadResult...................................... 2173
Rfc2544AsymmetricThroughputStreamGroupResult.............................. 2179
Rfc2544AsymmetricThroughputStreamResult........................................ 2179
Rfc2544Back2BackPerCoexistenceRatioResult..................................... 2180
Rfc2544Back2BackPerFrameSizeResult................................................ 2184
Rfc2544Back2BackPerIterationResult..................................................... 2187
Rfc2544Back2BackPerLoadResult.......................................................... 2190
Rfc2544Back2BackTestResult................................................................. 2193
Rfc2544BackToBackFramesConfig......................................................... 2196
Rfc2544BackToBackFramesProfile......................................................... 2202
Rfc2544FrameLossConfig....................................................................... 2203
Rfc2544FrameLossPerCoexistenceRatioResult..................................... 2210
Rfc2544FrameLossPerFrameSizeResult................................................ 2214
Rfc2544FrameLossPerIpv6ExtensionHeaderResult............................... 2219
Rfc2544FrameLossPerIterationResult..................................................... 2224
Rfc2544FrameLossPerLoadResult.......................................................... 2229
Rfc2544FrameLossProfile....................................................................... 2234
Rfc2544FrameLossTestResult................................................................. 2235
Rfc2544LatencyConfig............................................................................ 2237
Rfc2544LatencyPerCoexistenceRatioResult........................................... 2243
Rfc2544LatencyPerFrameSizeResult...................................................... 2249
Rfc2544LatencyPerIpv6ExtensionHeaderResult..................................... 2255
Rfc2544LatencyPerIterationResult.......................................................... 2261
Rfc2544LatencyPerLoadResult............................................................... 2267
Rfc2544LatencyProfile............................................................................. 2272
Rfc2544LatencyTestResult...................................................................... 2273
Rfc2544ProfileRate.................................................................................. 2277
Rfc2544SetupBackToBackTestCommand............................................... 2278
Rfc2544SetupFrameLossTestCommand................................................. 2281
Rfc2544SetupLatencyTestCommand...................................................... 2284
Rfc2544SetupThroughputTestCommand................................................ 2287
Rfc2544ThroughputConfig....................................................................... 2291
Rfc2544ThroughputPerCoexistenceRatioResult..................................... 2298
Rfc2544ThroughputPerFrameSizeResult................................................ 2303
Rfc2544ThroughputPerFrameSizeResultByPort..................................... 2308
Rfc2544ThroughputPerIpv6ExtensionHeaderResult............................... 2309
Rfc2544ThroughputPerIterationResult.................................................... 2314
Rfc2544ThroughputPerLoadResult......................................................... 2320
Rfc2544ThroughputPerLoadResultByPort.............................................. 2325
Rfc2544ThroughputProfile....................................................................... 2325
Rfc2544ThroughputTestResult................................................................ 2328
Rfc2544TrafficGroupPerIterationResult................................................... 2330
Rfc2544TrafficGroupWeightConfig.......................................................... 2333
Rfc2889AddrCachingCapacityConfig...................................................... 2333
Rfc2889AddrCachingPerAddrResult....................................................... 2338
Rfc2889AddrCachingPerFrameSizeResult............................................. 2341
Rfc2889AddrCachingPerIterationResult.................................................. 2343
Rfc2889AddrCachingPerPortResult........................................................ 2346
Rfc2889AddrCachingTestResult.............................................................. 2349
Rfc2889AddrLearningPerFrameSizeResult............................................. 2352
Rfc2889AddrLearningPerIterationResult................................................. 2354
Rfc2889AddrLearningPerLearningRateResult........................................ 2357
Rfc2889AddrLearningPerPortResult....................................................... 2360
Rfc2889AddrLearningRateConfig............................................................ 2362
Rfc2889AddrLearningTestResult............................................................. 2367
Rfc2889BroadcastFrameForwardingConfig............................................ 2370
Rfc2889BroadcastFrameForwardingPerBurstSizeResult........................ 2375
Rfc2889BroadcastFrameForwardingPerFrameSizeResult...................... 2378
Rfc2889BroadcastFrameForwardingPerIterationResult.......................... 2382
Rfc2889BroadcastFrameForwardingPerLoadResult............................... 2385
Rfc2889BroadcastFrameForwardingTestResult...................................... 2388
Rfc2889BroadcastFrameLatencyConfig.................................................. 2391
Rfc2889BroadcastFrameLatencyPerFrameSizePerPortResult............... 2395
Rfc2889BroadcastFrameLatencyPerFrameSizeResult........................... 2398
Rfc2889BroadcastFrameLatencyPerIterationResult............................... 2401
Rfc2889BroadcastFrameLatencyTestResult........................................... 2404
Rfc2889CongestionControlConfig........................................................... 2407
Rfc2889CongestionControlPerBurstSizeResult...................................... 2412
Rfc2889CongestionControlPerFrameSizeResult.................................... 2415
Rfc2889CongestionControlPerIterationResult......................................... 2418
Rfc2889CongestionControlPerLoadResult.............................................. 2421
Rfc2889CongestionControlPerPortResult............................................... 2424
Rfc2889CongestionControlTestResult..................................................... 2426
Rfc2889ErroredFramesFilteringConfig.................................................... 2429
Rfc2889ErroredFramesFilteringPerErrorTypeResult............................... 2435
Rfc2889ErroredFramesFilteringPerIterationResult.................................. 2437
Rfc2889ErroredFramesFilteringPerLoadResult....................................... 2440
40
All Objects Index
Rfc2889ErroredFramesFilteringTestResult.............................................. 2443
Rfc2889ForwardingConfig....................................................................... 2446
Rfc2889ForwardingPerBurstSizeResult.................................................. 2452
Rfc2889ForwardingPerFrameSizeResult................................................ 2455
Rfc2889ForwardingPerIterationResult..................................................... 2458
Rfc2889ForwardingPerLoadResult.......................................................... 2461
Rfc2889ForwardingTestResult................................................................. 2465
Rfc2889ForwardPressureConfig............................................................. 2467
Rfc2889ForwardPressurePerFrameSizeResult....................................... 2471
Rfc2889ForwardPressurePerIterationResult........................................... 2474
Rfc2889ForwardPressureTestResult....................................................... 2478
Rfc2889MaxForwardingRateConfig......................................................... 2480
Rfc2889MaxForwardingRatePerBurstSizeResult.................................... 2485
Rfc2889MaxForwardingRatePerFrameSizeResult.................................. 2489
Rfc2889MaxForwardingRatePerIterationResult...................................... 2492
Rfc2889MaxForwardingRatePerLoadResult........................................... 2495
Rfc2889MaxForwardingRateTestResult.................................................. 2498
Rfc2889SetupAddressCachingCapacityTestCommand.......................... 2501
Rfc2889SetupAddressLearningRateTestCommand................................ 2503
Rfc2889SetupBroadcastFrameForwardingTestCommand...................... 2505
Rfc2889SetupBroadcastFrameLatencyTestCommand............................ 2508
Rfc2889SetupCongestionControlTestCommand..................................... 2510
Rfc2889SetupErroredFramesFilteringTestCommand.............................. 2512
Rfc2889SetupForwardingTestCommand................................................. 2515
Rfc2889SetupForwardPressureTestCommand....................................... 2518
Rfc2889SetupMaxForwardingRateTestCommand.................................. 2521
Rfc3918AggregatedMulticastThroughputPerIterationResult................... 2523
Rfc3918AggregatedMulticastThroughputTestCaseConfig....................... 2526
Rfc3918Config......................................................................................... 2528
Rfc3918JoinLeaveLatencyPerIterationResult.......................................... 2533
Rfc3918JoinLeaveLatencyTestCaseConfig............................................. 2536
Rfc3918MixedClassThroughputPerIterationResult.................................. 2538
Rfc3918MixedClassThroughputTestCaseConfig..................................... 2541
Rfc3918MulticastForwardingLatencyPerIterationResult.......................... 2546
Rfc3918MulticastForwardingLatencyTestCaseConfig............................. 2550
Rfc3918MulticastGroupCapacityPerIterationResult................................ 2552
Rfc3918MulticastGroupCapacityTestCaseConfig.................................... 2555
Rfc3918ScaledGroupForwardingPerIterationResult................................ 2557
Rfc3918ScaledGroupForwardingTestCaseConfig................................... 2559
Rfc3918SetupAggregatedMulticastThroughputTestCommand................ 2561
Rfc3918SetupJoinLeaveLatencyTestCommand...................................... 2565
Rfc3918SetupMixedClassThroughputTestCommand.............................. 2568
Rfc3918SetupMulticastForwardingLatencyTestCommand...................... 2573
Rfc3918SetupMulticastGroupCapacityTestCommand............................. 2576
Rfc3918SetupScaledGroupForwardingTestCommand............................ 2580
Rfc4814EthIIIfDecorator.......................................................................... 2583
rffId........................................................................................................... 2584
RffId......................................................................................................... 2584
rftId........................................................................................................... 2585
RftId......................................................................................................... 2585
RI............................................................................................................. 2585
rieln.......................................................................................................... 2586
Rieln......................................................................................................... 2586
RingTopologyGenParams........................................................................ 2587
rip1Entries................................................................................................ 2588
Rip1Entry................................................................................................. 2588
rip2Entries................................................................................................ 2588
Rip2Entry................................................................................................. 2589
RipAuthenticationParams........................................................................ 2589
RipDeviceGenProtocolParams................................................................ 2590
Ripng........................................................................................................ 2591
ripngEntries.............................................................................................. 2591
RipngEntry............................................................................................... 2592
RipngRouteParams.................................................................................. 2592
RipngRouterConfig.................................................................................. 2593
RipngStateSummary................................................................................ 2593
RipRouteGenParams............................................................................... 2596
RipRouteGenRouteAttrParams............................................................... 2596
RipRouterConfig...................................................................................... 2597
RipRouterResults..................................................................................... 2598
RipSharedSessionParams....................................................................... 2599
Ripv1........................................................................................................ 2600
Ripv2........................................................................................................ 2600
Ripv4RouteParams.................................................................................. 2601
Ripv4RouterConfig................................................................................... 2602
Ripv4StateSummary................................................................................ 2602
RipViewRoutesCommand........................................................................ 2603
rnnId......................................................................................................... 2604
RnnId....................................................................................................... 2605
RouteGenApplyCommand....................................................................... 2605
RouteGenGetConfigurableRouteCountCommand.................................. 2606
RouteGenGetPrefixLengthDistCommand................................................ 2607
RouteGenSetDefaultsCommand............................................................. 2607
Router...................................................................................................... 2608
RouterAdvertisement............................................................................... 2609
routerAlert................................................................................................ 2610
RouterGenParams................................................................................... 2611
RouterInformationTlv............................................................................... 2612
RouterLsa................................................................................................ 2613
RouterLsaLink.......................................................................................... 2615
routerLsaLinks......................................................................................... 2616
routerLsaOptions..................................................................................... 2616
routerLsaTosMetrics................................................................................. 2617
RouterSolicitation..................................................................................... 2617
RouterTlv................................................................................................. 2618
RoutingResult.......................................................................................... 2621
rpab.......................................................................................................... 2622
Rpab........................................................................................................ 2622
RpcMsg.................................................................................................... 2623
rpfcp......................................................................................................... 2624
Rpfcp........................................................................................................ 2624
rpl............................................................................................................. 2625
Rpl............................................................................................................ 2626
rpli............................................................................................................ 2626
Rpli........................................................................................................... 2626
rplm.......................................................................................................... 2627
Rplm......................................................................................................... 2627
rpln........................................................................................................... 2628
Rpln.......................................................................................................... 2629
rplt............................................................................................................ 2629
Rplt........................................................................................................... 2630
RplyEgr.................................................................................................... 2630
RplyIng..................................................................................................... 2631
rpnId......................................................................................................... 2631
RpnId....................................................................................................... 2632
rptId.......................................................................................................... 2632
RptId........................................................................................................ 2633
rrdy........................................................................................................... 2634
rsnnNn..................................................................................................... 2634
RsnnNn.................................................................................................... 2635
rspnId....................................................................................................... 2635
RspnId...................................................................................................... 2636
rspvIpv6LspSubTlv.................................................................................. 2636
RsvpCustomObject.................................................................................. 2637
RsvpDetourSubObject............................................................................. 2638
RsvpDeviceGenProtocolParams............................................................. 2638
RsvpEgressS2lSubLspParams................................................................ 2639
RsvpEgressTunnelParams...................................................................... 2640
RsvpIngressS2lSubLspParams............................................................... 2642
RsvpIngressTunnelParams...................................................................... 2642
RsvpIpv4EroObject.................................................................................. 2647
RsvpIpv4ExplicitRouteParams................................................................ 2647
rsvpIpv4LspSubTlv.................................................................................. 2648
RsvpIpv4LsrParams................................................................................. 2649
RsvpLspResults....................................................................................... 2649
RsvpMoveEroHopsUnderEroObjectCommand....................................... 2651
RsvpP2MpSubGroupParams.................................................................. 2653
RsvpRouterConfig.................................................................................... 2655
RsvpRouterResults.................................................................................. 2659
RsvpSharedSessionParams.................................................................... 2661
RsvpSharedTunnelHeadEndParams....................................................... 2664
RsvpStateSummary................................................................................. 2665
41
All Objects Index
RsvpSubLspResults................................................................................. 2667
RsvpViewCompressedEROCommand.................................................... 2668
RsvpViewSubLspResultsCommand........................................................ 2669
RtpHeader................................................................................................ 2670
rtrAlert...................................................................................................... 2671
RxCpuPortResults................................................................................... 2674
RxPacketChannelOptions........................................................................ 2676
RxPortPairResults.................................................................................... 2677
RxPortResultFilter.................................................................................... 2685
RxStreamBlockResults............................................................................ 2685
RxStreamResults..................................................................................... 2693
RxStreamSummaryResults..................................................................... 2701
RxTrafficGroupResults............................................................................. 2709
SaaDeviceConfig..................................................................................... 2718
SaaDeviceGenProtocolParams............................................................... 2719
SaaDeviceResults.................................................................................... 2720
SaaPortConfig.......................................................................................... 2721
SaaPortResults........................................................................................ 2722
SaaSessionResults.................................................................................. 2724
SaaShowSessionInfoCommand.............................................................. 2726
SaaStopCommand................................................................................... 2727
SaveAsTclCommand................................................................................ 2727
SaveAsTclWithXmlCommand.................................................................. 2728
SaveAsTemplateCommand..................................................................... 2729
SaveAsXmlCommand.............................................................................. 2730
SaveFilterToLibraryCommand................................................................. 2731
SaveFrameConfigToPduTemplateCommand.......................................... 2731
SaveResultCommand.............................................................................. 2732
SaveSelectedCaptureDataCommand...................................................... 2734
SaveToTccCommand............................................................................... 2735
SawToothPatternDescriptor..................................................................... 2736
security..................................................................................................... 2737
selBrdcast................................................................................................ 2737
SenderIDTLV........................................................................................... 2738
SeqDiffCheckHistogram........................................................................... 2740
seqNums.................................................................................................. 2741
SeqRunLengthHistogram........................................................................ 2741
Sequencer................................................................................................ 2742
SequencerClearCommand...................................................................... 2747
SequencerDisableCommand................................................................... 2748
SequencerEnableCommand.................................................................... 2757
SequencerInsertBreakpointCommand..................................................... 2763
SequencerInsertCommand...................................................................... 2764
SequencerMoveCommand...................................................................... 2767
SequencerPauseCommand..................................................................... 2768
SequencerRemoveBreakpointCommand................................................ 2768
SequencerRemoveCommand................................................................. 2769
SequencerReplaceCommand.................................................................. 2770
SequencerStartCommand....................................................................... 2770
SequencerStepCommand....................................................................... 2771
serverId.................................................................................................... 2774
ServerProfile............................................................................................ 2775
ServiceClass............................................................................................ 2776
ServiceClassParameterThreshold........................................................... 2776
serviceName............................................................................................ 2777
serviceNameError.................................................................................... 2778
SetMstpRegionCommand........................................................................ 2780
SetRelationCommand.............................................................................. 2781
SetRelativesCommand............................................................................ 2782
SetupPortMappingsCommand................................................................. 2784
SetupPortsCommand............................................................................... 2784
simplePassword....................................................................................... 2785
SinusoidPatternDescriptor....................................................................... 2785
SipCalleeProtocolParams........................................................................ 2786
SipCallerProtocolParams......................................................................... 2788
SipCreateDataPlaneCommand............................................................... 2790
SipPortResults......................................................................................... 2791
SipUaProtocolConfig................................................................................ 2794
SipUaProtocolProfile................................................................................ 2797
SipUaResults........................................................................................... 2800
snap......................................................................................................... 2802
snapheader.............................................................................................. 2803
SndrID...................................................................................................... 2804
SonetAlarmsResults................................................................................ 2805
SonetClearStatsCommand...................................................................... 2808
SonetConfig............................................................................................. 2808
SonetGetConfigCommand....................................................................... 2811
SonetInjectOneCommand....................................................................... 2811
SonetInjectorCommand........................................................................... 2812
SonetInjectors.......................................................................................... 2813
SonetPathConfig...................................................................................... 2815
SonetPathInjectors................................................................................... 2816
SonetResetAlarmsCommand.................................................................. 2818
SonetResults............................................................................................ 2818
SonetSetConfigCommand....................................................................... 2820
sourceAddr............................................................................................... 2820
sourcePortsFabricEgressPathInformation............................................... 2825
sourcePortsFabricIngressPathInformation.............................................. 2826
specificIdentificationData......................................................................... 2828
sTag......................................................................................................... 2830
stag8021ad.............................................................................................. 2831
stags........................................................................................................ 2831
StairPatternDescriptor.............................................................................. 2832
startStopUnit............................................................................................ 2833
StartStopUnit............................................................................................ 2833
State......................................................................................................... 2834
StaticChartSeries..................................................................................... 2835
StcSystem................................................................................................ 2835
StepTestConfig......................................................................................... 2836
StpBridgePortConfig................................................................................ 2840
StpDeviceGenProtocolParams................................................................ 2841
StpPortConfig........................................................................................... 2844
StpStateSummary.................................................................................... 2847
StreamBlock............................................................................................. 2850
StreamBlockAutoSelectTunnelCommand................................................ 2858
StreamBlockClearAllTunnelCommand.................................................... 2859
StreamBlockExpandCommand................................................................ 2859
StreamBlockGetInfoCommand................................................................ 2860
StreamBlockGetOffsetReferenceCommand............................................ 2860
StreamBlockGetTunnelCommand........................................................... 2861
StreamBlockLoadProfile.......................................................................... 2862
StreamBlockResultFilter.......................................................................... 2864
StreamBlockSetTrafficPatternCommand................................................. 2864
StreamBlockUpdateCommand................................................................ 2866
StreamCollectionListModifier................................................................... 2868
StreamCollectionRangeModifier.............................................................. 2869
42
All Objects Index
streamId................................................................................................... 2870
StreamThresholdResults......................................................................... 2871
strictSrcRoute.......................................................................................... 2873
SubscribeDynamicResultViewCommand................................................ 2873
SubscribeResultsViewCommand............................................................. 2874
SubTlvs.................................................................................................... 2875
summaryAdditionalMetrics....................................................................... 2876
SummaryLsaBlock................................................................................... 2877
SupportedEndpointType.......................................................................... 2878
SupportedProtocol................................................................................... 2878
SUT.......................................................................................................... 2879
svlans....................................................................................................... 2879
SyncEthDeviceConfig.............................................................................. 2880
SyncEthDeviceResults............................................................................. 2881
SyncEthPortConfig................................................................................... 2885
SyncEthPortResults................................................................................. 2886
SyncEthStateSummary............................................................................ 2886
systemCapabilities................................................................................... 2887
SystemCapabilitiesTlv.............................................................................. 2888
SystemDescriptionTlv.............................................................................. 2889
SystemNameTlv....................................................................................... 2889
TableModifier............................................................................................ 2890
TagList...................................................................................................... 2891
tags.......................................................................................................... 2891
targetFecSubTlvs..................................................................................... 2891
TargetFecSubTlvs.................................................................................... 2891
targetFecTlv............................................................................................. 2892
tcgBandwidth........................................................................................... 2892
Tcp........................................................................................................... 2893
TeLsa....................................................................................................... 2896
TeParams................................................................................................. 2898
Test.......................................................................................................... 2900
TestPattern............................................................................................... 2900
TestResultSetting..................................................................................... 2901
TestTLV.................................................................................................... 2902
TestTLV.................................................................................................... 2902
TextHtmlResponseHeaderConfig............................................................ 2903
theCCMTLVS........................................................................................... 2903
theData.................................................................................................... 2904
theEPID.................................................................................................... 2905
theEPIDL.................................................................................................. 2906
theEPIDLS............................................................................................... 2906
theIPID..................................................................................................... 2907
theIPIDL................................................................................................... 2908
theIPIDLS................................................................................................. 2908
theLBMTLVs............................................................................................ 2908
theLBRTLVs............................................................................................. 2909
theLTMTLVs............................................................................................. 2910
theLTRTLVs............................................................................................. 2910
theManagementAddressDomain............................................................. 2911
theMDN.................................................................................................... 2912
theMDNL.................................................................................................. 2912
thePad...................................................................................................... 2913
thepadData.............................................................................................. 2914
theReservedDataSelect........................................................................... 2914
theTags.................................................................................................... 2915
theValue................................................................................................... 2915
ThroughputTestConfig.............................................................................. 2916
TimedRefreshPauseCommand................................................................ 2921
TimedRefreshResumeCommand............................................................ 2922
TimePropertiesResult.............................................................................. 2923
timestamp................................................................................................ 2925
TimeToLiveTlv.......................................................................................... 2926
TimeToTestConfig.................................................................................... 2927
TLV........................................................................................................... 2927
tlvs............................................................................................................ 2928
topologyInformationDescriptor................................................................. 2928
topologyInformationDescriptors............................................................... 2930
tos............................................................................................................ 2931
tosDiffserv................................................................................................ 2933
tracert....................................................................................................... 2934
TrafficClassesSupportedTlv..................................................................... 2935
TrafficDescriptor....................................................................................... 2936
TrafficDescriptorGroup............................................................................. 2941
TrafficDescriptorResult............................................................................. 2942
TrafficGroup............................................................................................. 2943
TrafficGroupBurstSizeProfile................................................................... 2944
TrafficGroupCodePointTag...................................................................... 2945
TrafficGroupDcbLoadSearchProfile......................................................... 2946
TrafficGroupFrameSizeProfile................................................................. 2947
TrafficGroupLoadSizeProfile.................................................................... 2949
TrafficGroupWeightProfile........................................................................ 2952
TrafficOptions........................................................................................... 2953
TrafficPathInfo.......................................................................................... 2953
TreeTopologyGenParams........................................................................ 2954
TwampAcceptSession.............................................................................. 2955
TwampClientConfig.................................................................................. 2955
TwampClientResults................................................................................ 2957
TwampPortTestSessionResults............................................................... 2958
TwampReflectorPackets.......................................................................... 2959
TwampRequestSession........................................................................... 2960
TwampSenderPackets............................................................................. 2962
TwampServerConfig................................................................................ 2962
TwampServerGreeting............................................................................. 2963
TwampServerResults............................................................................... 2964
TwampServerStart................................................................................... 2965
TwampSetupResponse............................................................................ 2965
TwampStartSession................................................................................. 2966
TwampStartSessionAcknowledge........................................................... 2967
TwampStateSummary.............................................................................. 2968
TwampStopSession................................................................................. 2969
TwampTestSession.................................................................................. 2970
TwampTestSessionResults...................................................................... 2972
TxCpuPortResults.................................................................................... 2972
txerrorestimate......................................................................................... 2975
TxPacketChannelOptions........................................................................ 2975
TxPortPairResults.................................................................................... 2976
TxStreamBlockResults............................................................................. 2977
TxStreamResults..................................................................................... 2978
TxTrafficGroupResults............................................................................. 2980
Udp.......................................................................................................... 2981
uni............................................................................................................ 2984
UnMapPortCommand.............................................................................. 2985
UnsubscribeDynamicResultViewCommand............................................ 2986
updatedLsas............................................................................................ 2986
UpdateDynamicResultViewCommand..................................................... 2986
UpdateMplsBindingsCommand............................................................... 2987
UploadFileCommand............................................................................... 2987
upstreamNbr............................................................................................ 2988
UserNote.................................................................................................. 2990
ValidateConfigCommand......................................................................... 2991
ValidateFilterExpressionCommand.......................................................... 2992
value........................................................................................................ 2992
Value........................................................................................................ 2993
Value........................................................................................................ 2994
ValueEventMessageChartSeries............................................................. 2994
VarDescTLV............................................................................................. 2994
VariableContainer.................................................................................... 2995
VariableDescriptor.................................................................................... 2995
VariableRequestOAMPDU....................................................................... 2995
VariableResponseOAMPDU.................................................................... 2996
VarRepoTLV............................................................................................. 2996
VcFecInfo................................................................................................. 2996
VcLsp....................................................................................................... 2998
VcMuxBridgedEth8023............................................................................ 3001
vendorEnterpriseNumberTlv.................................................................... 3002
vendorEscID............................................................................................ 3002
vendorID.................................................................................................. 3004
vendorSpecific......................................................................................... 3005
verf........................................................................................................... 3005
verify10.................................................................................................... 3006
Verify10.................................................................................................... 3007
VerifyResultsValueCondition.................................................................... 3008
43
All Objects Index
VFT.......................................................................................................... 3010
VicAdapterConfig..................................................................................... 3011
VicAdapterResults................................................................................... 3012
VicCreateVifsCommand........................................................................... 3014
VicFindVicsCommand.............................................................................. 3016
VicFindVifsCommand.............................................................................. 3017
VicGlobalConfig....................................................................................... 3018
VicLinkVifsCommand............................................................................... 3019
VicResetTlvsToDefaultsCommand.......................................................... 3019
VideoClientProtocolConfig....................................................................... 3020
VideoClientResults................................................................................... 3022
VideoClipDeleteCommand....................................................................... 3024
VideoClipDownloadCommand................................................................. 3024
VideoClipsEnumerateCommand.............................................................. 3025
VideoProtocolParams.............................................................................. 3025
VideoServerProtocolConfig...................................................................... 3027
VideoServerResults................................................................................. 3028
VideoServerSessions............................................................................... 3029
VideoServerStream.................................................................................. 3030
ViewControlPlaneMplsBindingCommand................................................ 3031
ViewControlPlaneMplsBindingResult....................................................... 3031
ViewFlappableEventsCommand.............................................................. 3033
ViewMplsBindingsCommand................................................................... 3034
ViewMplsBindingsSummaryCommand.................................................... 3034
VifConfig.................................................................................................. 3035
VifIdTLV.................................................................................................... 3036
VifResults................................................................................................. 3036
VifStateTLV.............................................................................................. 3037
VifToVicLink............................................................................................. 3038
VirtualMachineMacTlv.............................................................................. 3039
VirtualMachineNameTlv........................................................................... 3039
VirtualMachineUuidTlv............................................................................. 3040
Vlan (ethernet PDU library)...................................................................... 3040
VlanBlock................................................................................................. 3041
vlanDescriptor.......................................................................................... 3042
VlanIf........................................................................................................ 3043
VlanNameTlv........................................................................................... 3045
vlans......................................................................................................... 3046
VlanSwitchLink......................................................................................... 3046
VmWare................................................................................................... 3047
VmWareSubTlvList.................................................................................. 3048
vNicUuidTlv.............................................................................................. 3048
VNTag...................................................................................................... 3048
vntags...................................................................................................... 3049
vpi............................................................................................................ 3049
VplsBgpCeToPeLink................................................................................ 3050
VplsLdpCeToPeLink................................................................................. 3051
Vpn6PeGenCorePortParams.................................................................. 3052
Vpn6PeGenCustPortParams................................................................... 3052
Vpn6PeGenParams................................................................................. 3053
Vpn6PeSiteGenParams........................................................................... 3065
VpnAvailableMembersCommand............................................................ 3066
VpnBgpVplsGenCorePortParams........................................................... 3067
VpnBgpVplsGenCustPortParams............................................................ 3067
VpnBgpVplsGenParams.......................................................................... 3068
VpnBgpVplsSiteGenParams.................................................................... 3078
VpnCreateSitesCommand....................................................................... 3079
VpnGenConfigExpandCommand............................................................ 3080
VpnGenUpdateAvailablePortsCommand................................................ 3080
VpnIdGroup.............................................................................................. 3081
VpnIgpIsisSessionParams....................................................................... 3081
VpnIgpOspfv2SessionParams................................................................. 3083
VpnInfo6Pe.............................................................................................. 3085
VpnInfoPwe3............................................................................................ 3086
VpnInfoRfc2547....................................................................................... 3086
VpnInfoVpls.............................................................................................. 3087
VpnLdpVplsGenCorePortParams............................................................ 3088
VpnLdpVplsGenCustPortParams............................................................ 3089
VpnLdpVplsGenParams.......................................................................... 3089
VpnLdpVplsSiteGenParams.................................................................... 3103
VpnLspPingGenIpv4CoreParams............................................................ 3104
VpnLspPingGenIpv4VpnParams............................................................. 3105
VpnMartiniGenCorePortParams.............................................................. 3106
VpnMartiniGenCustPortParams.............................................................. 3107
VpnMartiniGenParams............................................................................. 3107
VpnMplsLdpSessionParams.................................................................... 3120
VpnMplsRsvpSessionParams................................................................. 3122
VpnRfc2547GenCorePortParams........................................................... 3124
VpnRfc2547GenCustPortParams............................................................ 3125
VpnRfc2547GenParams.......................................................................... 3125
VpnRfc2547SiteGenParams.................................................................... 3138
VpnSiteGenConfigExpandCommand...................................................... 3139
VpnSiteInfo6Pe........................................................................................ 3139
VpnSiteInfoRfc2547................................................................................. 3140
VpnSiteInfoVplsBgp................................................................................. 3141
VpnSiteInfoVplsLdp................................................................................. 3143
VqAnalyzer............................................................................................... 3145
VqAnalyzerChannelMembershipGenParams.......................................... 3148
VqAnalyzerGenConfigExpandCommand................................................ 3149
VqAnalyzerGenParams........................................................................... 3150
VqAnalyzerOptions.................................................................................. 3151
VqAnalyzerPassivePortGenParams........................................................ 3152
VqAnalyzerPortGenParams..................................................................... 3154
VqAnalyzerTunablePortGenParams........................................................ 3156
VqAnalyzerUnicastDeviceGenParams.................................................... 3157
VqAudioStreamResults............................................................................ 3158
VqDeviceChannelBlock........................................................................... 3163
VqDynamicPayloadConfig....................................................................... 3164
VqProbeChannelBlock............................................................................. 3165
VqVideoStreamResults............................................................................ 3167
VrfCustomerLink...................................................................................... 3179
VrfProviderLink........................................................................................ 3180
vxPortId.................................................................................................... 3180
WaitCommand......................................................................................... 3181
WildcardPreviewCommand..................................................................... 3186
Wimax16dPhy.......................................................................................... 3187
WimaxIf.................................................................................................... 3191
write10..................................................................................................... 3194
Write10..................................................................................................... 3194
write6....................................................................................................... 3195
Write6....................................................................................................... 3196
writeAndVerify10...................................................................................... 3196
WriteAndVerify10..................................................................................... 3197
writeBuffer................................................................................................ 3198
WriteBuffer............................................................................................... 3199
writeLong10............................................................................................. 3199
WriteLong10............................................................................................. 3200
xdRead10................................................................................................. 3201
XDRead10............................................................................................... 3202
xdWrite10................................................................................................. 3202
XDWrite10................................................................................................ 3203
xpWrite10................................................................................................. 3204
XPWrite10................................................................................................ 3205
zoningEnforcementStatusObjects........................................................... 3206
44
Aal5
Aal5 (aal5If:Aal5)
Description:
Parents: StreamBlock
Children: vpi
Next headers: ipv4:IPv4, ipv6:IPv6, aal5:LlcRoutedSnap, aal5:LlcRoutedNlpid, aal5:LlcBridgedEth8023, aal5:VpnEncap, aal5:VcMuxBridgedEth8023, ppp:PPP,
custom:Custom
Aal5 Attributes
Attribute
Description
clp
Type: clpBoolean
Default: 0
Possible Values:
Value Description
encapsulation
False
True
Type: vcEncapsulation
Default: 1
Possible Values:
Value Description
1
VC Multiplexed
LLC Encapsulated
Name
A text name for the object. This attribute is required when you use stream block modifiers such as RangeModifier,
RandomModifier, and TableModifier. See the description of the OffsetReference attribute for these modifier objects for more
information.
Type: string
pti
Type: ptiValue
Default: 0
Possible Values:
Value Description
vci
User Data, Uncongested
User Data, Congested
Management, Uncongested
Management, Congested
Type: INTEGER
Default: 32
Aal5If
Description:
ATM AAL5 interface object.
Writable Attributes | Read-Only Attributes

Parents: EmulatedDevice, ExternalDevice, ExternalDevicePort, Host, Port, Router, SUT
Children: MplsGeneralizedPwBindInfo, MplsIpv4PrefixBindInfo, MplsIpv4VpnBindInfo, MplsIpv6PrefixBindInfo, MplsIpv6VpnBindInfo, MplsRsvpTunnelBindInfo,
MplsVcBindInfo, MplsVplsBindInfo, Rfc4814EthIIIfDecorator
Relations:
45
Aal5If
Side name
(Type)
Relative
Description
ApplicableOnPhy
(ApplicableOnPhy)
AtmPhy
Specifies physical layer compatibility
DstBoundTo
(DstBinding)
PathDescriptor, StreamBlock, TrafficDescriptor
Specifies destination endpoints bound to

StreamBlock.
EncapsulationSource
(Encapsulation)
PathDescriptor
Specifies the encapsulation.
NetworkLink
(LinkSrc)
CustomLink, CustomLink, EoamLink, EoamLink, EthernetBridgeLink,

EthernetBridgeLink, IpForwardingLink, IpForwardingLink, ItagServiceLink,
ItagServiceLink, MplsForwardingLink, MplsForwardingLink,
MplsHierarchicalLink, MplsHierarchicalLink, MplsIpv4VpnCeToPeLink,
MplsIpv4VpnCeToPeLink, MplsIpv6VpnCeToPeLink,
MplsIpv6VpnCeToPeLink, MplsL2VpnPeToPLink, MplsL2VpnPeToPLink,
MplsL3VpnPeToPLink, MplsL3VpnPeToPLink, MVpnGreCeToPeLink,
MVpnGreCeToPeLink, MVpnGrePeToPLink, MVpnGrePeToPLink,
VifToVicLink, VifToVicLink, VlanSwitchLink, VlanSwitchLink,
VplsBgpCeToPeLink, VplsBgpCeToPeLink, VplsLdpCeToPeLink,
VplsLdpCeToPeLink
MemberOfVpn
(MemberOfVpn)
VpnIdGroup, VpnSiteInfo6Pe, VpnSiteInfoRfc2547, VpnSiteInfoVplsBgp,

VpnSiteInfoVplsLdp
Do not use, to be removed
MulticastExpectedRxPorts
(MulticastExpectedRxPorts)
Port
Traffic sent to this end point is expected

to be received as multicast traffic by any
of the ports connected through this
relation.
OptionallyStackedUnder
(OptionallyStackedOnEndpoint)
Aal5If, Dhcpv4ServerDefaultPoolConfig, Dhcpv4ServerPoolConfig,

Dhcpv6ServerAddrPoolConfig, Dhcpv6ServerDefaultAddrPoolConfig,
Dhcpv6ServerDefaultPrefixPoolConfig, Dhcpv6ServerPrefixPoolConfig, EthIIIf,
FcIf, GreIf, HdlcIf, Ipv4If, Ipv4NetworkBlock, Ipv6If, Ipv6NetworkBlock, ItagIf,
L2tpv2If, MacBlock, MplsIf, Pimv4JoinSrc, Pimv4PruneSrc, Pimv6JoinSrc,
Pimv6PruneSrc, PppIf, PppoeIf, PppoeServerIpv4PeerPool,
PppoxServerIpv4PeerPool, PppoxServerIpv6PeerPool, VlanBlock, VlanIf,
WimaxIf
Specifies an optionally-selected lower

interface in the stack. Selection is
controlled by protocol implementations
which decide based on other criteria
whether they should include the target
interface in their stack.
PrimaryIfSource
(PrimaryIf)
EmulatedDevice, ExternalDevice, ExternalDevicePort, Host, Port, Router,

SUT
Specifies if a top-level interface is facing

the DUT.
RelayBlockConfig
(RelayIf)
Dhcpv4BlockConfig, Dhcpv4BlockConfig
(ResolvesInterface)
BgpRouterConfig, LdpRouterConfig, RsvpIngressTunnelParams,

RsvpRouterConfig
Use this to link the traffic binding

interfaces and traffic binding resolver.
SrcBoundTo
(SrcBinding)
Specifies the source endpoint bound to

StreamBlock.
StackedOn
(StackedOnEndpoint)

WimaxIf
Specifies network endpoint stacking.
TopLevelIfSource
(TopLevelIf)

SUT
Specifies the top-level interface in the

interface stack.
UnicastExpectedRxPorts
(UnicastExpectedRxPorts)
Port

to be received as unicast traffic by any of
the ports connected through this relation.
46
Aal5If
Side name
(Type)
Relative
Description
UsesIfSource
(UsesIf)
AncpAccessNodeConfig, BfdRouterConfig, BridgePortConfig,

Dhcpv4BlockConfig, Dhcpv4ServerConfig, Dhcpv6BlockConfig,
Dhcpv6PdBlockConfig, Dhcpv6ServerConfig, Dot1xSupplicantBlockConfig,
EoamNodeConfig, FcEPortConfig, FcFPortConfig, FcHostConfig,
FcoeHostConfig, FcoeVePortConfig, FcoeVfPortConfig,
FtpClientProtocolConfig, FtpServerProtocolConfig, HttpClientProtocolConfig,
HttpServerProtocolConfig, Ieee1588v2ClockConfig, IgmpHostConfig,
IgmpRouterConfig, IsisRouterConfig, L2tpv2BlockConfig, LacpPortConfig,
LinkOamRouterConfig, LldpNodeConfig, LspPingProtocolConfig,
MldHostConfig, MldRouterConfig, Ospfv2RouterConfig, Ospfv3RouterConfig,
PacketChannel, PimRouterConfig, PppoaClientBlockConfig,
PppoaServerBlockConfig, PppoeClientBlockConfig, PppoeServerBlockConfig,
PppoL2tpv2ClientBlockConfig, PppoL2tpv2ServerBlockConfig,
PppProtocolConfig, RawTcpClientProtocolConfig,
RawTcpServerProtocolConfig, RipRouterConfig, SaaDeviceConfig,
SipUaProtocolConfig, SyncEthDeviceConfig, TwampClientConfig,
TwampServerConfig, VicAdapterConfig, VideoClientProtocolConfig,
VideoServerProtocolConfig, VifConfig
Specifies the interfaces used by the

configuration object (configuration object
examples: BgpRouterConfig,
LdpRouterConfig, and so on).
Aal5If Writable Attributes

Writable Attribute
Description
Common Writable Attributes
Active, Name
Clp
Cell loss priority.

Type: u8
Default: 0
Range: 0 - 1
Cpi
Common part indicator.

Type: u8
Default: 0
Gfc
Generic flow control.

Type: u8
Default: 0
Range: 0 - 15
IfCountPerLowerIf
Number of interfaces in this interface object.

Type: u32
Default: 1
IfRecycleCount
Number of times to increment the VPI before returning to the starting value. See IsRange for more information.
Type: u32
Default: 0
IsLoopbackIf
Whether this is a loopback interface.

Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
This is a loopback interface.
FALSE This is not a loopback interface.

IsRange
Method to use for creating VCIs and VPIs. You can generate a range or specify a list (VciList and VpiList).
Type: bool
Default: TRUE
Possible Values:
Value Description
TRUE
Generate a range of VCIs and VPIs using a combination of attributes as follows:

VCIs: Vci, VciRepeatCount, VciStep, VciStepMask, VciRecycleCount.
VPIs: Vpi, VpiRepeatCount, VpiStep, VpiStepMask, IfRecycleCount.
FALSE Use VciList and VpiList to specify VCIs and VPIs.
47
Aal5If
Writable Attribute
Description
PtiCell
Payload type identifier (user data cell/management cell).

Type: u8
Default: 0
Range: 0 - 1
PtiCongestion
Payload type identifier (explicit forward congestion indication).

Type: u8
Default: 0
Range: 0 - 1
Uu
User-to-user indication.
Type: u8
Default: 0
VcEncapsulation
VC encapsulation to use.
Type: enum
Default: VC_MULTIPLEXED
Possible Values:
Value
Description
VC_MULTIPLEXED
VC multiplexed.
LLC_ENCAPSULATED LLC encapsulated.

Vci
Virtual channel indicator. You can generate more than one VCI by using combinations of Vci, VciRepeatCount, VciStep,
VciStepMask, and VciRecycleCount. If you do that, then Vci is the starting point.
To use this attribute, the IsRange attribute must be TRUE (the default).
Type: u16
Default: 32
Range: 0 - 65535
VciList
A list of virtual channel indicators. To use this attribute, IsRange must be FALSE.
Type: u16
Default: 0
VciRecycleCount
Number of times to increment the VCI before returning to the starting value. See IsRange for more information.
Type: u32
Default: 0
VciRepeatCount
How many times to repeat the virtual channel indicator (VCI) before incrementing it. See IsRange for more information.
Type: u32
Default: 0
VciStep
Step value for generated VCIs. See IsRange for more information.
Type: s16
Default: 1
VciStepMask
VCI step mask. Indicates which parts of the VCI will change when incremented. See IsRange for more information.
Type: u16
Default: 65535
Vpi
Virtual path indicator. You can generate more than one VPI by using combinations of Vpi, VpiRepeatCount, VpiStep,
VpiStepMask, and IfRecycleCount. If you do that, then Vpi is the starting point.
To use this attribute, the IsRange attribute must be TRUE (the default).
Type: u16
Default: 0
Range: 0 - 4095
VpiList
A list of virtual path indicators. To use this attribute, IsRange must be FALSE.
Type: u16
Default: 0
VpiRepeatCount
How many times to repeat the virtual path indicator (VPI) before incrementing it. See IsRange for more information.
Type: u32
Default: 0
VpiStep
Step value for generated VPIs. See IsRange for more information.
Type: s16
Default: 1
48
AbstPppoeDeviceGenProtocolParams
Writable Attribute
Description
VpiStepMask
VPI step mask. Indicates which parts of the VPI will change when incremented. See IsRange for more information.
Type: u16
Default: 255
Aal5If Read-Only Attributes

Read-Only Attribute
Description
EffectiveBlockCount
Effective block count.

Type: u32
Default: 1
IfState
Interface state.
Type: enum
Default: DISABLED
Possible Values:
Value
Description
READY
Ready.
DISABLED
Not ready.
DELETING
Marked for delete.
PARTIALLY_READY Partially ready.
Description:
Specifies the PPPoE specific Host generator parameters.

Parents: EmulatedDeviceGenParams, HostGenParams, RouterGenParams
Children: DeviceGenLinkedStep
AbstPppoeDeviceGenProtocolParams Writable Attributes

Writable Attribute
Description
Active, Name
AcName
Set the Access Concentrator name in the PADO messages.

Type: string
Default: SpirentTestCenter
Range: 1 - 64 characters
Authentication
Select type of authentication to use.

Type: enum
Default: NONE
Possible Values:
Value
Description
NONE
No authentication.
AUTO
Sessions are authenticated by the protocol specified by the DUT (PAP or CHAP).
CHAP_MD5 Sessions are authenticated using CHAP.

PAP
Sessions are authenticated using PAP.
49
Writable Attribute
Description
AutoRetryCount
Maximum number of automatic retry attempts.

Type: u16
Default: 65535
Range: 1 - 65535
CircuitId
Enabled for DSL-type relay agents only. The circuit ID can be used to encode a local identifier for the circuit that received
a PPP packet from a client, destined for the access concentrator. Use wildcard characters to make each circuit ID unique:
@s - Session index associated with the PPPoX client.
@b - Block (host/router) index.
@p - Port name.
@m - MAC address of the PPPoX client.
@x - Custom step setup in (start,count,step,zeropadding,stutter) format.
start - starting value.
count - number of values to generate.
step - amount to increment the start value when the start value must be stepped.
zeropadding - length the value should be padded to by prepending 0's.
stutter - number of times a value should be repeated before applying the step.
@@ - This must be used to include the textual "@" symbol in the string.
Type: string
Default: circuit @s
EchoRequestGenFreq
Interval in seconds between sending out consecutive echo requests.

Type: u16
Default: 10
Range: 0 - 65535
EmulationType
PPPoX node emulation type.

Type: enum
Default: CLIENT
Possible Values:
Value
Description
CLIENT
All nodes under this port will run PPPoX client emulation.
SERVER All nodes under this port will run PPPoX server emulation.
EnableAutoRetry
Enable or disable automatic retry to connect failed PPP sessions.

Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
Enable automatic retry.
FALSE Disable automatic retry.

EnableEchoRequest
Enable echo requests.

Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
Enable transmission of echo requests.
FALSE Disable transmission of echo requests.

EnableMaxPayloadTag
Enables the PPP-Max-Payload-Tag (see RFC 4638).

Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
Enable the Max Payload Tag.
FALSE Disable the Max Payload Tag.
50
Writable Attribute
Description
EnableRelayAgent
Enable or disable the relay agent.

Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
Enable the relay agent.
FALSE Disable the relay agent.

IncludeRelayAgentInPadi
Include the relay agent tags in transmitted PADI messages.

Type: bool
Default: TRUE
Possible Values:
Value Description
TRUE
Include relay agent tags in PADI message.
FALSE Do not include relay agent tags in PADI message.

IncludeRelayAgentInPadr
Include the relay agent tags in transmitted PADR messages.

Type: bool
Default: TRUE
Possible Values:
Value Description
TRUE
Include relay agent tags in PADR message.
FALSE Do not include relay agent tags in PADR message.

IncludeTxChapId
Include or exclude the Identifier field of the Challenge message.

Type: bool
Default: TRUE
Possible Values:
Value Description
TRUE
Include the Identifier field.
FALSE Do not include the Identifier field.

IpcpEncap
Enable IPv6CP or IPv4CP. Must have at least one enabled.

Type: enum
Default: IPV4
Possible Values:
Value Description
IPV4
Enable IPv4 addressing.
IPV6
IPV4V6 Enable IPv4 and IPv6 addressing on the same PPP link.
Ipv4AddrPoolCount
Number of IPv4 addresses in the PPPoX server's pool.

Type: u16
Default: 1
Range: 1 - 65535
Ipv4AddrPoolStart
Starting IPv4 address for the PPPoX server's pool.

Type: ip
Default: 192.0.1.0
Ipv4AddrPoolStep
Step IPv4 address for the PPPoX server's pool.

Type: u16
Default: 1
Ipv6AddrPoolCount
Number of addresses in the address pool.

Type: u16
Default: 1
Range: 1 - 65535
Ipv6AddrPoolIntIdStart
IPv6 address pool Interface ID (lower 64 bits) start.

Type: ipv6
Default: ::2
51
Writable Attribute
Description
Ipv6AddrPoolIntIdStep
IPv6 address pool Interface ID (lower 64 bits) step.

Type: ipv6
Default: ::1
Ipv6AddrPoolPrefixStart
IPv6 address pool prefix (upper 64 bits) start.

Type: ipv6
Default: 2001::
Ipv6AddrPoolPrefixStep
IPv6 address pool prefix (upper 64 bits) step.

Type: ipv6
Default: 0:0:0:1::
MaxEchoRequestAttempts
Number of consecutive, unanswered echo requests to send before failing the subscriber session.
Type: u16
Default: 0
Range: 0 - 65535
MaxPayloadBytes
Maximum number of PPP payload bytes the client can transmit and receive. This value will be used in the
PPP-Max-Payload tag in PPPoE Active Discovery Initialized (PADI) and PPPoE Active Discovery Request (PADR)
messages.
Type: u16
Default: 1500
Range: 0 - 65535
PadiMaxAttempts
Maximum number of PADI packets that can be sent, without acknowledgment, before a session fails.
Type: u16
Default: 10
Range: 1 - 65535
PadiTimeout
Timeout value in seconds for acknowledgment of a PADI packet.

Type: u16
Default: 3
Range: 1 - 65535
PadrMaxAttempts
Maximum number of PADR packets that can be sent, without acknowledgment, before a session fails.
Type: u16
Default: 10
Range: 1 - 65535
PadrTimeout
Timeout value in seconds for acknowledgment of a PADR packet.

Type: u16
Default: 3
Range: 1 - 65535
Password
Password for authenticated PPP sessions. Use wildcard characters to make each password unique:
@p - Port name.
Type: string
Default: spirent
RelayAgentMacAddr
Enabled for RFC 2516-type relay agents only. The Relay Agent MAC address is the MAC address of the next hop from
the subscriber client group to the access concentrator.
Type: mac
Default: "" (empty string)
52
AcceptedReply
Writable Attribute
Description
RelayAgentType
Select the type of relay agent.

Type: enum
Default: RFC_2516
Possible Values:
Value
Description
RFC_2516
Use the RFC 2516-type relay agent.
DSL_FORUM Use the DSL-type relay agent.

RemoteOrSessionId
Remote ID or session ID depending on the relay agent type. Use wildcard characters to make each ID unique:
@p - Port name.
Type: string
Default: remote @m-@p-@b
ServiceName
Indicates the service to which will be connected (per RFC 2516). If the cell is left blank, any service is acceptable.
Type: string
Username
User name for authenticated PPP sessions. Use wildcard characters to make each user name unique:
@p - Port name.
Type: string
Default: spirent
AbstPppoeDeviceGenProtocolParams Read-Only Attributes

There are no read-only attributes.
AcceptedReply (oncrpcv2:AcceptedReply)
Description:
Children: verf
Next headers: oncrpcv2:MismatchInfo, custom:Custom
53
AccessAggregationCircuitIdAsciiTlv
AcceptedReply Attributes
Attribute
Description
Name
A text name for the object. This attribute is required when you use stream block modifiers such as RangeModifier, RandomModifier,
and TableModifier. See the description of the OffsetReference attribute for these modifier objects for more information.
Type: string
stat
Type: AcceptStat
Default: 0
Possible Values:
Value Description
0
SUCCESS
PROG_UNAVAIL
PROG_MISMATCH
PROC_UNAVAIL
GARBAGE_ARGS
SYSTEM_ERR
(ancp_draft0:AccessAggregationCircuitIdAsciiTlv)
Description:
Children: None
Next headers: ancp_draft0:CustomTlv, ancp_draft0:AccessLoopCircuitIdTlv, ancp_draft0:AccessAggregationCircuitIdAsciiTlv,
ancp_draft0:AccessAggregationCircuitIdBinaryVlanTlv, ancp_draft0:AccessAggregationCircuitIdBinaryAtmTlv
AccessAggregationCircuitIdAsciiTlv Attributes
Attribute
Description
ID
Type: ASCII
Default: Access-Node-Identifier eth slot/port :vlan1:vlan2
Length
Type: INTEGER
Default: 0
MessageSelect
Type: MessageSelectValues
Default: 3
Possible Values:
Value Description
1
Port Up
Port Down
Port Up, Port Down
Name
RandomModifier, and TableModifier. See the description of the OffsetReference attribute for these modifier objects for
more information.
Type: string
Pad
Type: ALIGNMENTPAD
Default: 0
Type
Type: OCTETSTRING
Default: 0003
54
(ancp_draft2:AccessAggregationCircuitIdAsciiTlv)
Description:
Children: None
Next headers: ancp_draft2:CustomTlv, ancp_draft2:AccessLoopCircuitIdTlv, ancp_draft2:AccessLoopRemoteIdTlv, ancp_draft2:AccessAggregationCircuitIdAsciiTlv,
AccessAggregationCircuitIdAsciiTlv Attributes
Attribute
Description
ID
Type: ASCII
Default: Access-Node-Identifier eth slot/port :vlan1:vlan2
Length
Type: INTEGER
Default: 0
MessageSelect
Default: 3
Possible Values:
Value Description
1
Port Up
Port Down
Port Up, Port Down
Name
more information.
Type: string
Pad
Type: ALIGNMENTPAD
Default: 0
Type
Type: OCTETSTRING
Default: 0003
AccessAggregationCircuitIdBinaryAtmTlv
(ancp_draft0:AccessAggregationCircuitIdBinaryAtmTlv)
Description:
Children: None
AccessAggregationCircuitIdBinaryAtmTlv Attributes
Attribute
Description
Length
Type: INTEGER
Default: 8
55
Attribute
Description
MessageSelect
Default: 3
Possible Values:
Value Description
1
Port Up
Port Down
Port Up, Port Down
Name
RandomModifier, and TableModifier. See the description of the OffsetReference attribute for these modifier objects
for more information.
Type: string
Type
Type: OCTETSTRING
Default: 0002
Vci
Type: INTEGER
Default: 0
Vpi
Type: INTEGER
Default: 0
(ancp_draft2:AccessAggregationCircuitIdBinaryAtmTlv)
Description:
Children: None
AccessAggregationCircuitIdBinaryAtmTlv Attributes
Attribute
Description
Length
Type: INTEGER
Default: 8
MessageSelect
Default: 3
Possible Values:
Value Description
1
Port Up
Port Down
Port Up, Port Down
Name
Type: string
Type
Type: OCTETSTRING
Default: 0006
Vci
Type: INTEGER
Default: 0
56
AccessAggregationCircuitIdBinaryVlanTlv
Attribute
Description
Vpi
Type: INTEGER
Default: 0
(ancp_draft0:AccessAggregationCircuitIdBinaryVlanTlv)
Description:
Children: None
AccessAggregationCircuitIdBinaryVlanTlv Attributes
Attribute
Description
Length
Type: INTEGER
Default: 8
MessageSelect
Default: 3
Possible Values:
Value Description
1
Port Up
Port Down
Port Up, Port Down
Name
Type: string
Type
Type: OCTETSTRING
Default: 0002
Vlan1
Type: INTEGER
Default: 0
Vlan2
Type: INTEGER
Default: 0
(ancp_draft2:AccessAggregationCircuitIdBinaryVlanTlv)
Description:
Children: None
57
AccessConcentratorGenConfigExpandCommand
AccessAggregationCircuitIdBinaryVlanTlv Attributes
Attribute
Description
Length
Type: INTEGER
Default: 8
MessageSelect
Default: 3
Possible Values:
Value Description
1
Port Up
Port Down
Port Up, Port Down
Name
Type: string
Type
Type: OCTETSTRING
Default: 0006
Vlan1
Type: INTEGER
Default: 0
Vlan2
Type: INTEGER
Default: 0
AccessConcentratorGenConfigExpandCommand
Description:
Expands the AccessConcentratorGenParams object into the Access Concentrator (Asymmetric Performance Test Package) test configuration.

Can be used with Command Sequencer: No
Parents: Sequencer, StcSystem
AccessConcentratorGenConfigExpandCommand Writable Attributes

Writable Attribute
Description
ExecuteSynchronous, ProgressCancelled
ClearExisting
Currently unsupported. Clear existing configuration (Hosts, StreamBlocks, and so on) before expanding.
Type: enum
Default: PROMPT
Possible Values:
Value
Description
PROMPT Display a prompt to the user.
GenParams
YES
Clear existing configuration.
NO
Do not clear existing configuration.
AccessConcentratorGenParams handle to expand.

Type: handle
Default: 0
58
AccessConcentratorGenParams
AccessConcentratorGenConfigExpandCommand Read-Only Attributes

Read-Only Attribute
Description
Common Read-Only Attributes
ElapsedTime, EndTime, ProgressCurrentStep, ProgressCurrentStepName, ProgressCurrentValue,

ProgressDisplayCounter, ProgressMaxValue, ProgressStepsCount, StartTime, State, Status
AccessConcentratorGenParams
Description:
The AccessConcentratorGenParams specifies the Access Concentrator (Asymmetric Performance Test Package) specific test parameters.

Parents: Project
Children: EmulatedDeviceGenParams, HostGenParams, Rfc2544BackToBackFramesConfig, Rfc2544FrameLossConfig, Rfc2544LatencyConfig,
Rfc2544ThroughputConfig, RouterGenParams
AccessConcentratorGenParams Writable Attributes

Writable Attribute
Description
Active, Name
DownstreamTrafficIpTos
Downstream traffic IP Type of Service as an integer.

Type: u8
Default: 0
DownstreamTrafficVlanPriority
Downstream traffic VLAN priority as an integer.

Type: u8
Default: 0
IpNextProtocolId
Specify the IP Next Protocol IDs (list of ints).

Type: u8
Default: 0
TrafficConfigMode
Specifies how traffic and streamblocks will be created.

Type: enum
Default: AUTO
Possible Values:
Value
Description
AUTO
Traffic and streamblocks will be created automatically based on created host blocks.
MANUAL Traffic and streamblocks will be specified manually. Note that they must be created outside of
AccessConcentrator and before AccessConcentratorGenParams can be expanded.
TrafficConnectivity
Specifies how the traffic connections will be created.

Type: enum
Default: FULL
Possible Values:
Value Description
FULL Each endpoint on one side will send to all endpoints on the opposite side.
PAIR Each endpoint on one side will send to one other endpoint on the opposite side.
TrafficDevices
Select which type of devices to use when configuring traffic.

Type: enum
Default: EDGE
Possible Values:
Value Description
ALL
Use all devices.
EDGE Use edge devices only.
59
AccessConcentratorGenUpdateTrafficCommand
Writable Attribute
Description
TrafficFlow
Specifies how the traffic flows will be created.

Type: enum
Default: BIDIRECTIONAL
Possible Values:
Value
Description
BIDIRECTIONAL
Traffic will flow bidirectionally between upstream and downstream sides.
DOWNSTREAM_TO_UPSTREAM Traffic will flow from the downstream side to the upstream side only.
UPSTREAM_TO_DOWNSTREAM Traffic will flow from the upstream side to the downstream side only.
Ttl
Specifies the time to live.

Type: u8
Default: 10
Range: 0 - 255
UpstreamTrafficIpTos
Upstream traffic IP Type of Service as an integer.

Type: u8
Default: 0
UpstreamTrafficVlanPriority
Upstream traffic VLAN priority as an integer.

Type: u8
Default: 0
AccessConcentratorGenParams Read-Only Attributes

AccessConcentratorGenUpdateTrafficCommand
Description:
Updates the auto-generated StreamBlocks using the specified AccessConcentratorGenParams object. This command should only be used when the
TrafficConfigMode is set to AUTO.

AccessConcentratorGenUpdateTrafficCommand Writable Attributes

Writable Attribute
Description
EnableFrameConfigUpdate
Enables update of the StreamBlock frame configuration.

Type: bool
Default: TRUE
Possible Values:
Value Description
TRUE
Enable frame config update.
FALSE Disable frame config update.

GenParams
Handle of the AccessConcentratorGenParams used to update traffic.

Type: handle
Default: 0
60
AccessLoopCircuitIdTlv
AccessConcentratorGenUpdateTrafficCommand Read-Only Attributes

Read-Only Attribute
Description

AccessLoopCircuitIdTlv (ancp_draft0:AccessLoopCircuitIdTlv)
Description:
Children: None
AccessLoopCircuitIdTlv Attributes
Attribute
Description
ID
Type: ASCII
Default: Access-Node-Identifier eth slot port:vlan-id
Length
Type: INTEGER
Default: 0
MessageSelect
Default: 3
Possible Values:
Value Description
1
Port Up
Port Down
Port Up, Port Down
Name
more information.
Type: string
Pad
Type: ALIGNMENTPAD
Default: 0
Type
Type: OCTETSTRING
Default: 0001
AccessLoopCircuitIdTlv (ancp_draft2:AccessLoopCircuitIdTlv)
Description:
Children: None
61
AccessLoopEncapsulationTlv
AccessLoopCircuitIdTlv Attributes
Attribute
Description
ID
Type: ASCII
Default: Access-Node-Identifier eth slot port:vlan-id
Length
Type: INTEGER
Default: 0
MessageSelect
Default: 3
Possible Values:
Value Description
1
Port Up
Port Down
Port Up, Port Down
Name
more information.
Type: string
Pad
Type: ALIGNMENTPAD
Default: 0
Type
Type: OCTETSTRING
Default: 0001
AccessLoopEncapsulationTlv (ancp_draft2:AccessLoopEncapsulationTlv)
Description:
Children: None
Next headers: ancp_draft2:DslTypeTlv, ancp_draft2:ActualNetDataRateUpstreamTlv, ancp_draft2:ActualNetDataRateDownstreamTlv,
ancp_draft2:MinimumNetDataRateUpstreamTlv, ancp_draft2:MinimumNetDataRateDownstreamTlv, ancp_draft2:AttainableNetDataRateUpstreamTlv,
ancp_draft2:AttainableNetDataRateDownstreamTlv, ancp_draft2:MaximumNetDataRateUpstreamTlv, ancp_draft2:MaximumNetDataRateDownstreamTlv,
ancp_draft2:MinimumNetLowPowerDataRateUpstreamTlv, ancp_draft2:MinimumNetLowPowerDataRateDownstreamTlv,
ancp_draft2:MaximumInterleavingDelayUpstreamTlv, ancp_draft2:ActualInterleavingDelayUpstreamTlv, ancp_draft2:MaximumInterleavingDelayDownstreamTlv,
ancp_draft2:ActualInterleavingDelayDownstreamTlv, ancp_draft2:AccessLoopEncapsulationTlv, ancp_draft2:DslLineAttributesCustomTlv
AccessLoopEncapsulationTlv Attributes
Attribute
Description
DataLink
Type: DataLinkValues
Default: 01
Possible Values:
Value Description
Encaps1
00
00 - AAL5
01
01 - ETHERNET
Type: Encaps1Values
Default: 00
Possible Values:
Value Description
00
00 - NA
01
01 - Untagged Ethernet
02
01 - Single-tagged Ethernet
62
AccessLoopRemoteIdTlv
Attribute
Description
Encaps2
Type: Encaps2Values
Default: 00
Possible Values:
Value Description
00
00 - NA
01
01 - PPPoA LLC
02
02 - PPPoA NULL
03
03 - IPoA LLC
04
04 - IPoA NULL
05
05 - Ethernet over AAL5 LLC with FCS
06
06 - Ethernet over AAL5 LLC without FCS
07
07 - Ethernet over AAL5 NULL with FCS
08
08 - Ethernet over AAL5 NULL without FCS
Length
Type: INTEGER
Default: 3
MessageSelect
Default: 3
Possible Values:
Value Description
1
Port Up
Port Down
Port Up, Port Down
Name
more information.
Type: string
Type
Type: OCTETSTRING
Default: 0090
AccessLoopRemoteIdTlv (ancp_draft2:AccessLoopRemoteIdTlv)
Description:
Children: None
AccessLoopRemoteIdTlv Attributes
Attribute
Description
ID
Type: ASCII
Default: SPIRENT
Length
Type: INTEGER
Default: 0
63
AccessStabilityGenParams
Attribute
Description
MessageSelect
Default: 3
Possible Values:
Value Description
1
Port Up
Port Down
Port Up, Port Down
Name
more information.
Type: string
Pad
Type: ALIGNMENTPAD
Default: 0
Type
Type: OCTETSTRING
Default: 0002
Description:
The AccessStabilityGenParams specifies the Access Stability specific test parameters.

Parents: Project
Children: AccessTestGenPortParams, EmulatedDeviceGenParams, HostGenParams, RouterGenParams
Relations:
Side name
(Type)
Relative
Description
FrameLengthDistribution
(AccessTestImixAffiliation)
Related iMIX frame length distribution profile.
AccessStabilityGenParams Writable Attributes

Writable Attribute
Description
Active, Name
DownstreamTrafficIpTos
Downstream traffic IP Type of Service as an integer.

Type: u8
Default: 0
DownstreamTrafficVlanPriority
Downstream traffic VLAN Priority as an integer.

Type: u8
Default: 0
Range: 0 - 7
DurationBursts
Specifies the traffic duration as number of frames in a burst.

Type: u32
Default: 1000
Range: 1 - 16777215
64
Writable Attribute
Description
DurationMode
Specifies the duration mode for each transmitted stream.

Type: enum
Default: SECONDS
Possible Values:
Value
Description
SECONDS Sets duration mode to time in seconds.
BURSTS
Sets duration mode to number of frames per transmission burst.
DurationSeconds
Specifies the traffic duration length in seconds.

Type: u32
Default: 60
Range: 1 - 5184000
DutL2tpNodeType
Specifies how the DUT will be tested in an L2TP Test.

Type: enum
Default: LNS
Possible Values:
Value Description
EnableFlapping
LAC
Test the DUT as a LAC (Spirent TestCenter will emulate the LNS).
LNS
Test the DUT as an LNS (Spirent TestCenter will emulate the LAC).
Enable or disable test flapping.

Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
Enable test flapping.
FALSE Disable test flapping.

FlapCount
Number of times to flap traffic.

Type: u8
Default: 2
FrameLengthMode
Specifies the frame size mode.

Type: enum
Default: FIXED
Possible Values:
Value
Description
FIXED
Fixed frame size.
INCR
Frame length will increment over a range.
DECR
Frame length will decrement over a range.
IMIX
Use an MIX frame length distribution.
RANDOM Frame length is random between a min and max.

AUTO
Frame length is automatically set based on the PDU configuration.
FrameSize
Frame length in bytes.

Type: u16
Default: 128
Range: 12 - 16383
FrameSizeMax
Maximum frame length in bytes.

Type: u16
Default: 256
Range: 12 - 16383
FrameSizeMin
Minimum frame length in bytes.

Type: u16
Default: 128
Range: 12 - 16383
65
Writable Attribute
Description
FrameSizeStep
Frame size step in bytes.

Type: u16
Default: 1
Range: 1 - 8192
IpNextProtocolId
Specify the IP Next Protocol IDs (list of ints).

Type: u8
Default: 0
IpVersion
Specifies the IP Version being tested.

Type: enum
Default: IPV4
Possible Values:
Value Description
IPV4
IPv4
IPV6
IPv6
Load
Traffic load in the specified load units when the traffic load mode is fixed.
Type: double
Default: 10
LoadMax
Maximum traffic load when the traffic load mode is random.

Type: double
Default: 100
LoadMin
Minimum traffic load when the traffic load mode is random.

Type: double
Default: 10
LoadMode
Specifies the traffic load mode.

Type: enum
Default: FIXED
Possible Values:
Value
Description
FIXED
Traffic will be sent at a fixed rate.
RANDOM Traffic will be sent at a random rate between some min and max.
LoadUnits
Specifies the traffic load units.

Type: enum
Default: PERCENT_LINE_RATE
Possible Values:
Value
Description
PERCENT_LINE_RATE
Specify load as a percent of the port line rate.
FRAMES_PER_SECOND
Specify load as frames per second.
INTER_BURST_GAP
Specify load by inter-burst gap.
MEGABITS_PER_SECOND Specify load in megabits per second.

KILOBITS_PER_SECOND
Specify load in kilobits per second.
BITS_PER_SECOND
Specify load in bits per second.
SessionDownTimeout
Maximum amount of time in seconds to wait for the sessions to come down.
Type: u32
Default: 120
Range: 1 - 4294967295
SessionUpTimeout
Maximum amount of time in seconds to wait for the sessions to come up.
Type: u32
Default: 120
Range: 1 - 4294967295
66
Writable Attribute
Description
TestType
Specifies the access stability test type.

Type: enum
Default: DHCP
Possible Values:
Value Description
DHCP
DHCP Stability Test.
PPPOX PPPoX Stability Test.

L2TP
TrafficConfigMode
L2TP Stability Test.
Specifies the traffic configuration mode.

Type: enum
Default: AUTO
Possible Values:
Value
Description
AUTO
Streamblocks will be automatically generated based on the host block distribution.
MANUAL User will specify the streamblocks.

NONE
TrafficConnectivity
No traffic will be configured.
Specifies how the hosts will be linked by streamblocks.

Type: enum
Default: FULL
Possible Values:
Value Description
FULL All hostblocks on one side will send to all hostblocks on the other side.
PAIR Hostblocks will be paired between the sides.
TrafficDevices
Select which type of devices to use when configuring traffic.

Type: enum
Default: EDGE
Possible Values:
Value Description
ALL
Use all devices.
EDGE Use edge devices only.

TrafficFlow
Specifies the traffic flow between upstream and downstream sides.

Type: enum
Possible Values:
Value
Description
BIDIRECTIONAL
Traffic will flow in both directions.
DOWNSTREAM_TO_UPSTREAM Traffic will only flow from the downstream to the upstream side (ie clients to
static hosts).
UPSTREAM_TO_DOWNSTREAM Traffic will only flow from the upstream to the downstream side (ie static hosts
to clients).
Ttl
Specifies the time to live.

Type: u8
Default: 10
Range: 0 - 255
TunnelDownTimeout
Maximum amount of time in seconds to wait for the tunnels to come down.
Type: u32
Default: 120
Range: 1 - 4294967295
TunnelUpTimeout
Maximum amount of time in seconds to wait for the tunnels to come up.
Type: u32
Default: 120
Range: 1 - 4294967295
67
AccessTestGenConfigExpandCommand
Writable Attribute
Description
UpstreamTrafficIpTos
Upstream traffic IP Type of Service as an integer.

Type: u8
Default: 0
UpstreamTrafficVlanPriority
Upstream traffic VLAN Priority as an integer.

Type: u8
Default: 0
Range: 0 - 7
AccessStabilityGenParams Read-Only Attributes

AccessTestGenConfigExpandCommand
Description:
Expands the AccessTestGenParams object into the access test configuration.

AccessTestGenConfigExpandCommand Writable Attributes

Writable Attribute
Description
ClearExisting
Type: enum
Default: PROMPT
Possible Values:
Value
Description
GenParams
YES
Clear the existing configuration.
NO
Do not clear the existing configuration.
Handle of the AccessTestGenParams to expand into a test configuration.

Type: handle
Default: 0
AccessTestGenConfigExpandCommand Read-Only Attributes

Read-Only Attribute
Description

AccessTestGenPortParams
Description:
68
AccessTestGenUpdateAvailablePortsCommand
The AccessTestGenPortParams specifies the Access Test port specific parameters.

Parents: AccessStabilityGenParams
Children: Dhcpv4PortConfig, Dhcpv6PortConfig, L2tpPortConfig, PppoxPortConfig
Relations:
Side name
(Type)
Relative
Description
AffiliatedPort
(AffiliationPort)
Port
Relation between the AccessTestGenPortParams and the Port object.
AccessTestGenPortParams Writable Attributes

Writable Attribute
Description
Active, Name
Side
Specifies the side of the topology the port is on.

Type: enum
Default: DOWNSTREAM
Possible Values:
Value
Description
DOWNSTREAM Port will be on the downstream side.
UPSTREAM
Port will be on the upstream side.
AccessTestGenPortParams Read-Only Attributes

AccessTestGenUpdateAvailablePortsCommand
Description:
Updates the available ports.

AccessTestGenUpdateAvailablePortsCommand Writable Attributes

Writable Attribute
Description
GenParams
Handle of the AccessTestGenParams.

Type: handle
Default: 0
RemoveUnusedPorts
Specifies if the unused ports should be removed.

Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
Remove the unused ports.
FALSE Do not remove the unused ports.
69
AccessTestGenUpdateTrafficCommand
AccessTestGenUpdateAvailablePortsCommand Read-Only Attributes

Read-Only Attribute
Description

AccessTestGenUpdateTrafficCommand
Description:
Update the configured traffic.

AccessTestGenUpdateTrafficCommand Writable Attributes

Writable Attribute
Description
EnableFrameConfigUpdate
Specifies if the frame configuration should be updated.

Type: bool
Default: TRUE
Possible Values:
Value Description
TRUE
Update frame configuration.
FALSE Do not update frame configuration.

GenParams
Handle of the AccessTestGenParams object.

Type: handle
Default: 0
AccessTestGenUpdateTrafficCommand Read-Only Attributes

Read-Only Attribute
Description

AccessVplsGenCeDeviceParams
Description:
The AccessVplsGenCeDeviceParams object is used to define customer or provider side host parameters for the generated VPLS configuration. To configure
the generated host parameters use the child EmulatedDeviceGenParams object.

Parents: AccessVplsGenParams
Children: EmulatedDeviceGenParams, HostGenParams, RouterGenParams
70
AccessVplsGenParams
AccessVplsGenCeDeviceParams Writable Attributes

Writable Attribute
Description
Active, Name
SideType
Side VPLS parameters are applied to.

Type: enum
Default: CUSTOMER
Possible Values:
Value
Description
CUSTOMER Customer side.
PROVIDER
Provider side.
AccessVplsGenCeDeviceParams Read-Only Attributes

AccessVplsGenParams
Description:
The AccessVplsGenParams object extends the VPLS configuration generation by defining Access protocols on CE devices.

Parents: VpnBgpVplsGenParams, VpnLdpVplsGenParams
Children: AccessVplsGenCeDeviceParams
AccessVplsGenParams Writable Attributes

Writable Attribute
Description
Active, Name
AccessVplsGenParams Read-Only Attributes

acCookie
Description:
Parents: PPPoETag
Children: None
acCookie Attributes
Attribute
Description
length
Type: OCTETSTRING
Default: 0000
71
acName
Attribute
Description
Name
more information.
Type: string
type
Type: OCTETSTRING
Default: 0104
value
Type: OCTETSTRING
acName
Description:
Parents: PPPoETag
Children: None
acName Attributes
Attribute
Description
length
Type: OCTETSTRING
Default: 0000
Name
more information.
Type: string
type
Type: OCTETSTRING
Default: 0102
value
Type: OCTETSTRING
acSystemError
Description:
Parents: PPPoETag
Children: None
acSystemError Attributes
Attribute
Description
length
Type: OCTETSTRING
Default: 0000
Name
more information.
Type: string
72
ActiveEvent
Attribute
Description
type
Type: OCTETSTRING
Default: 0202
value
Type: OCTETSTRING
ActiveEvent
Description:
This object contains messages generated by the system which may require a response from the user.

Parents: ActiveEventManager
ActiveEvent Writable Attributes

Writable Attribute
Description
Active, Name
AllowDefaultResponse
Type: bool
Default: TRUE
Possible Values:
Value Description
TRUE
FALSE
RequestReady
The event is prepared for presentation to the user.

Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
Event is ready.
FALSE Event is not ready.

Response
The user's response.

Type: enum
Default: NONE
Possible Values:
Value
Description
NONE
Not supported.
OK
Not supported.
YES
Yes
NO
No
IGNORE Ignore
RETRY
Return
CANCEL Cancel
ResponseReady
The user has responded.

Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
The user has responded.
FALSE The user has not responded.
73
ActiveEventManager
Writable Attribute
Description
SetAsDefaultResponse
If user responds yes when asked "Do not prompt me about this again. (Yes/No)" then this will be true. Future
events of this type will be processed using the same response that the user gave to this event.
Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
Response will be default response to future events of same type.
FALSE Future events will prompt user.
ActiveEvent Read-Only Attributes

Read-Only Attribute
Description
Category
Type: string
Level
Type: enum
Default: WARN
Possible Values:
Value
Description
DEBUG
INFO
WARN
ERROR
Message
A message that contains information or a question for the user.

Type: string
MsgContext
Type: string
Request
The type of request. Valid values are the logical OR of YES|NO or IGNORE|RETRY\CANCEL.
Type: enum
Default: NONE
Possible Values:
Value
Description
NONE
Not supported.
OK
Not supported.
YES
Can be OR'd with NO to represent a YES|NO request.
NO
Can be OR'd with YES to represent a YES|NO request.
IGNORE Can be OR'd with RETRY and CANCEL to represent a IGNORE|RETRY|CANCEL request.
RETRY
Can be OR'd with IGNORE and CANCEL to represent a IGNORE|RETRY|CANCEL request.
CANCEL Can be OR'd with IGNORE and RETRY to represent a IGNORE|RETRY|CANCEL request.
ActiveEventManager
Description:
Manages the ActiveEvents in the system. ActiveEvents describe events that occur while the system is running. An active event may simply provide information
or may require a response from the user.

Children: ActiveEvent
Automatically created from: StcSystem
74
ActualInterleavingDelayDownstreamTlv
ActiveEventManager Writable Attributes

Writable Attribute
Description
Active, Name
DefaultResponse
Type: enum
Default: NONE
Possible Values:
Value
Description
NONE
AUTO_RESPONSE
COMMAND_PROMPT
ActiveEventManager Read-Only Attributes

(ancp_draft0:ActualInterleavingDelayDownstreamTlv)
Description:
Children: None
ancp_draft0:ActualInterleavingDelayDownstreamTlv, ancp_draft0:DslLineAttributesCustomTlv
ActualInterleavingDelayDownstreamTlv Attributes
Attribute
Description
Length
Type: INTEGER
Default: 4
MessageSelect
Default: 3
Possible Values:
Value Description
1
Port Up
Port Down
Port Up, Port Down
Name
Type: string
Time
Type: INTEGER
Default: 0
Type
Type: OCTETSTRING
Default: 008E
75
(ancp_draft2:ActualInterleavingDelayDownstreamTlv)
Description:
Children: None
ActualInterleavingDelayDownstreamTlv Attributes
Attribute
Description
Length
Type: INTEGER
Default: 4
MessageSelect
Default: 3
Possible Values:
Value Description
1
Port Up
Port Down
Port Up, Port Down
Name
Type: string
Time
Type: INTEGER
Default: 0
Type
Type: OCTETSTRING
Default: 008E
ActualInterleavingDelayUpstreamTlv
(ancp_draft0:ActualInterleavingDelayUpstreamTlv)
Description:
Children: None
ActualInterleavingDelayUpstreamTlv Attributes
Attribute
Description
Length
Type: INTEGER
Default: 4
76
Attribute
Description
MessageSelect
Default: 3
Possible Values:
Value Description
1
Port Up
Port Down
Port Up, Port Down
Name
Type: string
Time
Type: INTEGER
Default: 0
Type
Type: OCTETSTRING
Default: 008C
(ancp_draft2:ActualInterleavingDelayUpstreamTlv)
Description:
Children: None
ActualInterleavingDelayUpstreamTlv Attributes
Attribute
Description
Length
Type: INTEGER
Default: 4
MessageSelect
Default: 3
Possible Values:
Value Description
1
Port Up
Port Down
Port Up, Port Down
Name
Type: string
Time
Type: INTEGER
Default: 0
Type
Type: OCTETSTRING
Default: 008C
77
ActualNetDataRateDownstreamTlv
(ancp_draft0:ActualNetDataRateDownstreamTlv)
Description:
Children: None
ActualNetDataRateDownstreamTlv Attributes
Attribute
Description
Length
Type: INTEGER
Default: 4
MessageSelect
Default: 3
Possible Values:
Value Description
1
Port Up
Port Down
Port Up, Port Down
Name
Type: string
Rate
Type: INTEGER
Default: 0
Type
Type: OCTETSTRING
Default: 0082
(ancp_draft2:ActualNetDataRateDownstreamTlv)
Description:
Children: None
ActualNetDataRateDownstreamTlv Attributes
Attribute
Description
Length
Type: INTEGER
Default: 4
78
ActualNetDataRateUpstreamTlv
Attribute
Description
MessageSelect
Default: 3
Possible Values:
Value Description
1
Port Up
Port Down
Port Up, Port Down
Name
Type: string
Rate
Type: INTEGER
Default: 0
Type
Type: OCTETSTRING
Default: 0082
(ancp_draft0:ActualNetDataRateUpstreamTlv)
Description:
Children: None
ActualNetDataRateUpstreamTlv Attributes
Attribute
Description
Length
Type: INTEGER
Default: 4
MessageSelect
Default: 3
Possible Values:
Value Description
1
Port Up
Port Down
Port Up, Port Down
Name
Type: string
Rate
Type: INTEGER
Default: 0
Type
Type: OCTETSTRING
Default: 0081
79
(ancp_draft2:ActualNetDataRateUpstreamTlv)
Description:
Children: None
ActualNetDataRateUpstreamTlv Attributes
Attribute
Description
Length
Type: INTEGER
Default: 4
MessageSelect
Default: 3
Possible Values:
Value Description
1
Port Up
Port Down
Port Up, Port Down
Name
Type: string
Rate
Type: INTEGER
Default: 0
Type
Type: OCTETSTRING
Default: 0081
AddChartMarkerCommand
Description:
Adds a custom event marker to a real-time chart.

Can be used with Command Sequencer: Yes
AddChartMarkerCommand Writable Attributes

Writable Attribute
Description
Text
Text of the marker.

Type: string
80
AddrArrayTLV
AddChartMarkerCommand Read-Only Attributes

Read-Only Attribute
Description

AddrArrayTLV (VICTLV:AddrArrayTLV)
Description:
Children: Addresses
Next headers: VICTLV:VifIdTLV, VICTLV:AddrArrayTLV, VICTLV:VifStateTLV, VICTLV:CustomTLV
AddrArrayTLV Attributes
Attribute
Description
Length
Type: INTEGER
Default: 0
Name
more information.
Type: string
Type
Type: INTEGER
Default: 5
AddrCustom
Description:
Parents: AddressType
Children: None
AddrCustom Attributes
Attribute
Description
Length
Type: INTEGER
Default: 0
Name
more information.
Type: string
Type
Type: INTEGER
Default: 0
Value
Type: OCTETSTRING
Default: 00
81
Address
Address
Description:
Parents: addresses
Children: None
Address Attributes
Attribute
Description
Name
information.
Type: string
value
Type: OCTETSTRING
Default: FF
Address
Description:
Parents: Addresses
Children: AddressType
Address Attributes
Attribute
Description
Name
information.
Type: string
addresses
Description:
Parents: PPP
Children: Address
addresses Attributes
Attribute
Description
Name
information.
Type: string
82
Addresses
Addresses
Description:
Parents: AddrArrayTLV
Children: Address
Addresses Attributes
Attribute
Description
Name
information.
Type: string
addressList (overloaded)
addressList (pim) - Object definition for the following paths:
StreamBlock.Pimv4Hello.options.Pimv4HelloOption.addressList
addressList (pim) - Object definition for the following paths:
StreamBlock.Pimv6Hello.options.Pimv6HelloOption.addressList
addressList Object (pim PDU library)

Description:
Parents: Pimv4HelloOption (StreamBlock.Pimv4Hello.options.Pimv4HelloOption)

Children: addrList
addressList Attributes
Attribute
Description
length
Type: INTEGER
Default: 4
Name
more information.
Type: string
type
Type: INTEGER
Default: 24
addressList Object (pim PDU library)
83
AddressType
Description:
Parents: Pimv6HelloOption (StreamBlock.Pimv6Hello.options.Pimv6HelloOption)

Children: addrList
addressList Attributes
Attribute
Description
length
Type: INTEGER
Default: 16
Name
more information.
Type: string
type
Type: INTEGER
Default: 24
AddressType
Description:
Parents: Address
Children: AddrCustom, AddrEthMac
AddressType Attributes
Attribute
Description
Name
information.
Type: string
AddResultChartQueryFromResultObjectCommand
Description:

AddResultChartQueryFromResultObjectCommand Writable Attributes

Writable Attribute
Description
ConfigClassId
Type: classId
Default: 0
84
AddrEthMac
Writable Attribute
Description
PropertyHandle
Type: handle
Default: 0
PropertyId
Type: propertyId
Default: 0
Result
Type: handle
Default: 0
ResultChartQuerySet
Type: handle
Default: 0
ResultClassId
Type: classId
Default: 0
ResultOptions
Type: string
AddResultChartQueryFromResultObjectCommand Read-Only Attributes

Read-Only Attribute
Description

ResultQuery
Type: handle
Default: 0
AddrEthMac
Description:
Parents: AddressType
Children: None
AddrEthMac Attributes
Attribute
Description
Length
Type: INTEGER
Default: 8
MacAddress
Type: MACADDR
Default: 00:00:00:00:00:01
Name
Type: string
Type
Type: INTEGER
Default: 1
Vlan
Type: INTEGER
Default: 1
85
addrExt
addrExt
Description:
Parents: IPv4HeaderOption
Children: None
addrExt Attributes
Attribute
Description
dest7thByte
Type: INTEGER
Default: 0
destIpv7
Type: INTEGER
Default: 0
length
Type: INTEGER
Default: 10
Name
more information.
Type: string
source7thByte
Type: INTEGER
Default: 0
sourceIpv7
Type: INTEGER
Default: 0
type
Type: Ipv4OptionType
Default: 147
Possible Values:
Value Description
0
End of Options List
NOP
130
Security
131
Loose Source Route
68
Time Stamp
133
Extended Security
Record Route
136
Stream Identifier
137
Strict Source Route
11
MTU Probe
12
MTU Reply
82
Traceroute
147
Address Extension
148
Router Alert
149
Selective Directed Broadcast Mode
addrList (overloaded)
addrList (icmpv6)
addrList (igmp)
addrList (ipv4)
addrList (pim) - Object definition for the following paths:
StreamBlock.Pimv4Hello.options.Pimv4HelloOption.addressList.addrList
86
addrList
addrList (pim) - Object definition for the following paths:

StreamBlock.Pimv6Hello.options.Pimv6HelloOption.addressList.addrList
addrList Object (icmpv6 PDU library)

Description:
Parents: MLDv2Query (StreamBlock.MLDv2Query)

MLDv2GroupRecord (StreamBlock.MLDv2Report.grpRecords.MLDv2GroupRecord)
Children: Ipv6Addr
addrList Attributes
Attribute
Description
Name
information.
Type: string
addrList Object (igmp PDU library)

Description:
Used in IGMP as a parent of Ipv4Addr objects.
Parents: Igmpv3Query (StreamBlock.Igmpv3Query)
GroupRecord (StreamBlock.Igmpv3Report.grpRecords.GroupRecord)
Children: Ipv4Addr
addrList Attributes
Attribute
Description
Name
information.
Type: string
addrList Object (ipv4 PDU library)

Description:
Parents: looseSrcRoute (StreamBlock.IcmpDestUnreach.ipData.ipHdr.options.IPv4HeaderOption.looseSrcRoute)

recordRoute (StreamBlock.IcmpDestUnreach.ipData.ipHdr.options.IPv4HeaderOption.recordRoute)
strictSrcRoute (StreamBlock.IcmpDestUnreach.ipData.ipHdr.options.IPv4HeaderOption.strictSrcRoute)
87
addrList
selBrdcast (StreamBlock.IcmpDestUnreach.ipData.ipHdr.options.IPv4HeaderOption.selBrdcast)
looseSrcRoute (StreamBlock.IcmpTimeExceeded.ipData.ipHdr.options.IPv4HeaderOption.looseSrcRoute)
recordRoute (StreamBlock.IcmpTimeExceeded.ipData.ipHdr.options.IPv4HeaderOption.recordRoute)
strictSrcRoute (StreamBlock.IcmpTimeExceeded.ipData.ipHdr.options.IPv4HeaderOption.strictSrcRoute)
selBrdcast (StreamBlock.IcmpTimeExceeded.ipData.ipHdr.options.IPv4HeaderOption.selBrdcast)
looseSrcRoute (StreamBlock.IcmpParameterProblem.ipData.ipHdr.options.IPv4HeaderOption.looseSrcRoute)
recordRoute (StreamBlock.IcmpParameterProblem.ipData.ipHdr.options.IPv4HeaderOption.recordRoute)
strictSrcRoute (StreamBlock.IcmpParameterProblem.ipData.ipHdr.options.IPv4HeaderOption.strictSrcRoute)
selBrdcast (StreamBlock.IcmpParameterProblem.ipData.ipHdr.options.IPv4HeaderOption.selBrdcast)
looseSrcRoute (StreamBlock.IcmpSourceQuench.ipData.ipHdr.options.IPv4HeaderOption.looseSrcRoute)
recordRoute (StreamBlock.IcmpSourceQuench.ipData.ipHdr.options.IPv4HeaderOption.recordRoute)
strictSrcRoute (StreamBlock.IcmpSourceQuench.ipData.ipHdr.options.IPv4HeaderOption.strictSrcRoute)
selBrdcast (StreamBlock.IcmpSourceQuench.ipData.ipHdr.options.IPv4HeaderOption.selBrdcast)
looseSrcRoute (StreamBlock.IcmpRedirect.ipData.ipHdr.options.IPv4HeaderOption.looseSrcRoute)
recordRoute (StreamBlock.IcmpRedirect.ipData.ipHdr.options.IPv4HeaderOption.recordRoute)
strictSrcRoute (StreamBlock.IcmpRedirect.ipData.ipHdr.options.IPv4HeaderOption.strictSrcRoute)
selBrdcast (StreamBlock.IcmpRedirect.ipData.ipHdr.options.IPv4HeaderOption.selBrdcast)
looseSrcRoute (StreamBlock.IPv4.options.IPv4HeaderOption.looseSrcRoute)
recordRoute (StreamBlock.IPv4.options.IPv4HeaderOption.recordRoute)
strictSrcRoute (StreamBlock.IPv4.options.IPv4HeaderOption.strictSrcRoute)
selBrdcast (StreamBlock.IPv4.options.IPv4HeaderOption.selBrdcast)
Children: Ipv4Addr
addrList Attributes
Attribute
Description
Name
information.
Type: string
addrList Object (pim PDU library)

Description:
Parents: addressList (StreamBlock.Pimv4Hello.options.Pimv4HelloOption.addressList)

Children: Ipv4Addr
addrList Attributes
Attribute
Description
Name
information.
Type: string
addrList Object (pim PDU library)

Description:
Parents: addressList (StreamBlock.Pimv6Hello.options.Pimv6HelloOption.addressList)

Children: Ipv6Addr
88
aggregationStatus
addrList Attributes
Attribute
Description
Name
information.
Type: string
aggregationStatus
Description:
Parents: LinkAggregationTlv
Children: None
aggregationStatus Attributes
Attribute
Description
aggregationCapability
Type: BITSTRING
Default: 1
aggregationStatus
Type: BITSTRING
Default: 1
Name
A text name for the object. This attribute is required when you use stream block modifiers such as
RangeModifier, RandomModifier, and TableModifier. See the description of the OffsetReference attribute for
these modifier objects for more information.
Type: string
reserved
Type: BITSTRING
Default: 000000
Analyzer
Description:
A Spirent TestCenter component that provides the received packet analysis capability.

Parents: PortAvgLatencyResults
Children: Analyzer16BitFilter, Analyzer32BitFilter, AnalyzerFrameConfigFilter, HighResolutionSamplingStreamBlockConfig, HighResolutionStreamBlockOptions
Automatically created from: Port
Automatically-created children: AnalyzerConfig, DiffServConfig, HighResolutionSamplingPortConfig
Result children (automatically created): AnalyzerPortResults, DiffServResults, FilteredStreamResults, InterestingStreamsResults, OverflowResults,
PortAvgLatencyResults, RxCpuPortResults, RxStreamResults, StreamThresholdResults
Relations:
Side name
(Type)
Relative
Description
ResultChild
(ResultChild)
AnalyzerPortResults, DiffServResults, FilteredStreamResults,

InterestingStreamsResults, OverflowResults, PortAvgLatencyResults,
RxCpuPortResults, RxStreamResults, StreamThresholdResults
Use this to connect a results object to an

object.
89
Analyzer16BitFilter
Analyzer Writable Attributes

Writable Attribute
Description
Active, Name
FilterOnInnerIP
Whether the analyzer filter on Inner IP.

Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
Analyzer filter on Inner IP.
FALSE Analyzer does not filter on Inner IP.

FilterOnStreamId
Whether the analyzer filters on stream ID.

Type: bool
Default: TRUE
Possible Values:
Value Description
TRUE
Analyzer filters on stream ID.
FALSE Analyzer does not filter on stream ID.
Analyzer Read-Only Attributes

Read-Only Attribute
Description
State
State of traffic analyzer.

Type: enum
Default: STOPPED
Possible Values:
Value
Description
STOPPED
Traffic analyzer is not ready to process any received packets.
RUNNING
Traffic analyzer is ready to process any received packets.
PENDING_START A start message has been sent to firmware, and traffic analyzer has not been confirmed to be running.
PENDING_STOP
A stop message has been sent to firmware, and traffic analyzer has not been confirmed to be stopped.
Analyzer16BitFilter
Description:
Entity describing a 16-bit comparator.

Parents: Analyzer, AnalyzerFrameConfigFilter
Analyzer16BitFilter Writable Attributes

Writable Attribute
Description
Active, Name
EndOfRange
End of range for the field values after applying the mask.
Type: u16
Default: 0xFFFF
FilterName
Text name used in .csv output.

Type: string
Default: CustomFilter0
90
Analyzer32BitFilter
Writable Attribute
Description
Index
Used for VLANs and MPLS. It represents the index of a VLAN or MPLS header when more than one VLAN or MPLS header
is stacked. For example, if you have two VLANs in your streamblock and you want to filter on the inner VLAN, set the index
to 1. If you want the outer VLAN, set the index to 0. Handle stacked MPLS headers in a similar way.
Type: u8
Default: 0
Range: 0 - 1
LocationType
Starting point from which the offset is referenced.

Type: enum
Default: START_OF_FRAME
Possible Values:
Value
Description
START_OF_FRAME
Beginning of the frame. The parent object can be Analyzer or AnalyzerFrameConfigFilter.
START_OF_IPV4_HDR
Beginning of the IPv4 header. The parent object must be AnalyzerFrameConfigFilter.
START_OF_IPV6_HDR
Beginning of the IPv6 header. The parent object must be AnalyzerFrameConfigFilter.
START_OF_PAYLOAD
Beginning of the payload. The parent object must be AnalyzerFrameConfigFilter.
START_OF_TCP_UDP_HDR Beginning of the UDP header. The parent object must be AnalyzerFrameConfigFilter.
VLAN_TAG
Location of the VLAN tag. The parent object must be AnalyzerFrameConfigFilter.
MPLS_TAG
Location of the MPLS tag. The parent object must be AnalyzerFrameConfigFilter.
L2TPV2_SESSION_ID
Location of the L2TPv2 session ID tag. The parent object must be AnalyzerFrameConfigFilter.
L2TPV2_TUNNEL_ID
Location of the L2TPv2 tunnel ID tag. The parent object must be AnalyzerFrameConfigFilter.
Mask
16-bit mask in hex.

Type: u16
Default: 0xFFFF
Offset
Number of bytes separating the mask's position from the specified location (in LocationType).
Type: u32
Default: 0
StartOfRange
Start of range for the field values after applying the mask.
Type: u16
Default: 0
Analyzer16BitFilter Read-Only Attributes

Analyzer32BitFilter
Description:
Entity describing a 32-bit comparator.

Parents: Analyzer, AnalyzerFrameConfigFilter
Analyzer32BitFilter Writable Attributes

Writable Attribute
Description
Active, Name
EndOfRange
End of range for the field values after applying the mask.
Type: u32
Default: 0xFFFFFFFF
91
AnalyzerConfig
Writable Attribute
Description
FilterName
Text name used in .csv output.

Type: string
Default: CustomFilter0
Index
Used for VLANs and MPLS. It represents the index of a VLAN or MPLS header when more than one VLAN or MPLS
header is stacked. For example, if you have two VLANs in your streamblock and you want to filter on the inner VLAN,
set the index to 1. If you want the outer VLAN, set the index to 0. Handle stacked MPLS headers in a similar way.
Type: u8
Default: 0
Range: 0 - 1
LocationType
Starting point from which the offset is referenced.

Type: enum
Default: SPIRENT_SIG_ID
Possible Values:
Value
Description
START_OF_FRAME
Beginning of frame.
START_OF_IPV4_HDR
Beginning of the IPv4 header.
START_OF_IPV6_HDR
Beginning of the IPv6 header.
START_OF_PAYLOAD
Beginning of the payload.
START_OF_TCP_UDP_HDR Beginning of the UDP header.

SPIRENT_SIG_ID
Beginning of the Spirent signature ID.
Mask
32-bit mask in hex.

Type: u32
Default: 0xFFFFFFFF
Offset
Number of bytes separating the mask's position from the specified location (in LocationType).
Type: u32
Default: 0
StartOfRange
Start of range for the field values after applying the mask.
Type: u32
Default: 0
Analyzer32BitFilter Read-Only Attributes

AnalyzerConfig
Description:
Specifies the configuration for various properties related to the traffic analyzer.

Automatically created from: Analyzer
Automatically-created children: FrameLengthHistogram, InterarrivalTimeHistogram, JitterHistogram, LatencyHistogram, SeqDiffCheckHistogram,
SeqRunLengthHistogram
Relations:
Side name
(Type)
Relative
Description
ActiveHistogram
(ActiveHistogram)
FrameLengthHistogram, InterarrivalTimeHistogram, JitterHistogram,

LatencyHistogram, SeqDiffCheckHistogram,
Indicates the relation to the active

histogram.
92
AnalyzerConfig
AnalyzerConfig Writable Attributes

Writable Attribute
Description
Active, Name
AdvSeqCheckerLateThreshold
A 31-bit value (NOT 32-bit) in sequence number units. If Stream Stats Group has been set to one of the groups that uses
Advanced Sequence Checker (see StreamStats Table), this value would be used as the late threshold; otherwise, this
value will be ignored. Analyzer uses this value to determine whether a packet is a late packet. A packet is a late packet if
its sequence number is smaller than expected sequence number minus late threshold. Default value is 1000. A good
choice for this threshold depends on the receive buffer of the DUT, as well as packet length.
Type: u32
Default: 1000
AlternateSigOffset
Specifies an alternate signature offset. The offset starts at the end of the frame.
Type: u16
Default: 0
Range: 0 - 16
HistogramMode
Specifies the method for performing histogram computations.

Type: enum
Default: LATENCY
Possible Values:
Value
Description
INTERARRIVAL_TIME Specifies that the histogram tracks frame inter-arrival times in 1 microsecond units.
LATENCY
Specifies that the histogram tracks frame transfer delay (latency) in 1 microsecond units.
FRAME_LENGTH
Specifies that the histogram tracks frame lengths in bytes.
SEQ_RUN_LENGTH
Specifies that the histogram tracks the number of in-sequence frames received between two
out-of-sequence frames.
SEQ_DIFF_CHECK
Specifies that the histogram tracks differences between the sequence numbers of consecutive
packets.
JITTER
Specifies that the histogram tracks frame jitter times in 1 microsecond units. Measured on
in-sequence frames only.
JumboFrameThreshold
Received frame sizes above this threshold will be counted as jumbo frames. The value you specify must be less than the
over-sized frame threshold to avoid frames being counted as over-sized but not counted as jumbo frames.
Note: 10/100/1000 Mbps Ethernet range is 12-16383; 10 Gigabit Ethernet range is 5616383; POS range is 4616383.
Type: u16
Default: 1518
OversizeFrameThreshold
Received frame sizes above this threshold will be counted as over-sized frames.
Type: u16
Default: 9018
SigMode
Specifies the method for performing the Spirent TestCenter signature field detection.
Type: enum
Default: ENHANCED_DETECTION
Possible Values:
Value
Description
LONG_SEQ_NUM
Spirent TestCenter signature field in received packets contains a long sequence number.
In this mode, the sequence number field is 48 bits long to allow for a larger range of
outstanding sequence numbers. However, it is possible that, on a very rare occasion and
under certain circumstances, a received packet that does not contain a Spirent TestCenter
signature field may falsely be detected as having a Spirent TestCenter signature field.
ENHANCED_DETECTION Spirent TestCenter signature field in received packets is configured for enhanced signature
detection. In this mode, the sequence number field is only 32 bits long. However, a 16-bit
inverse sequence number field is added to the signature to significantly reduce the likelihood
of a false positive detection of a Spirent TestCenter signature field in a received packet.
TimestampLatchMode
Specifies at what point during the reception of each packet that the receive timestamp is latched.
Type: enum
Possible Values:
Value
Description
START_OF_FRAME Specifies that the timestamp should be latched when the first byte of the frame is received.
END_OF_FRAME
Specifies that the timestamp should be latched when the last byte of the frame is received.
93
AnalyzerFilterCreateCommand
Writable Attribute
Description
UndersizeFrameThreshold
Received frame sizes below this threshold will be counted as under-sized frames.
Type: u16
Default: 64
VlanAlternateTpid
Specifies an alternate tag protocol identifier for VLAN tag. Defaults to 0x88A8 (34984 in decimal).
Type: u16
Default: 34984
Range: 1536 - 65535
AnalyzerConfig Read-Only Attributes

AnalyzerFilterCreateCommand
Description:
Create a new pattern matching filter.

AnalyzerFilterCreateCommand Writable Attributes

Writable Attribute
Description
CaptureProxyId
Capture proxy ID (handle).

Type: handle
Default: 0
FilterDescription
Description of this new analyzer filter.

Type: string
FrameConfig
Contains the PDU string for the pattern matching filter.

Type: string
ValueToBeMatched
Value to be matched in the captured frame.

Type: string
AnalyzerFilterCreateCommand Read-Only Attributes

Read-Only Attribute
Description

94
AnalyzerFrameConfigFilter
AnalyzerFrameConfigFilter
Description:
Analyzer filter profile defined on a specific frame configuration. This is the main proxy object for the analyzer filters. It contains the information for 32- and
16-bit filter configurations that you select.

Parents: Analyzer
Children: Analyzer16BitFilter, Analyzer32BitFilter
AnalyzerFrameConfigFilter Writable Attributes

Writable Attribute
Description
Active, Name
FrameConfig
String expression defining how analyzer should filter received frames for counters.
The following example counts all received Ethernet-IPv4 frames:
"<frame> <config> \
<pdus> \
<pdu name=\"eth1\" pdu=\"ethernet:EthernetII\"> </pdu> \
<pdu name=\"ip1\" pdu=\"ipv4:IPv4\"> \
<destAddr filterMinValue=\"0.0.0.0\" filterMaxValue=\"255.255.255.255\">255.255.255.255</destAddr>
\
</pdu> \
</pdus> \
</config> </frame>"
Type: string
Default: <frame><config><pdus><pdu name=\"eth1\" pdu=\"ethernet:EthernetII\" /><pdu name=\"ip_1\"
pdu=\"ipv4:IPv4\" /></pdus></config></frame>
Num16BitFilters
Number of 16 bit filter in use.

Type: u16
Default: 0
Num32BitFilters
Number of 32 bit filter in use.

Type: u16
Default: 0
Summary
Optional text describing the content of the filter profile (that is, field names and masks). This is a user-friendly version
of the FrameConfig attribute.
Type: string
AnalyzerFrameConfigFilter Read-Only Attributes

Read-Only Attribute
Description
PduInfo
Strings containing PDU information. The format is "PDU Name, String Handle, Object Handle, Indexed
Name".
Type: string
AnalyzerPortResults
Description:
Result object to store port results on the analyzer.

Parents: Analyzer
Relations:
95
AnalyzerPortResults
Side name
(Type)
Relative
Description
ResultParent
(ResultChild)
Analyzer
Use this to connect a results object to an object.
AnalyzerPortResults Writable Attributes

There are no writable attributes.
AnalyzerPortResults Read-Only Attributes

Read-Only Attribute
Description
ComboTriggerCount
Number of frames captured by all the triggers.

Type: u64
Default: 0
ComboTriggerRate
Number of frames received by all the triggers over the last 1-second interval.
Type: u64
Default: 0
CounterTimestamp
Time when the counter was stored.

Type: u64
Default: 0
FcoeFrameCount
Fiber channel over Ethernet frame count.

Type: u64
Default: 0
FcoeFrameRate
Fiber channel over Ethernet frame rate.

Type: u64
Default: 0
FcsErrorFrameCount
Number of FCS error frames received.

Type: u64
Default: 0
FcsErrorFrameRate
Number of FCS error frames received over the last 1-second interval.
Type: u64
Default: 0
HwFrameCount
Number of hardware frames received.

Type: u64
Default: 0
IcmpFrameCount
Number of ICMP frames received.

Type: u64
Default: 0
IcmpFrameRate
Number of ICMP frames received over the last 1-second interval.

Type: u64
Default: 0
Ipv4ChecksumErrorCount
Number of IPv4 checksum errors received.

Type: u64
Default: 0
Ipv4ChecksumErrorRate
Number of IPv4 checksum errors received over the last 1-second interval.
Type: u64
Default: 0
Ipv4FrameCount
Number of IPv4 frames received.

Type: u64
Default: 0
96
AnalyzerPortResults
Read-Only Attribute
Description
Ipv4FrameRate
Number of IPv4 frames received over the last 1-second interval.

Type: u64
Default: 0
Ipv6FrameCount

Type: u64
Default: 0
Ipv6FrameRate

Type: u64
Default: 0
Ipv6OverIpv4FrameCount
Number of IPv6 over IPv4 frames received.

Type: u64
Default: 0
Ipv6OverIpv4FrameRate
Number of IPv6 over IPv4 frames received over the last 1-second interval.
Type: u64
Default: 0
JumboFrameCount
Number of jumbo frames received.

Type: u64
Default: 0
JumboFrameRate
Number of jumbo frames received over the last 1-second interval.

Type: u64
Default: 0
L1BitCount
Total number of layer1 bits received.

Type: u64
Default: 0
L1BitRate
Total number of layer1 bits received over last 1-second interval.

Type: u64
Default: 0
MaxFrameLength
Maximum frame length received (in bytes).

Type: u64
Default: 0
MinFrameLength
Minimum frame length received (in bytes).

Type: u64
Default: 0
MplsFrameCount
Number of MPLS frames received.

Type: u64
Default: 0
MplsFrameRate
Number of MPLS frames received over the last 1-second interval.

Type: u64
Default: 0
OversizeFrameCount
Number of oversized frames received.

Type: u64
Default: 0
OversizeFrameRate
Number of oversized frames received over the last 1-second interval.

Type: u64
Default: 0
PauseFrameCount
Number of pause frames received.

Type: u64
Default: 0
PauseFrameRate
Number of pause frames received over the last 1-second interval.

Type: u64
Default: 0
97
AnalyzerPortResults
Read-Only Attribute
Description
PfcFrameCount
Priority pause frame count for fiber channel.

Type: u64
Default: 0
PfcFrameRate
Priority pause frame rate for fiber channel.

Type: u64
Default: 0
PfcPri0FrameCount
Number of priority0 pause frames received.

Type: u64
Default: null
PfcPri0FrameRate
Number of priority0 pause frames received over the last 1-second interval.
Type: u64
Default: null
PfcPri0Quanta
Total pause time requested for priority0 queue.

Type: u64
Default: null
PfcPri1FrameCount

Type: u64
Default: null
PfcPri1FrameRate
Type: u64
Default: null
PfcPri1Quanta

Type: u64
Default: null
PfcPri2FrameCount

Type: u64
Default: null
PfcPri2FrameRate
Type: u64
Default: null
PfcPri2Quanta

Type: u64
Default: null
PfcPri3FrameCount

Type: u64
Default: null
PfcPri3FrameRate
Type: u64
Default: null
PfcPri3Quanta

Type: u64
Default: null
PfcPri4FrameCount

Type: u64
Default: null
PfcPri4FrameRate
Type: u64
Default: null
PfcPri4Quanta

Type: u64
Default: null
98
AnalyzerPortResults
Read-Only Attribute
Description
PfcPri5FrameCount

Type: u64
Default: null
PfcPri5FrameRate
Type: u64
Default: null
PfcPri5Quanta

Type: u64
Default: null
PfcPri6FrameCount

Type: u64
Default: null
PfcPri6FrameRate
Type: u64
Default: null
PfcPri6Quanta

Type: u64
Default: null
PfcPri7FrameCount

Type: u64
Default: null
PfcPri7FrameRate
Type: u64
Default: null
PfcPri7Quanta

Type: u64
Default: null
PrbsBitErrorCount
Number of PRBS bit errors received.

Type: u64
Default: 0
PrbsBitErrorRate
Number of PRBS bit errors received over the last 1-second interval.
Type: u64
Default: 0
PrbsBitErrorRatio
PRBS bit error ratio.

Type: double
Default: 0
PrbsErrorFrameCount
Count of total PRBS error frames are received.

Type: u64
Default: null
PrbsErrorFrameRate
Rate at which PRBS error frames are received.

Type: u64
Default: null
PrbsFillOctetCount
Number of PRBS bytes received.

Type: u64
Default: 0
PrbsFillOctetRate
Number of PRBS fill bytes received over the last 1-second interval.
Type: u64
Default: 0
SigFrameCount
Number of Spirent signature frames received.

Type: u64
Default: 0
99
AnalyzerPortResults
Read-Only Attribute
Description
SigFrameRate
Rate at which Spirent signature frames are received.

Type: u64
Default: 0
TcpChecksumErrorCount
Number of frames with TCP checksum error received.

Type: u64
Default: 0
TcpChecksumErrorRate
Number of TCP checksum error frames received over the last 1-second interval.
Type: u64
Default: 0
TcpFrameCount
Number of TCP frames received.

Type: u64
Default: 0
TcpFrameRate
Number of TCP frames received over the last 1-second interval.

Type: u64
Default: 0
TotalBitCount
Total number of bits received.

Type: u64
Default: 0
TotalBitRate
Total number of bits received over the last 1-second interval.

Type: u64
Default: 0
TotalCellCount
Total number of cells received.

Type: u64
Default: 0
TotalCellRate
Total number of cells received over last 1-second interval.

Type: u64
Default: 0
TotalFrameCount
Total number of frames received.

Type: u64
Default: 0
TotalFrameRate
Total number of frames received over the last 1-second interval.

Type: u64
Default: 0
TotalOctetCount
Total number of bytes received.

Type: u64
Default: 0
TotalOctetRate
Total number of bytes received over the last 1-second interval.

Type: u64
Default: 0
Trigger1Count
Number of frames captured by trigger 1.

Type: u64
Default: 0
Trigger1Name
Name of trigger 1.
Type: string
Trigger1Rate
Number of frames received by trigger 1 over the last 1-second interval.

Type: u64
Default: 0
Trigger2Count

Type: u64
Default: 0
100
AnalyzerPortResults
Read-Only Attribute
Description
Trigger2Name
Name of trigger 2.
Type: string
Trigger2Rate

Type: u64
Default: 0
Trigger3Count

Type: u64
Default: 0
Trigger3Name
Name of trigger 3.
Type: string
Trigger3Rate

Type: u64
Default: 0
Trigger4Count

Type: u64
Default: 0
Trigger4Name
Name of trigger 4.
Type: string
Trigger4Rate

Type: u64
Default: 0
Trigger5Count

Type: u64
Default: 0
Trigger5Name
Name of trigger 5.
Type: string
Trigger5Rate

Type: u64
Default: 0
Trigger6Count

Type: u64
Default: 0
Trigger6Name
Name of trigger 6.
Type: string
Trigger6Rate

Type: u64
Default: 0
Trigger7Count

Type: u64
Default: 0
Trigger7Name
Name of trigger 7.
Type: string
Trigger7Rate

Type: u64
Default: 0
101
AnalyzerPortResults
Read-Only Attribute
Description
Trigger8Count

Type: u64
Default: 0
Trigger8Name
Name of trigger 8.
Type: string
Trigger8Rate

Type: u64
Default: 0
UdpChecksumErrorCount
Number of frames with UDP checksum error received.

Type: u64
Default: 0
UdpChecksumErrorRate
Number of UDP checksum error frames received over the last 1-second interval.
Type: u64
Default: 0
UdpFrameCount
Number of UDP frames received.

Type: u64
Default: 0
UdpFrameRate
Number of UDP frames received over the last 1-second interval.

Type: u64
Default: 0
UndersizeFrameCount
Number of undersized frames received.

Type: u64
Default: 0
UndersizeFrameRate
Number of undersized frames received over the last 1-second interval.

Type: u64
Default: 0
UserDefinedFrameCount1
Number of user defined capture filter1 frames received.

Type: u64
Default: null

Type: u64
Default: null

Type: u64
Default: null

Type: u64
Default: null

Type: u64
Default: null

Type: u64
Default: null
UserDefinedFrameRate1
Rate of user defined capture filter1 frames received.

Type: u64
Default: null

Type: u64
Default: null
102
AnalyzerPreloadProfile
Read-Only Attribute
Description

Type: u64
Default: null

Type: u64
Default: null

Type: u64
Default: null

Type: u64
Default: null
VlanFrameCount
Number of VLAN frames received.

Type: u64
Default: 0
VlanFrameRate
Number of VLAN frames received over the last 1-second interval.

Type: u64
Default: 0
Description:
Analyzer preload profile.

Parents: Project
Relations:
Side name
(Type)
Relative
AffiliationStreamBlock
(AffiliationAnalyzerPreloadStreamBlock)
StreamBlock
AnalyzerPreloadProfile Writable Attributes

Writable Attribute
Description
Active, Name
AnalyzerPreloadProfile Read-Only Attributes

AnalyzerStartCommand
Description:
Start the analyzer.
103
Description
AnalyzerStopCommand

AnalyzerStartCommand Writable Attributes

Writable Attribute
Description
AnalyzerList
A list of analyzers.
Type: handle
Default: 0
AnalyzerStartCommand Read-Only Attributes

Read-Only Attribute
Description

AnalyzerStopCommand
Description:
Stop the analyzer.

AnalyzerStopCommand Writable Attributes

Writable Attribute
Description
AnalyzerList
A list of analyzers.
Type: handle
Default: 0
AnalyzerStopCommand Read-Only Attributes

Read-Only Attribute
Description

AncpAbortCommand
Description:
Reset ANCP emulation.

104
AncpAccessLoopBlockConfig

AncpAbortCommand Writable Attributes

Writable Attribute
Description
BlockList
List of ANCP block config object handles (that is, AncpAccessNodeConfig).

Type: handle
Default: 0
ControlType
Control type for internal use only.

Type: enum
Default: ABORT
Possible Values:
Value
Description
ABORT
Abort.
INITIATEADJACENCY
Initiate Adjacency.
TERMINATEADJACENCY Terminate Adjacency.

PORTUP
Port Up.
PORTDOWN
Port Down.
STARTKEEPALIVE
Start or enable Keep-alive.
STOPKEEPALIVE
Stop or disable Keep-alive.
CLEARSTATS
Clear results.
AncpAbortCommand Read-Only Attributes

Read-Only Attribute
Description

Description:
ANCP Access Loop Block configuration settings.

Parents: AncpAccessNodeConfig
Children: AncpTlvConfig
Automatically created from: AncpAccessLoopGenParams
Relations:
Side name
(Type)
Relative
Description
DslProfile
(AffiliatedAncpDslLineProfile)
AncpDslLineProfile
Relation between the ANCP Access Loop Block config and the
ANCP DSL Line Profile.
AncpAccessLoopBlockConfig Writable Attributes

Writable Attribute
Description
Active, Name
105
AncpAccessLoopGenConfigExpandCommand
Writable Attribute
Description
DslLineStatePortDown
DSL line state to be included in a Port Down message.

Type: enum
Default: IDLE
Possible Values:
Value Description
IDLE
Sets the DSL line state to Idle in the Port Down message.
SILENT Sets the DSL line state to Silent in the Port Down message.
DslLineStatePortUp
DSL line state to be included in a Port Up message. Will only be included if IncludeDslLineStatePortUp is true.
Type: enum
Default: SHOWTIME
Possible Values:
Value
Description
SHOWTIME Sets the DSL line state to Showtime in the Port Up message.
IncludeDslLineStatePortUp
IDLE
Sets the DSL line state to Showtime in the Port Up message.
SILENT
Sets the DSL line state to Silent in the Port Up message.
Determines whether or not to include the DSL line state in the Port Up message.
Type: bool
Default: TRUE
Possible Values:
Value Description
TRUE
Include the DSL line state in the Port Up message.
FALSE Do not include the DSL line state in the Port Up message.
SessionBlock
Protocol block which contains subscriber information used in ANCP Loop Blocks (ie PppoeClientBlockConfig or
Dhcpv4BlockConfig).
Type: handle
Default: 0
AncpAccessLoopBlockConfig Read-Only Attributes

AncpAccessLoopGenConfigExpandCommand
Description:
Expands the AncpAccessLoopGenParams object into the ANCP access loop wizard.

AncpAccessLoopGenConfigExpandCommand Writable Attributes

Writable Attribute
Description
106
AncpAccessLoopGenParams
Writable Attribute
Description
ClearExisting
Type: enum
Default: PROMPT
Possible Values:
Value
Description
YES
Clear existing configuration.
NO
Do not clear existing configuration.
GenParams
AncpAccessLoopGenParams handle to expand.

Type: handle
Default: 0
UseEmulatedDeviceType
Determines whether EmulatedDevice or Host/Router objects should be created in the expansion.

Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
Expand creates EmulatedDevice objects with Role assigned to Host/Router.
FALSE Expand creates Host/Router objects.
AncpAccessLoopGenConfigExpandCommand Read-Only Attributes

Read-Only Attribute
Description

AncpAccessLoopGenParams
Description:
The AncpAccessLoopGenParams specifies the ANCP Access Loop Block generator parameters.

Parents: Project
Children: AncpAccessLoopGenSubscriberParams, Dhcpv4DeviceGenProtocolParams, PppoaDeviceGenProtocolParams, PppoeDeviceGenProtocolParams
Automatically-created children: AncpAccessLoopBlockConfig
AncpAccessLoopGenParams Writable Attributes

Writable Attribute
Description
Active, Name
AncpVersion
Select the ANCP Draft to use when configuring your ANCP Access Loop Block.
Type: enum
Default: L2CP_DRAFT_00
Possible Values:
Value
Description
L2CP_DRAFT_00 L2CP Draft 0 (draft-wadhwa-gsmp-l2control-configuration-00).
ANCP_DRAFT_02 ANCP Draft 2 (draft-ietf-ancp-protocol-02).
107
AncpAccessLoopGenSubscriberParams
Writable Attribute
Description
BlockIndexStart
The starting block index for the access loop blocks. The @b wildcard is replaced by the block index for the access loop
block.
Note: The access loop block generator expansion replaces @b with the corresponding string value.
Type: u32
Default: 1
Range: 0 - 4294967295
BlocksPerNode
Determines how many AncpAccessLoopGenSubscriberParams objects to create for each access node. This field is only
used by the Spirent TestCenter GUI.
The access loop block generator will create one access loop block for each AncpAccessLoopGenSubscriberParams
object under it.
Type: u32
Default: 1
Range: 1 - 4095
IpProtocol
Select the IP Protocol to use with the session protocol.

Type: enum
Default: IPV4
Possible Values:
Value Description
NONE No IP (only valid if session protocol is also "None").
IPV4
L2Type
The session protocol will use IPv4.
Sets the Layer 2 Type.

Type: enum
Default: ETHERNET
Possible Values:
Value
Description
ETHERNET Sets the Layer 2 Type to Ethernet.
ReplaceSessionBlockWildcard
ATM
Sets the Layer 2 Type to ATM.
EOA
Sets the Layer 2 Type to Ethernet over ATM.
Controls whether the access loop block generator replaces the @b wildcard with the corresponding string value in the
subscriber block configuration.
Type: bool
Default: TRUE
Possible Values:
Value Description
TRUE
The access loop block generator replaces @b with the corresponding string value.
FALSE @b substitution will be performed by the subscriber protocol implementation (e.g. PPP, DHCP).
Note: When this option is used, @b for the subscriber may not match @b for the access loop block.
SessionProtocol
Selects the type of subscriber session protocol to use.

Type: enum
Default: DHCP
Possible Values:
Value Description
NONE Static host.
PPP
PPP host.
DHCP DHCP host.
AncpAccessLoopGenParams Read-Only Attributes

Description:
108
The AncpAccessLoopGenSubscriberParams specifies the ANCP Access Loop Block's Subscriber specific parameters.

Parents: AncpAccessLoopGenParams
Relations:
Side name
(Type)
Relative
Description
AncpAccessNode
(AffiliatedAncpAccessNode)
EmulatedDevice
Relation between the AncpAccessLoopGenSubscriberParams and

the ANCP Access Node object.
AncpAccessLoopGenSubscriberParams Writable Attributes

Writable Attribute
Description
Active, Name
NumVlanTagsInStack
The number of VLAN Tags in the Subscriber's stack.

Type: u32
Default: 2
Range: 0 - 9
SubscriberCount
The number of subscribers in the block. If VLANs are used, this is the number of subscribers per VLAN.
Type: u32
Default: 1
Range: 1 - 32768
SubscriberIpv4Addr
The starting IPv4 address for the subscriber block.

Type: ip
Default: 192.0.0.2
SubscriberIpv4AddrStep
The step IPv4 address for the subscriber block.

Type: ip
Default: 0.0.0.1
SubscriberIpv4Gateway
The gateway IPv4 address for the subscriber block.

Type: ip
Default: 192.0.0.1
SubscriberIpv4PrefixLength
The IPv4 prefix length for the subscriber block.

Type: u8
Default: 24
Range: 1 - 32
SubscriberMac
The starting MAC address for the subscriber block.

Type: mac
Default: 00:10:94:00:00:02
SubscriberMacStep
The step MAC address for the subscriber block.

Type: mac
Default: 00:00:00:00:00:01
SubscriberVci
The starting VCI in the subscriber block.

Type: u16
Default: 0
Range: 0 - 65535
SubscriberVciCount
The number of VCIs in the subscriber block.

Type: u16
Default: 1
Range: 1 - 65535
SubscriberVciStep
The step to apply to the VCI in the subscriber block.

Type: u16
Default: 1
Range: 0 - 65535
109
AncpAccessNodeConfig
Writable Attribute
Description
SubscriberVlanCount
The number of VLAN IDs in the subscriber block.

Type: u32
Default: 1
Range: 1 - 4095
SubscriberVlanId
The starting VLAN ID for the subscriber block.

Type: u16
Default: 100
Range: 0 - 4095
SubscriberVlanIdStep
The step to apply for each subsequent VLAN ID.

Type: u16
Default: 1
Range: 0 - 4095
SubscriberVpi
The starting VPI in the subscriber block.

Type: u16
Default: 0
Range: 0 - 4095
SubscriberVpiCount
The number of VPIs in the subscriber block.

Type: u16
Default: 1
Range: 1 - 4095
SubscriberVpiStep
The step to apply to the VPI in the subscriber block.

Type: u16
Default: 1
Range: 0 - 4095
AncpAccessLoopGenSubscriberParams Read-Only Attributes

Description:
ANCP Access Node configuration settings.

Parents: EmulatedDevice
Children: AncpAccessLoopBlockConfig
Automatically-created children: AncpAccessNodeResults, Ipv4NetworkBlock
Result children (automatically created): AncpAccessNodeResults
Relations:
Side name
(Type)
Relative
Description
ViewControlPlaneMplsBindingResult
(ControlPlaneBindingResult)
ResultChild
(ResultChild)
AncpAccessNodeResults
UsesIf
(UsesIf)
Aal5If, EthIIIf, FcIf, GreIf, HdlcIf, Ipv4If, Ipv6If, ItagIf,

L2tpv2If, MplsIf, PppIf, PppoeIf, VlanIf, WimaxIf
Specifies the interfaces used by the configuration object

(configuration object examples: BgpRouterConfig,
110
AncpAccessNodeConfig Writable Attributes

Writable Attribute
Description
Active, Name
AncpKeepAliveTimeout
Keep-alive timeout in seconds.

Type: u8
Default: 10
Range: 1 - 25
AncpVersion
Select the ANCP Draft to use when configuring your ANCP Access Node.
Type: enum
Possible Values:
Value
Description
EnableBulkTransaction
Enables or disables Bulk Transaction capability. Only applicable with ANCP Draft 2.
Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
Enable Bulk Transaction capability.
FALSE Disable Bulk Transaction capability.

EnableDynamicTopologyDiscovery
Enables or disables Dynamic Topology Discovery capability.

Type: bool
Default: TRUE
Possible Values:
Value Description
TRUE
Enable Dynamic Topology Discovery capability.
FALSE Disable Dynamic Topology Discovery capability.

SenderName
MAC address to use as the sender name.

Type: mac
Default: 00:10:94:00:00:02
SenderNameSrc
Sets the source for the sender name.

Type: enum
Default: USE_ETHMAC
Possible Values:
Value
Description
MANUAL
Manually enter in a MAC address to use as the sender name.
USE_ETHMAC Use the Ethernet MAC address as the sender name.

TcpPort
TCP port to use when sending ANCP messages.

Type: u16
Default: 6068
Range: 1 - 65535
UsePartialBlockState
Flag indicating partial block state is being used.

Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
Use partial block state.
FALSE Do not use partial block state.
111
AncpAccessNodeConfig Read-Only Attributes

Read-Only Attribute
Description
AdjacencyBlockState
State of the adjacencies on the router.

Type: enum
Default: NONE
Possible Values:
Value
Description
NONE
Emulation is not yet running.
IDLE
Adjacencies are down.
ESTABLISHING At least one adjacency is establishing.
SubscriberBlockState
TERMINATING
At least one adjacency is terminating.
ESTABLISHED
At least one adjacency is established.
State of the subscribers on the router.

Type: enum
Default: NONE
Possible Values:
Value
Description
NONE
IDLE
Subscribers are down.
ESTABLISHING At least one subscriber is establishing.

TERMINATING
At least one subscriber is terminating.
ESTABLISHED
At least one subscriber is established.
Description:
ANCP Access Node results object.

Automatically created from: AncpAccessNodeConfig
Relations:
Side name
(Type)
Relative
Description
ResultParent
(ResultChild)
AncpAccessNodeResults Writable Attributes

112
AncpAccessNodeResults Read-Only Attributes

Read-Only Attribute
Description
BulkTransactionSupported
Feedback to tell you who supports the Bulk Transaction capability.

Type: enum
Default: UNSUPPORTED
Possible Values:
Value
Description
UNSUPPORTED Neither master nor slave supports the Bulk Transaction capability.
DynamicTopologyDiscoverySupported
MASTER
Only the master supports the Bulk Transaction capability.
SLAVE
Only the slave supports the Bulk Transaction capability.
NEGOTIATED
Both master and slave support the Bulk Transaction capability.
Feedback to tell you who supports the Dynamic Topology Discovery capability.
Type: enum
Possible Values:
Value
Description
UNSUPPORTED Neither master nor slave supports the Dynamic Topology Discovery capability.
KeepAliveEnabled
MASTER
Only the master supports the Dynamic Topology Discovery capability.
SLAVE
Only the slave supports the Dynamic Topology Discovery capability.
NEGOTIATED
Both master and slave support the Dynamic Topology Discovery capability.
Feedback to tell you whether or not keep-alives are enabled on this router.
Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
Keep-alives are enabled on this router.
FALSE Keep-alives are disabled on this router.

KeepAliveTimeoutCount
Total number of keep-alives that have timed out.

Type: u32
Default: 0
LineConfigSupported
Feedback to tell you who supports the Line Configuration capability.

Type: enum
Possible Values:
Value
Description
UNSUPPORTED Neither master nor slave supports the Line Configuration capability.
OamSupported
MASTER
Only the master supports the Line Configuration capability.
SLAVE
Only the slave supports the Line Configuration capability.
NEGOTIATED
Both master and slave support the Line Configuration capability.
Feedback to tell you who supports the OAM capability.

Type: enum
Possible Values:
Value
Description
UNSUPPORTED Neither master nor slave supports the OAM capability.
RxAckCount
MASTER
Only the master supports the OAM capability.
SLAVE
Only the slave supports the OAM capability.
NEGOTIATED
Both master and slave support the OAM capability.
Total number of ACK packets received.

Type: u32
Default: 0
113
Read-Only Attribute
Description
RxKeepAliveCount
Total number of keep-alive packets received.

Type: u32
Default: 0
RxManagementCount
Total number of port management packets received.

Type: u32
Default: 0
RxRstackCount
Total number of RSTACK packets received.

Type: u32
Default: 0
RxSynackCount
Total number of SYNACK packets received.

Type: u32
Default: 0
RxSynCount
Total number of SYN packets received.

Type: u32
Default: 0
RxTcpResetCount
Total number of TCP resets received.

Type: u32
Default: 0
SubscribersDown
Number of subscribers currently not established.

Type: u32
Default: 0
SubscribersUp
Number of subscribers currently established.

Type: u32
Default: 0
TransactionalMulticastSupported
Feedback to tell you who supports the Transactional Multicast capability.

Type: enum
Possible Values:
Value
Description
UNSUPPORTED Neither master nor slave supports the Transactional Multicast capability.
MASTER
Only the master supports the Transactional Multicast capability.
SLAVE
Only the slave supports the Transactional Multicast capability.
NEGOTIATED
Both master and slave support the Transactional Multicast capability.
TxAckCount
Total number of ACK packets sent.

Type: u32
Default: 0
TxKeepAliveCount
Total number of keep-alive packets sent.

Type: u32
Default: 0
TxPortDownCount
Total number of Port Down packets sent.

Type: u32
Default: 0
TxPortUpCount
Total number of Port Up packets sent.

Type: u32
Default: 0
TxRstackCount
Total number of RSTACK packets sent.

Type: u32
Default: 0
TxSynackCount
Total number of SYNACK packets sent.

Type: u32
Default: 0
114
AncpClearStatsCommand
Read-Only Attribute
Description
TxSynCount
Total number of SYN packets sent.

Type: u32
Default: 0
AncpClearStatsCommand
Description:
Clear ANCP results.

AncpClearStatsCommand Writable Attributes

Writable Attribute
Description
BlockList

Type: handle
Default: 0
ControlType

Type: enum
Default: ABORT
Possible Values:
Value
Description
ABORT
Abort.
INITIATEADJACENCY
Initiate Adjacency.

PORTUP
Port Up.
PORTDOWN
Port Down.
STARTKEEPALIVE
STOPKEEPALIVE
CLEARSTATS
Clear results.
AncpClearStatsCommand Read-Only Attributes

Read-Only Attribute
Description

AncpCpeToDslamLink
Description:
ANCP CPE to DSLAM link.
115
AncpDeviceGenProtocolParams
Relations:
Side name
(Type)
Relative
Description
ContainedLink
(ContainedLink)
AncpCpeToDslamLink, CustomLink, EoamLink, EthernetBridgeLink, IpForwardingLink,

ItagServiceLink, L3ForwardingLink, MplsForwardingLink, MplsHierarchicalLink,
MplsIpv4VpnCeToPeLink, MplsIpv6VpnCeToPeLink, MplsL2VpnPeToPLink,
MplsL3VpnPeToPLink, MVpnGreCeToPeLink, MVpnGrePeToPLink, VlanSwitchLink,
VplsBgpCeToPeLink, VplsLdpCeToPeLink, VrfCustomerLink, VrfProviderLink
Container
(ContainedLink)
EmulatedDevice
LinkDstDevice
(LinkDstDevice)
EmulatedDevice
AncpCpeToDslamLink Writable Attributes

Writable Attribute
Description
Active, Name
LinkType
Name of the link type (AncpCpeToDslamLink).

Type: string
AncpCpeToDslamLink Read-Only Attributes

Description:
Specifies the ANCP-specific router generator parameters.

AncpDeviceGenProtocolParams Writable Attributes

Writable Attribute
Description
Active, Name
AncpKeepAliveTimeout
Keep-alive timeout in seconds.

Type: u8
Default: 10
Range: 1 - 25
AncpVersion
Select the ANCP Draft to use when configuring your ANCP Access Node.
Type: enum
Possible Values:
Value
Description
116
Writable Attribute
Description
EnableBulkTransaction
Enables or disables Bulk Transaction capability. Only applicable with ANCP Draft 2.
Type: bool
Default: TRUE
Possible Values:
Value Description
TRUE
Enable Bulk Transaction capability.
FALSE Disable Bulk Transaction capability.

EnableDynamicTopologyDiscovery
Enables or disables Dynamic Topology Discovery capability.

Type: bool
Default: TRUE
Possible Values:
Value Description
TRUE
Enable Dynamic Topology Discovery capability.
FALSE Disable Dynamic Topology Discovery capability.

PeerIpv4Addr
Peer IPv4 address.

Type: ip
Default: 0.0.0.0
PeerIpv4AddrStep
Peer IPv4 address step.

Type: ip
Default: 0.0.0.0
SenderName
MAC address to use as the sender name.

Type: mac
Default: 00:10:94:00:00:02
SenderNameSrc
Sets the source for the sender name.

Type: enum
Default: USE_ETHMAC
Possible Values:
Value
Description
MANUAL
Manually enter in a MAC address to use as the sender name.
USE_ETHMAC Use the Ethernet MAC as the sender name.

SenderNameStep
Sender name MAC address step (when using MANUAL entry).

Type: mac
Default: 00:00:00:00:00:01
TcpPort
TCP port to use when sending ANCP messages.

Type: u16
Default: 6068
Range: 1 - 65535
UseGatewayAsPeerIpAddr
Flag indicating the Gateway IP should be used as the Peer IP.

Type: bool
Default: TRUE
Possible Values:
Value Description
TRUE
Use the Gateway as the Peer IP.
FALSE Do not use the Gateway as the Peer IP.
AncpDeviceGenProtocolParams Read-Only Attributes

117
AncpDslLineProfile
AncpDslLineProfile
Description:
ANCP DSL line profile configuration settings.

Parents: Project
Children: AncpTlvConfig
Relations:
Side name
(Type)
Relative
Description
(AffiliatedAncpDslLineProfile)
Relation between the ANCP access loop block config and

the ANCP DSL line profile.
AncpDslLineProfile Writable Attributes

Writable Attribute
Description
Active, Name
AncpVersion
Select the ANCP draft to use when configuring your ANCP DSL line profile.
Type: enum
Possible Values:
Value
Description
AncpDslLineProfile Read-Only Attributes

AncpImportSubscriberInfoCommand
Description:
Import Access Subscriber Information into the ANCP protocol.

AncpImportSubscriberInfoCommand Writable Attributes

Writable Attribute
Description
AccessLoopBlockList
Subscriber Information will be stored in the AccessLoopBlock.

Type: handle
Default: 0
BlockList
List of protocol blocks which contains subscriber information used in ANCP TLVs (that is,
PppoeClientBlockConfig or Dhcpv4BlockConfig).
Type: handle
Default: 0
118
AncpInitiateAdjacencyCommand
Writable Attribute
Description
L2NetworkIfList
L2 network interface handle used for ANCP TLV messages. For untagged subscribers this is the Host's
EthIIIf, for upstream C-Tag ID this is the Host's innermost VlanIf.
Type: handle
Default: 0
AncpImportSubscriberInfoCommand Read-Only Attributes

Read-Only Attribute
Description

AncpInitiateAdjacencyCommand
Description:
Initiate ANCP Adjacency.

AncpInitiateAdjacencyCommand Writable Attributes

Writable Attribute
Description
BlockList

Type: handle
Default: 0
ControlType

Type: enum
Default: ABORT
Possible Values:
Value
Description
ABORT
Abort.
INITIATEADJACENCY
Initiate Adjacency.

PORTUP
Port Up.
PORTDOWN
Port Down.
STARTKEEPALIVE
STOPKEEPALIVE
CLEARSTATS
Clear results.
AncpInitiateAdjacencyCommand Read-Only Attributes

Read-Only Attribute
Description

119
AncpInitiateAdjacencyWaitCommand
AncpInitiateAdjacencyWaitCommand
Description:
Wait for ANCP node's adjacencies to go into established state.

Parents: Sequencer
AncpInitiateAdjacencyWaitCommand Writable Attributes

Writable Attribute
Description
ErrorOnFailure
AdjacencyBlockState
State of the block to wait for.

Type: enum
Default: ESTABLISHED
Possible Values:
Value
Description
NONE
Null state.
IDLE
Idle state.
ESTABLISHING Establishing state.

TERMINATING
Terminating state.
ESTABLISHED
Established state.
ObjectList

Type: handle
Default: 0
WaitTime
Maximum amount of time to wait for ANCP node's adjacencies to go into established state.
Type: double
Default: 30.0
Range: 0.005 - 2147483647.0
AncpInitiateAdjacencyWaitCommand Read-Only Attributes

Read-Only Attribute
Description
PassFailState, Successful, Unsuccessful
AncpMapSubscriberCommand
Description:
Map Access Subscribers to a DSLAM local loop and assigns a profile. AccessLoopBlockList and DslProfileList must be the same length. SubscriberStartEndList
is twice the size of AccessLoopBlockList.

AncpMapSubscriberCommand Writable Attributes

Writable Attribute
Description
120
AncpPortConfig
Writable Attribute
Description
AccessLoopBlockList
List of ANCP Loop Block object handles (that is, AncpAccessLoopBlockConfig).

Type: handle
Default: 0
DslProfileList
List of ANCP DSL Line Profile object handles (that is, AncpDslLineProfile).
Type: handle
Default: 0
SubscriberStartEndList
Each pair of consecutive u16s represent an inclusive range of subscribers' starting and ending numbers
from the host bound using the AncpImportSubscriberInfoCommand.
Type: u16
Default: 0
AncpMapSubscriberCommand Read-Only Attributes

Read-Only Attribute
Description

AncpPortConfig
Description:
Port-level ANCP configuration settings.

Automatically-created children: AncpPortResults
Result children (automatically created): AncpPortResults
Relations:
Side name
(Type)
Relative
Description
ResultChild
(ResultChild)
AncpPortResults
AncpPortConfig Writable Attributes

Writable Attribute
Description
Active, Name
EstablishRate
Maximum number of Initiate Adjacency and/or Port Up attempts that will be made per second.
Type: u16
Default: 100
Range: 1 - 1000
SeqType
Port-level sequence type that determines in what order adjacencies and/or port up/downs are attempted.
Type: enum
Default: SEQUENTIAL
Possible Values:
Value
Description
SEQUENTIAL Attempted sequentially across routers under the port.
PARALLEL
Attempted in parallel across routers under the port.
121
AncpPortDownCommand
Writable Attribute
Description
TerminateRate
Maximum number of Terminate Adjacency and/or Port Down attempts that will be made per second.
Type: u16
Default: 100
Range: 1 - 1000
AncpPortConfig Read-Only Attributes

Read-Only Attribute
Description
AdjacencyPortState
State of the ANCP engine's adjacencies.

Type: enum
Default: NONE
Possible Values:
Value
Description
NONE
None of the routers are configured for ANCP.
IDLE
None of the adjacencies on the routers are establishing or terminating.
ESTABLISHING
At least one adjacency in one of the routers is establishing.
TERMINATING
At least one adjacency in one of the routers is terminating.
ESTABLISH_TERMINATE Adjacencies on this port are establishing on some routers and terminating on others.
ESTABLISHED
SubscriberPortState
At least one adjacency in one router is established.
State of the ANCP engine's subscribers.

Type: enum
Default: NONE
Possible Values:
Value
Description
NONE
None of the routers are configured for ANCP.
IDLE
None of the subscribers on the routers are establishing or terminating.
ESTABLISHING
At least one subscriber in one of the routers is establishing.
TERMINATING
At least one subscriber in one of the routers is terminating.
ESTABLISH_TERMINATE Subscribers on this port are establishing on some routers and terminating on others.
ESTABLISHED
At least one subscriber in one router is established.
AncpPortDownCommand
Description:
Terminate ANCP subscribers via the Port Down command.

AncpPortDownCommand Writable Attributes

Writable Attribute
Description
BlockList

Type: handle
Default: 0
122
AncpPortDownWaitCommand
Writable Attribute
Description
ControlType

Type: enum
Default: ABORT
Possible Values:
Value
Description
ABORT
Abort.
INITIATEADJACENCY
Initiate Adjacency.

PORTUP
Port Up.
PORTDOWN
Port Down.
STARTKEEPALIVE
STOPKEEPALIVE
CLEARSTATS
Clear results.
AncpPortDownCommand Read-Only Attributes

Read-Only Attribute
Description

AncpPortDownWaitCommand
Description:
Wait for ANCP node's subscribers to go into idle state.

Parents: Sequencer
AncpPortDownWaitCommand Writable Attributes

Writable Attribute
Description
ErrorOnFailure
ObjectList

Type: handle
Default: 0

Type: enum
Default: IDLE
Possible Values:
Value
Description
NONE
Null state.
IDLE
Idle state.

TERMINATING
Terminating state.
ESTABLISHED
Established state.
123
AncpPortResults
Writable Attribute
Description
WaitTime
Maximum amount of time to wait for ANCP node's subscribers to go into established state.
Type: double
Default: 30.0
Range: 0.005 - 2147483647.0
AncpPortDownWaitCommand Read-Only Attributes

Read-Only Attribute
Description
AncpPortResults
Description:
Port-level ANCP results.

Automatically created from: AncpPortConfig
Relations:
Side name
(Type)
Relative
Description
ResultParent
(ResultChild)
AncpPortConfig
AncpPortResults Writable Attributes

AncpPortResults Read-Only Attributes

Read-Only Attribute
Description
AdjacenciesDown
Number of adjacencies currently not established.

Type: u32
Default: 0
AdjacenciesEstablished
Number of adjacencies currently established.

Type: u32
Default: 0
KeepAliveTimeoutCount
Total number of keep-alives that have timed out.

Type: u32
Default: 0
RxAckCount
Total number of ACK packets received.

Type: u32
Default: 0
RxKeepAliveCount
Total number of keep-alive packets received.

Type: u32
Default: 0
RxManagementCount
Total number of port management packets received.

Type: u32
Default: 0
124
AncpPortUpCommand
Read-Only Attribute
Description
RxRstackCount
Total number of RSTACK packets received.

Type: u32
Default: 0
RxSynackCount
Total number of SYNACK packets received.

Type: u32
Default: 0
RxSynCount
Total number of SYN packets received.

Type: u32
Default: 0
RxTcpResetCount
Total number of TCP resets received.

Type: u32
Default: 0
SubscribersDown
Number of subscribers currently not established.

Type: u32
Default: 0
SubscribersUp
Number of subscribers currently established.

Type: u32
Default: 0
TxAckCount
Total number of ACK packets sent.

Type: u32
Default: 0
TxKeepAliveCount
Total number of keep-alive packets sent.

Type: u32
Default: 0
TxPortDownCount
Total number of Port Down packets sent.

Type: u32
Default: 0
TxPortUpCount
Total number of Port Up packets sent.

Type: u32
Default: 0
TxRstackCount
Total number of RSTACK packets sent.

Type: u32
Default: 0
TxSynackCount
Total number of SYNACK packets sent.

Type: u32
Default: 0
TxSynCount
Total number of SYN packets sent.

Type: u32
Default: 0
AncpPortUpCommand
Description:
Establish ANCP subscribers using the Port Up command.

125
AncpPortUpWaitCommand
AncpPortUpCommand Writable Attributes

Writable Attribute
Description
BlockList

Type: handle
Default: 0
ControlType

Type: enum
Default: ABORT
Possible Values:
Value
Description
ABORT
Abort.
INITIATEADJACENCY
Initiate Adjacency.

PORTUP
Port Up.
PORTDOWN
Port Down.
STARTKEEPALIVE
STOPKEEPALIVE
CLEARSTATS
Clear results.
AncpPortUpCommand Read-Only Attributes

Read-Only Attribute
Description

AncpPortUpWaitCommand
Description:
Wait for ANCP node's subscribers to go into established state.

Parents: Sequencer
AncpPortUpWaitCommand Writable Attributes

Writable Attribute
Description
ErrorOnFailure
ObjectList

Type: handle
Default: 0
126
AncpStartKeepAliveCommand
Writable Attribute
Description

Type: enum
Default: ESTABLISHED
Possible Values:
Value
Description
NONE
Null state.
IDLE
Idle state.
WaitTime
TERMINATING
Terminating state.
ESTABLISHED
Established state.
Maximum amount of time to wait for ANCP node's subscribers to go into established state.
Type: double
Default: 30.0
Range: 0.005 - 2147483647.0
AncpPortUpWaitCommand Read-Only Attributes

Read-Only Attribute
Description
AncpStartKeepAliveCommand
Description:
Start ANCP's keep-alive if it has been stopped while the adjacency is established. Enable ANCP's keep-alive if it has been disabled while the adjacency is
idle.

AncpStartKeepAliveCommand Writable Attributes

Writable Attribute
Description
BlockList

Type: handle
Default: 0
127
AncpStopKeepAliveCommand
Writable Attribute
Description
ControlType

Type: enum
Default: ABORT
Possible Values:
Value
Description
ABORT
Abort.
INITIATEADJACENCY
Initiate Adjacency.

PORTUP
Port Up.
PORTDOWN
Port Down.
STARTKEEPALIVE
STOPKEEPALIVE
CLEARSTATS
Clear results.
AncpStartKeepAliveCommand Read-Only Attributes

Read-Only Attribute
Description

AncpStopKeepAliveCommand
Description:
Stop ANCP's keep-alive if it has been started while the adjacency is established. Disable ANCP's keep-alive if it has been enabled while the adjacency is idle.

AncpStopKeepAliveCommand Writable Attributes

Writable Attribute
Description
BlockList

Type: handle
Default: 0
ControlType

Type: enum
Default: ABORT
Possible Values:
Value
Description
ABORT
Abort.
INITIATEADJACENCY
Initiate Adjacency.

PORTUP
Port Up.
PORTDOWN
Port Down.
STARTKEEPALIVE
STOPKEEPALIVE
CLEARSTATS
Clear results.
128
AncpTerminateAdjacencyCommand
AncpStopKeepAliveCommand Read-Only Attributes

Read-Only Attribute
Description

AncpTerminateAdjacencyCommand
Description:
Terminate ANCP Adjacency.

AncpTerminateAdjacencyCommand Writable Attributes

Writable Attribute
Description
BlockList

Type: handle
Default: 0
ControlType

Type: enum
Default: ABORT
Possible Values:
Value
Description
ABORT
Abort.
INITIATEADJACENCY
Initiate Adjacency.

PORTUP
Port Up.
PORTDOWN
Port Down.
STARTKEEPALIVE
STOPKEEPALIVE
CLEARSTATS
Clear results.
AncpTerminateAdjacencyCommand Read-Only Attributes

Read-Only Attribute
Description

AncpTerminateAdjacencyWaitCommand
Description:
Wait for ANCP node's adjacencies to go into idle state.
129
AncpTlvConfig

Parents: Sequencer
AncpTerminateAdjacencyWaitCommand Writable Attributes

Writable Attribute
Description
ErrorOnFailure
AdjacencyBlockState

Type: enum
Default: IDLE
Possible Values:
Value
Description
NONE
Null state.
IDLE
Idle state.

TERMINATING
Terminating state.
ESTABLISHED
Established state.
ObjectList

Type: handle
Default: 0
WaitTime
Maximum amount of time to wait for ANCP node's adjacencies to go into idle state.
Type: double
Default: 30.0
Range: 0.005 - 2147483647.0
AncpTerminateAdjacencyWaitCommand Read-Only Attributes

Read-Only Attribute
Description
AncpTlvConfig
Description:
ANCP TLV configuration settings.

Parents: AncpAccessLoopBlockConfig, AncpDslLineProfile
Children: AncpWildcardModifier
AncpTlvConfig Writable Attributes

Writable Attribute
Description
Active, Name
FrameConfig
XML string corresponding to the TLVs defined by this object.

Type: string
130
AncpUnMapSubscriberCommand
AncpTlvConfig Read-Only Attributes

Read-Only Attribute
Description
PduInfo
Type: string
AncpUnMapSubscriberCommand
Description:
Unmap Access Subscribers from a DSLAM local loop and assigns a profile. AccessLoopBlockList and DslProfileList must be the same length.
SubscriberStartEndList is twice the size of AccessLoopBlockList.

AncpUnMapSubscriberCommand Writable Attributes

Writable Attribute
Description
AccessLoopBlockList
List of ANCP Loop Block object handles (that is, AncpAccessLoopBlockConfig).

Type: handle
Default: 0
DslProfileList
List of ANCP DSL Line Profile object handles (that is, AncpDslLineProfile).
Type: handle
Default: 0
SubscriberStartEndList
Each pair of consecutive u16s represent an inclusive range of subscribers' starting and ending numbers
from the host bound using the AncpImportSubscriberInfoCommand To remove all subscribers using a
AncpDslLineProfile, leave the range empty.
Type: u16
Default: 0
AncpUnMapSubscriberCommand Read-Only Attributes

Read-Only Attribute
Description

AncpWildcardModifier
Description:
Used to insert wildcard values into the TLV definition.

Parents: AncpTlvConfig
131
app
AncpWildcardModifier Writable Attributes

Writable Attribute
Description
Active, Name
Data
Wildcard string that will replace the field in the TLV definition.
Type: string
OffsetReference
String that indicates the protocol field in the TLV (PDU) object to which the offset applies. Use the format
objectName.attribute, where objectName is the value of the Name attribute on the PDU object, and attribute is the
attribute you want to reference on that object.
For example, if you want to reference the ID field in an AccessLoopCircuitIdTlv object, create the AccessLoopCircuitIdTlv
object and set its Name attribute to "MyCircuitIdTlv". Then in the OffsetReference attribute of the AncpWildcardModifier
object, refer to this AccessLoopSircuitIdTlv field as MyCircuitIdTlv.ID.
Type: string
AncpWildcardModifier Read-Only Attributes

app
Description:
Parents: applicatonTlv
Children: AppStruct
app Attributes
Attribute
Description
Name
information.
Type: string
ApplicationPriorityTlv (lldp:ApplicationPriorityTlv)
Description:
Children: appTable
Next headers: lldp:SystemNameTlv, lldp:SystemDescriptionTlv, lldp:PortDescriptionTlv, lldp:SystemCapabilitiesTlv, lldp:ManagementAddrTlv, lldp:EndTlv,
lldp:CustomTlv, lldp:MacPhyConfigStatusTlv, lldp:PowerViaMdiTlv, lldp:LinkAggregationTlv, lldp:MaxFrameSizeTlv, lldp:PortVlanIdTlv, lldp:VlanNameTlv,
lldp:PortAndProtocolVlanIdTlv, lldp:ProtocolIdentityTlv, lldp:OrganizationallySpecificTlv, lldp:TrafficClassesSupportedTlv, lldp:PriorityBasedFlowControlTlv,
lldp:ETSConfigurationTlv, lldp:ETSRecommendationTlv, lldp:CongestionNotificationTlv, lldp:NivSupportTlv
ApplicationPriorityTlv Attributes
Attribute
Description
length
Type: INTEGER
Default: 0
132
applicatonTlv
Attribute
Description
Name
Type: string
oui
Type: OCTETSTRING
Default: 0080C2
reserved
Type: BITSTRING
Default: 0000000
subtype
Type: OCTETSTRING
Default: 12
type
Type: INTEGER
Default: 127
willing
Type: BITSTRING
Default: 1
applicatonTlv (overloaded)
applicatonTlv (lldp) - Object definition for the following paths:
StreamBlock.DcbxTlvt1.value.DcbxSubTlvt1.applicatonTlv
applicatonTlv (lldp) - Object definition for the following paths:
StreamBlock.DcbxTlvt2.value.DcbxSubTlvt2.applicatonTlv
applicatonTlv Object (lldp PDU library)

Description:
Parents: DcbxSubTlvt1 (StreamBlock.DcbxTlvt1.value.DcbxSubTlvt1)

Children: header
applicatonTlv Attributes
Attribute
Description
Name
more information.
Type: string
priorityMap
Type: BITSTRING
Default: 00001000
133
ApplyToILCommand
applicatonTlv Object (lldp PDU library)

Description:

Children: app, header
applicatonTlv Attributes
Attribute
Description
Name
information.
Type: string
ApplyToILCommand
Description:
Applies the current configuration.

Parents: Sequencer
ApplyToILCommand Writable Attributes

ApplyToILCommand Read-Only Attributes

AppPriority
Description:
Parents: appTable
Children: None
AppPriority Attributes
Attribute
Description
Name
Type: string
priority
Type: INTEGER
Default: 0
134
AppStruct
Attribute
Description
protocolId
Type: OCTETSTRING
Default: 1B21
reserved
Type: BITSTRING
Default: 00
sel
Type: INTEGER
Default: 0
AppStruct
Description:
Parents: app
Children: None
AppStruct Attributes
Attribute
Description
appId
Type: OCTETSTRING
Default: 8906
lowerOUI
Type: OCTETSTRING
Default: 1B21
Name
Type: string
priorityMap
Type: BITSTRING
Default: 00001000
sf
Type: BITSTRING
Default: 00
upperOUI
Type: BITSTRING
Default: 000000
appTable
Description:
Parents: ApplicationPriorityTlv
Children: AppPriority
appTable Attributes
Attribute
Description
Name
information.
Type: string
135
ARP
ARP (arp:ARP)
Description:
The ARP message
Children: None
Next headers: custom:Custom
ARP Attributes
Attribute
Description
hardware
Hardware type
Type: HardwareByte
Default: 0001
Possible Values:
Value Description
0001
Ethernet
ihAddr
Hardware address length

Type: INTEGER
Default: 6
ipAddr
Protocol address length

Type: INTEGER
Default: 4
Name
Type: string
operation
Operation code
Type: ARPOperationByte
Default: 1
Possible Values:
Value Description
protocol
Unknown
ARP Request
ARP Reply
Protocol type
Type: ProtocolByte
Default: 0800
Possible Values:
Value Description
0800
Internet IP
senderHwAddr
Sender hardware address

Type: MACADDR
Default: 00:00:01:00:00:02
senderPAddr
Sender IP address
Type: IPV4ADDR
Default: 192.85.1.2
targetHwAddr
Target hardware address

Type: MACADDR
Default: 00:00:00:00:00:00
targetPAddr
Target IP address
Type: IPV4ADDR
Default: 0.0.0.0
136
ArpCache
ArpCache
Description:
This object holds the ARP cache table per port.
Tcl example: stc::get [stc::get port1 -children-arpcache]

Relations:
Side name
(Type)
Relative
Description
ResultParent
(ResultChild)
Port
ArpCache Writable Attributes

Writable Attribute
Description
Active, Name
ArpCache Read-Only Attributes

Read-Only Attribute
Description
ArpCacheData
ARP cache data as an array of strings; each string containing "ObjName Location SourceAddress GatewayAddress
ResolvedMacAddress".
Tcl example: stc::get [stc::get port1 -children-arpcache] -ArpCacheData
Type: string
ArpNdConfig
Description:
ARP/ND configuration. The ARP/ND capability resolves the MAC address of the gateway/destination configured in stream blocks or emulated devices. A
project can contain exactly one ArpNdConfig object.

Automatically created from: Project
ArpNdConfig Writable Attributes

Writable Attribute
Description
Active, Name
DuplicateGatewayDetection
Whether to perform ARP/ND suppression for a duplicate gateway.

Type: bool
Default: TRUE
Possible Values:
Value Description
TRUE
Enable ARP/ND suppression for duplicate gateway.
FALSE Disable ARP/ND suppression for duplicate gateway.
137
ArpNdConfig
Writable Attribute
Description
EnableAutoArp
Whether to resolve IPv4 or IPv6 addresses before transmitting.

For emulated hosts and routers, once ARP has been resolved, it will not be resolved again. For stream blocks,
ARP will be resolved each time before transmitting, even if it has already been resolved.
Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
Resolve IP addresses before transmitting.
FALSE Do not resolve IP addresses before transmitting.

EnableCyclicArp
Whether to enable or disable cyclic ARP.

Tcl example: stc::config [stc::get project1 -children-arpndconfig] -EnableCyclicArp true
Type: bool
Default: TRUE
Possible Values:
Value Description
TRUE
Enable cyclic ARP.
FALSE Disable cyclic ARP.

EnableUniqueMacAddrInReply
Whether to enable the firmware to respond with a unique MAC address.

Tcl example: stc::config [stc::get project1 -children-arpndconfig] -EnableUniqueMacAddrInReply true
Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
Reply with unique MAC address.
FALSE Do not reply with MAC address.

EnableUniqueMacPattern
Sets the response pattern for the first two octets of the MAC address to be sent to firmware when
EnableUniqueMacAddrInReply is enabled.
Tcl example: stc::config [stc::get project1 -children-arpndconfig] -UniqueMACPattern 1111
Type: u16
Default: 2222
IgnoreFailures
Whether to ignore ARP/ND failures and proceed to transmit.

Type: bool
Default: TRUE
Possible Values:
Value Description
TRUE
If ARP/ND fails, transmit anyway.
FALSE If ARP/ND fails, do not transmit.

LearningRate
Learning rate for ARP/ND in packets per second.

Tcl example: stc::config [stc::get project1 -children-arpndconfig] -LearningRate 20000
Type: u32
Default: 250
MaxBurst
Maximum burst size allowed for ARP/ND. Specified in packets.

Tcl example: stc::config [stc::get project1 -children-arpndconfig] -MaxBurst 20000
Type: u32
Default: 16
ProcessGratuitousArpRequests
Whether to allow gratuitous ARP requests from the DUT.

Tcl example: stc::config [stc::get project1 -children-arpndconfig] -ProcessGratuitousArpRequests false
Type: bool
Default: TRUE
Possible Values:
Value Description
TRUE
Allow gratuitous ARP requests from the DUT.
FALSE Do not allow gratuitous ARP requests from the DUT.
138
ArpNdReport
Writable Attribute
Description
ProcessUnsolicitedArpReplies
Whether to allow unsolicited ARP replies from the DUT.

Tcl example: stc::config [stc::get project1 -children-arpndconfig] -ProcessUnsolicitedArpReplies false
Type: bool
Default: TRUE
Possible Values:
Value Description
TRUE
Allow unsolicited ARP replies from the DUT.
FALSE Do not allow unsolicited ARP replies from the DUT.

RetryCount
Retry count of ARP/ND.

Tcl example: stc::config [stc::get project1 -children-arpndconfig] -RetryCount 5
Type: u32
Default: 3
Range: 0 - 100
TimeOut
Timeout interval in milliseconds for ARP/ND.

Tcl example: stc::config [stc::get project1 -children-arpndconfig] -TimeOut 50
Type: u32
Default: 1000
UseLinkLocalAddrForNeighborDiscovery
Use link local interface of the emulated device to do neighbor discover

Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
Use link local interface
FALSE Use global interface
ArpNdConfig Read-Only Attributes

ArpNdReport
Description:
Provides the Arp/Nd Statistics after each Arp/Nd Operation.

Relations:
Side name
(Type)
Relative
Description
ResultParent
(ResultChild)
Port
ArpNdReport Writable Attributes

Writable Attribute
Description
Active, Name
139
ArpNdResults
ArpNdReport Read-Only Attributes

Read-Only Attribute
Description
ArpNdStatus
Provides the current status of Arp/Nd under port.

Type: enum
Default: IDLE
Possible Values:
Value
Description
IDLE
Arp/Nd is not in progress.
INPROGRESS Arp/Nd is in progress.

SUCCESSFUL All the attempted ARPs under port are successful.
FAILURE
Some attempted ARPs under port failed.
AttemptedArpNdCount
Total number of attempted Arp/Nd.

Type: u32
Default: 0
FailedArpNdCount
Total number of failed Arp/Nd.

Type: u32
Default: 0
SuccessfulArpNdCount
Total number of successful Arp/Nd.

Type: u32
Default: 0
ArpNdResults
Description:
Each port can contain exactly one ArpNd results.
Tcl example: stc::get port1 -children-arpndresults

Parents: Port
Relations:
Side name
(Type)
Relative
Description
ResultParent
(ResultChild)
Port
ArpNdResults Writable Attributes

ArpNdResults Read-Only Attributes

Read-Only Attribute
Description
RxArpReplyCount
Number of ARP replies received.

Type: u32
Default: 0
RxArpRequestCount
Number of ARP requests received.

Type: u32
Default: 0
140
ArpNdStartCommand
Read-Only Attribute
Description
RxGratuitousArpCount
Number of gratuitous ARP packets received.

Type: u32
Default: 0
RxIcmpV6ChecksumErrorCount
Number of ICMPv6 checksum errors received.

Type: u32
Default: 0
RxIcmpV6CodeErrorCount
Number of ICMPv6 code errors received.

Type: u32
Default: 0
RxIcmpV6LengthErrorCount
Number of ICMPv6 length errors received.

Type: u32
Default: 0
RxIpV6HopLimitErrorCount
Number of IPv6 hop limit errors received.

Type: u32
Default: 0
RxIpV6PayloadLengthErrorCount
Number of IPv6 payload length errors received.

Type: u32
Default: 0
RxNdDestAddrErrorCount
Number of neighbor discovery destination address errors received.

Type: u32
Default: 0
RxNdOptionErrorCount
Number of neighbor discovery options errors received.

Type: u32
Default: 0
RxNdTargetAddrErrorCount
Number of neighbor discovery target address errors received.

Type: u32
Default: 0
RxNeighborAdvertisementCount
Number of neighbor advertisements received.

Type: u32
Default: 0
RxNeighborSolicitationCount
Number of neighbor solicitations received.

Type: u32
Default: 0
TxArpReplyCount
Number of ARP replies sent.

Type: u32
Default: 0
TxArpRequestCount
Number of ARP requests sent.

Type: u32
Default: 0
TxNeighborAdvertisementCount
Number of neighbor advertisements sent.

Type: u32
Default: 0
TxNeighborSolicitationCount
Number of neighbor solicitations sent.

Type: u32
Default: 0
ArpNdStartCommand
141
ArpNdStartOnAllDevicesCommand
Description:
Send an ARP to the DUT to retrieve the gateway MAC address.
The sequence of commands that is executed is as follows:
- Start ARP/ND on Tx and Rx internally.
- Start ARP/ND verification on Tx and Rx if requested.

ArpNdStartCommand Writable Attributes

Writable Attribute
Description
ForceArp
Whether the command should be Arp even if Arp is not required.

Type: bool
Default: TRUE
Possible Values:
Value Description
TRUE
The command should be Arp.
FALSE The command should not be Arp.

HandleList
The handle of the port, stream or emulated device.

Type: handle
Default: 0
WaitForArpToFinish
Indicates if command should wait for all Arp/Nds to finish.

Type: bool
Default: TRUE
Possible Values:
Value Description
TRUE
Wait for Arp/Nd to finish.
FALSE Do not wait for Arp/Nd to finish.
ArpNdStartCommand Read-Only Attributes

Read-Only Attribute
Description

ArpNdState
The state of Arp/Nd.

Type: enum
Default: IDLE
Possible Values:
Value
Description
IDLE
Idle
WAITING
Waiting
SUCCESSFUL Passed
FAILURE
Failed
CONGESTED Congested
ArpNdStartOnAllDevicesCommand
Description:
142
ArpNdStartOnAllStreamBlocksCommand
Start Arp/Nd on all the devices under all specified ports.

ArpNdStartOnAllDevicesCommand Writable Attributes

Writable Attribute
Description
PortList
List of port handles.

Type: handle
Default: 0
WaitForArpToFinish
Whether the command should wait for all Arp/Nds to finish.

Type: bool
Default: TRUE
Possible Values:
Value Description
TRUE
Wait for Arp/Nds to finish.
FALSE Do not wait for Arp/Nds to finish.
ArpNdStartOnAllDevicesCommand Read-Only Attributes

Read-Only Attribute
Description

ArpNdState
Provides Status of Arp/Nd.

Type: enum
Default: IDLE
Possible Values:
Value
Description
IDLE
Idle.
WAITING
Arp/Nd is in progress.
SUCCESSFUL All attempted Arp/Nds resolved successfully.

FAILURE
Some attempted Arp/Nds could not resolve successfully.
CONGESTED Some attempted Arp/Nds are congested.
ArpNdStartOnAllStreamBlocksCommand
Description:
Start ARP/ND on all the streamblocks under all specified ports.

ArpNdStartOnAllStreamBlocksCommand Writable Attributes

Writable Attribute
Description
143
ArpNdStopCommand
Writable Attribute
Description
PortList
The ports that you want to do Arp/Nd.

Type: handle
Default: 0
WaitForArpToFinish
Indicates if command should wait for all Arp/Nds to finish.

Type: bool
Default: TRUE
Possible Values:
Value Description
TRUE
Wait for Arp/Nd to finish.
FALSE Do not wait for Arp/Nd to finish.
ArpNdStartOnAllStreamBlocksCommand Read-Only Attributes

Read-Only Attribute
Description

ArpNdState
Provides Status of Arp/Nd.

Type: enum
Default: IDLE
Possible Values:
Value
Description
IDLE
Idle.
WAITING
Arp/Nd is in progress.
SUCCESSFUL All attempted Arp/Nds resolved successfully.

FAILURE
Some attempted Arp/Nds could not resolve successfully.
CONGESTED Some attempted Arp/Nds are congested.
ArpNdStopCommand
Description:
Cancel ARP/ND. This command is exposed to the GUI.
The sequence of commands executed by StopArpNd is as follows:
- Stop ARP/ND on Tx and Rx if needed.
- Stop ARP/ND verification on Tx and Rx if needed.

ArpNdStopCommand Writable Attributes

Writable Attribute
Description
HandleList
The handle of port, stream or emulated device.

Type: handle
Default: 0
144
ArpNdUpdateArpCacheCommand
ArpNdStopCommand Read-Only Attributes

Read-Only Attribute
Description

ArpNdUpdateArpCacheCommand
Description:
The purpose of this command is to retrieve the ARP cache table on ports as well as to retrieve the resolved MAC address for selected streams/routers/or
hosts.

ArpNdUpdateArpCacheCommand Writable Attributes

Writable Attribute
Description
HandleList
The handle list is the list of ports or selected streams/routers/or host handles.
Type: handle
Default: 0
ArpNdUpdateArpCacheCommand Read-Only Attributes

Read-Only Attribute
Description

ArpNdVerifyResolvedCommand
Description:
Verify if ARP is resolved.

Parents: Sequencer
ArpNdVerifyResolvedCommand Writable Attributes

Writable Attribute
Description
HandleList
A list of handles (Port, Host, Router, or Stream).

Type: handle
Default: 0
145
AsbrSummaryLsa
ArpNdVerifyResolvedCommand Read-Only Attributes

Read-Only Attribute
Description
PassFailState
AsbrSummaryLsa
Description:
Represents the ASBR Summary LSA Block Attributes. ASBR Summary LSAs, generated by border routers, advertise Autonomous System Boundary Routers
(ASBRs) that are external to the area.

Parents: Ospfv2RouterConfig
AsbrSummaryLsa Writable Attributes

Writable Attribute
Description
AdvertisingRouterId
Specifies the router ID of the emulated router that this object is associated with. This will be the advertising router field in the
advertised LSAs.
Type: ip
Default: null
Age
Initial value, in seconds, of the LS age field in the LSA header.

Type: u16
Default: 0
Range: 0 - 3600
AsbrRouterId
Router ID of the AS boundary router in the external area.

Type: ip
Default: 0.0.0.0
CheckSum
This specifies whether the LSA will be advertised with a good or bad checksum.
Type: enum
Default: GOOD
Possible Values:
Value Description
BAD
LSA will be advertised with a bad checksum.
GOOD LSA will be advertised with a good checksum.

Metric
Cost metric to be used when advertising the specified ASBR summary LSAs.
Type: u32
Default: 1
Range: 1 - 16777215
146
ATM
Writable Attribute
Description
Options
Options
Type: enum
Default: EBIT
Possible Values:
Value
Description
TBIT
TOS: Type of Service (T,0).
EBIT
External Routing: Specifies the way AS-external-LSAs are flooded (E,1).
MCBIT
Multicast: Specifies whether IP multicast datagrams are forwarded (MC,2).
NPBIT
NSSA: Specifies the handling of Type-7 LSAs (N/P,3).
EABIT
External Attribute: Specifies the router's willingness to receive and forward External-Attributes-LSAs (EA,4).
DCBIT
Demand Circuit: Specifies the router's handling of demand circuits (DC,5).
OBIT
Opaque: Specifies the router's willingness to receive and forward Opaque LSAs as specified in RFC 2370 (O,6).
UNUSED7 Unused: This bit is not used.

RouteCategory
Specify the route type.

Type: enum
Default: UNDEFINED
Possible Values:
Value
Description
UNDEFINED
Category not defined.
PRIMARY
Primary route.
SECONDARY Secondary route.
SeqNum
UNIQUE
Unique route.
ANY
Any route.
Initial value of the LS sequence number field in the LSA header.

Type: u32
Default: 0x80000001
Range: 0 - 0xffffffff
AsbrSummaryLsa Read-Only Attributes

ATM (atm:ATM)
Description:
The ATM protocol data unit
Children: vpi
Next headers: ipv4:IPv4, ipv6:IPv6, aal5:LlcRoutedSnap, aal5:LlcRoutedNlpid, aal5:LlcBridgedEth8023, aal5:VpnEncap, aal5:VcMuxBridgedEth8023, ppp:PPP,
l2tpv2:L2TPv2, aal5:LlcSnapIana, custom:Custom
ATM Attributes
Attribute
Description
clp
Type: clpBoolean
Default: 0
Possible Values:
Value Description
0
False
True
147
AtmIdleCell
Attribute
Description
hec
Type: OCTETSTRING
Default: 00
Name
Type: string
pti
Type: ptiValue
Default: 0
Possible Values:
Value Description
vci
User Data, Uncongested
User Data, Congested
Management, Uncongested
Management, Congested
Type: INTEGER
Default: 32
AtmIdleCell
Description:
ATM Idle cell.

Automatically created from: AtmPhy
AtmIdleCell Writable Attributes

Writable Attribute
Description
Active, Name
Clp
Cell loss priority.

Type: bool
Default: TRUE
Possible Values:
Value Description
TRUE
The cell can be discarded if the network is under heavy congestion.
FALSE The cell is high priority and every effort should be made to forward it.
FillByte
Idle cell fill byte.

Type: u8
Default: 106
Gfc
Generic flow control.

Type: u8
Default: 0
Hec
Header error control.

Type: u8
Default: 82
Pti
Payload type indicator.

Type: u8
Default: 0
148
AtmPhy
Writable Attribute
Description
Vci
Virtual channel identifier.

Type: u16
Default: 0
Vpi
Virtual path identifier.

Type: u16
Default: 0
AtmIdleCell Read-Only Attributes

AtmPhy
Description:
Settings for ports in with their physical interface in ATM mode.

Parents: Port
Children: PhyCompensationOptions
Automatically-created children: AtmIdleCell, SonetConfig, SonetInjectors, SonetPathConfig, SonetPathInjectors
Relations:
Side name
(Type)
Relative
ActivePhyPort
(ActivePhy)
Port
ApplicableOnPhySource
(ApplicableOnPhy)
Aal5If
Description
AtmPhy Writable Attributes

Writable Attribute
Description
Active, Name
DataPathMode
Sets the path for the port to transmit data.

Type: enum
Default: NORMAL
Possible Values:
Value
Description
NORMAL
Port will transmit normally.
LOCAL_LOOPBACK Port will transmit in a loopback mode, so transmitted data will be received by the
transmitting port without going out on the wire.
LINE_MONITOR
EnforceMtuOnRx
Port will be placed in line monitor mode. All received packets will be transmitted as is but
can also be captured on the port.
Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
FALSE
149
AtmPhy
Writable Attribute
Description
HecCosetEnable
Enable/disable HEC coset.

Type: bool
Default: TRUE
Possible Values:
Value Description
TRUE
Enable
FALSE Disable
HecRxCorrectionEnable
Enable receive HEC correction.

Type: bool
Default: TRUE
Possible Values:
Value Description
TRUE
Enable
FALSE Disable
Mtu
Maximum transmission unit.

Type: u32
Default: 1500
Range: 0 - 16383
PassBadRxHecEnable
Enable pass bad receive HEC.

Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
Enable
FALSE Disable
PortSetupMode
Exclusively configures port setup or hardware register parameters.

Type: enum
Default: PORTCONFIG_ONLY
Possible Values:
Value
Description
PORTCONFIG_ONLY Only setup port setup parameters.
REGISTERS_ONLY
Only setup hardware register parameters (MII or MDIO).
AtmPhy Read-Only Attributes

Read-Only Attribute
Description
IsEnforceMtuOnRxSupported
Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
FALSE
IsMgtRegistersOnly
Enable configuration through the MII/MDIO registers on those ports that support it.
Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
Enable
FALSE Disable
150
AtmPhy
Read-Only Attribute
Description
LinkStatus
Link status.
Type: enum
Default: NONE
Possible Values:
Value
Description
DOWN
Link is down.
UP
Link is up.
ERROR
Link has error.
ADMIN_DOWN Link is administratively down.
ModuleType
SONET
Link is SONET.
NONE
No link present.
The module type plugs into the PersonalityCardType.

Type: enum
Default: NA
Possible Values:
Value
Description
NA
Hot-plugging module is not supported.
UNKNOWN
A module has been plugged in but cannot be identified.
ABSENT
No module plugged in.
SFP_FIBER
SFP fiber media.
SFP_Copper
SFP copper media.
XFP
XFP
XENPAK
Xenpak
X2
X2
E1000
E1000
TEN_GBASE_T 10GBASE-T
SFP_PLUS
SFP Plus
CFP
QSFP_PLUS
PersonalityCardType
Personality card type. This is the plugin module to the host card.
Type: enum
Default: NA
Possible Values:
Value
Description
NA
Hot-plugging personality card is not supported.
UNKNOWN
A personality card has been plugged in but cannot be identified.
ABSENT
No personality card plugged in.
SFP
SFP
XFP
XFP
XENPAK
Xenpak
X2
X2
CFP
151
AtmPhy
Read-Only Attribute
Description
TransceiverType
Transceiver type.
Type: enum
Default: MODULE_NONE
Possible Values:
Value
Description
MODULE_NONE
None
MODULE_10GBASE_ER
10GBASE-ER
MODULE_10GBASE_LR
10GBASE-LR
MODULE_10GBASE_SR
10GBASE-SR
MODULE_10GBASE_EW
10GBASE-EW
MODULE_10GBASE_LW
10GBASE-LW
MODULE_10GBASE_SW
10GBASE-SW
MODULE_10GBASE_CX4
10GBASE-CX4
MODULE_10GBASE_LX4
10GBASE-LX4
SPIRENT_10GBASE_CX4
Spirent 10GBASE-CX4
MODULE_OC48_LR
OC48-LR
MODULE_OC48_IR
OC48-IR
MODULE_OC48_SR
OC48-SR
MODULE_OC12_LR
OC12-LR
MODULE_OC12_IR
OC12-IR
MODULE_OC12_SR
OC12-SR
MODULE_OC3_LR
OC3-LR
MODULE_OC3_IR
OC3-IR
MODULE_OC3_SR
OC3-SR
MODULE_OC192_LR
OC192-LR
MODULE_OC192_IR
OC192-IR
MODULE_OC192_SR
OC192-SR
MODULE_OC192_VR
OC192-SR
MODULE_10GBASE_T
10GBASE-T
MODULE_XFP_CX4
XFP-CX4
MODULE_XFP_E
XFP-E
MODULE_1000BASE_T
1000BASE-T
MODULE_1000BASE_CX
1000BASE-CX
MODULE_1000BASE_LX
1000BASE-LX
MODULE_1000BASE_SX
1000BASE-SX
MODULE_40GBASE_LR
MODULE_40GBASE_SR
MODULE_40GBASE_CR4
MODULE_40GBASE_SR4
MODULE_100GBASE_LR
MODULE_100GBASE_SR
MODULE_FC_2G
MODULE_FC_4G
MODULE_FC_8G
MODULE_100BASE_FX
MODULE_SFP_PLUS_COPPER
TransceiverTypeList
Displays a list of all transceiver types available on the connected hardware.

Type: string
152
AttachedPortDescriptor
Description:
Parents: attachedPortDescriptors
Children: None
AttachedPortDescriptor Attributes
Attribute
Description
attachedNodeName
Type: WWN
Default: 10:00:10:94:00:00:00:00
attachedPhysicalPortNumber
Type: OCTETSTRING
Default: 00000000
attachedPortName
Type: WWN
Default: 20:00:10:94:00:00:00:00
attachedPortType
Type: PortType
Default: 00
Possible Values:
Value Description
00
Unidentified
01
N_Port
02
NL_Port
03
F/NL_Port
7F
Nx_Port
81
F_Port
82
FL_Port
84
E_Port
85
B_Port
Name
RangeModifier, RandomModifier, and TableModifier. See the description of the OffsetReference attribute
for these modifier objects for more information.
Type: string
reserved
Type: OCTETSTRING
Default: 000000
vendorSpecific1
Type: OCTETSTRING
Default: 00000000
vendorSpecific2
Type: OCTETSTRING
Default: (32 zeroes hexadecimal)
vendorSpecific3
Type: OCTETSTRING
Description:
Parents: attachedPortDescriptors
Children: None
153
attachedPortDescriptors
AttachedPortDescriptor Attributes
Attribute
Description
attachedNodeName
Type: WWN
Default: 10:00:10:94:00:00:00:00
attachedPhysicalPortNumber
Type: OCTETSTRING
Default: 00000000
attachedPortName
Type: WWN
Default: 20:00:10:94:00:00:00:00
attachedPortType
Type: PortType
Default: 00
Possible Values:
Value Description
00
Unidentified
01
N_Port
02
NL_Port
03
F/NL_Port
7F
Nx_Port
81
F_Port
82
FL_Port
84
E_Port
85
B_Port
Name
Type: string
reserved
Type: OCTETSTRING
Default: 000000
vendorSpecific1
Type: OCTETSTRING
Default: 00000000
vendorSpecific2
Type: OCTETSTRING
vendorSpecific3
Type: OCTETSTRING
attachedPortDescriptors (overloaded)
attachedPortDescriptors (fc)
attachedPortDescriptors (fcgs)
attachedPortDescriptors Object (fc PDU library)

Description:
154
attachedPortEntries
Parents: topologyInformationDescriptor
(StreamBlock.FCoE.fc.fcPayloads.FCPayload-Choice.gtinAccept.topologyInformationDescriptors.TopologyInformationDescriptor)
topologyInformationDescriptor (StreamBlock.FCoE.fc.fcPayloads.FCPayload-Choice.gatinAccept.topologyInformationDescriptor)
Children: AttachedPortDescriptor
attachedPortDescriptors Attributes
Attribute
Description
Name
information.
Type: string
attachedPortDescriptors Object (fcgs PDU library)

Description:
Parents: topologyInformationDescriptor (StreamBlock.GtinAccept.topologyInformationDescriptors.TopologyInformationDescriptor)

topologyInformationDescriptor (StreamBlock.GatinAccept.topologyInformationDescriptor)
Children: AttachedPortDescriptor
attachedPortDescriptors Attributes
Attribute
Description
Name
information.
Type: string
attachedPortEntries (overloaded)
attachedPortEntries (fc)
attachedPortEntries (fcgs)
attachedPortEntries Object (fc PDU library)

Description:
Parents: gapnlAccept (StreamBlock.FCoE.fc.fcPayloads.FCPayload-Choice.gapnlAccept)

Children: AttachedPortEntry
155
AttachedPortEntry
attachedPortEntries Attributes
Attribute
Description
Name
information.
Type: string
attachedPortEntries Object (fcgs PDU library)

Description:
Parents: gapnlAccept (StreamBlock.GapnlAccept)

Children: AttachedPortEntry
attachedPortEntries Attributes
Attribute
Description
Name
information.
Type: string
AttachedPortEntry
Description:
Parents: attachedPortEntries
Children: None
AttachedPortEntry Attributes
Attribute
Description
Name
Type: string
portFlags
Type: OCTETSTRING
Default: 00
portName
Type: WWN
Default: 20:00:10:94:00:00:00:00
156
AttachedPortEntry
Attribute
Description
portType
Type: PortType
Default: 00
Possible Values:
Value Description
reserved
00
Unidentified
01
N_Port
02
NL_Port
03
F/NL_Port
7F
Nx_Port
81
F_Port
82
FL_Port
84
E_Port
85
B_Port
Type: OCTETSTRING
Default: 0000
AttachedPortEntry
Description:
Parents: attachedPortEntries
Children: None
AttachedPortEntry Attributes
Attribute
Description
Name
Type: string
portFlags
Type: OCTETSTRING
Default: 00
portName
Type: WWN
Default: 20:00:10:94:00:00:00:00
portType
Type: PortType
Default: 00
Possible Values:
Value Description
reserved
00
Unidentified
01
N_Port
02
NL_Port
03
F/NL_Port
7F
Nx_Port
81
F_Port
82
FL_Port
84
E_Port
85
B_Port
Type: OCTETSTRING
Default: 0000
157
attachedRouters
attachedRouters
Description:
Parents: ospfv2NetworkLsa
Children: Ospfv2AttachedRouter
attachedRouters Attributes
Attribute
Description
Name
information.
Type: string
AttachPortsCommand
Description:
Connects to the chassis, then reserves and maps the ports. Uses the location defined in the specified Port objects to connect to the chassis and reserve the
ports, after which it creates the mapping between the physical ports and their logical representation in the test configuration. You can use AttachPortsCommand
in place of performing these operations separately (by using the connect and reserve functions along with the MapPorts command).

AttachPortsCommand Writable Attributes

Writable Attribute
Description
AutoConnect
Connect to each port's chassis if not already connected.

Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
Connect to each port's chassis.
FALSE Do not connect to each port's chassis.

ContinueOnFailure
In the case that attaching a port fails, continue on with other ports in the list.
Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
Continue when attaching a port fails.
FALSE Stop and return error when attaching a port fails.

PortList
List of one or more ports to reserve and map.

Type: handle
Default: 0
158
AttainableNetDataRateDownstreamTlv
Writable Attribute
Description
RevokeOwner
Whether to kick off the current owners of the ports and reserve the ports.
Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
Kick off current owners.
FALSE Reserve only if the ports are available.
AttachPortsCommand Read-Only Attributes

Read-Only Attribute
Description

(ancp_draft0:AttainableNetDataRateDownstreamTlv)
Description:
Children: None
AttainableNetDataRateDownstreamTlv Attributes
Attribute
Description
Length
Type: INTEGER
Default: 4
MessageSelect
Default: 3
Possible Values:
Value Description
1
Port Up
Port Down
Port Up, Port Down
Name
Type: string
Rate
Type: INTEGER
Default: 0
Type
Type: OCTETSTRING
Default: 0086
159
(ancp_draft2:AttainableNetDataRateDownstreamTlv)
Description:
Children: None
AttainableNetDataRateDownstreamTlv Attributes
Attribute
Description
Length
Type: INTEGER
Default: 4
MessageSelect
Default: 3
Possible Values:
Value Description
1
Port Up
Port Down
Port Up, Port Down
Name
Type: string
Rate
Type: INTEGER
Default: 0
Type
Type: OCTETSTRING
Default: 0086
AttainableNetDataRateUpstreamTlv
(ancp_draft0:AttainableNetDataRateUpstreamTlv)
Description:
Children: None
AttainableNetDataRateUpstreamTlv Attributes
Attribute
Description
Length
Type: INTEGER
Default: 4
160
Attribute
Description
MessageSelect
Default: 3
Possible Values:
Value Description
1
Port Up
Port Down
Port Up, Port Down
Name
Type: string
Rate
Type: INTEGER
Default: 0
Type
Type: OCTETSTRING
Default: 0085
(ancp_draft2:AttainableNetDataRateUpstreamTlv)
Description:
Children: None
AttainableNetDataRateUpstreamTlv Attributes
Attribute
Description
Length
Type: INTEGER
Default: 4
MessageSelect
Default: 3
Possible Values:
Value Description
1
Port Up
Port Down
Port Up, Port Down
Name
Type: string
Rate
Type: INTEGER
Default: 0
Type
Type: OCTETSTRING
Default: 0085
161
auth
auth (overloaded)
auth (bfd) - Object definition for the following paths:
StreamBlock.BFDSimpleAuth.auth
auth (bfd) - Object definition for the following paths:
StreamBlock.BFDCryptoAuth.auth
auth Object (bfd PDU library)

Description:
Parents: BFDSimpleAuth (StreamBlock.BFDSimpleAuth)

Children: simplePassword
auth Attributes
Attribute
Description
AuthKeyId
Type: INTEGER
Default: 0
AuthLength
Type: INTEGER
Default: 3
authType
Type: INTEGER
Default: 1
Name
Type: string
auth Object (bfd PDU library)

Description:
Parents: BFDCryptoAuth (StreamBlock.BFDCryptoAuth)

Children: None
auth Attributes
Attribute
Description
AuthKey1
Type: INTEGER
Default: 0
AuthKey2
Type: INTEGER
Default: 0
AuthKeyId
Type: INTEGER
Default: 0
162
AuthenticationParams
Attribute
Description
AuthLength
Type: INTEGER
Default: 24
authType
Type: MD5AuthenticationType
Default: 2
Possible Values:
Value Description
2
2-Keyed MD5
3-Meticulous Keyed MD5
Name
RandomModifier, and TableModifier. See the description of the OffsetReference attribute for these modifier
objects for more information.
Type: string
Res
Type: INTEGER
Default: 0
SeqNum
Type: INTEGER
Default: 0
AuthenticationParams
Description:
Authentication parameters.
AuthenticationParams Writable Attributes

Writable Attribute
Description
Active, Name
Authentication
Authentication type.
Type: enum
Default: NONE
Possible Values:
Value
Description
NONE
No authentication is used.
SIMPLE Use simple authentication.

MD5
Use MD5 key ID for authentication.
Md5KeyId
MD5 key ID (0 - 255).

Type: u8
Default: 1
Password
Authentication password. A string of up to 16 characters can be used as a password for the MD5 authentication
type. Up to 8 characters can be used for the SIMPLE authentication type.
Type: string
Default: Spirent
AuthenticationParams Read-Only Attributes

163
authSelect
authSelect
Description:
Parents: header
Children: hdrAuthSelectCrypto, hdrAuthSelectNone, hdrAuthSelectPassword, hdrAuthSelectUserDef
authSelect Attributes
Attribute
Description
Name
information.
Type: string
AutomationOptions
Description:
Options for system messages for Spirent TestCenter Automation. Various system messages can be generated while running automation. You can also create
your own messages using the log function. See the Spirent TestCenter Automation Programmer's Guide for more information.

AutomationOptions Writable Attributes

Writable Attribute
Description
Active, Name
AutoSubscribe
Type: bool
Default: TRUE
Possible Values:
Value Description
TRUE
FALSE
LogLevel
Specify the level of system messages. The messages will be sent to the output specified by the LogTo attribute.
Type: enum
Default: WARN
Possible Values:
Value
Description
DEBUG Display DEBUG, INFO, WARN, and ERROR messages.
INFO
Display INFO, WARN, and ERROR messages.
WARN
Display WARN and ERROR messages.
ERROR Display only ERROR messages.

LogTo
Where to send system messages. The default sends to standard output (stdout), usually the console. If you give a
filename, system messages are written to that file. Use forward slashes / between directory names.
Tcl example: -logTo "output/logfiles/log.txt"
Type: string
Default: stdout
MaxBackup
Type: u16
Default: 0
MaxFileSizeInMB
Type: u32
Default: 10
164
autoNegotiationAdvertisedCapability
Writable Attribute
Description
SuppressTclErrors
NOTE: It is recommended that you do not use this attribute. Specifies whether to hide Tcl exceptions when command
errors occur, and use a -1 return code instead.
Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
Suppress Tcl exceptions. Use -1 return code instead.
FALSE Throw a Tcl exception when a command error occurs. Do not use -1 return code.
AutomationOptions Read-Only Attributes

autoNegotiationAdvertisedCapability
Description:
Parents: MacPhyConfigStatusTlv
Children: None
autoNegotiationAdvertisedCapability Attributes
Attribute
Description
b1000baseT
Type: BITSTRING
Default: 0
b1000baseTFD
Type: BITSTRING
Default: 0
b1000baseX
Type: BITSTRING
Default: 0
b1000baseXFD
Type: BITSTRING
Default: 0
b100baseT2
Type: BITSTRING
Default: 0
b100baseT2FD
Type: BITSTRING
Default: 0
b100baseT4
Type: BITSTRING
Default: 0
b100baseTX
Type: BITSTRING
Default: 1
b100baseTXFD
Type: BITSTRING
Default: 0
b10baseT
Type: BITSTRING
Default: 0
b10baseTFD
Type: BITSTRING
Default: 0
bFdxAPause
Type: BITSTRING
Default: 0
165
autoNegotiationSupportAndStatus
Attribute
Description
bFdxBPause
Type: BITSTRING
Default: 0
bFdxPause
Type: BITSTRING
Default: 0
bFdxSPause
Type: BITSTRING
Default: 0
Name
RangeModifier, RandomModifier, and TableModifier. See the description of the OffsetReference
attribute for these modifier objects for more information.
Type: string
other
Type: BITSTRING
Default: 0
autoNegotiationSupportAndStatus
Description:
Parents: MacPhyConfigStatusTlv
Children: None
autoNegotiationSupportAndStatus Attributes
Attribute
Description
autoNegotiationEnabled
Type: BITSTRING
Default: 0
autoNegotiationSupported
Type: BITSTRING
Default: 0
Name
Type: string
reserved
Type: BITSTRING
Default: 000000
BaseBridgePortResults
Description:
Commons bridge port results.
BaseBridgePortResults Writable Attributes

166
BaseBridgePortResults
BaseBridgePortResults Read-Only Attributes

Read-Only Attribute
Description
BridgeId
Bridge priority (2 bytes) followed by the MAC address (6 bytes).

Type: string
Default: 80-00-00-00-10-00-10-00
DesignatedId

Type: string
Default: NA
InstanceNum
For MSTP, instance number of the MSTI for these results.

Type: u16
Default: 0
PortId
Port priority and port number.

Type: string
Default: 0x8001
RegionalRootId
Regional root ID (MSTP only).

Type: string
Default: NA
RootId
Root (bridge) priority (2 bytes) followed by the root MAC address (6 bytes).
Type: string
Default: NA
RxAgree
Number of BPDUs received with the agreement bit set (RSTP only).
Type: u32
Default: 0
RxBpduFlag
Last received BPDU flag value (in hex).

Type: string
Default: 0x00
RxBpdus
Number of BPDUs received.

Type: u32
Default: 0
RxPortRole
Reported states are disabled, alternate port, backup port, root port, and designated port
Type: string
Default: NA
RxPortState
Reported states are listening, discarding, learning, and forwarding.

Type: string
Default: NA
RxProposals
Number of times that the root port is notified by the designated port that it wants to progress rapidly to forwarding
state.
Type: u64
Default: 0
RxTcAck
Number of BPDUs received with the TC acknowledge bit set (RSTP only).
Type: u32
Default: 0
RxTcBitSet
Number of BPDUs received with the TC bit set.

Type: u32
Default: 0
RxTcn
Number of TCN BPDUs received (STP only).

Type: u64
Default: 0
TxAgree
Number of BPDUs transmitted with the agreement bit set (RSTP only).
Type: u32
Default: 0
167
baseControl
Read-Only Attribute
Description
TxBpduFlag
Last transmitted BPDU flag value (in hex).

Type: string
Default: 0x00
TxBpdus
Number of BPDUs transmitted.

Type: u32
Default: 0
TxPortRole
Reported states are disabled, alternate port, backup port, root port, and designated port
Type: string
Default: NA
TxPortState

Type: string
Default: NA
TxProposals
Number of times that the designated port notifies the root port that it wants to progress rapidly to forwarding state.
Type: u64
Default: 0
TxTcAck
Number of BPDUs transmitted with the TC acknowledge bit set (RSTP only).
Type: u32
Default: 0
TxTcBitSet
Number of BPDUs transmitted with the TC bit set.

Type: u32
Default: 0
TxTcn
Number of TCN BPDUs transmitted (STP only).

Type: u64
Default: 0
VlanId
Starting VLAN ID of the STP bridge port.

Type: string
Default: NA
baseControl (overloaded)
baseControl (RPR) - Object definition for the following paths:
StreamBlock.DataFrame.rch.baseControl
StreamBlock.ControlFrame.rch.baseControl
StreamBlock.FairnessFrame.baseControl
StreamBlock.IdleFrame.baseControl
baseControl Object (RPR PDU library)

Description:
Parents: rch (StreamBlock.DataFrame.rch)

rch (StreamBlock.ControlFrame.rch)
Children: None
168
baseControl
baseControl Attributes
Attribute
Description
fe
Type: feValues
Default: 0
Possible Values:
Value Description
ft
Not Fairness Eligible
Fairness Eligible
Type: ftValues
Default: 00
Possible Values:
Value Description
0
Idle Frame
Control Frame
Fairness Frame
Data Frame
Name
Type: string
parity
Type: BITSTRING
Default: 0
ri
Type: riValues
Default: 0
Possible Values:
Value Description
sc
we
Transmitted on ringlet0
Type: scValues
Default: 00
Possible Values:
Value Description
0
Class C
Class B
Class A, subclass A1
Class A, subclass A0
Type: weValues
Default: 0
Possible Values:
Value Description
0
Not Wrap Eligible
Wrap Eligible

Description:
Parents: FairnessFrame (StreamBlock.FairnessFrame)
169
baseControl
Children: None
Attribute
Description
fe
Type: feValues
Default: 0
Possible Values:
Value Description
ft
Not Fairness Eligible
Fairness Eligible
Type: ftValues
Default: 00
Possible Values:
Value Description
0
Idle Frame
Control Frame
Fairness Frame
Data Frame
Name
Type: string
parity
Type: BITSTRING
Default: 0
ri
Type: riValues
Default: 0
Possible Values:
Value Description
0
sc
Type: BITSTRING
Default: 11
we
Type: weValues
Default: 0
Possible Values:
Value Description
0
Not Wrap Eligible
Wrap Eligible

Description:
Parents: IdleFrame (StreamBlock.IdleFrame)

Children: None
170
basicZoning
Attribute
Description
fe
Type: BITSTRING
Default: 0
ft
Type: ftValues
Default: 00
Possible Values:
Value Description
0
Idle Frame
Control Frame
Fairness Frame
Data Frame
Name
Type: string
parity
Type: BITSTRING
Default: 0
ri
Type: riValues
Default: 0
Possible Values:
Value Description
0
sc
Type: BITSTRING
Default: 11
we
Type: weValues
Default: 0
Possible Values:
Value Description
0
Not Wrap Eligible
Wrap Eligible
basicZoning (overloaded)
basicZoning (fc)
basicZoning (fcsw)
basicZoning Object (fc PDU library)

Description:
Parents: MRPayloadChoice (StreamBlock.FCoE.fc.fcPayloads.FCPayload-Choice.mergeRequest.payload.MRPayloadChoice)
171
bcnMode
Children: None
basicZoning Attributes
Attribute
Description
activeZoneSetLength
Type: INTEGER
Default: 0
Name
Type: string
zoneSetDatabaseObjectLength
Type: INTEGER
Default: 0
basicZoning Object (fcsw PDU library)

Description:
Parents: MRPayloadChoice (StreamBlock.MReq.payload.MRPayloadChoice)

Children: None
basicZoning Attributes
Attribute
Description
activeZoneSetLength
Type: INTEGER
Default: 0
Name
Type: string
Type: INTEGER
Default: 0
bcnMode
Description:
Parents: bcnTlv
Children: bcnMode0, bcnMode1, bcnMode2, bcnMode3, bcnMode4, bcnMode5, bcnMode6, bcnMode7
172
bcnMode0
bcnMode Attributes
Attribute
Description
Name
information.
Type: string
bcnMode0
Description:
Parents: bcnMode, bcnMode, bcnMode, bcnMode, bcnMode, bcnMode, bcnMode, bcnMode
Children: None
bcnMode0 Attributes
Attribute
Description
cpAdmin
Type: INTEGER
Default: 0
Name
Type: string
remTagOper
Type: INTEGER
Default: 0
reserved
Type: BITSTRING
Default: 0000
rpAdmin
Type: INTEGER
Default: 0
rpOper
Type: INTEGER
Default: 0
bcnMode1
Description:
Children: None
bcnMode1 Attributes
Attribute
Description
cpAdmin
Type: INTEGER
Default: 0
173
bcnMode2
Attribute
Description
Name
Type: string
remTagOper
Type: INTEGER
Default: 0
reserved
Type: BITSTRING
Default: 0000
rpAdmin
Type: INTEGER
Default: 0
rpOper
Type: INTEGER
Default: 0
bcnMode2
Description:
Children: None
bcnMode2 Attributes
Attribute
Description
cpAdmin
Type: INTEGER
Default: 0
Name
Type: string
remTagOper
Type: INTEGER
Default: 0
reserved
Type: BITSTRING
Default: 0000
rpAdmin
Type: INTEGER
Default: 0
rpOper
Type: INTEGER
Default: 0
bcnMode3
Description:
Children: None
174
bcnMode4
bcnMode3 Attributes
Attribute
Description
cpAdmin
Type: INTEGER
Default: 0
Name
Type: string
remTagOper
Type: INTEGER
Default: 0
reserved
Type: BITSTRING
Default: 0000
rpAdmin
Type: INTEGER
Default: 0
rpOper
Type: INTEGER
Default: 0
bcnMode4
Description:
Children: None
bcnMode4 Attributes
Attribute
Description
cpAdmin
Type: INTEGER
Default: 0
Name
Type: string
remTagOper
Type: INTEGER
Default: 0
reserved
Type: BITSTRING
Default: 0000
rpAdmin
Type: INTEGER
Default: 0
rpOper
Type: INTEGER
Default: 0
bcnMode5
Description:
175
bcnMode6

Children: None
bcnMode5 Attributes
Attribute
Description
cpAdmin
Type: INTEGER
Default: 0
Name
Type: string
remTagOper
Type: INTEGER
Default: 0
reserved
Type: BITSTRING
Default: 0000
rpAdmin
Type: INTEGER
Default: 0
rpOper
Type: INTEGER
Default: 0
bcnMode6
Description:
Children: None
bcnMode6 Attributes
Attribute
Description
cpAdmin
Type: INTEGER
Default: 0
Name
Type: string
remTagOper
Type: INTEGER
Default: 0
reserved
Type: BITSTRING
Default: 0000
rpAdmin
Type: INTEGER
Default: 0
rpOper
Type: INTEGER
Default: 0
176
bcnMode7
bcnMode7
Description:
Children: None
bcnMode7 Attributes
Attribute
Description
cpAdmin
Type: INTEGER
Default: 0
Name
Type: string
remTagOper
Type: INTEGER
Default: 0
reserved
Type: BITSTRING
Default: 0000
rpAdmin
Type: INTEGER
Default: 0
rpOper
Type: INTEGER
Default: 0
bcnTlv
Description:
Parents: DcbxSubTlvt1
Children: bcnMode, header
bcnTlv Attributes
Attribute
Description
bcna
Type: OCTETSTRING
Default: 0000000000000000
cpSf
Type: INTEGER
Default: 0
Name
Type: string
rpAlpha
Type: DOUBLE
Default: 1.1
rpBelta
Type: DOUBLE
Default: 1.1
rpGd
Type: DOUBLE
Default: 1.1
177
BenchmarkEthernet10GigPortConfig
Attribute
Description
rpGi
Type: DOUBLE
Default: 1.1
rpRd
Type: INTEGER
Default: 0
rpRmin
Type: INTEGER
Default: 0
rpTd
Type: INTEGER
Default: 0
rpTmax
Type: INTEGER
Default: 0
rpW
Type: INTEGER
Default: 0
BenchmarkEthernet10GigPortConfig
Description:
Config object.

Parents: DcbTestConfig, Rfc2544BackToBackFramesConfig, Rfc2544FrameLossConfig, Rfc2544LatencyConfig, Rfc2544ThroughputConfig,
Rfc2889AddrCachingCapacityConfig, Rfc2889AddrLearningRateConfig, Rfc2889BroadcastFrameForwardingConfig, Rfc2889BroadcastFrameLatencyConfig,
Rfc2889CongestionControlConfig, Rfc2889ErroredFramesFilteringConfig, Rfc2889ForwardingConfig, Rfc2889ForwardPressureConfig,
Rfc2889MaxForwardingRateConfig, Rfc3918Config
BenchmarkEthernet10GigPortConfig Writable Attributes

Writable Attribute
Description
Active, Name
EnableDeficitIdleCount
Whether to enable deficit idle count.

Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
Enable deficit idle count.
FALSE Disable deficit idle count.

EnableFlowControl
Whether to enable Ethernet flow control.

Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
Enable Ethernet flow control.
FALSE Disable Ethernet flow control.

EnablePriorityFlowControl
Whether to enable 802.1Qbb priority flow control.

Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
Enable 802.1Qbb priority flow control.
FALSE Disable 802.1Qbb priority flow control.
178
BenchmarkTrafficGroupPerIterationResult
Writable Attribute
Description
PriorityFlowControlArray
Whether to enable 802.1Qbb priority flow control map.

Type: bool
Default: TRUE
Possible Values:
Value Description
TRUE
Enable 802.1Qbb priority flow control map.
FALSE Disable 802.1Qbb priority flow control map.
BenchmarkEthernet10GigPortConfig Read-Only Attributes

Description:
Traffic group per iteration result object.

Parents: DcbBackToBackPerIterationResult, DcbCongestionControlPerIterationResult, DcbCongestionControlPerPortResult,
DcbErroredFramesFilteringPerIterationResult, DcbMaximumForwardingRatePerIterationResult, DcbPfcBufferingAndLatencyPerIterationResult,
DcbPfcBufferingPerIterationResult, DcbPfcLoadValidationPerIterationResult, DcbPfcResponseTimePerIterationResult, DcbQueueputPerIterationResult,
DcbStepPerIterationResult, Rfc3918AggregatedMulticastThroughputPerIterationResult, Rfc3918JoinLeaveLatencyPerIterationResult,
Rfc3918MixedClassThroughputPerIterationResult, Rfc3918MulticastForwardingLatencyPerIterationResult, Rfc3918MulticastGroupCapacityPerIterationResult,
Rfc3918ScaledGroupForwardingPerIterationResult
BenchmarkTrafficGroupPerIterationResult Writable Attributes

BenchmarkTrafficGroupPerIterationResult Read-Only Attributes

Read-Only Attribute
Description
AvgInterarrivalTime
Average interarrival time in microseconds.

Type: double
Default: 0
AvgJitter
Average jitter in microseconds.

Type: double
Default: 0
AvgLatency
Average latency in microseconds.

Type: double
Default: 0
BurstSize
Burst size.
Type: u32
Default: 0
DroppedFrameCount
Number of frames dropped.

Type: u64
Default: 0
DroppedFramePct
Percentage of frames dropped.

Type: double
Default: 0
179
Read-Only Attribute
Description
DuplicateFrameCount
Number of duplicate frames received.

Type: u64
Default: 0
ExpectedRxFrameCount
Number of frames expected to be received.

Type: u64
Default: 0
FcsErrorFrameCount
Number of frames received with FCS errors.

Type: u64
Default: 0
ForwardingRate
Rate at which frames are received in fps.

Type: double
Default: 0
Specifies the name of the iMIX distribution when Frame Size Type is iMIX.
Type: string
Default: N/A
FrameSizeType
Frame size type.

Type: string
Default: N/A
IntendedAvgFrameSize
Average configured frame size.

Type: double
Default: 0
IntendedLoad
Intended load in percentage.

Type: double
Default: 0
IntendedMbpsLoad
Intended load in Mbps.

Type: double
Default: 0
LateFrameCount
Number of frame received late.

Type: u64
Default: 0
MaxInterarrivalTime
Maximum interarrival time in microseconds.

Type: double
Default: 0
MaxJitter
Maximum jitter in microseconds.

Type: double
Default: 0
MaxLatency
Maximum latency in microseconds.

Type: double
Default: 0
MbpsForwardingRate
Rate at which frames are received in Mbps.

Type: double
Default: 0
MinInterarrivalTime
Minimum interarrival time in microseconds.

Type: double
Default: 0
MinJitter
Minimum jitter in microseconds.

Type: double
Default: 0
MinLatency
Minimum latency in microseconds.

Type: double
Default: 0
180
BFD
Read-Only Attribute
Description
OfferedAvgFrameSize
Average transmitted frame size.

Type: double
Default: 0
OfferedLoad
Offered load.
Type: double
Default: 0
OfferedMbpsLoad
Offered load in Mbps.

Type: double
Default: 0
OutSeqFrameCount
Number of frames received out of sequence.

Type: u64
Default: 0
PrbsBitErrorCount
Number of frames received with PRBS bit errors.

Type: u64
Default: 0
ReorderedFrameCount
Number of reordered frames received.

Type: u64
Default: 0
RxFrameCount
Number of frames received.

Type: u64
Default: 0
TrafficGroupName
Traffic group name.

Type: string
Default: 0
TxFrameCount
Total number of frames transmitted.

Type: u64
Default: 0
TxFrameRate
Rate at which frames are transmitted in fps.

Type: double
Default: 0
BFD (bfd:BFD)
Description:
Children: header
BFD Attributes
Attribute
Description
Name
information.
Type: string
181
BfdAdminDownCommand
BfdAdminDownCommand
Description:
Administratively stop a BFD session for one or more routers running BFD.

BfdAdminDownCommand Writable Attributes

Writable Attribute
Description
ObjectList
List of router object handles on which to perform this command. The default is the handle of the Project
object, which means all routers in the project will be affected.
Type: handle
Default: 0
BfdAdminDownCommand Read-Only Attributes

Read-Only Attribute
Description

BfdAdminUpCommand
Description:
Administratively start a BFD session for one or more routers running BFD.

BfdAdminUpCommand Writable Attributes

Writable Attribute
Description
ObjectList
Type: handle
Default: 0
BfdAdminUpCommand Read-Only Attributes

Read-Only Attribute
Description

182
BfdAuthenticationParams
BfdAuthenticationParams
Description:
Authentication parameters for BFD.

Automatically created from: BfdDeviceGenProtocolParams, BfdRouterConfig
BfdAuthenticationParams Writable Attributes

Writable Attribute
Description
Authentication
The type of authentication to use.

Type: enum
Default: NONE
Possible Values:
Value
Description
NONE
No authentication.
SIMPLE Simple password authentication.

MD5
MD5 authentication.
Md5KeyId
The MD5 key ID for the session. The Authentication attribute must be set to MD5.
Type: u8
Default: 1
Password
The password for the session. The Authentication attribute must be set to SIMPLE.
Type: string
Default: Spirent
BfdAuthenticationParams Read-Only Attributes

BFDCryptoAuth (bfd:BFDCryptoAuth)
Description:
Children: auth, header
BFDCryptoAuth Attributes
Attribute
Description
Name
information.
Type: string
BfdDeviceGenProtocolParams
Description:
Configure BFD Control Plane Independent Sessions and BFD Timer values from the Create Routers Wizard
183
BfdDeviceGenProtocolParams

Children: BfdIpv4ControlPlaneIndependentSession, BfdIpv6ControlPlaneIndependentSession, DeviceGenLinkedStep
Automatically-created children: BfdAuthenticationParams
BfdDeviceGenProtocolParams Writable Attributes

Writable Attribute
Description
Active, Name
DetectMultiplier
BFD DetectMultiplier
Type: u32
Default: 3
Range: 2 - 100
EchoRxInterval
BFD Echo Receive Interval

Type: u32
Default: 0
Range: 0 - 10000
EnableControlPlaneIndependentSessions
Enable BFD Control Independent Sessions

Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
Add BFD Control Independent Sessions
FALSE No Control Independent Sessions to be configured

ipv4SessionAddr
Starting IPv4 session destination address

Type: ip
Default: 192.0.0.1
ipv4SessionAddrStep
Address Increment for IPv4 Control Plane Independent Sessions

Type: ip
Default: 0.0.0.0
ipv4SessionCount
Number of IPv4 Control Plane independent sessions

Type: u16
Default: 1
ipv4SessionIncr
IPv4 Destination Increment

Type: ip
Default: 0.0.0.1
ipv6SessionAddr
Starting IPv46 session destination address

Type: ipv6
Default: 2001::1
ipv6SessionAddrStep
Address Increment for IPv6 Control Plane Independent Sessions

Type: ipv6
Default: ::0
ipv6SessionCount
Number of IPv6 Control Plane independent sessions

Type: u16
Default: 1
ipv6SessionIncr
IPv6 Destination Increment

Type: u8
Default: 1
Mask
Mask used to increment the IPv6 Address

Type: u8
Default: 128
Range: 1 - 128
184
BfdDisableDemandModeCommand
Writable Attribute
Description
RouterRole
BFD RouterRole.
Type: enum
Default: ACTIVE
Possible Values:
Value
Description
PASSIVE PASSIVE
ACTIVE
ACTIVE
RxInterval
BFD Receive Interval

Type: u32
Default: 50
Range: 1 - 10000
TxInterval
BFD Transmit Interval

Type: u32
Default: 50
Range: 1 - 10000
BfdDeviceGenProtocolParams Read-Only Attributes

BfdDisableDemandModeCommand
Description:
Disable Demand mode on one or more BFD sessions.

BfdDisableDemandModeCommand Writable Attributes

Writable Attribute
Description
ObjectList
Type: handle
Default: 0
BfdDisableDemandModeCommand Read-Only Attributes

Read-Only Attribute
Description

BfdEnableDemandModeCommand
Description:
185
BfdInitiatePollCommand
Enable Demand mode on one or more BFD sessions.

BfdEnableDemandModeCommand Writable Attributes

Writable Attribute
Description
ObjectList
Type: handle
Default: 0
BfdEnableDemandModeCommand Read-Only Attributes

Read-Only Attribute
Description

BfdInitiatePollCommand
Description:
Initiate a Poll Sequence on one or more BFD sessions. The BFD sessions must have Demand mode enabled.

BfdInitiatePollCommand Writable Attributes

Writable Attribute
Description
ObjectList
Type: handle
Default: 0
BfdInitiatePollCommand Read-Only Attributes

Read-Only Attribute
Description

BfdIpv4ControlPlaneIndependentSession
186
BfdIpv4SessionResults
Description:
Object to add Control Plane Independent IPv4 Independent Session. The IP Address specified in this object is the destination address. The source is always
the Router IP Address.

Parents: BfdDeviceGenProtocolParams, BfdRouterConfig
Automatically-created children: Ipv4NetworkBlock
BfdIpv4ControlPlaneIndependentSession Writable Attributes

Writable Attribute
Description
Active, Name
EnableMyDiscriminator
Set a MyDiscriminator value for the control plane independent session when this value is true. MyDiscriminator
is auto generated by STC when this value is false
Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
Allow user to set MyDiscriminator value
FALSE Auto generate MyDiscriminator values

MyDiscriminator
MyDiscriminator value to be set when EnableMyDiscriminator is true.

Type: u32
Default: 1
MyDiscriminatorIncrement
MyDiscriminator Increment value to be used in case of multiple Control Plane Independent sessions configured
when EnableMyDiscriminator is true.
Type: u32
Default: 1
BfdIpv4ControlPlaneIndependentSession Read-Only Attributes

Description:
BFD IPv4 session results.

Parents: BfdRouterConfig
Relations:
Side name
(Type)
Relative
Description
ResultParent
(ResultChild)
BfdRouterConfig
BfdIpv4SessionResults Writable Attributes

187
BfdIpv4SessionResults Read-Only Attributes

Read-Only Attribute
Description
BfdControlBits
A bit mask of the PFCADR bits in the BFD control packet.

Type: u8
Default: 0
BfdDiagnosticCode
A diagnostic code specifying the local system's reason for the last session state change. Allows remote systems
to determine the reason that the previous session failed.
Type: enum
Default: NO_DIAGNOSTIC
Possible Values:
Value
Description
NO_DIAGNOSTIC
No Diagnostic (0)
CD_TIME_EXPIRE
Control Detection Time Expired (1)
ECHO_FUNCTION_FAILED
Echo Function Failed (2)
NBOR_SIG_SESSION_DOWN
Neighbor Signaled Session Down (3)
FOR_PLANE_RESET
Forwarding Plane Reset (4)
PATH_DOWN
Path Down (5)
CONCAT_PATH_DOWN
Concatenated Path Down (6)
ADMIN_DOWN
Administratively Down (7)
REVERSE_CONCAT_PATH_DOWN Reverse Concatenated Path Down (8)

BfdSessionState
The current BFD session state as seen by the transmitting system.

Type: enum
Default: DOWN
Possible Values:
Value
Description
ADMINDOWN AdminDown (0)
DOWN
Down (1)
INIT
Init (2)
UP
Up (3)
ipv4DstAddr
Destination IPv4 address associated with the BFD session.

Type: ip
Default: 225.0.0.1
ipv4SrcAddr
Source IPv4 address associated with the BFD session.

Type: ip
Default: 192.0.0.1
MyDiscriminator
Transmitted discriminator identifier.

Type: u32
Default: 0
RxCount
Number of BFD Control packets received.

Type: u32
Default: 30
RxDesiredMinRxInterval
Desired minimum receive interval for Control packets received from the DUT.
Type: u32
Default: 30
Range: 1 - 10000
RxReqMinEchoRxInterval
Desired minimum receive interval for Echo packets received from the DUT.
Type: u32
Default: 0
Range: 0 - 10000
TxCount
Number of BFD Control packets sent.

Type: u32
Default: 30
Range: 0 - 4294967295
188
Read-Only Attribute
Description
TxInterval
Negotiated transmit interval in milliseconds.

Type: u32
Default: 30
Range: 1 - 10000
YourDiscriminator
Discriminator identifier received from the DUT.

Type: u32
Default: 0
Description:
Object to add Control Plane Independent IPv6 Independent Session. The IP Address specified in this object is the destination address. The source is always
the Router IP Address

Parents: BfdDeviceGenProtocolParams, BfdRouterConfig
BfdIpv6ControlPlaneIndependentSession Writable Attributes

Writable Attribute
Description
Active, Name
EnableMyDiscriminator
Set a MyDiscriminator value for the control plane independent session when this value is true. MyDiscriminator
is auto generated by STC when this value is false
Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
Allow user to set MyDiscriminator value
FALSE Auto generate MyDiscriminator values

MyDiscriminator
MyDiscriminator value to be set when EnableMyDiscriminator is true.

Type: u32
Default: 1
MyDiscriminatorIncrement
MyDiscriminator Increment value to be used in case of multiple Control Plane Independent sessions configured
when EnableMyDiscriminator is true.
Type: u32
Default: 1
BfdIpv6ControlPlaneIndependentSession Read-Only Attributes

Description:
BFD IPv6 session results.
189
Relations:
Side name
(Type)
Relative
Description
ResultParent
(ResultChild)
BfdRouterConfig
BfdIpv6SessionResults Writable Attributes

BfdIpv6SessionResults Read-Only Attributes

Read-Only Attribute
Description
BfdControlBits

Type: u8
Default: 0
BfdDiagnosticCode
A diagnostic code specifying the local system's reason for the last session state change. Allows remote systems
to determine the reason that the previous session failed.
Type: enum
Possible Values:
Value
Description
NO_DIAGNOSTIC
No Diagnostic (0)
CD_TIME_EXPIRE
FOR_PLANE_RESET
PATH_DOWN
Path Down (5)
CONCAT_PATH_DOWN
ADMIN_DOWN

BfdSessionState

Type: enum
Default: DOWN
Possible Values:
Value
Description
ADMINDOWN AdminDown (0)
DOWN
Down (1)
INIT
Init (2)
UP
Up (3)
ipv6DstAddr
Destination IPv6 address associated with the BFD session.

Type: ipv6
Default: 2003::1
ipv6SrcAddr
Source IPv6 address associated with the BFD session.

Type: ipv6
Default: 2002::1
MyDiscriminator

Type: u32
Default: 0
RxCount

Type: u32
Default: 30
190
BfdResumePdusCommand
Read-Only Attribute
Description
Type: u32
Default: 30
Range: 1 - 10000
Type: u32
Default: 0
Range: 0 - 10000
TxCount

Type: u32
Default: 30
Range: 0 - 4294967295
TxInterval

Type: u32
Default: 30
Range: 1 - 10000
YourDiscriminator

Type: u32
Default: 0
BfdResumePdusCommand
Description:
Resume sending BFD PDUs for one or more BFD sessions.

BfdResumePdusCommand Writable Attributes

Writable Attribute
Description
ObjectList
Type: handle
Default: 0
BfdResumePdusCommand Read-Only Attributes

Read-Only Attribute
Description

BfdRouterConfig
Description:
191
BfdRouterConfig
Configure Bidirectional Forwarding Detection (BFD) for the router.

Children: BfdIpv4ControlPlaneIndependentSession, BfdIpv6ControlPlaneIndependentSession
Automatically-created children: BfdAuthenticationParams
Result children (automatically created): BfdIpv4SessionResults, BfdIpv6SessionResults, BfdRouterResults
Relations:
Side name
(Type)
Relative
Description
ResultChild
(ResultChild)
BfdIpv4SessionResults, BfdIpv6SessionResults,
BfdRouterResults
UsesIf
(UsesIf)

Specifies the interfaces used by the configuration

object (configuration object examples:
BgpRouterConfig, LdpRouterConfig, and so on).
BfdRouterConfig Writable Attributes

Writable Attribute
Description
Active, Name
DetectMultiplier
Value to multiply the negotiated transmit interval by to calculate the detection time for the transmitting system in
Asynchronous mode.
Type: u32
Default: 3
Range: 2 - 100
EchoRxInterval
Minimum interval in milliseconds that the emulated router wants between received BFD Echo packets.
Type: u32
Default: 0
Range: 0 - 10000
RouterRole
The role for the router to take.

Type: enum
Default: ACTIVE
Possible Values:
Value
Description
PASSIVE Take the Passive role. A system taking the Passive role must not begin sending BFD packets for a
particular session until it has received a BFD packet for that session.
ACTIVE
Take the Active role. A system taking the Active role must send BFD Control packets for a particular
session.
RxInterval
Minimum interval in milliseconds that the emulated router wants between received BFD Control packets.
Type: u32
Default: 50
Range: 1 - 10000
TxInterval
Minimum interval in milliseconds that the emulated router wants between transmitted BFD Control packets.
Type: u32
Default: 50
Range: 1 - 10000
Whether to use partial block state.

Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
192
BfdRouterResults
BfdRouterConfig Read-Only Attributes

Read-Only Attribute
Description
SessionsDownCount
Number of BFD sessions in the Down and AdminDown state.

Type: u16
Default: 0
SessionsUpCount
Number of BFD sessions in the Up state.

Type: u16
Default: 0
BfdRouterResults
Description:
BFD results for the router.

Relations:
Side name
(Type)
Relative
Description
ResultParent
(ResultChild)
BfdRouterConfig
BfdRouterResults Writable Attributes

BfdRouterResults Read-Only Attributes

Read-Only Attribute
Description
RxCount
Number of BFD packets received on this router.

Type: u32
Default: 0
TxCount
Number of BFD packets sent on this router.

Type: u32
Default: 0
BfdSessionResults
Description:
BFD session results.
BfdSessionResults Writable Attributes

193
BfdSessionResults
BfdSessionResults Read-Only Attributes

Read-Only Attribute
Description
BfdControlBits

Type: u8
Default: 0
BfdDiagnosticCode
A diagnostic code specifying the local system's reason for the last session state change. Allows remote systems to
determine the reason that the previous session failed.
Type: enum
Possible Values:
Value
Description
NO_DIAGNOSTIC
No Diagnostic (0)
CD_TIME_EXPIRE
FOR_PLANE_RESET
PATH_DOWN
Path Down (5)
CONCAT_PATH_DOWN
ADMIN_DOWN

BfdSessionState

Type: enum
Default: DOWN
Possible Values:
Value
Description
ADMINDOWN ADMINDOWN
DOWN
DOWN
INIT
INIT
UP
UP
MyDiscriminator

Type: u32
Default: 0
RxCount

Type: u32
Default: 30
Type: u32
Default: 30
Range: 1 - 10000
Type: u32
Default: 0
Range: 0 - 10000
TxCount

Type: u32
Default: 30
Range: 0 - 4294967295
TxInterval

Type: u32
Default: 30
Range: 1 - 10000
YourDiscriminator

Type: u32
Default: 0
194
BfdSetDiagnosticStateCommand
BfdSetDiagnosticStateCommand
Description:
Set the code to be sent that specifies the reason for the last session state change.

BfdSetDiagnosticStateCommand Writable Attributes

Writable Attribute
Description
BfdDiagnosticCode
Diagnostic code to use.

Type: enum
Possible Values:
Value
Description
NO_DIAGNOSTIC
No Diagnostic (0).
CD_TIME_EXPIRE
Control Detection Time Expired (1).
Echo Function Failed (2).
Neighbor Signaled Session Down (3).
FOR_PLANE_RESET
Forwarding Plane Reset (4).
PATH_DOWN
Path Down (5).
CONCAT_PATH_DOWN
Concatenated Path Down (6).
ADMIN_DOWN
Administratively Down (7).
REVERSE_CONCAT_PATH_DOWN Reverse Concatenated Path Down (8).

ObjectList
List of router object handles on which to perform this command. The default is the handle of the Project object, which
means all routers in the project will be affected.
Type: handle
Default: 0
BfdSetDiagnosticStateCommand Read-Only Attributes

Read-Only Attribute
Description

BFDSimpleAuth (bfd:BFDSimpleAuth)
Description:
Children: auth, header
BFDSimpleAuth Attributes
Attribute
Description
Name
information.
Type: string
195
BfdStateSummary
BfdStateSummary
Description:
The state of the BFD sessions.

Parents: Port, Project
Relations:
Side name
(Type)
Relative
Description
ResultParent
(ResultChild)
Port, Project
BfdStateSummary Writable Attributes

BfdStateSummary Read-Only Attributes

Read-Only Attribute
Description
SessionsDownCount
Number of BFD sessions in the Down and AdminDown state.

Type: u32
Default: 0
SessionsUpCount
Number of BFD sessions in the Up state.

Type: u32
Default: 0
BfdStopPdusCommand
Description:
Stop sending BFD PDUs for one or more BFD sessions.

BfdStopPdusCommand Writable Attributes

Writable Attribute
Description
ObjectList
Type: handle
Default: 0
BfdStopPdusCommand Read-Only Attributes

Read-Only Attribute
Description

196
BgpAuthenticationParams
BgpAuthenticationParams
Description:
Specifies all BGP authentication parameters.

Automatically created from: BgpDeviceGenProtocolParams, BgpRouterConfig, BgpSharedSessionParams
BgpAuthenticationParams Writable Attributes

Writable Attribute
Description
Authentication
Specify authentication type.

Type: enum
Default: NONE
Possible Values:
Value
Description
NONE
SIMPLE SIMPLE authentication is used.

MD5
MD5 authentication is used.
Md5KeyId
MD5 Key ID.

Type: u8
Default: 1
Password
Specify the authentication password.

Type: string
Default: Spirent
BgpAuthenticationParams Read-Only Attributes

BgpBreakTcpSessionCommand
Description:
Tear down the TCP sessions from the list of routers. If TCP sessions are already down, this command will be ignored.

BgpBreakTcpSessionCommand Writable Attributes

Writable Attribute
Description
Code
BGP notification code to be sent.

Type: u16
Default: 6
RouterList
Router handle list.

Type: handle
Default: 0
SubCode
BGP notification subcode to be sent.

Type: u16
Default: 0
197
BgpCapabilityConfig
BgpBreakTcpSessionCommand Read-Only Attributes

Read-Only Attribute
Description

BgpCapabilityConfig
Description:
Child of BgpRouterConfig to contain Afi and SubAfi attributes. You can create more than one of these objects if you need more than one AFI/SAFI pair.

Parents: BgpRouterConfig
BgpCapabilityConfig Writable Attributes

Writable Attribute
Description
Active, Name
Afi
Address family identifier. This is part of the multiprotocol extensions for BGP-4, which are described in an Internet Draft.
For this value, use one of the protocol numbers given in RFC 1700, in the Address Family Numbers section. This address
family identifier is used in conjunction with the subsequent address family identifier (see the SubAfi attribute) to identify the
protocol of the routes being advertised in the network layer reachability information (NLRI).
Type: u16
Default: 0
Range: 0 - 65535
SubAfi
The subsequent address family identifier is part of the multiprotocol extensions for BGP-4, which are described in an Internet
Draft.
This value is used in conjunction with the address family identifier (see the Afi attribute). This field provides additional
information about the type of network layer reachability information carried in the attribute.
Type: u8
Default: 0
Range: 0 - 255
BgpCapabilityConfig Read-Only Attributes

BgpDeviceGenProtocolParams
Description:
Specifies the BGP-specific router generator parameters.

Automatically-created children: BgpAuthenticationParams
198
BgpDeviceGenProtocolParams
BgpDeviceGenProtocolParams Writable Attributes

Writable Attribute
Description
Active, Name
AsNum
Autonomous system for the emulated BGP router.

Type: u16
Default: 1
Range: 0 - 65535
AsNum4Byte
Enable4ByteAsNum must be set to TRUE. The 4-byte autonomous system number for the emulated BGP router.
Type: string
Default: 1:1
AsNum4ByteStep
Enable4ByteAsNum must be set to TRUE. The gap between 4-byte autonomous system numbers configured for
emulated BGP router.
Type: string
Default: 0
AsNumStep
Autonomous system step for the emulated BGP router.

Type: u16
Default: 0
Range: 0 - 65535
BgpMode
BGP mode.
Type: enum
Default: EBGP
Possible Values:
Value Description
EBGP External BGP.
IBGP Internal BGP.
DutAs
Autonomous system number of the BGP peer router session on the DUT.
Type: u16
Default: 1001
Range: 0 - 65535
DutAsNum4Byte
Enable4ByteAsNum must be set to TRUE. The gap between 4-byte autonomous system numbers for the generated
Type: string
Default: 1:1001
DutAsNum4ByteStep
Enable4ByteDutAsNum must be set to TRUE. The gap between 4-byte autonomous system numbers configured
for the DUT.
Type: string
Default: 0
DutAsStep
Autonomous system number step of the BGP peer router session on the DUT.
Type: u16
Default: 0
Range: 0 - 65535
DutIpv4Addr
IPv4 address of the BGP peer for the session.

Type: ip
Default: 192.85.1.1
DutIpv4AddrStep
IPv4 address step of the BGP peer for the session.

Type: ip
Default: 0.0.0.0
DutIpv6Addr
IPv6 address of the BGP peer for the session.

Type: ipv6
Default: ::2
DutIpv6AddrStep

Type: ipv6
Default: ::0
199
BgpGlobalConfig
Writable Attribute
Description
Enable4ByteAsNum
Whether to enable a 4-byte autonomous system number for the emulated BGP router.
Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
Enable 4-byte autonomous system number for the emulated router.
FALSE Disable 4-byte autonomous system number for the emulated router.
Enable4ByteDutAsNum
Whether to enable the ability of the emulated BGP router to handle a DUT with a 4-byte autonomous system number.
Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
Enable 4-byte autonomous system number for the emulated router.
FALSE disable 4-byte DUT autonomous system number for the emulated router.
EnableBfd
Enable or disable BFD (Bidirectional Forwarding Detection).

Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
Enable BFD.
FALSE Disable BFD.

GracefulRestart
Enable or disable graceful restart on the emulated BGP router.

Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
Enable graceful restart on the emulated BGP router.
FALSE Disable graceful restart on the emulated BGP router.

IpVersion
UseGatewayAsDutIpAddr
IP version to use for the BGP session.

Type: enum
Default: IPV4
Possible Values:
Value Description
IPV4
IP version 4.
IPV6
IP version 6.
Use gateway address as DUT IP address.

Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
FALSE Not use gateway address as DUT IP address.
BgpDeviceGenProtocolParams Read-Only Attributes

BgpGlobalConfig
Description:
Specify global values for BGP router configuration. Attribute settings at the profile level take precedence over the global settings.
200
BgpGlobalConfig

BgpGlobalConfig Writable Attributes

Writable Attribute
Description
Active, Name
ConnectionRetryCount
Specify the number of retries to use when establishing the TCP connection for the BGP session.
Type: u32
Default: 100
Range: 0 - 65535
ConnectionRetryInterval
BGP Connection Retry Interval in seconds.

Type: u16
Default: 30
Range: 10 - 300
ScalabilityMode
Allows user to turn off certain functionality to reduce memory consumption and CPU usage.
Type: enum
Default: NORMAL
Possible Values:
Value
Description
NORMAL
Normal mode of operation.
NO_TRAFFIC_BINDING Turn off Traffic support by disabling label processing.

DISCARD_UPDATES
SequentialStartup
Prevents processing of received BGP UPDATE messages, which increases route

reflector convergence times, however BGP receive results will be invalid.
Whether to start BGP sessions sequentially.

Type: enum
Default: DISABLE
Possible Values:
Value
Description
DISABLE Disable sequential startup. Spirent TestCenter will not start BGP sessions sequentially.
ENABLE Enable sequential startup.
StaggerClose
Delay time in milliseconds before closing a BGP session.

Type: u16
Default: 100
Range: 0 - 10000
StaggerOpen
Number of milliseconds to wait before sending a session starting Open message.

Type: u16
Default: 100
Range: 0 - 10000
UpdateCount
Maximum routes per BGP UPDATE message.

Type: u16
Default: 2000
Range: 1 - 65535
UpdateDelay
Specify the delay between successive BGP UPDATE messages in milliseconds.

Type: u16
Default: 30
Range: 0 - 10000
VplsDraftVersion
Specify which VPLS version to use.

Type: enum
Default: VERSION_00
Possible Values:
Value
Description
VERSION_00
draft-ietf-l2vpn-vpls-bgp-00
VERSION_02
draft-ietf-l2vpn-vpls-bgp-02
VERSION_VPLS_4761 VPLS RFC 4761
201
BgpImportRouteTableCommand
BgpGlobalConfig Read-Only Attributes

BgpImportRouteTableCommand
Description:
Import route table.

BgpImportRouteTableCommand Writable Attributes

Writable Attribute
Description
DeleteRoutes
Whether to prompt to delete routes.

Type: enum
Default: PROMPT
Possible Values:
Value
Description
PROMPT Delete routes prompt.
YES
Display delete prompt.
NO
Do not display delete prompt.
ImportParams
Handle of BgpImportRouteTableParams.
Type: handle
Default: 0
RouterList
Router handle list.

Type: handle
Default: 0
BgpImportRouteTableCommand Read-Only Attributes

Read-Only Attribute
Description

Summary
BGP route import summary.

Type: string
BgpImportRouteTableParams
Description:
Bgp import route table parameters.

Parents: Project
202
BgpIpv4RouteConfig
Relations:
Side name
(Type)
Relative
Description
(SelectedRouterRelation)
EmulatedDevice
Selected router.
BgpImportRouteTableParams Writable Attributes

Writable Attribute
Description
Active, Name
AddTesterAsn
Specify whether to add Tester AS Number.

Type: bool
Default: TRUE
Possible Values:
Value Description
TRUE
Add Tester AS Number.
FALSE Do not add Tester AS Number.

FileName
BGP route table to import.

Type: inputFilePath
MaxRouteBlks
Maximum route blocks to be created.

Type: u32
Default: 1000
MaxRoutesPerRouteBlock
Maximum routes per route block.

Type: u32
Default: 2500
RouterType
Router type.
Type: enum
Default: CISCO_VERSION_ONE
Possible Values:
Value
Description
CISCO_VERSION_ONE
Router type is CISCO_VERSION_ONE.
JUNIPER_VERSION_ONE Router type is JUNIPER_VERSION_ONE.

ALCATEL_VERSION_ONE Router type is ALCATEL_VERSION_ONE.
ALCATEL_VERSION_TWO Router type is ALCATEL_VERSION_TWO.
UseTesterIpAsNextHop
Specify whether to use TesterIp as NextHop.

Type: bool
Default: TRUE
Possible Values:
Value Description
TRUE
Use TesterIp as NextHop.
FALSE Do not use TesterIp as NextHop.
BgpImportRouteTableParams Read-Only Attributes

BgpIpv4RouteConfig
Description:
Defines the characteristics of BGP IPv4 routes.
203
BgpIpv4RouteConfig

Automatically-created children: BgpVpnRouteConfig, Ipv4NetworkBlock
Relations:
Side name
(Type)
Relative
EchoReplyErrorGeneration
(EchoReplyErrorFecInfo)
Description
BgpIpv4RouteConfig Writable Attributes

Writable Attribute
Description
AggregatorAs
AS number to use for the AGGREGATOR attribute.

Type: string
AggregatorIp
IP address to use for the AGGREGATOR attribute.

Type: ip
Default: null
AsPath
List of AS numbers, in string format, that will be used in the AS_PATH attribute (type code 2) in BGP UPDATE messages.
This list identifies the autonomous systems through which the routing information carried in the UPDATE message has
passed.
Type: string
Default: 1
AsPathIncrement
Modifies the AS PATH of each route within a route block.

Type: string
Default: 1
AsPathPerBlockCount
Number of AS Paths per route block.

Type: u32
Default: 1
AsPathSegmentType
Path segment type for the AS path specified by the asPath attribute.
Type: enum
Default: SEQUENCE
Possible Values:
Value
Description
SET
An unordered set of ASs that a route in the UPDATE message has traversed.
SEQUENCE
An ordered set of ASs that a route in the UPDATE message has traversed.
CONFED_SEQ An ordered set of Member AS Numbers in the local confederation that the UPDATE message has traversed.
CONFED_SET An unordered set of Member AS Numbers in the local confederation that the UPDATE message has
traversed.
AtomicAggregatePresent
Whether to include the ATOMIC_AGGREGATE attribute in BGP UPDATE messages. When this is TRUE, the receiving
BGP speaker cannot de-aggregate the prefix into more specific routes.
Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
Include the ATOMIC_AGGREGATE attribute. The receiving BGP speaker cannot de-aggregate the prefix into
more specific routes.
FALSE Do not include the ATOMIC_AGGREGATE attribute. Specific routes can be de-aggregated .
ClusterIdList
Identifies the route reflectors that a prefix has passed through. This is the optional CLUSTER_LIST path attribute (type code
10), as covered in RFC 2796. This needs a list of cluster IDs (router IDs). Enter up to four comma-separated cluster IDs in
the form of IPv4 addresses.
Type: ip
Default: 0.0.0.0
204
BgpIpv4RouteConfig
Writable Attribute
Description
Community
Specify a list of BGP communities in string format. A community is a group of destinations that share some common property.
This is the optional COMMUNITIES community path attribute (type code 8) in UPDATE messages. BGP communities are
described in RFC 1997.
Enter up to eight comma-separated pairs. Put a colon between the parts of the pair.
Example: AS:Value,AS:Value.
where each AS and Value is between 0 - 65535, up to 8 pairs. AS numbers cannot be duplicated. Each AS can have only
one value.
Type: string
Default: 1:1
CommunityIncrement
Specifies a list of BGP community incrementers in string format. This is a list of incremintors, each element in the list will
specify which community value is to be incremented.
Type: string
Default: 1:1
CommunityPerBlockCount
Number of unique communities in this route block.

Type: u32
Default: 1
Label
NOTE: This is deprecated. It will be removed in subsequent releases, so it is recommended that you do not use it.
Route label.
Type: enum
Default: NONE
Possible Values:
Value
Description
NONE
None.
FIXED
Fixed.
INCREMENTAL Incremental.
LocalPreference
Value for the LOCAL_PREF path attribute in UPDATE messages. This informs other BGP speakers in the same AS of the
local BGP speaker's degree of preference for a route. A higher number means more preference.
Type: u32
Default: 10
Range: 0 - 4294967295
LocalPreferenceIncrement
Modifier to allow a routeblock to vary the Local Preference. The count will be tied to Network Count.
Type: u32
Default: 0
Range: 0 - 4294967295
MdtGroupAddr
MDT Group address.

Type: ip
Default: 0.0.0.0
MdtIpv4Addr
MDT IPv4 address.

Type: ip
Default: 0.0.0.0
Med
The value for the multi-exit discriminator (MED). This is the optional MULTI_EXIT_DISC path attribute (type code 4) in
UPDATE messages. This value can be used by a BGP speaker's decision process to discriminate among multiple exit
points to a neighboring autonomous system. An exit or entry point with a lower MED should be preferred.
Type: u32
Default: null
Range: 0 - 4294967295
MedIncrement
Modifier to allow a routeblock to vary the MED. The count will be tied to Network Count.
Type: u32
Default: 0
Range: 0 - 4294967295
NextHop
Specify the IP address of the border router that should be used as the next hop to the destinations listed in the UPDATE
message. This is the mandatory NEXT_HOP path attribute in UPDATE messages.
Type: ip
Default: null
205
BgpIpv4RouteConfig
Writable Attribute
Description
NextHopCount
Number of unique Next Hops in the route block. This count will have a multiplier affect on the route count.
Type: u32
Default: 1
NextHopIncrement
Modifier to allow a route block to vary the Next Hop.

Type: ip
Default: 0.0.0.1
Origin
Describes how a prefix came to be routed by BGP. It defines the origin of the path information. This attribute is generated
by the AS that originated the route(s) in the update message.
Type: enum
Default: IGP
Possible Values:
Value
Description
IGP
IGP (0) - The Network Layer Reachability Information is interior to the originating AS.
EGP
EGP (1) - The Network Layer Reachability Information was learned through EGP.
INCOMPLETE Incomplete (2) - The Network Layer Reachability Information was learned in some other way.
OriginatorId
Router ID of the originator of the route in the local AS. This is the optional ORIGINATOR_ID path attribute (type code 9).
Type: ip
Default: null
PrefixLengthCount
Number of unique prefix lengths in the route block. This count will have a multiplier affect on the route count.
Type: u8
Default: 1
Range: 1 - 32
PrefixLengthIncrement
Modifier to allow a route block to vary the prefix length.

Type: u8
Default: 1
Range: 1 - 32
RouteLabel
Route label.
Type: enum
Default: FIXED
Possible Values:
Value
Description
FIXED
Route label is FIXED.
INCREMENTAL Route label is INCREMENTAL.

RouteSubAfi
The route's subsequent address family identifier.

Type: enum
Default: UNICAST
Possible Values:
Value
Description
UNICAST
SubAFI is UNICAST.
MULTICAST
SubAFI is MULTICAST.
UNICAST_AND_MULTICAST SubAFI is UNICAST_AND_MULTICAST.
SubAfi
LABELED_IP
SubAFI is LABELED_IP.
MDT
SubAFI is MDT.
VPN
SubAFI is VPN.
Subsequent address family identifier.
Type: enum
Default: UNICAST
Possible Values:
Value
Description
UNICAST
SubAFI is UNICAST.
MULTICAST
SubAFI is MULTICAST.
UNICAST_AND_MULTICAST SubAFI is UNICAST_AND_MULTICAST.
206
BgpIpv4VplsConfig
Writable Attribute
Description
VpnPresent
Specify whether a VPN is present.
Enabled if the Label attribute is set to FIXED or INCREMENTAL.
Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
VPN is present.
FALSE VPN is not present.
BgpIpv4RouteConfig Read-Only Attributes

Read-Only Attribute
Description
RouteCount
Number of routes in this route block.

Type: u32
Default: 1
BgpIpv4VplsConfig
Description:
Defines the characteristics of BGP VPLS IPv4 routes.

Relations:
Side name
(Type)
Relative
Description
BgpIpv4VplsConfig Writable Attributes

Writable Attribute
Description
AsPath
This list identifies the autonomous systems through which the routing information carried in the UPDATE message has passed.
Type: string
Default: 1
AsPathIncrement

Type: string
Default: 1
AsPathPerBlockCount

Type: u32
Default: 1
207
BgpIpv4VplsConfig
Writable Attribute
Description
AsPathSegmentType
Type: enum
Default: SEQUENCE
Possible Values:
Value
Description
SET
SEQUENCE
traversed.
BlkOffset
VPLS label block offset. This is a field in the NLRI. The starting VE ID of the block of VEs to which this BGP NLRI (labelblock) could be advertised. The receiver of the NLRI will process the NLRI and install the label if its VE is included in the VE
ID range defined by the Block Offset and Block Size.
Type: u16
Default: 1
Range: 0 - 65535
BlkOffsetStep
Type: u16
Default: 0
BlkSize
VPLS label block size. This is a field in the NLRI. This is the number of labels in the block, starting from the block offset.
Type: u16
Default: 1
Range: 1 - 65535
ClusterIdList
Type: ip
Default: 0.0.0.0
EnableFlooding
Specify whether to set the F control flag to indicate that the VE is capable of flooding. If set, the sender can send one frame
to represent all of the u-PEs the PE represents. If not set, the sender must send a separate copy of a given frame for each
of the u-PEs that the PE represents.
Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
VE is capable of flooding. This sets the F control flag.
FALSE VE is not capable of flooding. This clears the F control flag.

LocalPreference
Type: u32
Default: 10
Range: 0 - 4294967295
Type: u32
Default: 0
Range: 0 - 4294967295
Med
The value for the multi-exit discriminator (MED). This is the optional MULTI_EXIT_DISC path attribute (type code 4) in UPDATE
messages. This value can be used by a BGP speaker's decision process to discriminate among multiple exit points to a
neighboring autonomous system. An exit or entry point with a lower MED should be preferred.
Type: u32
Default: null
Range: 0 - 4294967295
MedIncrement
Type: u32
Default: 0
Range: 0 - 4294967295
208
BgpIpv4VplsConfig
Writable Attribute
Description
MtuSize
MTU (Maximum Transmission Unit) size in number of bytes. Maximum allowable frame size allowed to traverse a given VPLS
instance.
Type: u16
Default: 1500
Range: 64 - 65535
NextHop
Type: ip
Default: null
RouteDistinguisher
Route distinguisher in string format. This is a field in the NLRI. An 8-byte value that is concatenated with an IPv4 prefix to
create a unique VPN IPv4 prefix.
Type: string
Default: 1:1
RouteDistinguisherStep
Increment value for RD for each successive VRF within a routeblock.

Type: string
Default: 0:1
RouteTarget
Specify the value of the extended community path attribute called Route Target, in string format. This is the Route Target
extended community, carried in the optional Extended Community path attribute (type code 16) in UPDATE messages. The
Route Target identifies a set of sites to which a PE router distributes routes. BGP extended communities are described in an
Internet Draft.
Enter the attribute as a comma-separated list of up to eight entries, formatted as AS:Number or IPv4:Number. The default
value is in AS:Number format.
Type: string
Default: 1:1
RouteTargetStep
Increment value for RT for each successive VRF within a routeblock.

Type: string
Default: 0:1
StripVlan
Whether to set the P control flag. If this is set to TRUE, the P control flag is set, and the PE will strip the outermost VLAN from
an Ethernet frame received from a CE before encapsulating it, and will push a VLAN onto a frame before sending it to a CE.
Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
Set the P control flag.
FALSE Do not set the P control flag.

VeId
Specify the VPLS edge ID (VEID). This is a field in the NLRI. Identifier for the local PE or represented u-PE(s). In Spirent
TestCenter the VE identifier represents an emulated endpoint (can be either a PE or a u-PE) that is being advertised by the
BGP speaker.
If there are multiple VPLS objects under a BgpSession object, set this attribute to the same value for each VPLS object.
Type: u16
Default: 1
Range: 0 - 65535
VeIdStep
Increment value for VE ID for each successive VRF within a routeblock.

Type: u16
Default: 0
VrfCount
Number of unique VRFs to create within a routebock.

Type: u32
Default: 1
BgpIpv4VplsConfig Read-Only Attributes

Read-Only Attribute
Description
RouteCount

Type: u32
Default: 1
209
BgpIpv4VpnFecInfo
BgpIpv4VpnFecInfo
Description:

Parents: Ipv4EchoRequestConfig
Relations:
Side name
(Type)
Relative
Description
EchoRequestConfig
(InnerMostFecInfo)
Ipv4EchoRequestConfig
DstFecInfo
(NextFecInfo)
BgpIpv4VpnFecInfo, BgpVplsFecInfo, GeneralizedPseudoWireFecInfo,

Ipv4PrefixFecInfo, VcFecInfo
BgpIpv4VpnFecInfo Writable Attributes

Writable Attribute
Description
Active, Name
AddrIncrement
Type: u32
Default: 1
NetworkCount
Type: u32
Default: 1
Range: 1 - 4294967295
PrefixLength
Type: u8
Default: 24
Range: 1 - 32
RouteDistinguisher
Type: string
Default: 100:1
RouteDistinguisherIncrement
Type: string
Default: 0:1
StartIpAddr
Type: ip
Default: 192.0.1.0
VrfCount
Type: u16
Default: 1
BgpIpv4VpnFecInfo Read-Only Attributes

BgpIpv6RouteConfig
Description:
Defines the characteristics of BGP IPv6 routes.

Automatically-created children: BgpVpnRouteConfig, Ipv6NetworkBlock
Relations:
210
BgpIpv6RouteConfig
Side name
(Type)
Relative
Description
BgpIpv6RouteConfig Writable Attributes

Writable Attribute
Description
AggregatorAs

Type: string
AggregatorIp

Type: ip
Default: null
AsPath
passed.
Type: string
Default: 1
AsPathIncrement

Type: string
Default: 1
AsPathPerBlockCount

Type: u32
Default: 1
AsPathSegmentType
Type: enum
Default: SEQUENCE
Possible Values:
Value
Description
SET
SEQUENCE
CONFED_SEQ An ordered set of Member AS Numbers in the local confederation that the UPDATE message has
traversed.
traversed.
Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
ClusterIdList
Identifies the route reflectors that a prefix has passed through. This is the optional CLUSTER_LIST path attribute (type
code 10), as covered in RFC 2796. This needs a list of cluster IDs (router IDs). Enter up to four comma-separated cluster
IDs in the form of IPv4 addresses.
Type: ip
Default: 0.0.0.0
211
BgpIpv6RouteConfig
Writable Attribute
Description
Community
one value.
Type: string
Default: 1:1
CommunityIncrement
Specifies a list of BGP community incrementers in string format. This is a list of incremintors, each element in the list will
specify which community value is to be incremented.
Type: string
Default: 1:1
CommunityPerBlockCount
Number of unique communities in this route block.

Type: u32
Default: 1
Label
Route label.
Type: enum
Default: NONE
Possible Values:
Value
Description
NONE
None.
FIXED
Fixed.
INCREMENTAL Incremental.
LocalNextHop
This is the link-local IPv6 address of the next hop (emulated router).
Specify the 16-byte link-local address, as needed for a 32-byte next hop.
Type: ipv6
Default: null
LocalPreference
Type: u32
Default: 10
Range: 0 - 4294967295
Type: u32
Default: 0
Range: 0 - 4294967295
MdtGroupAddr
MDT Group address.

Type: ip
Default: 0.0.0.0
MdtIpv4Addr
MDT IPv4 address.

Type: ip
Default: 0.0.0.0
Med
UPDATE messages. This value can be used by a BGP speaker's decision process to discriminate among multiple exit
points to a neighboring autonomous system. An exit or entry point with a lower MED should be preferred.
Type: u32
Default: null
Range: 0 - 4294967295
MedIncrement
Modifier to allow a route block to vary the MED. The count will be tied to Network Count.
Type: u32
Default: 0
Range: 0 - 4294967295
212
BgpIpv6RouteConfig
Writable Attribute
Description
NextHop
Type: ipv6
Default: null
NextHopCount
Type: u32
Default: 1
NextHopIncrement

Type: ipv6
Default: 0::1
Origin
The setting of the mandatory ORIGIN path attribute in UPDATE messages. This defines the origin of the path information.
Type: enum
Default: IGP
Possible Values:
Value
Description
IGP
EGP
OriginatorId
Router ID of the originator of the route in the local AS. This is the optional ORIGINATOR_ID path attribute (type code 9).
Type: ip
Default: null
PrefixLengthCount
Type: u8
Default: 1
Range: 1 - 128
PrefixLengthIncrement

Type: u8
Default: 1
Range: 1 - 128
RouteLabel
Route label.
Type: enum
Default: FIXED
Possible Values:
Value
Description
FIXED
Route label is FIXED.
INCREMENTAL Route label is INCREMENTAL.

RouteSubAfi
The route's subsequent address family identifier.

Type: enum
Default: UNICAST
Possible Values:
Value
Description
UNICAST
SubAfi is UNICAST.
MULTICAST
SubAfi is MULTICAST.
UNICAST_AND_MULTICAST SubAfi is UNICAST_AND_MULTICAST.

LABELED_IP
SubAfi is LABELED_IP.
MDT
SubAfi is MDT.
VPN
SubAfi is VPN.
213
BgpIpv6VplsConfig
Writable Attribute
Description
SubAfi
Type: enum
Default: UNICAST
Possible Values:
Value
Description
UNICAST
SubAfi is UNICAST.
MULTICAST
SubAfi is MULTICAST.
UNICAST_AND_MULTICAST SubAfi is UNICAST_AND_MULTICAST.

VpnPresent
Specify whether a VPN is present.
Enabled if the Label attribute is set to FIXED or INCREMENTAL.
Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
VPN is present.
FALSE VPN is not present.
BgpIpv6RouteConfig Read-Only Attributes

Read-Only Attribute
Description
RouteCount

Type: u32
Default: 1
BgpIpv6VplsConfig
Description:

Relations:
Side name
(Type)
Relative
Description
BgpIpv6VplsConfig Writable Attributes

Writable Attribute
Description
AsPath
The list of AS numbers, in string format, that will be used in the AS_PATH attribute (type code 2) in BGP UPDATE messages.
This list identifies the autonomous systems through which the routing information carried in the UPDATE message has passed.
Type: string
Default: 1
AsPathIncrement

Type: string
Default: 1
214
BgpIpv6VplsConfig
Writable Attribute
Description
AsPathPerBlockCount

Type: u32
Default: 1
AsPathSegmentType
The path segment type for the AS path specified by the asPath attribute.
Type: enum
Default: SEQUENCE
Possible Values:
Value
Description
SET
SEQUENCE
traversed.
BlkOffset
VPLS label block offset. This is a field in the NLRI. The starting VE ID of the block of VEs to which this BGP NLRI (labelblock) could be advertised. The receiver of the NLRI will process the NLRI and install the label if its VE is included in the VE
ID range defined by the Block Offset and Block Size.
Type: u16
Default: 1
Range: 0 - 65535
BlkOffsetStep
Type: u16
Default: 0
BlkSize
VPLS label block size. This is a field in the NLRI. This is the number of labels in the block, starting from the block offset.
Type: u16
Default: 1
Range: 1 - 65535
ClusterIdList
Type: ip
Default: 0.0.0.0
EnableFlooding
Specify whether to set the F control flag to indicate that the VE is capable of flooding. If set, the sender can send one frame
to represent all of the u-PEs the PE represents. If not set, the sender must send a separate copy of a given frame for each
of the u-PEs that the PE represents.
Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
VE is capable of flooding. This sets the F control flag.
FALSE VE is not capable of flooding. This clears the F control flag.

LocalNextHop
Specify the IPv6 link-local address of the next hop. This is the link-local IPv6 address of the next hop (emulated router).
Type: ipv6
Default: null
LocalPreference
The value for the LOCAL_PREF path attribute in UPDATE messages. This informs other BGP speakers in the same AS of
the local BGP speaker's degree of preference for a route. A higher number means more preference.
Type: u32
Default: 10
Range: 0 - 4294967295
Type: u32
Default: 0
Range: 0 - 4294967295
215
BgpIpv6VplsConfig
Writable Attribute
Description
Med
The value for the multi-exit discriminator (MED). This is the optional MULTI_EXIT_DISC path attribute (type code 4) in UPDATE
messages. This value can be used by a BGP speaker's decision process to discriminate among multiple exit points to a
neighboring autonomous system. An exit or entry point with a lower MED should be preferred.
Type: u32
Default: null
Range: 0 - 4294967295
MedIncrement
Type: u32
Default: 0
Range: 0 - 4294967295
MtuSize
MTU (Maximum Transmission Unit) size in number of bytes. Maximum allowable frame size allowed to traverse a given VPLS
instance.
Type: u16
Default: 1500
Range: 64 - 65535
NextHop
Type: ipv6
Default: null
RouteDistinguisher
Type: string
Default: 1:1

Type: string
Default: 0:1
RouteTarget
Route Target identifies a set of sites to which a PE router distributes routes. BGP extended communities are described in an
Internet Draft.
Enter the attribute as a comma-separated list of up to eight entries, formatted as AS:Number or IPv4:Number. The default
value is in AS:Number format.
Type: string
Default: 1:1
RouteTargetStep

Type: string
Default: 0:1
StripVlan
Whether to set the P control flag. If this is set to TRUE, the P control flag is set, and the PE will strip the outermost VLAN
from an Ethernet frame received from a CE before encapsulating it, and will push a VLAN onto a frame before sending it to
a CE.
Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
Set the P control flag.
FALSE Do not set the P control flag.

VeId
Specify the VPLS edge ID (VEID). This is a field in the NLRI. Identifier for the local PE or represented u-PE(s). In Spirent
TestCenter the VE identifier represents an emulated endpoint (can be either a PE or a u-PE) that is being advertised by the
BGP speaker.
If there are multiple VPLS objects under a BgpSession object, set this attribute to the same value for each VPLS object.
Type: u16
Default: 1
Range: 0 - 65535
VeIdStep
Increment value for VE ID for each successive VRF within a routeblock.

Type: u16
Default: 0
216
bgpLabeledIpv4PrefixSubTlv
Writable Attribute
Description
VrfCount
The number of unique VRFs to create within a routebock.

Type: u32
Default: 1
BgpIpv6VplsConfig Read-Only Attributes

Read-Only Attribute
Description
RouteCount

Type: u32
Default: 1
Description:
Parents: TargetFecSubTlvs
Children: None
bgpLabeledIpv4PrefixSubTlv Attributes
Attribute
Description
ipv4Prefix
Type: IPV4ADDR
Default: 192.168.1.1
length
Type: INTEGER
Default: 5
Name
Type: string
prefixLength
Type: INTEGER
Default: 24
reserved
Type: ALIGNMENTPAD
Default: 0
type
Type: INTEGER
Default: 12
Description:
Children: None
217
BgpReadvertiseRouteCommand
bgpLabeledIpv6PrefixSubTlv Attributes
Attribute
Description
ipv6Prefix
Type: IPV6ADDR
Default: 2000::1
length
Type: INTEGER
Default: 17
Name
Type: string
prefixLength
Type: INTEGER
Default: 64
reserved
Type: ALIGNMENTPAD
Default: 0
type
Type: INTEGER
Default: 13
BgpReadvertiseRouteCommand
Description:
Re-send the BGP routes from the list of routers.

BgpReadvertiseRouteCommand Writable Attributes

Writable Attribute
Description
RouterList
Router handle list.

Type: handle
Default: 0
BgpReadvertiseRouteCommand Read-Only Attributes

Read-Only Attribute
Description

BgpRefreshRoutesCommand
Description:
Refresh BGP routes.
218
BgpRestartRouterCommand

BgpRefreshRoutesCommand Writable Attributes

Writable Attribute
Description
RouterList
BGP router handle list.

Type: handle
Default: 0
BgpRefreshRoutesCommand Read-Only Attributes

Read-Only Attribute
Description

BgpRestartRouterCommand
Description:
Perform the BGP graceful restart from the list of routers.

BgpRestartRouterCommand Writable Attributes

Writable Attribute
Description
RouterList
Router handle list.

Type: handle
Default: 0
BgpRestartRouterCommand Read-Only Attributes

Read-Only Attribute
Description

BgpResumeKeepaliveCommand
Description:
Start sending keepalives from the list of routers. If keepalives are already being sent or the router has not been started, this command will be ignored.

219
BgpResumeTcpSessionCommand

BgpResumeKeepaliveCommand Writable Attributes

Writable Attribute
Description
RouterList
Router handle list.

Type: handle
Default: 0
BgpResumeKeepaliveCommand Read-Only Attributes

Read-Only Attribute
Description

BgpResumeTcpSessionCommand
Description:
Resume the TCP sessions from the list of routers. If TCP sessions are already up, this command will be ignored.

BgpResumeTcpSessionCommand Writable Attributes

Writable Attribute
Description
RouterList
Router handle list.

Type: handle
Default: 0
BgpResumeTcpSessionCommand Read-Only Attributes

Read-Only Attribute
Description

BgpRouteGenParams
Description:
Specifies BGP route generation parameters.

Parents: Project
220
BgpRouteGenRouteAttrParams
Children: FullMeshTopologyGenParams, GridTopologyGenParams, HubSpokeTopologyGenParams, Ipv4RouteGenParams, Ipv6RouteGenParams,

RingTopologyGenParams, TreeTopologyGenParams
Relations:
Side name
(Type)
Relative
Description
EmulatedDevice
The routers that routes will be generated on.
BgpRouteGenParams Writable Attributes

Writable Attribute
Description
Active, Name
BgpRouteGenParams Read-Only Attributes

Description:
BGP specific route attribute parameters.

Parents: Ipv4RouteGenParams, Ipv6RouteGenParams
BgpRouteGenRouteAttrParams Writable Attributes

Writable Attribute
Description
Active, Name
Ipv4NextHopCount
Type: u32
Default: 1
Ipv4NextHopIncrement

Type: ip
Default: 0.0.0.1
Ipv4PrefixLengthCount
Type: u8
Default: 1
Range: 1 - 32
Ipv4PrefixLengthIncrement

Type: u32
Default: 1
Range: 1 - 32
Ipv6NextHop
Specify the IP address of the border router that should be used as the next hop to the destinations listed in the
UPDATE message. This is the mandatory NEXT_HOP path attribute in UPDATE messages.
Type: ipv6
Default: 2000::1
Ipv6NextHopCount
Type: u32
Default: 1
221
Writable Attribute
Description
Ipv6NextHopIncrement

Type: ipv6
Default: 0::0
Ipv6PrefixLengthCount
Type: u8
Default: 1
Range: 1 - 128
Ipv6PrefixLengthIncrement

Type: u32
Default: 1
Range: 1 - 128
LocalPreference
The value for the LOCAL_PREF path attribute in UPDATE messages. This informs other BGP speakers in the
same AS of the local BGP speaker's degree of preference for a route. A higher number means more preference.
Type: u32
Default: 10
Range: 0 - 4294967295
Type: u32
Default: 0
Range: 0 - 4294967295
Med
The value for the multi-exit discriminator (MED). This is the optional MULTI_EXIT_DISC path attribute (type
code 4) in UPDATE messages. This value can be used by a BGP speaker's decision process to discriminate
among multiple exit points to a neighboring autonomous system. An exit or entry point with a lower MED should
be preferred.
Type: u32
Default: null
Range: 0 - 4294967295
MedIncrement
Type: u32
Default: 0
Range: 0 - 4294967295
NextHop
Specify the IP address of the border router that should be used as the next hop to the destinations listed in the
UPDATE message. This is the mandatory NEXT_HOP path attribute in UPDATE messages.
Type: ip
Default: 1.1.1.1
PrimaryAsPathIncrement
Modifies the primary AS PATH of each route within a route block.

Type: string
Default: 1
PrimaryAsPathSuffix
AS path suffix for primary routes.

Type: string
Default: 1
SecondaryAsPathIncrement
Modifies the secondary AS PATH of each route within a route block.

Type: string
Default: 1
SecondaryAsPathSuffix
AS path suffix for secondary routes.

Type: string
Default: 1
UseIpv4DeviceAddrAsNextHop
NOTE: This is deprecated. It will be removed in subsequent releases, so it is recommended that you
do not use it.
Used to indicate if generated route block should use the device's IPv4 address as the next hop.
Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
Use device IPv4 address as next hop.
FALSE Use user specified next hop address.
222
BgpRouterConfig
Writable Attribute
Description
UseIpv4DeviceInterfaceAddrAsNextHop
Type: bool
Default: TRUE
Possible Values:
Value Description
TRUE
FALSE
UseIpv6DeviceAddrAsNextHop
do not use it.
Used to indicate if generated route block should use the device's IPv6 address as the next hop.
Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
Use device IPv6 address as next hop.
FALSE Use user specified Next hop address.

UseIpv6DeviceInterfaceAddrAsNextHop
Type: bool
Default: TRUE
Possible Values:
Value Description
TRUE
FALSE
BgpRouteGenRouteAttrParams Read-Only Attributes

BgpRouterConfig
Description:
Defines the characteristics of an emulated router that acts as a BGP speaker.

Children: BgpCapabilityConfig, BgpIpv4RouteConfig, BgpIpv4VplsConfig, BgpIpv6RouteConfig, BgpIpv6VplsConfig, BgpVplsAdConfig
Result children (automatically created): BgpRouterResults
Relations:
Side name
(Type)
Relative
Description
(ResolvesInterface)

Use this to link the traffic binding interfaces and

traffic binding resolver.
ResultChild
(ResultChild)
BgpRouterResults
223
BgpRouterConfig
BgpRouterConfig Writable Attributes

Writable Attribute
Description
Afi
Instead use the BgpCapabilityConfig object SubAfi attribute.
Address family identifier.
Type: u16
Default: 0
Range: 0 - 65535
AsNum
Autonomous system number for the emulated BGP router. Since this is the tester AS number, the number is arbitrary and
you can enter any number that has been configured on the DUT as a BGP neighbor.
Type: u16
Default: 1
Range: 0 - 65535
AsNum4Byte
4-byte autonomous system number for the emulated BGP router. To use this, Enable4ByteAsNum must be set to TRUE.
Since this is the tester AS, this number is arbitrary and you can enter any number that has been configured on the DUT as a
BGP neighbor.
Type: string
Default: 1:1
BgpSessionIpAddress
Type: enum
Default: INTERFACE_IP
Possible Values:
Value
Description
INTERFACE_IP
ROUTER_ID
DutAsNum
Autonomous system number configured for the DUT.

Type: u16
Default: 1001
Range: 0 - 65535
DutAsNum4Byte
4-byte autonomous system number configured for the DUT. To use this, Enable4ByteDutAsNum must be set to TRUE.
Type: string
Default: 1:1001
DutIpv4Addr
Specify the IPv4 address of the BGP peer for the session.
Type: ip
Default: null
DutIpv6Addr
Type: ipv6
Default: null
Enable4ByteAsNum
Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
Enable 4-byte autonomous system number for the emulated router. Use AsNum4Byte to set this.
FALSE Disable 4-byte autonomous system number for the emulated router.
Enable4ByteDutAsNum
Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
Enable handling of 4-byte autonomous system number for the DUT. Use DutAsNum4Byte to set this.
FALSE Disable handling of 4-byte autonomous system number for the DUT.
224
BgpRouterConfig
Writable Attribute
Description
EnableBfd
Enable or disable BFD (Bidirectional Forwarding Detection) for this router. You must also create a BfdRouterConfig object
under the parent Router object.
Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
Enable BFD.
FALSE Disable BFD.

EnablePackRoutes
Whether to enable the use of the minimum number of UPDATE messages to send the configured route blocks.
Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
Use the minimum number of UPDATE messages when sending configured route blocks.
FALSE Send one route block per UPDATE message.

EnableRefreshRoutes
Whether to enable Refresh Routes.

Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
Enable Refresh Routes. Spirent TestCenter will send out and respond to BGP Route Refresh messages.
FALSE Disable Refresh Routes.

GracefulRestart
Enable or disable graceful restart on the emulated BGP router. If enabled, it causes an emulated router's peer to retain the
router's advertised routes in the peer's route database when the session is closed. If disabled, it causes an emulated router's
peer to remove the router's advertised routes from its route database when the session is closed.
Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
Enable graceful restart.
FALSE Disable graceful restart.

HoldTimeInterval
BGP Hold Time value to use when negotiating with peers. If the router does not receive KEEPALIVE or UPDATE or
NOTIFICATION messages within the Hold Time field of the OPEN message, then the BGP connection to the peer will be
closed.
Type: u16
Default: 90
Range: 3 - 65535
Initiate
Whether the emulated BGP router will initiate a session (including retry attempts), or listen for the peer to initiate a session.
Type: bool
Default: TRUE
Possible Values:
Value Description
TRUE
Emulated router initiates the session.
FALSE Emulated router listens for the peer to initiate the session.
IpVersion

Type: enum
Default: IPV4
Possible Values:
Value Description
IPV4
IP version 4.
IPV6
IP version 6.
225
BgpRouterConfig
Writable Attribute
Description
KeepAliveInterval
Number of seconds between transmissions of KEEPALIVE messages by the emulated router to the DUT (in the absence of
sending any other BGP packets).
Type: u16
Default: 30
Range: 1 - 65535
MinLabel
Minimum label value used. Establishes the starting point for the range for labels advertised by the session.
Type: u32
Default: 16
Range: 0 - 1048575
PeerAs
Use DutAsNum instead.
Specify the autonomous system number of the BGP peer router session on the DUT.
Type: u16
Default: 1001
Range: 0 - 65535
RestartDelay
Amount of time the Restart Router command waits before the BGP session is restarted.
Type: u16
Default: 1
Range: 0 - 4095
RestartTime
BGP graceful restart time. The amount of time (in seconds) that the emulated router will wait for its peer to re-establish the
session. If the session is not re-established within this time frame, the stale routes will be removed from the route database.
Type: u16
Default: 90
Range: 0 - 4095
SubAfi
Instead use the BgpCapabilityConfig object SubAfi attribute.
Type: u8
Default: 0
Range: 0 - 255
Tos
Provides an indication of the quality of service wanted.

Note: This attribute is not available in the Spirent TestCenter GUI application.
Type: u8
Default: 192
Range: 0 - 255
Ttl
Time to live. Specifies the time span of a packet.

Note: This attribute is not available in the Spirent TestCenter GUI application.
Type: u8
Default: 255
Range: 1 - 255
ViewRoutes
Whether to enable View Routes.

Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
Enable View Routes. The Spirent TestCenter chassis will start to collect routes/LSAs it receives from the peer. Then
later if a View Routes command is issued, the stored routes can be sent for display.
FALSE Disable View Routes.
226
BgpRouterResults
BgpRouterConfig Read-Only Attributes

Read-Only Attribute
Description
EiBgp
Whether the BGP speaker is internal or external.

Type: enum
Default: EBGP
Possible Values:
Value Description
IBGP Internal BGP speaker type.
EBGP External BGP speaker type.
LearnedLabelCount
Count of number of learned labels.

Type: u32
Default: 0
ResolvedLabelCount
Count of number of resolved labels.

Type: u32
Default: 0
RouterState
Reports the status of the emulated router on the current port.

Type: enum
Default: NONE
Possible Values:
Value
Description
NONE
No state.
IDLE
Prior to invoking Open_BgpSession or Start_Router, an emulated router is in the Idle state.
CONNECT
Connecting.
ACTIVE
Active.
OPEN_SENT
Open is sent.
OPEN_CONFIRM Open is confirmed.

ESTABLISHED
UnResolvedLabelCount
The session is confirmed by the peer. The router state is Established.
Count of number of unresolved labels.

Type: u32
Default: 0
BgpRouterResults
Description:
Specifies types of BGP real time and final result statistics.

Relations:
Side name
(Type)
Relative
Description
ResultParent
(ResultChild)
BgpRouterConfig
BgpRouterResults Writable Attributes

227
BgpRouterResults
BgpRouterResults Read-Only Attributes

Read-Only Attribute
Description
LastRxUpdateRouteCount
Number of routes in the last-received UPDATE message.

Type: u64
Default: 0
OutstandingRouteCount
Outstanding route count. Number of routes that should be in the DUT's current route table.
Type: u64
Default: 0
RxAdvertisedRouteCount
Received router count. Total cumulative feasible routes received by the emulated router.
Type: u64
Default: 0
RxAdvertisedUpdateCount
Received update packet count. Number of Update packets received from DUT.
Type: u64
Default: 0
RxKeepAliveCount
BGP KeepAlive count received. Total number of KeepAlive packets received from the DUT during the test.
Type: u64
Default: 0
RxNotificationCount
BGP Notification count received. Number of Notification packets received by the emulated router during the
test.
Type: u64
Default: 0
RxNotifyCode
BGP Notify code received. The last NOTIFICATION code the emulated router received from the DUT.
Type: u8
Default: 0
RxNotifySubCode
BGP Notify subcode received. Each NOTIFICATION code has a sub-code.

Type: u8
Default: 0
RxOpenCount
BGP Open message count received. Opens received from DUT. In stable BGP scenarios, this should match
the value in the previous field.
Type: u64
Default: 0
RxRouteRefreshCount
Number of advertised route refresh message received.

Type: u64
Default: 0
RxWithdrawnRouteCount
Withdrawn route count received. Total cumulative unfeasible routes received by the emulated router.
Type: u64
Default: 0
TxAdvertisedRouteCount
Advertised route count transmitted. Total cumulative feasible routes the emulated router has sent out in all
UPDATE packets.
Type: u64
Default: 0
TxAdvertisedUpdateCount
Advertised update route count transmitted. Total number of UPDATE packets with feasible routes sent to
DUT.
Type: u64
Default: 0
TxKeepAliveCount
BGP KeepAlive count transmitted. Total number of KEEPALIVE packets sent to DUT during test.
Type: u64
Default: 0
TxNotificationCount
BGP Notification count transmitted. Number of Notification packets sent from the emulated router.
Type: u64
Default: 0
228
BgpSharedSessionParams
Read-Only Attribute
Description
TxNotifyCode
BGP Notify code transmitted. Last Notification code the emulated router sent to DUT.
Type: u8
Default: 0
TxNotifySubCode
BGP Notify subcode transmitted. Each NOTIFICATION code has a sub-code.

Type: u8
Default: 0
TxOpenCount
BGP Open message count transmitted. Total number of OPEN packets sent to DUT. Initial one, plus number
of times the emulated router re-establishes sessions.
Type: u64
Default: 0
TxRouteRefreshCount
Number of advertised route refresh message transmitted.

Type: u64
Default: 0
TxWithdrawnRouteCount
Withdrawn route count transmitted. Total number of unfeasible routes the emulated router has sent out in
all UPDATE packets.
Type: u64
Default: 0
TxWithdrawnUpdateCount
Withdrawn update route count transmitted. Total number of UPDATE packets with unfeasible routes sent to
DUT (route flapping).
Type: u64
Default: 0
Description:
BGP shared session parameters used for wizard.

BgpSharedSessionParams Writable Attributes

Writable Attribute
Description
Active, Name
AsNum
Autonomous system number for the emulated BGP router.

Type: u16
Default: 1
Range: 0 - 65535
AsNum4Byte
4-byte autonomous system number for the emulated BGP router. To use this, Enable4ByteAsNum must be set to TRUE.
Since this is the tester AS, this number is arbitrary and you can enter any number that has been configured on the DUT
as a BGP neighbor.
Type: string
Default: 1:1
AsNum4ByteStep
Enable4ByteAsNum must be set to TRUE. The gap between 4-byte autonomous system numbers configured for
Type: string
Default: 0
AsNumStep
Autonomous system step for the emulated BGP router.

Type: u16
Default: 0
Range: 0 - 65535
229
Writable Attribute
Description
DutAs
Autonomous system number configured for the DUT.

Type: u16
Default: 1001
Range: 0 - 65535
DutAsNum4Byte
4-byte autonomous system number configured for the DUT. Enable4ByteDutAsNum must be set to TRUE.
Type: string
Default: 1:1001
DutAsNum4ByteStep
Enable4ByteDutAsNum must be set to TRUE. The gap between 4-byte autonomous system numbers configured for
the DUT.
Type: string
Default: 0
DutAsStep
Autonomous system number step of the BGP peer router session on the DUT.
Type: u16
Default: 0
Range: 0 - 65535
DutIpv4Addr
Type: ip
Default: 192.85.1.1
DutIpv4AddrStep

Type: ip
Default: 0.0.0.0
DutIpv6Addr
Type: ipv6
Default: ::2
DutIpv6AddrStep

Type: ipv6
Default: ::0
Enable4ByteAsNum
Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
Enable 4-byte autonomous system number for the emulated router. Use AsNum4Byte to set this.
FALSE Disable 4-byte autonomous system number for the emulated router. Use AsNum4Byte to set this.
Enable4ByteDutAsNum
Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
Enable handling of 4-byte autonomous system number for the DUT. Use DutAsNum4Byte to set this.
FALSE Disable handling of 4-byte autonomous system number for the DUT. Use DutAsNum4Byte to set this.
EnableBfd
Enable or disable BFD (Bidirectional Forwarding Detection) for this router. You must also create a BfdRouterConfig
object under the parent Router object.
Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
Enable BFD.
FALSE Disable BFD.
230
BgpStateSummary
Writable Attribute
Description
EnablePackRoutes
Whether to enable the use of the minimum number of UPDATE messages to send the configured route blocks.
Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
Use the minimum number of UPDATE messages when sending configured route blocks.
FALSE Send one route block per UPDATE message.

GracefulRestart
Enable or disable graceful restart on the emulated BGP router. If enabled, it causes an emulated router's peer to retain
the router's advertised routes in the peer's route database when the session is closed. If disabled, it causes an emulated
router's peer to remove the router's advertised routes from its route database when the session is closed.
Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE

IpVersion

Type: enum
Default: IPV4
Possible Values:
Value Description
IPV4
IP version v4.
IPV6
IP version v6.

Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
FALSE Not use gateway address as DUT IP address.
BgpSharedSessionParams Read-Only Attributes

BgpStateSummary
Description:
BGP router states summarized at port and project level.

Relations:
Side name
(Type)
Relative
Description
ResultParent
(ResultChild)
Port, Project
BgpStateSummary Writable Attributes

231
BgpStopKeepaliveCommand
BgpStateSummary Read-Only Attributes

Read-Only Attribute
Description
ActiveCount
Number of routers in active state.

Type: u32
Default: 0
ConnectCount
Number of routers in connect state.

Type: u32
Default: 0
EstablishedCount
Number of routers in established state.

Type: u32
Default: 0
IdleCount
Number of routers in idle state.

Type: u32
Default: 0
NotStartedCount
Number of routers not started.

Type: u32
Default: 0
OpenConfirmCount
Number of routers in openconfirm state.

Type: u32
Default: 0
OpenSentCount
Number of routers in opensent state.

Type: u32
Default: 0
RouterDownCount
Number of routers in states other than established state.

Type: u32
Default: 0
RouterUpCount
Number of routers in established state.

Type: u32
Default: 0
BgpStopKeepaliveCommand
Description:
Stop sending keepalives from the list of routers. If keepalives are already not being sent or the router has not been started, this command will be ignored.

BgpStopKeepaliveCommand Writable Attributes

Writable Attribute
Description
RouterList
Router handle list.

Type: handle
Default: 0
232
BgpViewRoutesCommand
BgpStopKeepaliveCommand Read-Only Attributes

Read-Only Attribute
Description

BgpViewRoutesCommand
Description:
View BGP routes.

BgpViewRoutesCommand Writable Attributes

Writable Attribute
Description
FileName
Name of the view route file.

Type: outputFilePath
Default: routes.txt
RouterList
Router handle list.

Type: handle
Default: 0
BgpViewRoutesCommand Read-Only Attributes

Read-Only Attribute
Description

BgpVplsAdConfig
Description:

Relations:
Side name
(Type)
Relative
233
Description
BgpVplsAdConfig
BgpVplsAdConfig Writable Attributes

Writable Attribute
Description
AggregatorAs

Type: string
AggregatorIp

Type: ip
Default: null
AsPath
The list of AS numbers, in string format, that will be used in the AS_PATH attribute (type code 2) in BGP UPDATE messages.
passed.
Type: string
Default: 1
AsPathIncrement

Type: string
Default: 1
AsPathPerBlockCount

Type: u32
Default: 1
AsPathSegmentType
The path segment type for the AS path specified by the asPath attribute.
Type: enum
Default: SEQUENCE
Possible Values:
Value
Description
SET
SEQUENCE
traversed.
Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
ClusterIdList
Type: ip
Default: 0.0.0.0
Community
one value.
Type: string
Default: 1:1
LocalPreference
The value for the LOCAL_PREF path attribute in UPDATE messages. This informs other BGP speakers in the same AS of
the local BGP speaker's degree of preference for a route. A higher number means more preference.
Type: u32
Default: 10
Range: 0 - 4294967295
234
BgpVplsAdConfig
Writable Attribute
Description
Type: u32
Default: 0
Range: 0 - 4294967295
Med
UPDATE messages. This value can be used by a BGP speaker's decision process to discriminate among multiple exit points
to a neighboring autonomous system. An exit or entry point with a lower MED should be preferred.
Type: u32
Default: null
Range: 0 - 4294967295
MedIncrement
Type: u32
Default: 0
Range: 0 - 4294967295
NextHop
Type: ip
Default: null
Origin
The setting of the mandatory ORIGIN path attribute in UPDATE messages. This defines the origin of the path information.
Type: enum
Default: IGP
Possible Values:
Value
Description
IGP
EGP
OriginatorId
The router ID of the originator of the route in the local AS. This is the optional ORIGINATOR_ID path attribute (type code
9).
Type: ip
Default: null
PeAddr
PE IPv4 address.
Type: ip
Default: null
RouteDistinguisher
Type: string
Default: 100:1

Type: string
Default: 0:1
RouteTarget
Route Target identifies a set of sites to which a PE router distributes routes. BGP extended communities are described in
an Internet Draft.
Type: string
Default: 100:1
RouteTargetStep

Type: string
Default: 0:1
VplsId
VPLS ID.
Type: string
Default: 1001:1
VplsIdStep
Increment value for VPLS ID for each successive VRF within a routeblock.
Type: string
Default: 0:1
235
BgpVplsFecInfo
Writable Attribute
Description
VrfCount
The number of unique VRFs to create within a routebock.

Type: u32
Default: 1
BgpVplsAdConfig Read-Only Attributes

Read-Only Attribute
Description
RouteCount

Type: u32
Default: 1
BgpVplsFecInfo
Description:

Relations:
Side name
(Type)
Relative
Description
EchoRequestConfig
(InnerMostFecInfo)
DstFecInfo
(NextFecInfo)

BgpVplsFecInfo Writable Attributes

Writable Attribute
Description
Active, Name
FarEndVeId
Type: u16
Default: 0
FarEndVeIdIncrement
Type: u16
Default: 1
NearEndVeId
Type: u16
Default: 0
NearEndVeIdIncrement
Type: u16
Default: 0
RouteDistinguisher
Type: string
Default: 100:1
RouteDistinguisherIncrement
Type: string
Default: 0:1
VplsBlockCount
Type: u32
Default: 1
Range: 1 - 4294967295
236
BgpVpnRouteConfig
BgpVplsFecInfo Read-Only Attributes

BgpVpnRouteConfig
Description:
Defines the characteristics of BGP VPN routes.

Automatically created from: BgpIpv4RouteConfig, BgpIpv6RouteConfig
BgpVpnRouteConfig Writable Attributes

Writable Attribute
Description
Active, Name
RouteDistinguisher
Route distinguisher (RD) in string format. A route distinguisher is an 8-byte value that is concatenated with an IPv4
prefix to create a unique VPN IPv4 prefix.
Type: string
Default: 100:1

Type: string
Default: 0:1
RouteOrigin
Specify the value of the extended community called Route Origin, in string format. The Route Origin extended
community is carried in the optional Extended Community path attribute (type code 16) in UPDATE messages. BGP
extended communities are described in an Internet Draft.
This value is ignored unless the EnableRouteOrigin is set to TRUE.
Type: string
RouteTarget
Specify the value of the extended community path attribute called Route Target, in string format. This is the Route
Target extended community, carried in the optional Extended Community path attribute (type code 16) in UPDATE
messages. The Route Target identifies a set of sites to which a PE router distributes routes. BGP extended communities
are described in an Internet Draft.
Type: string
Default: 100:1
RouteTargetStep

Type: string
Default: 0:1
VrfCount
Number of unique VRFs to create within a routebock.

Type: u32
Default: 1
BgpVpnRouteConfig Read-Only Attributes

BgpWithdrawRouteCommand
Description:
Withdraw the BGP routes from the list of routers.
237
BinaryResponseHeaderConfig

BgpWithdrawRouteCommand Writable Attributes

Writable Attribute
Description
CategoryFilter
Category filter on the routes to be withdrawn.

Type: enum
Default: ANY
Possible Values:
Value
Description
UNDEFINED
Route category is UNDEFINED.
PRIMARY
Route category is PRIMARY.
SECONDARY Route category is SECONDARY.

UNIQUE
Route category is UNIQUE.
ANY
Route category is ANY.
PercentFilter
Percent of the total routes to be withdrawn.

Type: double
Default: 100.0
Range: 0 - 100
PrefixFilter
Prefix filter on the routes to be withdrawn.

Type: u8
Default: 0
Range: 0 - 128
RouteList
Route handle list.

Type: handle
Default: 0
BgpWithdrawRouteCommand Read-Only Attributes

Read-Only Attribute
Description

BinaryResponseHeaderConfig
Description:
HTTP server response header configuration for binary types.

Parents: HttpServerProtocolProfile
Automatically created from: HttpServerProtocolProfile
BinaryResponseHeaderConfig Writable Attributes

Writable Attribute
Description
Active, Name
238
body
BinaryResponseHeaderConfig Read-Only Attributes

body
Description:
Parents: cred
Children: None
body Attributes
Attribute
Description
data
Type: OCTETSTRING
length
Type: INTEGER
Default: 0
Name
more information.
Type: string
padding
Type: ALIGNMENTPAD
Default: 0
BridgePortConfig
Description:
Protocol configuration object for STP/MSTP.

Children: MstiConfig, MstpBridgePortConfig, StpBridgePortConfig
Result children (automatically created): BridgePortResults
Relations:
Side name
(Type)
Relative
Description
ResultChild
(ResultChild)
BridgePortResults
UsesIf
(UsesIf)


239
BridgePortConfig
BridgePortConfig Writable Attributes

Writable Attribute
Description
Active, Name
BridgeMacAddr
MAC address of the bridge - second component of the bridge ID. The MAC address does not have to be unique if it is
configured for shared media (not point-to-point).
Type: mac
Default: 00:00:10:00:10:00
BridgePriority
Specifies the priority for the bridge. A low numerical value indicates a high bridge priority. The algorithm uses this value
during the root bridge election process. The bridge with the highest bridge priority value is elected as the root bridge on the
network.
Type: u16
Default: 32768
Range: 0 - 65535
EventLogLevel
Type: enum
Default: EVENT_LOG_LEVEL_DEBUG
Possible Values:
Value
Description
EVENT_LOG_LEVEL_CONVERGENCE_EVENTS
EVENT_LOG_LEVEL_DEBUG
ForwardDelay
Forward delay timer. Specifies the length of time that the bridge remains in the listening and learning states before entering
the forwarding state.
Type: u8
Default: 15
Range: 4 - 30
HelloTime
Time interval between the generation of configuration BPDUs by the root bridge.
STP/PVST+ bridge - specifies how often the bridge broadcasts hello messages to other bridges. In 802.1D, hello messages
are used as a keep-alive mechanism.
RSTP/RPVST+ bridge - specifies how often the bridge sends a BPDU with current information. In 802.1W, BPDUs are used
as a keep-alive mechanism.
Type: u8
Default: 2
Range: 1 - 10
HoldCount
Transmit hold count. The maximum number of BPDUs transmitted per second. Used to limit the transmission rate.
Type: u8
Default: 3
Range: 1 - 30
MaxAgeTime
Timeout value used to discard messages. Specifies the length of time that the protocol information received on a port is
stored by the bridge. This timeout value is used by all bridges in the bridged LAN. The max age value is set by the root.
This parameter is conveyed to ensure that each bridge in a bridged LAN has a consistent value against which to test the
age of stored configuration information.
Type: u8
Default: 20
Range: 6 - 40
MsgAgeTime
Age of the message in seconds. Used when STP bridge port is custom. Specifies the configuration age, which is the time
since the generation of the configuration BPDU by the root bridge.
Type: u8
Default: 1
Range: 1 - 39
PortNum
Port number - second component of the port ID. Indicates the port number on the emulated bridge. This number is included
in BPFDUs.
Type: u16
Default: 1
Range: 1 - 255
240
BridgePortResults
Writable Attribute
Description
PortPriority
Priority for the port on the bridge - first component of the port ID. Specifies the priority for the port. A low numerical value
indicates a high port priority. The algorithm uses this value to elect the root port. The port with the highest port priority value
is elected root port.
Type: u16
Default: 128
Range: 0 - 255
RootBridge
Specifies the initial root bridge on the bridge port.

Type: enum
Default: 0
Possible Values:
Value
Description
SELF
Current bridge is the root bridge. (Path cost is 0.)
CUSTOM Identifies a different bridge as the root bridge.

RootMacAddr
MAC address of the root bridge - second component of the root bridge ID. Disabled for all MSTP instances other than 0
(CIST).
Type: mac
Default: 00:00:10:00:10:00
RootPortCost
Specifies the cost to reach the root bridge. Disabled for all MSTP instances other than 0 (CIST). This value is used by the
DUT to determine which port is the primary path to the root bridge.
Type: u32
Default: 0
Range: 0 - 200000000
RootPriority
Bridge priority for the root bridge - priority component of the root bridge ID. Used to determine which bridge is elected as
root. Disabled for all MSTP instances other than 0 (CIST).
Type: u16
Default: 32768
Range: 0 - 65535

Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
Partial block state is used.
FALSE Partial block state is not used.
BridgePortConfig Read-Only Attributes

Read-Only Attribute
Description
ElectedRoot
Elected root bridge.

Type: string
Default: NA
BridgePortResults
Description:
STP/MSTP results.

Parents: BridgePortConfig, MstiConfig
Relations:
241
BridgePortResults
Side name
(Type)
Relative
Description
ResultParent
(ResultChild)
BridgePortConfig, MstiConfig
BridgePortResults Writable Attributes

BridgePortResults Read-Only Attributes

Read-Only Attribute
Description
BridgeId

Type: string
Default: 80-00-00-00-10-00-10-00
DesignatedId

Type: string
Default: NA
InstanceNum

Type: u16
Default: 0
PortId

Type: string
Default: 0x8001
RegionalRootId

Type: string
Default: NA
RootId
Type: string
Default: NA
RxAgree
Type: u32
Default: 0
RxBpduFlag

Type: string
Default: 0x00
RxBpdus

Type: u32
Default: 0
RxPortRole
Receive port role. Reported states are disabled, alternate port, backup port, root port, and designated port.
Type: string
Default: NA
RxPortState
Receive port state. Reported states are listening, discarding, learning, and forwarding.
Type: string
Default: NA
RxProposals
state.
Type: u64
Default: 0
RxTcAck
Type: u32
Default: 0
242
bTag
Read-Only Attribute
Description
RxTcBitSet

Type: u32
Default: 0
RxTcn

Type: u64
Default: 0
TxAgree
Type: u32
Default: 0
TxBpduFlag

Type: string
Default: 0x00
TxBpdus

Type: u32
Default: 0
TxPortRole
Transmit port role. Reported states are disabled, alternate port, backup port, root port, and designated port.
Type: string
Default: NA
TxPortState

Type: string
Default: NA
TxProposals
Type: u64
Default: 0
TxTcAck
Type: u32
Default: 0
TxTcBitSet

Type: u32
Default: 0
TxTcn

Type: u64
Default: 0
VlanId

Type: string
Default: NA
bTag
Description:
Parents: bVlanTag
Children: None
bTag Attributes
Attribute
Description
DEI
Type: BITSTRING
Default: 0
243
BurstPatternDescriptor
Attribute
Description
Name
more information.
Type: string
PCP
Type: BITSTRING
Default: 001
Type
Type: OCTETSTRING
Default: 88a8
VID
Type: INTEGER
Default: 100
BurstPatternDescriptor
Description:
Used to describe a burst load type.

Parents: ClientLoadPhase
BurstPatternDescriptor Writable Attributes

Writable Attribute
Description
Active, Name
BurstTime
Duration of the burst. The time unit is controlled by the LoadPhaseDurationUnits attribute on the ClientLoadPhase
object.
Type: u32
Default: 20
Height
Amount of instantaneous burst load to apply. The LoadType attribute in the ClientLoadProfile object controls
the type of load that is generated.
Type: s32
Default: 30
PauseTime
Pause time between bursts. The time unit is controlled by the LoadPhaseDurationUnits attribute on the
ClientLoadPhase object.
Type: u32
Default: 40
Repetitions
Number of stair steps.

Type: u32
Default: 1
BurstPatternDescriptor Read-Only Attributes

bVlanTag
Description:
Parents: MAC-in-MAC, EncapMAC-in-MAC
244
bwg_percentage
Children: bTag
bVlanTag Attributes
Attribute
Description
Name
information.
Type: string
bwg_percentage
Description:
Parents: pgTlv
Children: None
bwg_percentage Attributes
Attribute
Description
bwg_percentage0
Type: INTEGER
Default: 0
bwg_percentage1
Type: INTEGER
Default: 0
bwg_percentage2
Type: INTEGER
Default: 0
bwg_percentage3
Type: INTEGER
Default: 0
bwg_percentage4
Type: INTEGER
Default: 0
bwg_percentage5
Type: INTEGER
Default: 0
bwg_percentage6
Type: INTEGER
Default: 0
bwg_percentage7
Type: INTEGER
Default: 0
Name
Type: string
CallBody (oncrpcv2:CallBody)
Description:
Children: cred, verf
245
CapabilityFlags
CallBody Attributes
Attribute
Description
Name
more information.
Type: string
proc
Type: INTEGER
Default: 0
prog
Type: INTEGER
Default: 0
rpcvers
Type: INTEGER
Default: 2
vers
Type: INTEGER
Default: 0
CapabilityFlags
Description:
Parents: CtrlChanCapTLV
Children: None
CapabilityFlags Attributes
Attribute
Description
DeleteAcceptance
Type: Boolean
Default: 0
Possible Values:
Value Description
Fragmented
False
True
Type: Boolean
Default: 0
Possible Values:
Value Description
0
False
True
Name
Type: string
OffsetRewrite
Type: Boolean
Default: 0
Possible Values:
Value Description
Reserved
False
True
Type: BITSTRING
Default: 00
246
Capture
Attribute
Description
Role
Type: BoolRole
Default: 0
Possible Values:
Value Description
StatefulRestart
VLAN
Adapter
Switch
Type: Boolean
Default: 0
Possible Values:
Value Description
0
False
True
Type: Boolean
Default: 0
Possible Values:
Value Description
0
False
True
Capture
Description:
Provides for capturing frame data during a test. Eight 4-byte pattern matching filters and 19 trigger events can be created and combined to capture 8 to 16
MB of control and data plane traffic per port.

Children: CaptureBytePattern, CaptureRangePattern, CaptureStatisticsFilter
Automatically-created children: CaptureFilter, CaptureFilterStartEvent, CaptureFilterStopEvent, CaptureRawPacketTagsInfo
Capture Writable Attributes

Writable Attribute
Description
Active, Name
AbortSaveTask
Allows the user to abort saving a file while saving. Internal Use Only.
Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
Abort the file saving task.
FALSE Do not abort the file saving task.

BufferMode
What to do when the capture buffer is full.

Type: enum
Default: WRAP
Possible Values:
Value
Description
WRAP
When the buffer is full, roll over and continue.
STOP_ON_FULL When the buffer is full, stop.
247
Capture
Writable Attribute
Description
CaptureFilterMode
Filter mode to use.

Type: enum
Default: FRAMECONTENT
Possible Values:
Value
Description
FRAMECONTENT
Frame content filter mode.
BYTEOFFSETANDRANGE Byte offset filter mode.

CurrentFilterBytesUsed
Internally used by GUI. No use-case from automation.

Type: u32
Default: 0
Range: 0 - 32
CurrentFiltersUsed

Type: u32
Default: 0
Range: 0 - 8
CurrentTask

Type: enum
Default: IDLE
Possible Values:
Value
Description
IDLE
No tasks are being performed. Internal use only.
SAVING Currently saving buffer to file. Internal use only.

ElapsedTime
Start capture elapsed time.

Type: string
Default: 0:00:00
FlagMode
Flag mode for capture.

Type: enum
Default: REGULAR_FLAG_MODE
Possible Values:
Value
Description
REGULAR_FLAG_MODE Regular flag mode.
ADV_SEQ_FLAG_MODE Advance sequence flag mode.
Mode
Indicates what to capture.

Type: enum
Default: REGULAR_MODE
Possible Values:
Value
Description
REGULAR_MODE Capture all frames.
SIG_MODE
RealTimeBufferStatus
Capture the Spirent signature tag portion of the frames.

Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
Buffer is full and ready for reading. Internal use only.
FALSE Buffer has been populated. Internal use only.

RealTimeFramesBuffer

Type: u8
Default: 0
248
Capture
Writable Attribute
Description
RealTimeMode
Use this option to enable or disable real-time capture.

Note: Real-time capture supports a maximum of 4 ports.
Type: enum
Default: REALTIME_DISABLE
Possible Values:
Value
Description
REALTIME_DISABLE Disables real-time capture.
REALTIME_ENABLE Enables real-time capture.
SliceCaptureSize
Indicates the length of data in bytes to be saved when SliceMode is enabled.

Type: u32
Default: 128
Range: 32 - 4000
SliceMode
Use this option to save only the specified length of the frames.
Type: enum
Default: DISABLE
Possible Values:
Value
Description
DISABLE Disables slice mode.
ENABLE Enables slice mode.
SliceOffset
Indicates the offset in bytes from the specified slice offset reference.
Type: u32
Default: 0
SliceOffsetRef
Indicates the slice offset reference. Used only when SliceMode is enabled.
Type: enum
Default: PREAMBLE
Possible Values:
Value
Description
PREAMBLE
Offset reference is Preamble.
FRAME
Offset reference is start of frame.
IP
Offset reference is start of IP header.
IP_PAYLOAD Offset reference is start of IP payload.

SrcMode
Indicates the source for capture data.

Type: enum
Default: TX_RX_MODE
Possible Values:
Value
Description
TX_MODE
Only control plane transmitted packets are captured.
RX_MODE
Only received frames (control and data plane) traffic are captured.
TX_RX_MODE Transmitted and received frames are captured.

Start
Indicates the start event for capture (internal use only).

Type: u32
Default: 0x00004000
Stop
Indicates the stop event for capture (internal use only).

Type: u32
Default: 0x00000000
TabIndex

Type: u32
Default: 0
249
CaptureAnalyzerFilter
Capture Read-Only Attributes

Read-Only Attribute
Description
ElapsedTime
CaptureState
Indicates the current state of capture on card.

Type: enum
Default: READY
Possible Values:
Value
Description
READY
Capture daemon is ready, but has not been started.
RUNNING
Capture daemon on card is currently capturing frames.
PENDING
Capture daemon state between start and running, and running to stop.
UNAVAILABLE Capture daemon is not available.

PktCount
Count of captured packets. This count is updated when the capture stops.
Type: u32
Default: 0
PktSavedCount
Indicates the current number of packets saved when data is saved.

Type: u32
Default: 0
CaptureAnalyzerFilter
Description:
Represents the filter usage options.

Parents: CaptureFilter
CaptureAnalyzerFilter Writable Attributes

Writable Attribute
Description
Active, Name
FilterDescription
Description of the Capture Analyzer filter.

Type: string
FrameConfig
XML describing selected options of the frame configuration.

Type: string
IndexNum
Index number of the Capture Analyzer filter. Cannot be duplicated with another object.
Type: u32
Default: 0
IsNotSelected
Indicates whether or not to apply negation (logical NOT).

Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
Apply negation (logical NOT).
FALSE Do not apply negation (logical NOT).
250
CaptureBytePattern
Writable Attribute
Description
IsSelected
Whether to use the Capture Analyzer filter.

Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
Use the Capture Analyzer filter.
FALSE Do not use the Capture Analyzer filter.

RelationToNextFilter
ValueToBeMatched
Relation to the next filter (specified by IndexNum). If next filter is not present, then this is ignored.
Type: enum
Default: AND
Possible Values:
Value Description
AND
Logical AND.
OR
Logical OR.

Type: string
CaptureAnalyzerFilter Read-Only Attributes

Read-Only Attribute
Description
PduInfo
PDU content information.

Type: string
CaptureBytePattern
Description:
Byte offset pattern.

Parents: Capture
CaptureBytePattern Writable Attributes

Writable Attribute
Description
Active, Name
Mask
Byte offset mask.

Type: u8
Default: 255
Offset
Offset value.
Type: u16
Default: 0
Value
Pattern value.
Type: u8
Default: 0
251
CaptureDataSaveCommand
CaptureBytePattern Read-Only Attributes

CaptureDataSaveCommand
Description:
Save the captured data to a file.

CaptureDataSaveCommand Writable Attributes

Writable Attribute
Description
AppendSuffixToFileName
Whether to append a suffix to the saved capture file name.

Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
Append suffix to saved capture file name.
FALSE Do not append suffix to saved capture file name.

CaptureProxyId

Type: handle
Default: 0
EndFrameIndex
End captured frame index to be viewed.

Type: u32
Default: 0
FileName
Name of the capture file.

FileNameFormat
Format to use for the capture file.

Type: enum
Default: PCAP
Possible Values:
Value Description
SCAP Proprietary Spirent format.
PCAP PCAP format, used by Wireshark and other packet sniffer applications.
FileNamePath
Path in which to save the capture file.

Type: string
252
CaptureFilter
Writable Attribute
Description
IsScap
NOTE: This is deprecated. It will be removed in subsequent releases, so it is recommended that you do
not use it.
Instead of this attribute, use the FileNameFormat attribute.
Save the file in Spirent Capture file format.
Type: bool
Default: TRUE
Possible Values:
Value Description
TRUE
Save file in Spirent Capture file format.
FALSE Save file in PCAP format.

StartFrameIndex
Start captured frame index to be viewed.

Type: u32
Default: 0
CaptureDataSaveCommand Read-Only Attributes

Read-Only Attribute
Description

CaptureFilter
Description:
Represents the preset capture filter options. Logical OR is applied on the properties.

Children: CaptureAnalyzerFilter, CapturePatternExpression
Automatically created from: Capture
CaptureFilter Writable Attributes

Writable Attribute
Description
Active, Name
FcsError
FCS error option.

Type: enum
Default: IGNORE
Possible Values:
Value
Description
IGNORE
Ignore the FCS error option.
INCLUDE Capture frames that contain FCS errors.

EXCLUDE Do not capture frames that contain FCS errors.
FilterExpression
Read-only option.
Type: string
Default: { None }
FilterName
Event filter name.

Type: string
FrameLength
Length of frame when FrameLenMatch option is selected.

Type: u32
Default: 0
253
CaptureFilter
Writable Attribute
Description
FrameLenMatch
Match specified frame length.

Type: enum
Default: IGNORE
Possible Values:
Value
Description
IGNORE
Ignore the frame length match option.
INCLUDE Capture frames that match the specified frame length.

EXCLUDE Do not capture frames that match the specified frame length.
GuiExpression
Read-only option.
Type: string
Igmp
IGMP option.
Type: enum
Default: IGNORE
Possible Values:
Value
Description
IGNORE
Ignore the IGMP option.
INCLUDE Capture IGMP frames.

EXCLUDE Do not capture IGMP frames.
Ipv4
IPv4 option.
Type: enum
Default: IGNORE
Possible Values:
Value
Description
IGNORE
Ignore the IPv4 option.
INCLUDE Capture IPv4 frames.

EXCLUDE Do not capture IPv4 frames.
Ipv4CheckSumError
IPv4 checksum error option.

Type: enum
Default: IGNORE
Possible Values:
Value
Description
IGNORE
Ignore the IPv4 checksum error option.
INCLUDE Capture frames that contain IPv4 checksum errors.

EXCLUDE Do not capture frames that contain IPv4 checksum errors.
Ipv6
IPv6 option.
Type: enum
Default: IGNORE
Possible Values:
Value
Description
IGNORE
INCLUDE Capture IPv6 frames.

EXCLUDE Do not capture IPv6 frames.
Jumbo
Jumbo frame option.

Type: enum
Default: IGNORE
Possible Values:
Value
Description
IGNORE
Ignore the jumbo frame option.
INCLUDE Capture frames that are jumbo.

EXCLUDE Do not capture frames that are jumbo.
254
CaptureFilter
Writable Attribute
Description
L1Error
L1 error option.
Type: enum
Default: IGNORE
Possible Values:
Value
Description
IGNORE
Ignore the L1 error option.
INCLUDE Capture frames that contain layer 1 errors.

EXCLUDE Do not capture frames that contain layer 1 errors.
Oversized
Oversized frame option.

Type: enum
Default: IGNORE
Possible Values:
Value
Description
IGNORE
Ignore the oversized frame option.
INCLUDE Capture frames that are oversized.

EXCLUDE Do not capture frames that are oversized.
PrbsError
PRBS error option.

Type: enum
Default: IGNORE
Possible Values:
Value
Description
IGNORE
Ignore the PRBS error option.
INCLUDE Capture frames that contain PRBS errors.

EXCLUDE Do not capture frames that contain PRBS errors.
QualifyEvents
Use this option to capture all frames that match the specified event.
Type: bool
Default: TRUE
Possible Values:
Value Description
TRUE
Enables capturing frames that match specified event.
FALSE Disables capturing frames that match specified event.

SigPresent
Spirent signature option.

Type: enum
Default: IGNORE
Possible Values:
Value
Description
IGNORE
Ignore Spirent signature option.
INCLUDE Capture frames with Spirent signature.

EXCLUDE Do not capture frames with Spirent signature.
SigSeqNumError
Signature sequence error option.

Type: enum
Default: IGNORE
Possible Values:
Value
Description
IGNORE
Ignore the signature sequence error option.
INCLUDE Capture frames that contain signature sequence errors.

EXCLUDE Do not capture frames that contain signature sequence errors.
StreamId
ID of stream when StreamIdMatch option is selected.

Type: u32
Default: 0
255
CaptureFilterResetCommand
Writable Attribute
Description
StreamIdMatch
Match specified stream ID.

Type: enum
Default: IGNORE
Possible Values:
Value
Description
IGNORE
Ignore the Stream ID Match option.
INCLUDE Capture frames that match the specified stream ID.

EXCLUDE Do not capture frames that match the specified stream ID.
Tcp
TCP option.
Type: enum
Default: IGNORE
Possible Values:
Value
Description
IGNORE
Ignore the TCP option.
INCLUDE Capture TCP frames.

EXCLUDE Do not capture TCP frames.
TcpUdpIgmpCheckSumError
TCP/UDP checksum error option.

Type: enum
Default: IGNORE
Possible Values:
Value
Description
IGNORE
Ignore the TCP/UDP checksum error option.
INCLUDE Capture frames that contain TCP/UDP checksum errors.

EXCLUDE Do not capture frames that contain TCP/UDP checksum errors.
Udp
UDP option.
Type: enum
Default: IGNORE
Possible Values:
Value
Description
IGNORE
Ignore the UDP option.
INCLUDE Capture UDP frames.

EXCLUDE Do not capture UDP frames.
Undersized
Undersized frame option.

Type: enum
Default: IGNORE
Possible Values:
Value
Description
IGNORE
Ignore the undersized frame option.
INCLUDE Capture frames that are undersized.

EXCLUDE Do not capture frames that are undersized.
CaptureFilter Read-Only Attributes

CaptureFilterResetCommand
Description:
Reset the filter configuration to default.
256
CaptureFilterResetStartEventCommand

CaptureFilterResetCommand Writable Attributes

Writable Attribute
Description
CaptureProxyId

Type: handle
Default: 0
CaptureFilterResetCommand Read-Only Attributes

Read-Only Attribute
Description

CaptureFilterResetStartEventCommand
Description:
Reset the Capture filter start event to default.

CaptureFilterResetStartEventCommand Writable Attributes

Writable Attribute
Description
CaptureProxyId

Type: handle
Default: 0
CaptureFilterResetStartEventCommand Read-Only Attributes

Read-Only Attribute
Description

CaptureFilterResetStopEventCommand
Description:
Reset the filter stop event to default.

257
CaptureFilterStartEvent
CaptureFilterResetStopEventCommand Writable Attributes

Writable Attribute
Description
CaptureProxyId

Type: handle
Default: 0
CaptureFilterResetStopEventCommand Read-Only Attributes

Read-Only Attribute
Description

Description:
Events that specify when to start capturing frames.

CaptureFilterStartEvent Writable Attributes

Writable Attribute
Description
Active, Name
FcsError
FCS error option.

Type: enum
Default: IGNORE
Possible Values:
Value
Description
IGNORE
INCLUDE Start capturing frames upon matching an FCS error.

EXCLUDE Do not start capturing frames upon matching an FCS error.
FilterExpression
Read-only option.
Type: string
Default: { None }
FilterName
Capture filter name.

Type: string
FrameLength
Length of frame when FrameLenMatch is selected.

Type: u32
Default: 0
258
Writable Attribute
Description
FrameLenMatch

Type: enum
Default: IGNORE
Possible Values:
Value
Description
IGNORE
INCLUDE Start capturing frames upon matching the specified frame length.
EXCLUDE Do not start capturing frames upon matching the specified frame length.
GuiExpression
Read-only option.
Type: string
Igmp
IGMP option.
Type: enum
Default: IGNORE
Possible Values:
Value
Description
IGNORE
INCLUDE Start capturing frames upon matching an IGMP frame.

EXCLUDE Do not start capturing frames upon matching an IGMP frame.
Ipv4
IPv4 option.
Type: enum
Default: IGNORE
Possible Values:
Value
Description
IGNORE
INCLUDE Start capturing frames upon matching an IPv4 frame.

EXCLUDE Do not start capturing frames upon matching an IPv4 frame.
Ipv4CheckSumError

Type: enum
Default: IGNORE
Possible Values:
Value
Description
IGNORE
INCLUDE Start capturing frames upon matching an IPv4 checksum error.

EXCLUDE Do not start capturing frames upon matching an IPv4 checksum error.
Ipv6
IPv6 option.
Type: enum
Default: IGNORE
Possible Values:
Value
Description
IGNORE
INCLUDE Start capturing frames upon matching an IPv6 frame.

EXCLUDE Do not start capturing frames upon matching an IPv6 frame.
Jumbo
Jumbo frame option.

Type: enum
Default: IGNORE
Possible Values:
Value
Description
IGNORE
INCLUDE Start capturing frames upon matching a jumbo frame.

EXCLUDE Do not start capturing frames upon matching a jumbo frame.
259
Writable Attribute
Description
L1Error
L1 error option.
Type: enum
Default: IGNORE
Possible Values:
Value
Description
IGNORE
INCLUDE Start capturing frames upon matching a layer 1 error.

EXCLUDE Do not start capturing frames upon matching a layer 1 error.
Oversized

Type: enum
Default: IGNORE
Possible Values:
Value
Description
IGNORE
INCLUDE Start capturing frames upon matching an oversized frame.

EXCLUDE Do not start capturing frames upon matching an oversized frame.
PrbsError
PRBS error option.

Type: enum
Default: IGNORE
Possible Values:
Value
Description
IGNORE
INCLUDE Start capturing frames upon matching a PRBS error.

EXCLUDE Do not start capturing frames upon matching a PRBS error.
SigPresent

Type: enum
Default: IGNORE
Possible Values:
Value
Description
IGNORE
Ignore the Spirent signature option.
INCLUDE Start capturing frames upon matching Spirent signature.

EXCLUDE Do not start capturing frames upon matching Spirent signature.
SigSeqNumError
Signature Sequence Error option.

Type: enum
Default: IGNORE
Possible Values:
Value
Description
IGNORE
Ignore the Signature Sequence Error option.

StartEvents
Use this option to start capturing frames upon matching the specified pattern.
Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
Enables start capturing frames upon matching specified pattern.
FALSE Disables start capturing frames upon matching specified pattern.

StreamId
ID of stream when StreamIdMatch is selected.

Type: u32
Default: 0
260
CaptureFilterStopEvent
Writable Attribute
Description
StreamIdMatch

Type: enum
Default: IGNORE
Possible Values:
Value
Description
IGNORE
INCLUDE Start capturing frames upon matching the specified stream ID.
EXCLUDE Do not start capturing frames upon matching the specified stream ID.
Tcp
TCP option.
Type: enum
Default: IGNORE
Possible Values:
Value
Description
IGNORE
INCLUDE Start capturing frames upon matching a TCP frame.

EXCLUDE Do not start capturing frames upon matching a TCP frame.

Type: enum
Default: IGNORE
Possible Values:
Value
Description
IGNORE
INCLUDE Start capturing frames upon matching a TCP/UDP checksum error.

EXCLUDE Do not start capturing frames upon matching a TCP/UDP checksum error.
Udp
UDP option.
Type: enum
Default: IGNORE
Possible Values:
Value
Description
IGNORE
INCLUDE Start capturing frames upon matching a UDP frame.

EXCLUDE Do not start capturing frames upon matching a UDP frame.
Undersized

Type: enum
Default: IGNORE
Possible Values:
Value
Description
IGNORE
INCLUDE Start capturing frames upon matching an undersized frame.

EXCLUDE Do not start capturing frames upon matching an undersized frame.
CaptureFilterStartEvent Read-Only Attributes

Description:
Events that specify when to stop capturing frames.
261
CaptureFilterStopEvent Writable Attributes

Writable Attribute
Description
Active, Name
FcsError
FCS error option.

Type: enum
Default: IGNORE
Possible Values:
Value
Description
IGNORE
INCLUDE Stop capturing frames upon matching an FCS error.

EXCLUDE Do not stop capturing frames upon matching an FCS error.
FilterExpression
Read-only option.
Type: string
Default: { None }
FilterName
Stop event filter name.

Type: string
FrameLength
Length of frame when FrameLenMatch is selected.

Type: u32
Default: 0
FrameLenMatch

Type: enum
Default: IGNORE
Possible Values:
Value
Description
IGNORE
INCLUDE Stop capturing frames upon matching the specified frame length.
EXCLUDE Do not stop capturing frames upon matching the specified frame length.
GuiExpression
Read-only option.
Type: string
Igmp
IGMP option.
Type: enum
Default: IGNORE
Possible Values:
Value
Description
IGNORE
INCLUDE Stop capturing frames upon matching an IGMP frame.

EXCLUDE Do not stop capturing frames upon matching an IGMP frame.
Ipv4
IPv4 option.
Type: enum
Default: IGNORE
Possible Values:
Value
Description
IGNORE
INCLUDE Stop capturing frames upon matching an IPv4 frame.

EXCLUDE Do not stop capturing frames upon matching an IPv4 frame.
262
Writable Attribute
Description
Ipv4CheckSumError

Type: enum
Default: IGNORE
Possible Values:
Value
Description
IGNORE
INCLUDE Stop capturing frames upon matching an IPv4 checksum error.

EXCLUDE Do not stop capturing frames upon matching an IPv4 checksum error.
Ipv6
IPv6 option.
Type: enum
Default: IGNORE
Possible Values:
Value
Description
IGNORE
INCLUDE Stop capturing frames upon matching an IPv6 frame.

EXCLUDE Do not stop capturing frames upon matching an IPv6 frame.
Jumbo
Jumbo frame option.

Type: enum
Default: IGNORE
Possible Values:
Value
Description
IGNORE
INCLUDE Stop capturing frames upon matching a jumbo frame.

EXCLUDE Do not stop capturing frames upon matching a jumbo frame.
L1Error
L1 error option.
Type: enum
Default: IGNORE
Possible Values:
Value
Description
IGNORE
INCLUDE Stop capturing frames upon matching a layer 1 error.

EXCLUDE Do not stop capturing frames upon matching a layer 1 error.
Oversized

Type: enum
Default: IGNORE
Possible Values:
Value
Description
IGNORE
INCLUDE Stop capturing frames upon matching an oversized frame.

EXCLUDE Do not stop capturing frames upon matching an oversized frame.
PrbsError
PRBS error option.

Type: enum
Default: IGNORE
Possible Values:
Value
Description
IGNORE
INCLUDE Stop capturing frames upon matching a PRBS error.

EXCLUDE Do not stop capturing frames upon matching a PRBS error.
263
Writable Attribute
Description
SigPresent

Type: enum
Default: IGNORE
Possible Values:
Value
Description
IGNORE
Ignore the Spirent signature option.
INCLUDE Stop capturing frames upon matching a Spirent signature.

EXCLUDE Do not stop capturing frames upon matching a Spirent signature.
SigSeqNumError
Signature sequence error option.

Type: enum
Default: IGNORE
Possible Values:
Value
Description
IGNORE
Ignore the Signature sequence error option.

StopEvents
Use this option to stop capturing frames upon matching the specified data pattern.
Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
Enables pattern matching stop events.
FALSE Disables pattern matching stop events.

StreamId
ID of stream when StreamIdMatch is selected.

Type: u32
Default: 0
StreamIdMatch

Type: enum
Default: IGNORE
Possible Values:
Value
Description
IGNORE
INCLUDE Stop capturing frames upon matching the specified stream ID.
EXCLUDE Do not stop capturing frames upon matching the specified stream ID.
Tcp
TCP option.
Type: enum
Default: IGNORE
Possible Values:
Value
Description
IGNORE
INCLUDE Stop capturing frames upon matching a TCP frame.

EXCLUDE Do not stop capturing frames upon matching a TCP frame.

Type: enum
Default: IGNORE
Possible Values:
Value
Description
IGNORE
INCLUDE Stop capturing frames upon matching a TCP/UDP checksum error.

EXCLUDE Do not stop capturing frames upon matching a TCP/UDP checksum error.
264
CaptureGetFrameCommand
Writable Attribute
Description
Udp
UDP option.
Type: enum
Default: IGNORE
Possible Values:
Value
Description
IGNORE
INCLUDE Stop capturing frames upon matching a UDP frame.

EXCLUDE Do not stop capturing frames upon matching a UDP frame.
Undersized

Type: enum
Default: IGNORE
Possible Values:
Value
Description
IGNORE
INCLUDE Stop capturing frames upon matching an undersized frame.

EXCLUDE Do not stop capturing frames upon matching an undersized frame.
CaptureFilterStopEvent Read-Only Attributes

CaptureGetFrameCommand
Description:
Get the capture frame and populate packet frame object.

CaptureGetFrameCommand Writable Attributes

Writable Attribute
Description
CaptureProxyId

Type: handle
Default: 0
FrameIndex
Frame index to be retrieved.

Type: u32
Default: 0
CaptureGetFrameCommand Read-Only Attributes

Read-Only Attribute
Description

DataLength
Retrieved frame's length of data in bytes.

Type: u32
Default: 0
265
CaptureGetRawDataCommand
Read-Only Attribute
Description
PacketData
Retrieved frame's data in hex format.

Type: string
PreambleLength
Retrieved frame's length of preamble in bytes.

Type: u32
Default: 0
Timestamp
Retrieved frame timestamp.

Type: string
CaptureGetRawDataCommand
Description:
Used to view the data capture in debug mode.

CaptureGetRawDataCommand Writable Attributes

Writable Attribute
Description
CaptureProxyId

Type: handle
Default: 0
CaptureGetRawDataCommand Read-Only Attributes

Read-Only Attribute
Description

CapturePatternExpression
Description:
Set up capture pattern logical expression.

Parents: CaptureFilter, CaptureStatisticsFilter
CapturePatternExpression Writable Attributes

Writable Attribute
Description
Active, Name
266
CapturePktPduParserCommand
Writable Attribute
Description
ByteExpression
Byte offset expression.

Type: string
FrameLengthExpression
Frame length expression.

Type: string
CapturePatternExpression Read-Only Attributes

CapturePktPduParserCommand
Description:
Parses the PDU string and returns offset and length. Internal use only.

CapturePktPduParserCommand Writable Attributes

Writable Attribute
Description
CaptureProxyId

Type: handle
Default: 0
FilterDescription
Description of this filter.

Type: string
PduFrameConfig
Holds the PDU configuration string. Internal use only.

Type: string
CapturePktPduParserCommand Read-Only Attributes

Read-Only Attribute
Description

FieldLength
Length of the filter in bytes.

Type: u32
Default: 0
CaptureRangePattern
Description:
267
CaptureRawPacketTagsInfo
Capture range pattern.

Parents: Capture
CaptureRangePattern Writable Attributes

Writable Attribute
Description
Active, Name
Max
Maximum value.
Type: u16
Default: 0
Min
Minimum value.
Type: u16
Default: 0
CaptureRangePattern Read-Only Attributes

CaptureRawPacketTagsInfo
Description:
Raw packet tags information such as chassis name, streamId, and so on.

CaptureRawPacketTagsInfo Writable Attributes

Writable Attribute
Description
Active, Name
CaptureRawPacketTagsInfo Read-Only Attributes

Read-Only Attribute
Description
ChassisName
Name of the chassis.

Type: string
Index
Packet index.
Type: u32
Default: 0
PortName
Name of the port.

Type: string
RxTimestamp
Received timestamp of the packet.

Type: u32
Default: 0
SequenceNumber
Sequence number of the packet.

Type: u32
Default: 0
268
CaptureReleaseCommand
Read-Only Attribute
Description
StreamId
Stream ID of the captured raw packet.

Type: u32
Default: 0
TxRxDelta
Time difference between the packet received and transmitted.

Type: string
TxTimestamp
Transmitted timestamp of the packet.

Type: u32
Default: 0
CaptureReleaseCommand
Description:
Release the capture. On HyperMetrics cards, only one port can be capturing at a time. This command is available to release the capture to be used by any
other port on the HyperMetrics card.

CaptureReleaseCommand Writable Attributes

Writable Attribute
Description
CaptureProxyId

Type: handle
Default: 0
CaptureReleaseCommand Read-Only Attributes

Read-Only Attribute
Description

CaptureStartAllCommand
Description:
Start capture on specified capture proxy IDs (handles).

269
CaptureStartCommand
CaptureStartAllCommand Writable Attributes

Writable Attribute
Description
CaptureProxyIds
Capture proxy IDs (handles).

Type: handle
Default: 0
CaptureStartAllCommand Read-Only Attributes

Read-Only Attribute
Description

CaptureStartCommand
Description:
Start capture on specified capture proxy ID (handle).

CaptureStartCommand Writable Attributes

Writable Attribute
Description
CaptureProxyId

Type: handle
Default: 0
RealTimeDecoderLocation
Specifies the full location to the real time decoder application.

Type: string
RealTimeHostName
Specifies the host (ip address) address on which the real time decoder application is running. Currently,
only local host is supported.
Type: string
Default: 127.0.0.1
RealTimeTcpPort
Specifies the port on which the real time decoder application communicates with Spirent TestCenter.
Type: u16
Default: 2006
CaptureStartCommand Read-Only Attributes

Read-Only Attribute
Description

270
CaptureStatisticsFilter
CaptureStatisticsFilter
Description:
User-defined statistics counter.

Parents: Capture
Children: CapturePatternExpression
CaptureStatisticsFilter Writable Attributes

Writable Attribute
Description
Active, Name
FcsError
FCS error filter.

Type: enum
Default: IGNORE
Possible Values:
Value
Description
IGNORE
Ignore filter.
INCLUDE Include filter.

EXCLUDE Exclude filter.
PrbsError
PRBS error filter.

Type: enum
Default: IGNORE
Possible Values:
Value
Description
IGNORE
Ignore filter.
INCLUDE Include filter.

EXCLUDE Exclude filter.
CaptureStatisticsFilter Read-Only Attributes

CaptureStopAllCommand
Description:
Stop capture on specified capture proxy IDs (handles).

CaptureStopAllCommand Writable Attributes

Writable Attribute
Description
CaptureProxyIds
Capture proxy IDs (handles).

Type: handle
Default: 0
271
CaptureStopCommand
CaptureStopAllCommand Read-Only Attributes

Read-Only Attribute
Description

CaptureStopCommand
Description:
Stop capture on specified capture proxy ID (handle).

CaptureStopCommand Writable Attributes

Writable Attribute
Description
CaptureProxyId

Type: handle
Default: 0
CaptureStopCommand Read-Only Attributes

Read-Only Attribute
Description

CaptureViewCommand
Description:
View the captured data in a decoder.

CaptureViewCommand Writable Attributes

Writable Attribute
Description
CaptureProxyId

Type: handle
Default: 0
272
CCM
Writable Attribute
Description
EndFrameIndex
End capture frame index that wants to be viewed.

Type: u32
Default: 0
FileName
Name of binary to run for viewing captured data.

Type: string
FileNamePath
Path to current decoder.

Type: string
StartFrameIndex
Start capture frame index that wants to be viewed.

Type: u32
Default: 0
CaptureViewCommand Read-Only Attributes

Read-Only Attribute
Description

CCM (EOAM:CCM)
Description:
Children: cfmHeader, MACPreamble, MAID, theCCMTLVS
CCM Attributes
Attribute
Description
CCMIntervalField
Type: CCMIntField
Default: 4
Possible Values:
Value Description
0
invalid
3 1/3 ms
10 ms
100 ms
1s
10 s
1 min
10 min
FirstTLVOffset
Type: OCTETSTRING
Default: 46
ITU-TY1731
Type: OCTETSTRING
MAEPI
Type: INTEGER
Default: 0
273
CCM
Attribute
Description
Name
Type: string
OpCode
Type: OCTETSTRING
Default: 1
RDIbit
Type: RDIfield
Default: 0
Possible Values:
Value Description
0
zero
one
Reserved
Type: BITSTRING
Default: 0000
SequenceNumber
Type: INTEGER
Default: 0
CCM (serviceoam:CCM)
Description:
Children: cfmHeader, MAID, theCCMTLVS
CCM Attributes
Attribute
Description
CCMIntervalField
Type: CCMIntField
Default: 4
Possible Values:
Value Description
0
invalid
3 1/3 ms
10 ms
100 ms
1s
10 s
1 min
10 min
FirstTLVOffset
Type: OCTETSTRING
Default: 46
ITU-TY1731
Type: OCTETSTRING
MAEPI
Type: INTEGER
Default: 0
Name
Type: string
274
CCMTLVList
Attribute
Description
OpCode
Type: OCTETSTRING
Default: 1
RDIbit
Type: RDIfield
Default: 0
Possible Values:
Value Description
0
zero
one
Reserved
Type: BITSTRING
Default: 0000
SequenceNumber
Type: INTEGER
Default: 0
CCMTLVList
Description:
Parents: theCCMTLVS
Children: EndTLV, InterfaceStatusTLV, OrgSpecTLV, PortStatusTLV, SenderIDTLV
CCMTLVList Attributes
Attribute
Description
Name
information.
Type: string
CCMTLVList
Description:
Parents: theCCMTLVS
Children: EndTLV, InterfaceStatusTLV, OrgSpecTLV, PortStatusTLV, SenderIDTLV
CCMTLVList Attributes
Attribute
Description
Name
information.
Type: string
275
cdb10
cdb10
Description:
Parents: fcpCdb
Children: None
cdb10 Attributes
Attribute
Description
control
Type: OCTETSTRING
Default: 00
lba
Type: OCTETSTRING
Default: 00000000
length
Type: INTEGER
Default: 0
miscInfo1
Type: BITSTRING
Default: 000
miscInfo2
Type: BITSTRING
Default: 00000000
Name
Type: string
opCode
Type: OCTETSTRING
Default: 00
service
Type: BITSTRING
Default: 00000
CDB10 (scsi:CDB10)
Description:
Children: None
Next headers: fcp:FcpCmndDl
CDB10 Attributes
Attribute
Description
control
Type: OCTETSTRING
Default: 00
lba
Type: OCTETSTRING
Default: 00000000
length
Type: INTEGER
Default: 0
miscInfo1
Type: BITSTRING
Default: 000
miscInfo2
Type: BITSTRING
Default: 00000000
276
cdb6
Attribute
Description
Name
Type: string
opCode
Type: OCTETSTRING
Default: 00
service
Type: BITSTRING
Default: 00000
cdb6
Description:
Parents: fcpCdb
Children: None
cdb6 Attributes
Attribute
Description
control
Type: OCTETSTRING
Default: 00
lba
Type: INTEGER
Default: 0
length
Type: INTEGER
Default: 0
miscInfo
Type: BITSTRING
Default: 000
Name
Type: string
opCode
Type: OCTETSTRING
Default: 00
CDB6 (scsi:CDB6)
Description:
Children: None
277
cfmHeader
CDB6 Attributes
Attribute
Description
control
Type: OCTETSTRING
Default: 00
lba
Type: INTEGER
Default: 0
length
Type: INTEGER
Default: 0
miscInfo
Type: BITSTRING
Default: 000
Name
Type: string
opCode
Type: OCTETSTRING
Default: 00
cfmHeader (overloaded)
cfmHeader (EOAM)
cfmHeader (serviceoam)
cfmHeader Object (EOAM PDU library)

Description:
Parents: CCM (StreamBlock.CCM)

LBM (StreamBlock.LBM)
LBR (StreamBlock.LBR)
LTM (StreamBlock.LTM)
LTR (StreamBlock.LTR)
LMM (StreamBlock.LMM)
LMR (StreamBlock.LMR)
DMM (StreamBlock.DMM)
DMR (StreamBlock.DMR)
Children: None
278
cfmHeader
cfmHeader Attributes
Attribute
Description
MDlevel
Type: MDLvalues
Default: 0
Possible Values:
Value Description
0
zero
one
two
three
four
five
six
seven
Name
more information.
Type: string
Version
Type: BITSTRING
Default: 00000
cfmHeader Object (serviceoam PDU library)

Description:

LBM (StreamBlock.LBM)
LTM (StreamBlock.LTM)
LTR (StreamBlock.LTR)
Children: None
cfmHeader Attributes
Attribute
Description
MDlevel
Type: INTEGER
Default: 0
Name
more information.
Type: string
Version
Type: BITSTRING
Default: 00000
279
ChangeLacpGroupCommand
ChangeLacpGroupCommand
Description:
Do not use this command.

ChangeLacpGroupCommand Writable Attributes

Writable Attribute
Description
LacpGroup
LACP group handle.

Type: handle
Default: 0
LacpList
List of LACP handles.

Type: handle
Default: 0
ChangeLacpGroupCommand Read-Only Attributes

Read-Only Attribute
Description

ChangeMstpRegionCommand
Description:

ChangeMstpRegionCommand Writable Attributes

Writable Attribute
Description
MstpRegionList
MSTP region.
Type: handle
Default: 0
ChangeMstpRegionCommand Read-Only Attributes

Read-Only Attribute
Description

280
ChangePimGroupCommand
ChangePimGroupCommand
Description:

ChangePimGroupCommand Writable Attributes

Writable Attribute
Description
GroupList
List of PIM Group Config handles.

Type: handle
Default: 0
MulticastGroup
Multicast Group object handle.

Type: handle
Default: 0
ChangePimGroupCommand Read-Only Attributes

Read-Only Attribute
Description

ChangePimRpmapCommand
Description:

ChangePimRpmapCommand Writable Attributes

Writable Attribute
Description
MulticastGroup
Multicast Group object handle.

Type: handle
Default: 0
RpmapList
List of Rpmap object handles.

Type: handle
Default: 0
281
ChangeStpTypeCommand
ChangePimRpmapCommand Read-Only Attributes

Read-Only Attribute
Description

ChangeStpTypeCommand
Description:

ChangeStpTypeCommand Writable Attributes

Writable Attribute
Description
StpPortList
STP protocol to test - STP/RSTP/PVSTP/RPVSTP/MSTP.

Type: handle
Default: 0
StpType
Port type (trunk or access port).

Type: u8
Default: 0
ChangeStpTypeCommand Read-Only Attributes

Read-Only Attribute
Description

ChannelFlushRxQueueCommand
Description:
Flush the receive queue of the channels.

ChannelFlushRxQueueCommand Writable Attributes

Writable Attribute
Description
282
ChannelReceiveCommand
Writable Attribute
Description
ChannelList
List of channels to be flushed.

Type: handle
Default: 0
ChannelFlushRxQueueCommand Read-Only Attributes

Read-Only Attribute
Description

ChannelReceiveCommand
Description:
Retreive the received packet from receive queue.

ChannelReceiveCommand Writable Attributes

Writable Attribute
Description
Channel
Channel to retreive the received packet.

Type: handle
Default: 0
ChannelReceiveCommand Read-Only Attributes

Read-Only Attribute
Description

ReceivedData
Data that is retreived from the receive queue.

Type: string
TimeStamp
Receive time stamp of the retrieved packet.

Type: string
ChannelResetCounterCommand
Description:
Reset counters of the channels.
283
ChannelSendCommand

ChannelResetCounterCommand Writable Attributes

Writable Attribute
Description
ChannelList
List of channels for Reset counters.

Type: handle
Default: 0
ChannelResetCounterCommand Read-Only Attributes

Read-Only Attribute
Description

ChannelSendCommand
Description:
Send packet out of the channel.

ChannelSendCommand Writable Attributes

Writable Attribute
Description
Channel
Channel that will be used to send the packet.

Type: handle
Default: 0
Data
Data to be transmitted by the channel.

Type: string
Default: 00
ChannelSendCommand Read-Only Attributes

Read-Only Attribute
Description

ChannelStartCommand
Description:
284
ChannelStopCommand
Start channel to send and receive packets.

ChannelStartCommand Writable Attributes

Writable Attribute
Description
ChannelList
List of channels to be started.

Type: handle
Default: 0
ChannelStartCommand Read-Only Attributes

Read-Only Attribute
Description

ChannelStopCommand
Description:
Stop channel send and receive packets.

ChannelStopCommand Writable Attributes

Writable Attribute
Description
ChannelList
List of channels to be stopped.

Type: handle
Default: 0
ChannelStopCommand Read-Only Attributes

Read-Only Attribute
Description

ChartAxis
Description:
285
ChartAxisMapping

Parents: ResultDataSet
Relations:
Side name
(Type)
Relative
ChartAxisMapping
(MappingAxis)
ChartAxisMapping
Description
ChartAxis Writable Attributes

Writable Attribute
Description
Active, Name
AutoName
Type: bool
Default: TRUE
Possible Values:
Value Description
TRUE
FALSE
Location
Type: enum
Default: LEFT1
Possible Values:
Value
Description
LEFT1
LEFT2
RIGHT1
RIGHT2
LogarithmicBase
Type: enum
Default: None
Possible Values:
Value
Description
None
BASE_E
BASE_2
BASE_10
ChartAxis Read-Only Attributes

ChartAxisMapping
Description:

Parents: ResultQuery
Relations:
Side name
(Type)
Relative
ChartAxis
(MappingAxis)
ChartAxis
286
Description
chassisComponent
ChartAxisMapping Writable Attributes

Writable Attribute
Description
Active, Name
QueryPropertyId
Type: propertyId
Default: 0
QueryRoot
Type: handle
Default: 0
ChartAxisMapping Read-Only Attributes

chassisComponent
Description:
Parents: chassisid
Children: None
chassisComponent Attributes
Attribute
Description
id
Type: ASCII
Default: SPIRENT
Name
information.
Type: string
subtype
Type: ChassisIDSubTypeValues
Default: 01
Possible Values:
Value Description
01
Chassis Component
02
Interface Alias
03
Port Component
04
MAC Address
05
Network Address
06
Interface Name
07
Locally Assigned
chassisComponent
Description:
Parents: ChassisIDList
Children: None
287
ChassisConnectCommand
chassisComponent Attributes
Attribute
Description
ChassisID
Type: ASCII
Default: SPIRENT
ChassisIDSubtype
Default: 01
Possible Values:
Value Description
Name
01
Chassis Component
02
Interface Alias
03
Port Component
04
MAC Address
05
Network Address
06
Interface Name
07
Locally Assigned
more information.
Type: string
ChassisConnectCommand
Description:
Connect to a chassis.

ChassisConnectCommand Writable Attributes

Writable Attribute
Description
FileName
Type: inputFilePath
Hostname
Hostname or IP address of the chassis to connect to.

Type: string
InputChassis
Handle of the chassis to connect or reconnect to.

Type: handle
Default: 0
Option
Chassis connect option(currently not used).

Type: enum
Default: OPTION_CONNECT_TO_MCPUS
Possible Values:
Value
Description
OPTION_CONNECT_TO_MCPUS
Currently not used.
OPTION_CONNECT_TO_MCPUS_AND_CCPUS Currently not used.
288
ChassisDisconnectAllCommand
Writable Attribute
Description
TcpPort
TCP port number of the chassis to connect to. Should be left at the default.
Type: u16
Default: 40004
TimeoutInSec
Connect timeout in seconds.

Type: u32
Default: 0
ChassisConnectCommand Read-Only Attributes

Read-Only Attribute
Description

OutputChassis
Handle to the connected chassis.

Type: handle
Default: 0
OutputChassisList
Type: handle
Default: 0
ChassisDisconnectAllCommand
Description:
Disconnect from all chassis to which the application is currently connected.

ChassisDisconnectAllCommand Writable Attributes

Writable Attribute
Description
ChassisDisconnectAllCommand Read-Only Attributes

Read-Only Attribute
Description

ChassisDisconnectCommand
Description:
Disconnect from a chassis.

289
chassisid
ChassisDisconnectCommand Writable Attributes

Writable Attribute
Description
Chassis
Handle of the chassis to disconnect from.

Type: handle
Default: 0
Hostname
Hostname or IP address of the chassis to disconnect from.

Type: string
Default: 10.100.19.105
ChassisDisconnectCommand Read-Only Attributes

Read-Only Attribute
Description

chassisid
Description:
Parents: ChassisIdTlv
Children: chassisComponent, custom, interfaceAlias, interfaceName, locallyAssigned, macAddress, networkAddress4, networkAddress6, portComponent
chassisid Attributes
Attribute
Description
Name
information.
Type: string
chassisid
Description:
Parents: SndrID, SenderIDTLV
Children: ChassisIDList
chassisid Attributes
Attribute
Description
Name
information.
Type: string
290
ChassisIDList
ChassisIDList
Description:
Parents: chassisid
Children: ChassisComponent, Custom, InterfaceAlias, InterfaceName, LocallyAssigned, MacAddress, NetworkAddress4, NetworkAddress6, PortComponent
ChassisIDList Attributes
Attribute
Description
Name
information.
Type: string
ChassisIdTlv (lldp:ChassisIdTlv)
Description:
Children: chassisid
Next headers: lldp:PortIdTlv
ChassisIdTlv Attributes
Attribute
Description
length
Type: INTEGER
Default: 0
Name
more information.
Type: string
type
Type: INTEGER
Default: 1
checksums
Description:
Parents: Gre
Children: GreChecksum
checksums Attributes
Attribute
Description
Name
information.
Type: string
291
CiscoDCE8021adSTag
CiscoDCE8021adSTag (dce:CiscoDCE8021adSTag)
Description:
Children: dtag, outerdamac, outersamac, stag8021ad
Next headers: ipv4:IPv4, ipv6:IPv6, fc:FCoE
CiscoDCE8021adSTag Attributes
Attribute
Description
ethertype
Type: EtherTypes
Default: 88B5
Possible Values:
Value Description
0200
XEROX PUP
0201
PUP Addr Trans
0400
Nixdorf
0600
XEROX NS IDP
0660
DLOG
0661
DLOG2
0800
Internet IP
0801
X.75 Internet
0802
NBS Internet
0803
ECMA Internet
0804
Chaosnet
0805
X.25 Level 3
0806
ARP
0807
XNS Compatibility
0808
Frame Relay ARP
8035
RARP
86DD IPv6
880B PPP
8809
Slow Protocol
8847
MPLS Unicast
8848
MPLS Multicast
8863
PPPoE Discovery
8864
PPPoE Session
8906
FCoE
8914
FIP
Name
Type: string
originaldamac
Type: MACADDR
Default: 00:00:01:00:00:01
292
CiscoDCE8021adSTag
Attribute
Description
originalethertype
Type: EtherTypes
Default: 88B5
Possible Values:
Value Description
0200
XEROX PUP
0201
PUP Addr Trans
0400
Nixdorf
0600
XEROX NS IDP
0660
DLOG
0661
DLOG2
0800
Internet IP
0801
X.75 Internet
0802
NBS Internet
0803
ECMA Internet
0804
Chaosnet
0805
X.25 Level 3
0806
ARP
0807
XNS Compatibility
0808
Frame Relay ARP
8035
RARP
86DD IPv6
880B PPP
originalsamac
8809
Slow Protocol
8847
MPLS Unicast
8848
MPLS Multicast
8863
PPPoE Discovery
8864
PPPoE Session
8906
FCoE
8914
FIP
Type: MACADDR
Default: 00:10:94:00:00:02
293
CiscoDCECiscoStag
Attribute
Description
stagethertype
Type: EtherTypes
Default: 88a8
Possible Values:
Value Description
0200
XEROX PUP
0201
PUP Addr Trans
0400
Nixdorf
0600
XEROX NS IDP
0660
DLOG
0661
DLOG2
0800
Internet IP
0801
X.75 Internet
0802
NBS Internet
0803
ECMA Internet
0804
Chaosnet
0805
X.25 Level 3
0806
ARP
0807
XNS Compatibility
0808
Frame Relay ARP
8035
RARP
86DD IPv6
880B PPP
8809
Slow Protocol
8847
MPLS Unicast
8848
MPLS Multicast
8863
PPPoE Discovery
8864
PPPoE Session
8906
FCoE
8914
FIP
CiscoDCECiscoStag (dce:CiscoDCECiscoStag)
Description:
Children: ciscostag, dtag, outerdamac, outersamac
Next headers: ipv4:IPv4, ipv6:IPv6
294
CiscoDCECiscoStag
CiscoDCECiscoStag Attributes
Attribute
Description
ethertype
Type: EtherTypes
Default: 88B5
Possible Values:
Value Description
0200
XEROX PUP
0201
PUP Addr Trans
0400
Nixdorf
0600
XEROX NS IDP
0660
DLOG
0661
DLOG2
0800
Internet IP
0801
X.75 Internet
0802
NBS Internet
0803
ECMA Internet
0804
Chaosnet
0805
X.25 Level 3
0806
ARP
0807
XNS Compatibility
0808
Frame Relay ARP
8035
RARP
86DD IPv6
880B PPP
8809
Slow Protocol
8847
MPLS Unicast
8848
MPLS Multicast
8863
PPPoE Discovery
8864
PPPoE Session
8906
FCoE
8914
FIP
Name
Type: string
originaldamac
Type: MACADDR
Default: 00:00:01:00:00:01
295
CiscoDCECiscoStag
Attribute
Description
originalethertype
Type: EtherTypes
Default: 88B5
Possible Values:
Value Description
0200
XEROX PUP
0201
PUP Addr Trans
0400
Nixdorf
0600
XEROX NS IDP
0660
DLOG
0661
DLOG2
0800
Internet IP
0801
X.75 Internet
0802
NBS Internet
0803
ECMA Internet
0804
Chaosnet
0805
X.25 Level 3
0806
ARP
0807
XNS Compatibility
0808
Frame Relay ARP
8035
RARP
86DD IPv6
880B PPP
originalsamac
8809
Slow Protocol
8847
MPLS Unicast
8848
MPLS Multicast
8863
PPPoE Discovery
8864
PPPoE Session
8906
FCoE
8914
FIP
Type: MACADDR
Default: 00:10:94:00:00:02
296
CiscoHDLC
Attribute
Description
stagethertype
Type: EtherTypes
Default: 88a8
Possible Values:
Value Description
0200
XEROX PUP
0201
PUP Addr Trans
0400
Nixdorf
0600
XEROX NS IDP
0660
DLOG
0661
DLOG2
0800
Internet IP
0801
X.75 Internet
0802
NBS Internet
0803
ECMA Internet
0804
Chaosnet
0805
X.25 Level 3
0806
ARP
0807
XNS Compatibility
0808
Frame Relay ARP
8035
RARP
86DD IPv6
880B PPP
8809
Slow Protocol
8847
MPLS Unicast
8848
MPLS Multicast
8863
PPPoE Discovery
8864
PPPoE Session
8906
FCoE
8914
FIP
CiscoHDLC (hdlc:CiscoHDLC)
Description:
Children: None
Next headers: ipv4:IPv4, ip:IP, ipv6:IPv6, ip:IPv6LL, mpls:Mpls, custom:Custom
CiscoHDLC Attributes
Attribute
Description
address
Type: OCTETSTRING
Default: 0F
control
Type: OCTETSTRING
Default: 00
Name
information.
Type: string
297
ciscostag
Attribute
Description
protocolType
Type: EtherTypes
Default: 0800
Possible Values:
Value Description
0200
XEROX PUP
0201
PUP Addr Trans
0400
Nixdorf
0600
XEROX NS IDP
0660
DLOG
0661
DLOG2
0800
Internet IP
0801
X.75 Internet
0802
NBS Internet
0803
ECMA Internet
0804
Chaosnet
0805
X.25 Level 3
0806
ARP
0807
XNS Compatibility
0808
Frame Relay ARP
8035
RARP
86DD IPv6
880B PPP
8809
Slow Protocol
8847
MPLS Unicast
8848
MPLS Multicast
8863
PPPoE Discovery
8864
PPPoE Session
8906
FCoE
8914
FIP
ciscostag
Description:
Parents: CiscoDCECiscoStag
Children: None
ciscostag Attributes
Attribute
Description
dei_cfi
Type: BITSTRING
Default: 0
Name
more information.
Type: string
vl
Type: BITSTRING
Default: 0
298
class1InterConnectPortParams
Attribute
Description
vlan
Type: INTEGER
Default: 0
Description:
Parents: elpRequestAccept, elp
Children: None
class1InterConnectPortParams Attributes
Attribute
Description
imx
Type: BITSTRING
Default: 0
lks
Type: BITSTRING
Default: 0
Name
Type: string
recvDataFieldSize
Type: INTEGER
Default: 1000
reserved
Type: BITSTRING
Default: 000000000000
val
Type: BITSTRING
Default: 0
xps
Type: BITSTRING
Default: 0
class1SvcParams (overloaded)
class1SvcParams (fc) - Object definition for the following paths:
StreamBlock.ELSFLOGI.class1SvcParams
StreamBlock.ELSPLOGI.class1SvcParams
StreamBlock.ELSFLOGILSACC.class1SvcParams
StreamBlock.FCoE.fc.fcPayloads.FCPayload-Choice.plogiRequest.class1SvcParams
StreamBlock.FCoE.fc.fcPayloads.FCPayload-Choice.plogiAccept.class1SvcParams
StreamBlock.FCoE.fc.fcPayloads.FCPayload-Choice.flogiRequest.class1SvcParams
StreamBlock.FCoE.fc.fcPayloads.FCPayload-Choice.flogiAccept.class1SvcParams
StreamBlock.FCoE.fc.fcPayloads.FCPayload-Choice.fdiscRequest.class1SvcParams
StreamBlock.FCoE.fc.fcPayloads.FCPayload-Choice.fdiscAccept.class1SvcParams
StreamBlock.FIP.DL.DL-Choice.flogiRequest.flogi.class1SvcParams
StreamBlock.FIP.DL.DL-Choice.flogiAccept.flogiAcc.class1SvcParams
StreamBlock.FIP.DL.DL-Choice.npivFdiscRequest.fdisc.class1SvcParams
299
class1SvcParams
StreamBlock.FIP.DL.DL-Choice.npivFdiscAccept.fdiscAcc.class1SvcParams
class1SvcParams Object (fc PDU library)

Description:
Parents: ELSFLOGI (StreamBlock.ELSFLOGI)

Children: None
class1SvcParams Attributes
Attribute
Description
initiatorCtrl
Type: OCTETSTRING
Default: 0000
Name
Type: string
nxPortEndToEndCredit
Type: INTEGER
Default: 0
openSeqPerExchange
Type: INTEGER
Default: 0
options
Type: OCTETSTRING
Default: 0000
recipientCtrl
Type: OCTETSTRING
Default: 0000
reserved1
Type: INTEGER
Default: 0
reserved2
Type: INTEGER
Default: 0
reserved3
Type: INTEGER
Default: 0
totalConcurrentSeq
Type: INTEGER
Default: 0

Description:
Parents: ELSPLOGI (StreamBlock.ELSPLOGI)

Children: None
300
class1SvcParams
Attribute
Description
initiatorCtrl
Type: OCTETSTRING
Default: 0000
Name
Type: string
Type: INTEGER
Default: 0
openSeqPerExchange
Type: INTEGER
Default: 0
options
Type: OCTETSTRING
Default: 0000
recipientCtrl
Type: OCTETSTRING
Default: 0000
reserved1
Type: INTEGER
Default: 0
reserved2
Type: INTEGER
Default: 0
reserved3
Type: INTEGER
Default: 0
reserved4
Type: INTEGER
Default: 0
RxDataFieldSize
Type: INTEGER
Default: 0
totalConcurrentSeq
Type: INTEGER
Default: 0

Description:
Parents: ELSFLOGILSACC (StreamBlock.ELSFLOGILSACC)

Children: None
Attribute
Description
crTov
Type: INTEGER
Default: 0
Name
Type: string
301
class1SvcParams
Attribute
Description
options
Type: OCTETSTRING
Default: 0000
recipientCtrl
Type: OCTETSTRING
Default: 0000
reserved1
Type: INTEGER
Default: 0
reserved2
Type: INTEGER
Default: 0
reserved3
Type: INTEGER
Default: 0

Description:
Parents: plogiRequest (StreamBlock.FCoE.fc.fcPayloads.FCPayload-Choice.plogiRequest)

plogiAccept (StreamBlock.FCoE.fc.fcPayloads.FCPayload-Choice.plogiAccept)
flogiRequest (StreamBlock.FCoE.fc.fcPayloads.FCPayload-Choice.flogiRequest)
flogiAccept (StreamBlock.FCoE.fc.fcPayloads.FCPayload-Choice.flogiAccept)
fdiscRequest (StreamBlock.FCoE.fc.fcPayloads.FCPayload-Choice.fdiscRequest)
fdiscAccept (StreamBlock.FCoE.fc.fcPayloads.FCPayload-Choice.fdiscAccept)
flogi (StreamBlock.FIP.DL.DL-Choice.flogiRequest.flogi)
flogiAcc (StreamBlock.FIP.DL.DL-Choice.flogiAccept.flogiAcc)
fdisc (StreamBlock.FIP.DL.DL-Choice.npivFdiscRequest.fdisc)
fdiscAcc (StreamBlock.FIP.DL.DL-Choice.npivFdiscAccept.fdiscAcc)
Children: None
Attribute
Description
currentSequences
Type: OCTETSTRING
Default: 01
endToEndCredit
Type: OCTETSTRING
Default: 0000
iCtl
Type: OCTETSTRING
Default: 0000
Name
Type: string
openSeqPerExchange
Type: OCTETSTRING
Default: 0001
rCtl
Type: OCTETSTRING
Default: 0000
recDataFieldSize
Type: OCTETSTRING
Default: 0840
reserved1
Type: OCTETSTRING
Default: 00
302
Attribute
Description
reserved2
Type: OCTETSTRING
Default: 0000
serviceOptions
Type: OCTETSTRING
Default: 0000
Description:
Children: None
Attribute
Description
Name
Type: string
recvDataFieldSize
Type: INTEGER
Default: 1000
reserved
Type: BITSTRING
Default: 000000000000
rrr
Type: BITSTRING
Default: 00
seq
Type: BITSTRING
Default: 0
val
Type: BITSTRING
Default: 0
303
class2SvcParams

Description:

Children: None
Attribute
Description
initiatorCtrl
Type: OCTETSTRING
Default: 0000
Name
Type: string
Type: INTEGER
Default: 0
openSeqPerExchange
Type: INTEGER
Default: 0
options
Type: OCTETSTRING
Default: 0000
recipientCtrl
Type: OCTETSTRING
Default: 0000
reserved1
Type: INTEGER
Default: 0
reserved2
Type: INTEGER
Default: 0
reserved3
Type: INTEGER
Default: 0
totalConcurrentSeq
Type: INTEGER
Default: 0

Description:

Children: None
304
class2SvcParams
Attribute
Description
initiatorCtrl
Type: OCTETSTRING
Default: 0000
Name
Type: string
Type: INTEGER
Default: 0
openSeqPerExchange
Type: INTEGER
Default: 0
options
Type: OCTETSTRING
Default: 0000
recipientCtrl
Type: OCTETSTRING
Default: 0000
reserved1
Type: INTEGER
Default: 0
reserved2
Type: INTEGER
Default: 0
reserved3
Type: INTEGER
Default: 0
reserved4
Type: INTEGER
Default: 0
RxDataFieldSize
Type: INTEGER
Default: 0
totalConcurrentSeq
Type: INTEGER
Default: 0

Description:

Children: None
Attribute
Description
crTov
Type: INTEGER
Default: 0
Name
Type: string
305
class2SvcParams
Attribute
Description
options
Type: OCTETSTRING
Default: 0000
recipientCtrl
Type: OCTETSTRING
Default: 0000
reserved1
Type: INTEGER
Default: 0
reserved2
Type: INTEGER
Default: 0
reserved3
Type: INTEGER
Default: 0

Description:

Children: None
Attribute
Description
currentSequences
Type: OCTETSTRING
Default: 01
endToEndCredit
Type: OCTETSTRING
Default: 0000
iCtl
Type: OCTETSTRING
Default: 0000
Name
Type: string
openSeqPerExchange
Type: OCTETSTRING
Default: 0001
rCtl
Type: OCTETSTRING
Default: 0000
recDataFieldSize
Type: OCTETSTRING
Default: 0840
reserved1
Type: OCTETSTRING
Default: 00
306
Attribute
Description
reserved2
Type: OCTETSTRING
Default: 0000
serviceOptions
Type: OCTETSTRING
Default: 0000
Description:
Children: None
Attribute
Description
Name
Type: string
recvDataFieldSize
Type: INTEGER
Default: 1000
reserved
Type: BITSTRING
Default: 000000000000
rrr
Type: BITSTRING
Default: 00
seq
Type: BITSTRING
Default: 1
val
Type: BITSTRING
Default: 1
307
class3SvcParams

Description:

Children: None
Attribute
Description
initiatorCtrl
Type: OCTETSTRING
Default: 0000
Name
Type: string
Type: INTEGER
Default: 0
openSeqPerExchange
Type: INTEGER
Default: 0
options
Type: OCTETSTRING
Default: 0000
recipientCtrl
Type: OCTETSTRING
Default: 0000
reserved1
Type: INTEGER
Default: 0
reserved2
Type: INTEGER
Default: 0
reserved3
Type: INTEGER
Default: 0
totalConcurrentSeq
Type: INTEGER
Default: 0

Description:

Children: None
308
class3SvcParams
Attribute
Description
initiatorCtrl
Type: OCTETSTRING
Default: 0000
Name
Type: string
Type: INTEGER
Default: 0
openSeqPerExchange
Type: INTEGER
Default: 0
options
Type: OCTETSTRING
Default: 0000
recipientCtrl
Type: OCTETSTRING
Default: 0000
reserved1
Type: INTEGER
Default: 0
reserved2
Type: INTEGER
Default: 0
reserved3
Type: INTEGER
Default: 0
reserved4
Type: INTEGER
Default: 0
RxDataFieldSize
Type: INTEGER
Default: 0
totalConcurrentSeq
Type: INTEGER
Default: 0

Description:

Children: None
Attribute
Description
crTov
Type: INTEGER
Default: 0
Name
Type: string
309
class3SvcParams
Attribute
Description
options
Type: OCTETSTRING
Default: 0000
recipientCtrl
Type: OCTETSTRING
Default: 0000
reserved1
Type: INTEGER
Default: 0
reserved2
Type: INTEGER
Default: 0
reserved3
Type: INTEGER
Default: 0

Description:

Children: None
Attribute
Description
currentSequences
Type: OCTETSTRING
Default: 01
endToEndCredit
Type: OCTETSTRING
Default: 0000
iCtl
Type: OCTETSTRING
Default: 0000
Name
Type: string
openSeqPerExchange
Type: OCTETSTRING
Default: 0001
rCtl
Type: OCTETSTRING
Default: 0000
recDataFieldSize
Type: OCTETSTRING
Default: 0840
reserved1
Type: OCTETSTRING
Default: 00
310
classEnableVector
Attribute
Description
reserved2
Type: OCTETSTRING
Default: 0000
serviceOptions
Type: OCTETSTRING
Default: 0000
classEnableVector
Description:
Parents: PFC
Children: None
classEnableVector Attributes
Attribute
Description
lsOctet
Type: BITSTRING
Default: 00000000
msOctet
Type: BITSTRING
Default: 00000000
Name
more information.
Type: string
classFSvcParams
Description:
Children: None
classFSvcParams Attributes
Attribute
Description
concSeq
Type: INTEGER
Default: 1
endToEndCredit
Type: INTEGER
Default: 1
Name
Type: string
openSeqPerExchange
Type: INTEGER
Default: 1
311
clientIdHW
Attribute
Description
Type: BITSTRING
Default: 00
recvDataFieldSize
Type: INTEGER
Default: 1000
reserved1
Type: BITSTRING
Default: 000000000000000
reserved2
Type: OCTETSTRING
Default: 0000
reserved3
Type: BITSTRING
Default: 0000000000000
reserved4
Type: OCTETSTRING
Default: 0000
val
Type: BITSTRING
Default: 1
xii
Type: BITSTRING
Default: 0
clientIdHW
Description:
DHCP client identifier (hardware)
Parents: DHCPOption
Children: None
clientIdHW Attributes
Attribute
Description
clientHWA
Type: MACADDR
Default: 00:00:01:00:00:02
IDType
Type: OCTETSTRING
Default: 01
Name
Type: string
optionLength
Type: OCTETSTRING
Default: 07
type
Type: OCTETSTRING
Default: 3D
clientIdnonHW
Description:
312
ClientLoadPhase
DHCP client identifier (non-hardware)

Parents: DHCPOption
Children: None
clientIdnonHW Attributes
Attribute
Description
IDType
Type: OCTETSTRING
Default: 00
Name
Type: string
optionLength
Type: OCTETSTRING
Default: 07
type
Type: OCTETSTRING
Default: 3D
value
Type: OCTETSTRING
Default: 010203040506
ClientLoadPhase
Description:
Describes phases of load offered by a client to a server.

Parents: ClientLoadProfile
Children: BurstPatternDescriptor, FlatPatternDescriptor, RandomPatternDescriptor, SawToothPatternDescriptor, SinusoidPatternDescriptor, StairPatternDescriptor
ClientLoadPhase Writable Attributes

Writable Attribute
Description
Active, Name
LoadPattern
Pattern of load generated during this phase.

Type: enum
Default: STAIR
Possible Values:
Value
Description
STAIR
Load increments in stair step form.
FLAT
Load stays at a specific level.
BURST
Load generated is bursty.
SINUSOID
Load varies in a sine wave pattern.
RANDOM
Load level is randomly generated.
SAWTOOTH Load varies in a saw tooth pattern.
313
ClientLoadProfile
Writable Attribute
Description
LoadPhaseDurationUnits
Units for specifying duration of this load phase.

The value of this attribute determines the time unit used by many other objects, such as: BurstPatternDescriptor,
FlatPatternDescriptor, RandomPatternDescriptor, SawToothPatternDescriptor, SinusoidPatternDescriptor,
StairPatternDescriptor.
Type: enum
Default: SECONDS
Possible Values:
Value
Description
MILLISECONDS Milliseconds
SECONDS
Seconds
MINUTES
Minutes
HOURS
Hours
PhaseName
User-specified name for this phase of load generation.

Type: string
PhaseNum
Phase number for this phase of load generation. Load phases are applied in sorted (ascending) order.
Type: u8
Default: 1
ClientLoadPhase Read-Only Attributes

ClientLoadProfile
Description:
Describes load offered by a client to a server. There can be 0 or more ClientLoadProfile objects in the project.

Parents: Project
Children: ClientLoadPhase
Relations:
Side name
(Type)
Relative
Description
L4L7ProtocolConfigClientBase
(AffiliatedClientLoadProfile)
FtpClientProtocolConfig, FtpProtocolParams, HttpClientProtocolConfig,

HttpProtocolParams, RawTcpClientProtocolConfig, RawTcpProtocolParams,
SipCalleeProtocolParams, SipCallerProtocolParams, SipUaProtocolConfig,
VideoClientProtocolConfig, VideoProtocolParams
Specifies the client load profile

used by a client.
ClientLoadProfile Writable Attributes

Writable Attribute
Description
Active, Name
314
ClientLoadProfileRunStateWaitCommand
Writable Attribute
Description
LoadType
How the load is specified.

Type: enum
Default: CONNECTIONS
Possible Values:
Value
Description
CONNECTIONS
Load specified as the number of connections.
CONNECTIONS_PER_TIME_UNIT
Load specified as the number of connections per time unit.
TRANSACTIONS
Load specified as the number of transactions.
TRANSACTIONS_PER_TIME_UNIT Load specified as the number of transactions per time unit.

BANDWIDTH
Load specified as bandwidth given in Kbps.
MaxConnectionsAttempted
Maximum number of connections to be attempted from client.

Type: u32
Default: 4294967295
MaxOpenConnections
Maximum number of connections that can be open from a client.

Type: u32
Default: 4096
MaxTransactionsAttempted
Maximum number of transactions from a client.

Type: u32
Default: 4294967295
ProfileName
User-defined name for the profile.

Type: string
RandomizationSeed
Seed for random load settings.

Type: u32
Default: 123456
UseDynamicLoad
Use Dynamic Load mode, which allows the specification of the load as a parameter of the client configuration.
Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
Use the dynamic load of the client configuration.
FALSE Don't use the dynamic load of the client configuration.
ClientLoadProfile Read-Only Attributes

ClientLoadProfileRunStateWaitCommand
Description:
Have Application Layer Clients wait on specific Load Profile Run State.

Parents: Sequencer
ClientLoadProfileRunStateWaitCommand Writable Attributes

Writable Attribute
Description
ErrorOnFailure
315
ClientProfile
Writable Attribute
Description
LoadProfileRunState
Specify whether to wait for profile to be running or stopped.

Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
Wait for profile to be running.
FALSE Wait for profile to be stopped.

ObjectList
List of handles for objects to wait for.

Type: handle
Default: 0
WaitTime
Amount of time to wait for expected run state

Type: double
Default: 30.0
Range: 0.005 - 2147483647.0
ClientLoadProfileRunStateWaitCommand Read-Only Attributes

Read-Only Attribute
Description
ClientProfile
Description:
Describes protocol behavioral characteristics for clients.

Parents: Project
Children: HttpClientProtocolProfile, RawTcpClientProtocolProfile, SipUaProtocolProfile
Relations:
Side name
(Type)
Relative
Description
(AffiliatedClientProfile)
FtpClientProtocolConfig, FtpProtocolParams, HttpClientProtocolConfig,

HttpProtocolParams, RawTcpClientProtocolConfig, RawTcpProtocolParams,
SipCalleeProtocolParams, SipCallerProtocolParams, SipUaProtocolConfig,
VideoClientProtocolConfig, VideoProtocolParams
Specifies the client profile used by

a client.
ClientProfile Writable Attributes

Writable Attribute
Description
Active, Name
EnableDelayedAck
Whether to enable or disable Delayed ACK on TCP connections.

Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
Enable
FALSE Disable
316
ClockSynchronizationResult
Writable Attribute
Description
Ipv4Tos
IPv4 type of service setting to use for application layer traffic.

Type: u8
Default: 192
Range: 0 - 255
Ipv6TrafficClass
IPv6 traffic class settings to use for application layer traffic.

Type: u8
Default: 0
Range: 0 - 255
ProfileName
User-specified name for the profile.

Type: string
RxWindowSizeLimit
Upper limit of advertised Rx Window for TCP connections.

Type: u32
Default: 32768
ClientProfile Read-Only Attributes

ClockSynchronizationResult
Description:
IEEE 1588v2 clock synchronization results.

Parents: Ieee1588v2ClockConfig
Relations:
Side name
(Type)
Relative
Description
ResultParent
(ResultChild)
Ieee1588v2ClockConfig
ClockSynchronizationResult Writable Attributes

ClockSynchronizationResult Read-Only Attributes

Read-Only Attribute
Description
AvgMeanPathDelay
Average mean propagation delay between two ports.

Type: s64
Default: 0
AvgOffsetMinusDeviation
Difference between the average offset and the deviation.

Type: u64
Default: 0
AvgOffsetPlusDeviation
Sum of the average offset and the deviation.

Type: u64
Default: 0
CurrentMeanPathDelay
Mean propagation delay between two ports.

Type: s64
Default: 0
317
CloneCommand
Read-Only Attribute
Description
CurrentOffset
Value of the current Universal Coordinated Time offset.

Type: s32
Default: 0
LogMinDelayRequestInterval
Minimum permitted mean time interval between successive Pdelay_Req message.

Type: u64
Default: 0
MaxMeanPathDelay
Maximum mean propagation delay between two ports.

Type: s64
Default: 0
MinMeanPathDelay
Minimum mean propagation delay between two ports.

Type: s64
Default: 0
NegativeOffsetPeak
Maximum value of the negative offset.

Type: u32
Default: 0
OffsetDeviation
Distance of the offset from the mean.

Type: u64
Default: 0
OffsetStandardDeviation
Standard deviation from the mean of the offset.

Type: u64
Default: 0
PeerMeanPathDelay
An estimate of the current one-way propagation delay on the link.

Type: u64
Default: 0
PositiveOffsetPeak
Maximum value of the positive offset.

Type: u32
Default: 0
StepRemoved
Number of communication paths traversed between the local clock and the grandmaster clock.
Type: u64
Default: 0
TimeOfDay
Type: string
Default: 01 January 1970 12:00:00.000000000
CloneCommand
Description:
Clones objects.

CloneCommand Writable Attributes

Writable Attribute
Description
Active, ExecuteSynchronous, Name, ProgressCancelled
318
CollapseResultViewDataCommand
Writable Attribute
Description
CloneChildren
Whether the objects' children should be cloned.

Type: bool
Default: TRUE
Possible Values:
Value Description
TRUE
Clones the objects' children.
FALSE Does not clone the objects' children.

CloneCount
Number of copies to make.

Type: u32
Default: 1
SrcList
List of objects to clone.

Type: handle
Default: 0
CloneCommand Read-Only Attributes

Read-Only Attribute
Description

ReturnList
List of cloned objects.

Type: handle
Default: 0
CollapseResultViewDataCommand
Description:

CollapseResultViewDataCommand Writable Attributes

Writable Attribute
Description
ResultViewData
Type: handle
Default: 0
CollapseResultViewDataCommand Read-Only Attributes

Read-Only Attribute
Description

PresentationResultQuery
Type: handle
Default: 0
319
ColumnDisplayProperties
ColumnDisplayProperties
Description:

Parents: DynamicResultView
ColumnDisplayProperties Writable Attributes

Writable Attribute
Description
Active, Name
ColumnCaption
Type: string
ColumnGroups
Type: string
ColumnPrecision
Type: u8
Default: 255
ColumnPropertyId
Type: string
ColumnUnits
Type: u8
Default: 255
ColumnWidth
Type: u32
Default: 0
ColumnDisplayProperties Read-Only Attributes

commonIdentificationData (overloaded)
commonIdentificationData (fc)
commonIdentificationData (fcgs)
commonIdentificationData Object (fc PDU library)

Description:
Parents: gnidAccept (StreamBlock.FCoE.fc.fcPayloads.FCPayload-Choice.gnidAccept)

Children: CommonIdentificationData
320
CommonIdentificationData
commonIdentificationData Attributes
Attribute
Description
Name
information.
Type: string
commonIdentificationData Object (fcgs PDU library)

Description:
Parents: gnidAccept (StreamBlock.GnidAccept)

Children: CommonIdentificationData
commonIdentificationData Attributes
Attribute
Description
Name
information.
Type: string
Description:
Parents: commonIdentificationData
Children: None
CommonIdentificationData Attributes
Attribute
Description
Name
Type: string
nodeName
Type: WWN
Default: 10:00:10:94:00:00:00:00
nPortName
Type: WWN
Default: 20:00:10:94:00:00:00:00
321
Description:
Parents: commonIdentificationData
Children: None
CommonIdentificationData Attributes
Attribute
Description
Name
Type: string
nodeName
Type: WWN
Default: 10:00:10:94:00:00:00:00
nPortName
Type: WWN
Default: 20:00:10:94:00:00:00:00
commonSvcParams
Description:
Parents: flogi, flogiAcc, fdisc, fdiscAcc, plogiRequest, plogiAccept, flogiRequest, flogiAccept, fdiscRequest, fdiscAccept
Children: None
commonSvcParams Attributes
Attribute
Description
bufferToBufferCredit
Type: OCTETSTRING
Default: 0010
commFeatures
Type: OCTETSTRING
Default: 8000
edtov
Type: OCTETSTRING
Default: 000007D0
fcPhVersionHigh
Type: OCTETSTRING
Default: 00
fcPhVersionLow
Type: OCTETSTRING
Default: 20
Name
Type: string
RcvDataSize
Type: OCTETSTRING
Default: 0840
relOffsetbyInfoCategory
Type: OCTETSTRING
Default: 0000
totalConcurrentSequence
Type: OCTETSTRING
Default: 0002
322
commSvcParams
commSvcParams (overloaded)
commSvcParams (fc) - Object definition for the following paths:
StreamBlock.ELSFLOGI.commSvcParams
StreamBlock.ELSPLOGI.commSvcParams
StreamBlock.ELSFLOGILSACC.commSvcParams
commSvcParams Object (fc PDU library)

Description:

Children: None
commSvcParams Attributes
Attribute
Description
bbCredit
Type: INTEGER
Default: 1
bbRxDataFieldSize
Type: INTEGER
Default: 0
bbScN
Type: INTEGER
commFeatures
Type: OCTETSTRING
Default: 0000
fcPhVersion
Type: OCTETSTRING
Default: 2020
Name
Type: string
reserved
Type: OCTETSTRING
Default: 0000000000000000

Description:

Children: None
323
commSvcParams
Attribute
Description
bbCredit
Type: INTEGER
Default: 1
bbRxDataFieldSize
Type: INTEGER
Default: 0
bbScN
Type: INTEGER
commFeatures
Type: OCTETSTRING
Default: 0000
eDTov
Type: INTEGER
Default: 0
fcPhVersion
Type: OCTETSTRING
Default: 2020
Name
Type: string
relativeOffsetByInfoCategory
Type: INTEGER
Default: 0
reserved
Type: INTEGER
Default: 0
totalConcurrentSeq
Type: INTEGER
Default: 0

Description:

Children: None
Attribute
Description
bbCredit
Type: INTEGER
Default: 1
bbRxDataFieldSize
Type: INTEGER
Default: 0
bbScN
Type: INTEGER
commFeatures
Type: OCTETSTRING
Default: 0000
324
ConfigBfdIlLoggingCommand
Attribute
Description
eDTov
Type: INTEGER
Default: 0
fcPhVersion
Type: OCTETSTRING
Default: 2020
Name
Type: string
rATov
Type: INTEGER
Default: 0
ConfigBfdIlLoggingCommand
Description:

ConfigBfdIlLoggingCommand Writable Attributes

Writable Attribute
Description
DebugLevel
Debug Level to be enabled.

Type: enum
Default: INFO
Possible Values:
Value
Description
INFO
Error, Fatal, Warning, Debug and Info messages will be logged.
DEBUG Error, Fatal, Warning and Debug messages will be logged.

WARN
Error, Fatal and Warning messages will be logged.
ERROR Error and Fatal messages will be logged.

FATAL
Fatal messages will be logged.
DebugOptions
Wildcard options to be applied to log messages.

Type: string
MaxFileCount
Max number of files to create.

Type: u8
Default: 1
Range: 1 - 4
MaxFileSize
Maximum log file size. File will wrap after max is reached.
Type: u32
Default: 10000
Range: 1 - 2000000
325
ConfigBgpIlLoggingCommand
ConfigBfdIlLoggingCommand Read-Only Attributes

Read-Only Attribute
Description

ConfigBgpIlLoggingCommand
Description:

ConfigBgpIlLoggingCommand Writable Attributes

Writable Attribute
Description
DebugLevel

Type: enum
Default: INFO
Possible Values:
Value
Description
INFO

WARN

FATAL
DebugOptions
Wildcard options to be applies to log messages

Type: string
MaxFileCount

Type: u8
Default: 1
Range: 1 - 4
MaxFileSize
Type: u32
Default: 10000
Range: 1 - 2000000
ConfigBgpIlLoggingCommand Read-Only Attributes

Read-Only Attribute
Description

326
ConfigFcFcoeIlLoggingCommand
ConfigFcFcoeIlLoggingCommand
Description:

ConfigFcFcoeIlLoggingCommand Writable Attributes

Writable Attribute
Description
DebugLevel

Type: enum
Default: INFO
Possible Values:
Value
Description
INFO
WARN

FATAL
DebugOptions
Wildcard options to be applies to log messages.

Type: string
MaxFileCount

Type: u8
Default: 1
Range: 1 - 4
MaxFileSize
Type: u32
Default: 10000
Range: 1 - 2000000
ConfigFcFcoeIlLoggingCommand Read-Only Attributes

Read-Only Attribute
Description

ConfigIeee1588v2IlLoggingCommand
Description:

327
ConfigIsisIlLoggingCommand
ConfigIeee1588v2IlLoggingCommand Writable Attributes

Writable Attribute
Description
DebugLevel
Type: enum
Default: INFO
Possible Values:
Value
Description
INFO
DEBUG
WARN
ERROR
FATAL
DebugOptions
Type: string
MaxFileCount
Type: u8
Default: 1
Range: 1 - 4
MaxFileSize
Type: u32
Default: 10000
Range: 1 - 2000000
ConfigIeee1588v2IlLoggingCommand Read-Only Attributes

Read-Only Attribute
Description

ConfigIsisIlLoggingCommand
Description:

ConfigIsisIlLoggingCommand Writable Attributes

Writable Attribute
Description
328
ConfigLacpIlLoggingCommand
Writable Attribute
Description
DebugLevel

Type: enum
Default: INFO
Possible Values:
Value
Description
INFO

WARN

FATAL
DebugOptions
Wildcard options to be applies to log messages.

Type: string
MaxFileCount

Type: u8
Default: 1
Range: 1 - 4
MaxFileSize
Type: u32
Default: 10000
Range: 1 - 2000000
ConfigIsisIlLoggingCommand Read-Only Attributes

Read-Only Attribute
Description

ConfigLacpIlLoggingCommand
Description:

ConfigLacpIlLoggingCommand Writable Attributes

Writable Attribute
Description
329
ConfigLdpIlLoggingCommand
Writable Attribute
Description
DebugLevel

Type: enum
Default: INFO
Possible Values:
Value
Description
INFO

WARN

FATAL
DebugOptions

Type: string
MaxFileCount

Type: u8
Default: 1
Range: 1 - 4
MaxFileSize
Type: u32
Default: 10000
Range: 1 - 2000000
ConfigLacpIlLoggingCommand Read-Only Attributes

Read-Only Attribute
Description

ConfigLdpIlLoggingCommand
Description:

ConfigLdpIlLoggingCommand Writable Attributes

Writable Attribute
Description
330
ConfigLldpIlLoggingCommand
Writable Attribute
Description
DebugLevel

Type: enum
Default: INFO
Possible Values:
Value
Description
INFO

WARN

FATAL
DebugOptions

Type: string
MaxFileCount

Type: u8
Default: 1
Range: 1 - 4
MaxFileSize
Type: u32
Default: 10000
Range: 1 - 2000000
ConfigLdpIlLoggingCommand Read-Only Attributes

Read-Only Attribute
Description

ConfigLldpIlLoggingCommand
Description:

ConfigLldpIlLoggingCommand Writable Attributes

Writable Attribute
Description
331
ConfigOspfv2IlLoggingCommand
Writable Attribute
Description
DebugLevel

Type: enum
Default: INFO
Possible Values:
Value
Description
INFO

WARN

FATAL
DebugOptions

Type: string
MaxFileCount

Type: u8
Default: 1
Range: 1 - 4
MaxFileSize
Type: u32
Default: 10000
Range: 1 - 2000000
ConfigLldpIlLoggingCommand Read-Only Attributes

Read-Only Attribute
Description

Description:

ConfigOspfv2IlLoggingCommand Writable Attributes

Writable Attribute
Description
332
Writable Attribute
Description
DebugLevel

Type: enum
Default: INFO
Possible Values:
Value
Description
INFO

WARN

FATAL
DebugOptions

Type: string
MaxFileCount

Type: u8
Default: 1
Range: 1 - 4
MaxFileSize
Type: u32
Default: 10000
Range: 1 - 2000000
ConfigOspfv2IlLoggingCommand Read-Only Attributes

Read-Only Attribute
Description

Description:

ConfigOspfv3IlLoggingCommand Writable Attributes

Writable Attribute
Description
333
ConfigPimIlLoggingCommand
Writable Attribute
Description
DebugLevel

Type: enum
Default: INFO
Possible Values:
Value
Description
INFO

WARN

FATAL
DebugOptions

Type: string
MaxFileCount

Type: u8
Default: 1
Range: 1 - 4
MaxFileSize
Type: u32
Default: 10000
Range: 1 - 2000000
ConfigOspfv3IlLoggingCommand Read-Only Attributes

Read-Only Attribute
Description

ConfigPimIlLoggingCommand
Description:

ConfigPimIlLoggingCommand Writable Attributes

Writable Attribute
Description
334
ConfigPropertiesCommand
Writable Attribute
Description
DebugLevel

Type: enum
Default: INFO
Possible Values:
Value
Description
INFO

WARN

FATAL
DebugOptions

Type: string
MaxFileCount

Type: u8
Default: 1
Range: 1 - 4
MaxFileSize
Type: u32
Default: 10000
Range: 1 - 2000000
ConfigPimIlLoggingCommand Read-Only Attributes

Read-Only Attribute
Description

ConfigPropertiesCommand
Description:
Configure multiple objects' properties at once.
Tcl example:
stc::perform ConfigProperties -objectlist [stc::get project1 -children-port] -propertylist \
{ -generator.generatorConfig.schedulingMode RATE_BASED -generator.generatorConfig.durationMode CONTINUOUS }

ConfigPropertiesCommand Writable Attributes

Writable Attribute
Description
ObjectList
List of objects to be configured. All objects must be of the same type.

Type: handle
Default: 0
PropertyList
Property name/value pairs. DAN syntax is allowed.

Type: string
335
ConfigRipIlLoggingCommand
ConfigPropertiesCommand Read-Only Attributes

Read-Only Attribute
Description

ConfigRipIlLoggingCommand
Description:

ConfigRipIlLoggingCommand Writable Attributes

Writable Attribute
Description
DebugLevel

Type: enum
Default: INFO
Possible Values:
Value
Description
INFO

WARN

FATAL
DebugOptions

Type: string
MaxFileCount

Type: u8
Default: 1
Range: 1 - 4
MaxFileSize
Type: u32
Default: 10000
Range: 1 - 2000000
ConfigRipIlLoggingCommand Read-Only Attributes

Read-Only Attribute
Description

336
ConfigRsvpIlLoggingCommand
ConfigRsvpIlLoggingCommand
Description:

ConfigRsvpIlLoggingCommand Writable Attributes

Writable Attribute
Description
DebugLevel

Type: enum
Default: INFO
Possible Values:
Value
Description
INFO

WARN

FATAL
DebugOptions

Type: string
MaxFileCount

Type: u8
Default: 1
Range: 1 - 4
MaxFileSize
Type: u32
Default: 10000
Range: 1 - 2000000
ConfigRsvpIlLoggingCommand Read-Only Attributes

Read-Only Attribute
Description

ConfigStpIlLoggingCommand
Description:

337
ConfigSyncEthIlLoggingCommand
ConfigStpIlLoggingCommand Writable Attributes

Writable Attribute
Description
DebugLevel

Type: enum
Default: INFO
Possible Values:
Value
Description
INFO

WARN

FATAL
DebugOptions

Type: string
MaxFileCount

Type: u8
Default: 1
Range: 1 - 4
MaxFileSize
Type: u32
Default: 10000
Range: 1 - 2000000
ConfigStpIlLoggingCommand Read-Only Attributes

Read-Only Attribute
Description

ConfigSyncEthIlLoggingCommand
Description:
Configure SyncE IL logging.

ConfigSyncEthIlLoggingCommand Writable Attributes

Writable Attribute
Description
338
Configuration
ConfigSyncEthIlLoggingCommand Read-Only Attributes

Read-Only Attribute
Description

Configuration
Description:
Parents: LI, RI
Children: None
Configuration Attributes
Attribute
Description
LinkEvents
Type: OAMPDUConfigLE
Default: 1
Possible Values:
Value Description
1
DTE supports interpreting Link Events
DTE does not support interpreting Link Events
Name
information.
Type: string
OAMMode
Type: OAMPDUConfigMode
Default: 1
Possible Values:
Value Description
OAMRLS
DTE configured in Active mode
DTE configured in Passive mode
Type: OAMPDUConfigRLS
Default: 1
Possible Values:
Value Description
1
DTE is capable of OAM remote loopback mode
DTE is not capable of OAM remote loopback mode
Reserved
Type: BITSTRING
Default: 000
UnidirSupport
Type: OAMPDUConfigUS
Default: 1
Possible Values:
Value Description
1
DTE is capable of sending OAMPDUs when the receive path is non-operational
DTE is not capable of sending OAMPDUs when the receive path is non-operational
339
ConfigureTestModuleCommand
Attribute
Description
VarRet
Type: OAMPDUConfigVR
Default: 1
Possible Values:
Value Description
1
DTE supports sending Variable Response OAMPDUs
DTE does not support sending Variable Response OAMPDUs
ConfigureTestModuleCommand
Description:
Command to configure settings for one or more test module.

ConfigureTestModuleCommand Writable Attributes

Writable Attribute
Description
PortGroupSize
Port group size to set for the test module(s).

Type: u16
Default: 0
TestModuleList
List of one or more test module to configure.

Type: handle
Default: 0
ConfigureTestModuleCommand Read-Only Attributes

Read-Only Attribute
Description

CongestionNotificationTlv (lldp:CongestionNotificationTlv)
Description:
Children: None
lldp:ApplicationPriorityTlv, lldp:ETSConfigurationTlv, lldp:ETSRecommendationTlv, lldp:NivSupportTlv
340
ContinuousTestConfig
CongestionNotificationTlv Attributes
Attribute
Description
cnMask
Type: BITSTRING
Default: 00000000
defOnMask
Type: BITSTRING
Default: 00000000
length
Type: INTEGER
Default: 7
Name
Type: string
oui
Type: OCTETSTRING
Default: 0080C2
reserved
Type: BITSTRING
Default: 0000000
subtype
Type: OCTETSTRING
Default: 13
type
Type: INTEGER
Default: 127
willing
Type: BITSTRING
Default: 1
Description:
Configuration for custom continuous test.

Parents: Project
ContinuousTestConfig Writable Attributes

Writable Attribute
Description
Active, Name
DelayAfterTransmission
Length of time you want to wait, after the test is complete, for all traffic to be received.
Type: u16
Default: 15
Range: 0 - 3600
EnableArp
Whether to enable or disable ARP. Enabling will append ARPing commands into the sequencer.
Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
ARP is enabled.
FALSE ARP is disabled.
341
Writable Attribute
Description
EnableDhcp
Whether to enable or disable DHCP. Enabling will append DHCP related commands into the sequencer.
Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
DHCP is enabled.
FALSE DHCP is disabled.

EnableL2tp
Flag to add/not add L2TP commands.

Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
Adds L2TP commands.
FALSE Does not add L2TP commands.

EnablePauseBeforeTraffic
If this option is enabled, this will pause the sequencer prior to starting traffic. This pause allows you time to do a final
DUT check (for example, check routes) before Spirent TestCenter proceeds with traffic start.
Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
Enable pause before starting traffic.
FALSE No pause before starting traffic.

EnablePpp
Whether to enable or disable PPP. Enabling will append PPP related commands into the sequencer.
Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
PPP is enabled.
FALSE PPP is disabled.

EnableRouter
Whether to enable or disable router. Enabling will append commands into the sequencer to start and stop all routers.
Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
Router is enabled.
FALSE Router is disabled.

EnableWaitAfterAdvertisement
Whether to wait until advertisement completes. Enabling will append commands into the sequencer to wait for routing
events and states .
Type: bool
Default: TRUE
Possible Values:
Value Description
TRUE
Wait until advertisement completes.
FALSE Do not wait until advertisement completes.

EnableWaitForMplsBinding
Flag to indicate whether to wait for MPLS binding. If enabled, traffic waits for MPLS streams to bind.
Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
Traffic waits for MPLS streams to bind.
FALSE Traffic does not wait for MPLS streams to bind.
342
Writable Attribute
Description
FixedFrameSize
Sets the fixed frame size in bytes when FrameSizeType is FIXED.

Type: u16
Default: 128
Range: 40 - 16383
FixedInterburstGapValue
Constant inter-burst gap value for all iterations. This attribute is ignored when InterBurstGapMode is RANDOM.
Type: u8
Default: 0
Range: 0 - 100
FixedLoad
Sets the fixed load rate when LoadType is FIXED.

Type: double
Default: 10
FrameSizeType
Specifies the method of setting the frame size.

Type: enum
Default: USE_PORTS_STREAMS
Possible Values:
Value
Description
USE_PORTS_STREAMS Use frame size that is currently set in streamblocks.
FIXED
Frame size is constant and equal to FixedFrameSize.
RANDOM
Frame size is randomly chosen within the range set by RandomMinFrameSize and
RandomMaxFrameSize.
IMIX
Frame sizes is defined by existing iMIX distribution.
ImixDistribution
Specifies the selected iMIX distribution to be used from the available iMIX distributions in Spirent TestCenter.
Type: handle
Default: 0
InterburstGapMode
Specifies the inter-burst gap mode, the idle time between packets, as either fixed or random.
Type: enum
Default: FIXED
Possible Values:
Value
Description
FIXED
Specifies that the inter-burst gap is a fixed value.
RANDOM Specifies that the inter-burst gap is set randomly each iteration, between the range of
RandomMinInterburstGapValue and RandomMaxInterburstGapValue.
LatencyDistributionList
List of up to 16 time intervals (latency buckets) into which received-frame latency values will be directed.
Type: u16
Default: 2
LoadType
Method of setting the load rate.

Type: enum
Possible Values:
Value
Description
USE_PORTS_STREAMS Use load that is currently set in stream blocks or ports.
FIXED
Load rate is constant and equal to FixedLoad.
RANDOM
Load rate is randomly chosen within the range set by RandomMinLoad and
RandomMaxLoad.
343
Writable Attribute
Description
LoadUnits
Unit of measurement for the load parameter, applied to all ports and streams in the test.
Type: enum
Possible Values:
Value
Description
PERCENT_LINE_RATE
Percentage of the line rate.
FRAMES_PER_SECOND
Frames per second.
INTER_BURST_GAP
Inter-burst gap, or idle time between packets.
MEGABITS_PER_SECOND Megabits per second.

KILOBITS_PER_SECOND
Kilobits per second.
BITS_PER_SECOND
Bits per second.
RandomMaxFrameSize
Maximum frame size when FrameSizeType is RANDOM.

Type: u16
Default: 256
Range: 40 - 16383
RandomMaxInterburstGapValue
Maximum inter-burst gap value for all iterations. This attribute is ignored when InterBurstGapMode is FIXED.
Type: u8
Default: 12
Range: 0 - 100
RandomMaxLoad
When using Random mode for load on the ports, the maximum load for each port. This attribute is ignored if LoadType
is set to CUSTOM, FIXED or STEP.
Type: double
Default: 50
RandomMinFrameSize
Minimum frame size when FrameSizeType is RANDOM.

Type: u16
Default: 128
Range: 40 - 16383
RandomMinInterburstGapValue
Minimum inter-burst gap value for all iterations. This attribute is ignored when InterBurstGapMode is FIXED.
Type: u8
Default: 12
Range: 0 - 100
RandomMinLoad
When using Random mode for load on the ports, the minimum load for each port. This attribute is ignored if LoadType
Type: double
Default: 10
StartTrafficDelay
This is the number of seconds to wait before sending traffic. This setting gives you the flexibility to start traffic ?n?
seconds after test start, or ?n? seconds after advertisement is complete.
Type: u16
Default: 0
Range: 0 - 3600
TrafficStartMode
Whether to start traffic synchronously across ports.

Type: enum
Default: SYNCHRONOUS
Possible Values:
Value
Description
SYNCHRONOUS
Traffic start is synchronous.
NONSYNCHRONOUS Traffic start is nonsynchronous.
ContinuousTestConfig Read-Only Attributes

Read-Only Attribute
Description
TestType
Type of test is Custom.

Type: string
Default: Custom
344
Control
Control
Description:
Parents: controls
Children: None
Control Attributes
Attribute
Description
Name
information.
Type: string
value
Type: OCTETSTRING
Default: 03
ControlFrame (RPR:ControlFrame)
Description:
Children: ControlFrameSize, extendedHeader, rch
ControlFrame Attributes
Attribute
Description
controlTypeValue
Type: controlTypeValuesField
Default: 01
Possible Values:
Value Description
01
Station Attribute Discovery Frame
02
Topology and Protection Protocol Frame
03
Topology and Protection Checksum Frame
04
Link Round Trip Time Measurement Request Frame
05
Link Round Trip Time Measurement Response Frame
06
Fairness Differential Delay Frame
07
OAM Echo Request Frame
08
OAM Echo Response Frame
09
OAM Flush Frame
0A
OAM Organization Specific Frame
controlVersion
Type: OCTETSTRING
Default: 00
Name
information.
Type: string
345
ControlFrameSize
ControlFrameSize
Description:
Parents: ControlFrame
Children: dataMin, regMax
ControlFrameSize Attributes
Attribute
Description
Name
information.
Type: string
controls
Description:
Parents: PPP
Children: Control
controls Attributes
Attribute
Description
Name
information.
Type: string
ControlWord (mpls:ControlWord)
Description:
Children: None
Next headers: ethernet:EthernetII, ipv4:IPv4, ipv6:IPv6, custom:Custom
ControlWord Attributes
Attribute
Description
Name
Type: string
reserved
Type: INTEGER
Default: 0
seqNum
Type: INTEGER
Default: 0
type
Type: BITSTRING
Default: 0000
346
CopyCommand
CopyCommand
Description:
Copies objects. If there is only a single source object, and the source object and destination object are of the same type, the destination object will be copied
over by the source object; otherwise, the source objects will be copied under the destination object.

CopyCommand Writable Attributes

Writable Attribute
Description
DstList
Target object to copy to.

Type: handle
Default: 0
RepeatCount
Number of copies to make.

Type: u32
Default: 1
SrcList
List of source objects to copy from.

Type: handle
Default: 0
CopyCommand Read-Only Attributes

Read-Only Attribute
Description

ReturnList
List of copied objects.

Type: handle
Default: 0
CopyFilterToPortsCommand
Description:
Copy filter of capture proxy ID to port proxy ID.

CopyFilterToPortsCommand Writable Attributes

Writable Attribute
Description
CaptureProxyId

Type: handle
Default: 0
347
CounterFilterProperty
Writable Attribute
Description
ToPortProxyId
Port proxy ID (handle) to copy data.

Type: handle
Default: 0
CopyFilterToPortsCommand Read-Only Attributes

Read-Only Attribute
Description

CounterFilterProperty
Description:
Configure counter filter property.

Parents: CounterResultFilter
Children: CounterFilterProperty
Result children (automatically created): VerifyResultsValueCondition
CounterFilterProperty Writable Attributes

Writable Attribute
Description
Active, Name
BooleanOperator
BooleanOperator to carry chain multiple filter conditions.

Type: enum
Default: AND
Possible Values:
Value Description
AND
OR
ComparisonOperator
Operator to use for value comparison.

Type: enum
Default: GREATER_THAN
Possible Values:
Value
Description
LESS_THAN
LESS_THAN_OR_EQUAL
GREATER_THAN
GREATER_THAN_OR_EQUAL
EQUAL
NOT_EQUAL
BETWEEN
348
CounterResultFilter
Writable Attribute
Description
InvertComparison
Use invert of selected filter conditions.

Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
FALSE
MaxValueOperand
Max value to use for comparison when BETWEEN ComparisonOperator selected.

Type: string
Default: 0
MinValueOperand
Min value to use for comparison when BETWEEN ComparisonOperator selected.

Type: string
Default: 0
PropertyOperand
Counter property to be used for filter.

Type: string
Default: 0
ValueOperand
Value to be used for comparison with counter value.

Type: string
Default: 0
CounterFilterProperty Read-Only Attributes

CounterResultFilter
Description:
Configure a counter result filter.

Parents: Project
Children: CounterFilterProperty, CounterSortProperty
Relations:
Side name
(Type)
Relative
ResultQuery
(ResultFilters)
ResultQuery
Description
CounterResultFilter Writable Attributes

Writable Attribute
Description
Active, Name
ResultsLimitCount
Maximum number of filtered result to evaluate.

Type: u32
Default: 50
CounterResultFilter Read-Only Attributes

349
CounterResultFilterInfo
CounterResultFilterInfo
Description:
Information about counter result filter selected for subscription.

CounterResultFilterInfo Writable Attributes

Writable Attribute
Description
Active, Name
CounterResultFilterInfo Read-Only Attributes

Read-Only Attribute
Description
FilteredResultCount
Number of results available for selected filter.

Type: u32
Default: 0
CounterResultFilterLoadFromTemplateCommand
Description:

CounterResultFilterLoadFromTemplateCommand Writable Attributes

Writable Attribute
Description
FileName
Name of the file from which the result filter will be loaded.
Type: string
Default: ResulterFilterTemplate.xml
TargetCounterResultFilter
Handle of the result filter to which the loaded configuration will overwrite.
Type: handle
Default: 0
CounterResultFilterLoadFromTemplateCommand Read-Only Attributes

Read-Only Attribute
Description

CounterResultFilter
Handle of the result filter to which configuration has been loaded.

Type: handle
Default: 0
350
CounterResultFilterSaveAsTemplateCommand
CounterResultFilterSaveAsTemplateCommand
Description:

CounterResultFilterSaveAsTemplateCommand Writable Attributes

Writable Attribute
Description
CounterResultFilter
Handle of counter result filter.

Type: handle
Default: 0
FileName
File name of the saved template.

Type: string
Default: ResultFilterTemplate.xml
CounterResultFilterSaveAsTemplateCommand Read-Only Attributes

Read-Only Attribute
Description

CounterSortProperty
Description:

Parents: CounterResultFilter
Children: CounterSortProperty
CounterSortProperty Writable Attributes

Writable Attribute
Description
Active, Name
SortDirection
Type: enum
Default: ASCENDING
Possible Values:
Value
Description
ASCENDING
DESCENDING
SortProperty
Type: string
Default: 0
CounterSortProperty Read-Only Attributes

351
CreateAndReservePortsCommand
CreateAndReservePortsCommand
Description:

CreateAndReservePortsCommand Writable Attributes

Writable Attribute
Description
ChassisList
Type: string
Default: 0
LocationList
Type: csp
Default: 0
RevokeOwner
Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE

SlotList
Type: string
Default: 0
CreateAndReservePortsCommand Read-Only Attributes

Read-Only Attribute
Description

PortList
Type: handle
Default: 0
CreateConnectionCommand
Description:

Parents: Sequencer
CreateConnectionCommand Writable Attributes

Writable Attribute
Description
ConnectionType
Type of connection to create.

Type: string
Default: Router
352
CreateEventMessageResultQueryCommand
Writable Attribute
Description
CreateClassId
Type of connection objection to create.

Type: classId
Default: 0
CreateCount
Number of connection objects to create.

Type: u32
Default: 1
ParentList
Parent object under which the connection objects are to be created.

Type: handle
Default: 0
SourceInterface
Source interface of the connection.

Type: handle
Default: 0
TargetInterface
Target interface of the connection.

Type: handle
Default: 0
CreateConnectionCommand Read-Only Attributes

Read-Only Attribute
Description
ReturnList
Connection object handles.

Type: handle
Default: 0
CreateEventMessageResultQueryCommand
Description:
Creates the result queries necessary to enable a group of event message types.

CreateEventMessageResultQueryCommand Writable Attributes

Writable Attribute
Description
AllObjects
Whether all objects are enabled.

Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
All objects that support the specified event message type group will be enabled.
FALSE The Objects attribute is used to specify which objects to enable event messages on.
GroupName
Name of the event message type group to enable.

Type: string
353
CreateFrameConfigFromPduTemplateCommand
Writable Attribute
Description
Objects
A collection of object handles to enable event messages on. This is ignored if the AllObjects attribute is true.
Type: handle
Default: 0
ResultDataSet
Handle of the ResultDataSet.

Type: handle
Default: 0
CreateEventMessageResultQueryCommand Read-Only Attributes

Read-Only Attribute
Description

CreateFrameConfigFromPduTemplateCommand
Description:
Overwrite the FrameConfig property of the stream block using a PDU template file located in the Templates subfolder.

CreateFrameConfigFromPduTemplateCommand Writable Attributes

Writable Attribute
Description
FileName
File name of the PDU template.

Type: inputFilePath
StreamBlock
Target stream block.

Type: handle
Default: 0
CreateFrameConfigFromPduTemplateCommand Read-Only Attributes

Read-Only Attribute
Description

CreateFrameLengthDistributionCommand
Description:
Create a frame length distribution.
354
CreateFromTemplateCommand

CreateFrameLengthDistributionCommand Writable Attributes

Writable Attribute
Description
DistributionName
Name for the frame length distribution to be created.

Type: string
Default: FrmLenDist
Slots
Comma-separated list for distribution slot configuration: <Fixed:FrameLength |

Random:MinFrameLength~MaxFrameLength>:<weight>
Type: string
Default: Fixed:40:5867,Fixed:44:200,Fixed:576:2366,Fixed:1500:1567
CreateFrameLengthDistributionCommand Read-Only Attributes

Read-Only Attribute
Description

Handle of the created frame length distribution object.

Type: handle
Default: 0
CreateFromTemplateCommand
Description:
Creates a new object from a template.

CreateFromTemplateCommand Writable Attributes

Writable Attribute
Description
ParentConfig
Handle of the parent object to create under.

Type: handle
Default: 0
TemplateUri
URI of the template to create from.

Type: string
UseSystemDefaultTemplate
Whether to use only the system default templates.

Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
Uses only the system default templates when resolving the URI.
FALSE Uses both user and system templates when resolving the URI.
355
CreateGroupedStreamBlocksCommand
CreateFromTemplateCommand Read-Only Attributes

Read-Only Attribute
Description

Config
The created object.

Type: handle
Default: 0
CreateGroupedStreamBlocksCommand
Description:
Create stream block(s) with traffic group association. New group and/or subgroup objects will be automatically created under project if there are no pre-existing
group and/or subgroup with matching names. If group and/or subgroup with matching names already pre-exist, then the newly created stream block(s) will be
appended to the pre-existing group and/or subgroup.

CreateGroupedStreamBlocksCommand Writable Attributes

Writable Attribute
Description
DstBinding
Destination endpoints.
Type: handle
Default: 0
ExpandToPorts
Whether the stream block should be expanded to port.

Type: bool
Default: TRUE
Possible Values:
Value Description
TRUE
Expand the stream block.
FALSE Do not expand the stream block.

Handle to frame length distribution.

Type: handle
Default: 0
Group
Name of the group.

Type: string
Default: Group
SrcBinding
Source endpoints.
Type: handle
Default: 0
Subgroup
Name of the subgroup.

Type: string
Default: Subgroup
356
CreateHighResolutionStreamBlockConfigCommand
CreateGroupedStreamBlocksCommand Read-Only Attributes

Read-Only Attribute
Description

GroupCollection
Contains the handle to group collection.

Type: handle
Default: 0
StreamBlocks
Contains the handle to stream blocks.

Type: handle
Default: 0
TrafficGroup
Contains the handle to traffic group.

Type: handle
Default: 0
CreateHighResolutionStreamBlockConfigCommand
Description:
Command to create high resolution stream block sampling configuration.

CreateHighResolutionStreamBlockConfigCommand Writable Attributes

Writable Attribute
Description
BaselineSampleCount
Number of samples used to calculate the trigger value.

Type: u8
Default: 3
EnableTrigger
Whether triggering should be enabled or disabled.

Type: bool
Default: TRUE
Possible Values:
Value Description
TRUE
Enable triggering.
FALSE Disable triggering.

NamePrefix
Prefix name to use for high resolution sampling objects.

Type: string
Default: StreamBlockSample
PortHandleList
Handle of Rx ports for high resolution sampling.

Type: handle
Default: 0
StreamBlockHandleList
Handle of stream block for high resolution sampling.

Type: handle
Default: 0
TotalSamples
Total number of samples supported for high resolution sampling.

Type: u16
Default: 1000
357
CreateIgmpMldHostProtocolCommand
Writable Attribute
Description
TriggerCondition
Condition to apply the statistic.

Type: enum
Default: LESS_THAN
Possible Values:
Value
Description
LESS_THAN
Less than condition.
LESS_THAN_OR_EQUAL
Less than or equal condition.
GREATER_THAN
Greater than condition.
GREATER_THAN_OR_EQUAL Greater than or equal condition.

EQUAL
Equal condition.
NOT_EQUAL
Not equal condition.
TriggerLocation
Trigger location.
Type: u8
Default: 20
Range: 0 - 99
TriggerStat
What statistic to use for triggering.

Type: string
Default: FrameRate
TriggerValue
Value to use for trigger condition.

Type: double
Default: 95
TriggerValueUnitMode
Type of trigger value.

Type: enum
Default: PERCENT_BASELINE
Possible Values:
Value
Description
PERCENT_BASELINE
Percent of baseline as trigger unit.
ABSOLUTE
Absolute value as trigger unit.
KILOBITS_PER_SECOND
Kbps as trigger unit.
MEGABITS_PER_SECOND Mbps as trigger unit.

GIGABITS_PER_SECOND
Gbps as trigger unit.
CreateHighResolutionStreamBlockConfigCommand Read-Only Attributes

Read-Only Attribute
Description

CreateIgmpMldHostProtocolCommand
Description:
This command enables a device to run the IGMP/MLD protocol.

358
CreateIgmpMldQuerierProtocolCommand
CreateIgmpMldHostProtocolCommand Writable Attributes

Writable Attribute
Description
DeviceList
List of emulated devices on which to create IGMP/MLD.

Type: handle
Default: 0
GroupList
Specifies a list of multicast group handles which will be added to the group membership for the specified devices.
Type: handle
Default: 0
Version
Specifies the multicast protocol.

Type: enum
Default: IGMP_V2
Possible Values:
Value
Description
IGMP_V1 Second version (obsoleted IGMPv0) of IGMP, specified in RFC 1112.
IGMP_V2 IGMP version specified in RFC 2236. Improved IGMP version that adds leave messages, shortening the
amount of time required for a router to determine that no stations are in a particular group.
IGMP_V3 Specified in RFC 3376, this major revision of the IGMP protocol adds the ability to specify the source(s) that
a receiver is willing to listen to.
MLD_V1
Initial multicast protocol version for IPv6, similar to IGMPv2. It is specified in RFC 2710.
MLD_V2
Version of MLD, specified in RFC 3810, that adds the "include" and "exclude" filter functionality as in IGMPv3.
CreateIgmpMldHostProtocolCommand Read-Only Attributes

Read-Only Attribute
Description

ReturnList
Object handles to the created IgmpHostConfig/MldHostConfig objects.

Type: handle
Default: 0
CreateIgmpMldQuerierProtocolCommand
Description:
This command enables a device to emulate an IGMP/MLD querier.

CreateIgmpMldQuerierProtocolCommand Writable Attributes

Writable Attribute
Description
DeviceList
List of emulated devices on which to create the IGMP/MLD querier.

Type: handle
Default: 0
359
CreateLogicalPortsCommand
Writable Attribute
Description
Version
Specifies the multicast protocol.

Type: enum
Default: IGMP_V2
Possible Values:
Value
Description
MLD_V1
MLD_V2
CreateIgmpMldQuerierProtocolCommand Read-Only Attributes

Read-Only Attribute
Description

ReturnList
Object handles to the created IgmpRouterConfig/MldRouterConfig objects.

Type: handle
Default: 0
CreateLogicalPortsCommand
Description:
Create one or more logical port.

Parents: Sequencer
CreateLogicalPortsCommand Writable Attributes

Writable Attribute
Description
CreateClassId
Type: classId
Default: 0
CreateCount
Number of ports to create.

Type: u32
Default: 1
NamePrefix
Name prefix for the port.

Type: string
Default: myPort
NameStartNumber
Type: u32
Default: 0
NameSuffix
Name suffix for the port.

Type: string
ParentList
Type: handle
Default: 0
360
CreateMulticastIpv4GroupCommand
Writable Attribute
Description
PhyClassName
Physical media to create for the port(for example, "EthernetCopper").

Type: string
Default: EthernetCopper
CreateLogicalPortsCommand Read-Only Attributes

Read-Only Attribute
Description
ReturnList
Type: handle
Default: 0
Description:
This command creates IPv4 multicast groups that can be used by traffic streams.

CreateMulticastIpv4GroupCommand Writable Attributes

Writable Attribute
Description
GroupCount
Specifies the number of multicast group objects to create.

Type: u32
Default: 1
Range: 1 - 65535
GroupIpStep
Specifies the IpAddress Step per group object. GroupIpStep can be null, which indicates the next multicast
IP should be used.
Type: ip
Default: null
IpCount
Specifies the number of multicast IP addresses in the range.

Type: u32
Default: 1
Range: 1 - 65535
IpStart
Specifies a starting multicast IP address.

Type: ip
Default: 225.0.0.1
IpStep
Specifies a multicast step IP address.

Type: ip
Default: 0.0.0.1
CreateMulticastIpv4GroupCommand Read-Only Attributes

Read-Only Attribute
Description

361
Read-Only Attribute
Description
ReturnList
Object handles to the multicast group blocks.

Type: handle
Default: 0
Description:
This command creates IPv6 multicast groups that can be used by traffic streams.

CreateMulticastIpv6GroupCommand Writable Attributes

Writable Attribute
Description
GroupCount
Specifies the number of multicast group objects to create.

Type: u32
Default: 1
Range: 1 - 65535
GroupIpStep
Specifies the IpAddress Step per group object. GroupIpStep can be null, which indicates the next multicast
IP should be used.
Type: ipv6
Default: null
IpCount
Specifies the number of multicast IP addresses in the range.

Type: u32
Default: 1
Range: 1 - 65535
IpStart
Specifies a starting multicast IP address.

Type: ipv6
Default: ff1e::1
IpStep
Specifies a multicast step IP address.

Type: ipv6
Default: ::1
CreateMulticastIpv6GroupCommand Read-Only Attributes

Read-Only Attribute
Description

ReturnList
Object handles to the multicast group blocks.

Type: handle
Default: 0
362
CreateNetworkIfCommand
CreateNetworkIfCommand
Description:

CreateNetworkIfCommand Writable Attributes

Writable Attribute
Description
Port
Type: handle
Default: 0
CreateNetworkIfCommand Read-Only Attributes

Read-Only Attribute
Description

CreateNewMulticastGroupCommand
Description:
Creates a multicast group membership block.

Parents: Sequencer
CreateNewMulticastGroupCommand Writable Attributes

Writable Attribute
Description
CreateClassId
ID of the class to create.

Type: classId
Default: 0
CreateCount
Number of multicast group memberships to create.

Type: u32
Default: 1
ParentList
List of handles.
Type: handle
Default: 0
CreateNewMulticastGroupCommand Read-Only Attributes

Read-Only Attribute
Description
ReturnList
List of handles created after the command completes.

Type: handle
Default: 0
363
CreateNewMulticastGroupMembershipCommand
CreateNewMulticastGroupMembershipCommand
Description:
Creates a multicast group membership block.

Parents: Sequencer
CreateNewMulticastGroupMembershipCommand Writable Attributes

Writable Attribute
Description
CreateClassId
ID of the class to create.

Type: classId
Default: 0
CreateCount
Number of multicast group memberships to create.

Type: u32
Default: 1
ParentList
List of handles.
Type: handle
Default: 0
CreateNewMulticastGroupMembershipCommand Read-Only Attributes

Read-Only Attribute
Description
ReturnList
List of handles created after the command completes.

Type: handle
Default: 0
CreateNewOptionCommand
Description:

Parents: Sequencer
CreateNewOptionCommand Writable Attributes

Writable Attribute
Description
CreateClassId
Class ID.
Type: classId
Default: 0
CreateCount
Count
Type: u32
Default: 1
ParentList
List of parent handles.

Type: handle
Default: 0
364
CreatePimIpv4GroupsCommand
CreateNewOptionCommand Read-Only Attributes

Read-Only Attribute
Description
ReturnList
List of return handles.

Type: handle
Default: 0
Description:

CreatePimIpv4GroupsCommand Writable Attributes

Writable Attribute
Description
DeviceList
Type: handle
Default: 0
EnablingPruning
Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
FALSE
GroupType
Type: enum
Default: STARG
Possible Values:
Value
Description
STARG
SG
STARSTARRP
JoinSrcAddr
Type: ip
Default: 192.0.1.0
JoinSrcAddrStep
Type: ip
Default: 0.0.0.0
JoinSrcPrefix
Type: u8
Default: 24
Range: 1 - 32
MulticastGroupList
Type: handle
Default: 0
PruneSrcAddr
Type: ip
Default: 192.0.1.0
PruneSrcAddrStep
Type: ip
Default: 0.0.0.0
365
CreatePimIpv4MapCommand
Writable Attribute
Description
PruneSrcPrefix
Type: u8
Default: 24
Range: 1 - 32
RpIpAddr
Type: ip
Default: 192.0.0.1
RpIpAddrStep
Type: ip
Default: 0.0.0.0
CreatePimIpv4GroupsCommand Read-Only Attributes

Read-Only Attribute
Description

PimGroupList
Type: handle
Default: 0
Description:

CreatePimIpv4MapCommand Writable Attributes

Writable Attribute
Description
DeviceList
Type: handle
Default: 0
MulticastGroupList
Type: handle
Default: 0
RpHoldTime
Type: u16
Default: 150
Range: 1 - 65535
RpIpAddr
Type: ip
Default: 192.0.0.1
RpIpAddrStep
Type: ip
Default: 0.0.0.0
RpPriority
Type: u8
Default: 0
366
CreatePimIpv4MapCommand Read-Only Attributes

Read-Only Attribute
Description

PimMapList
Type: handle
Default: 0
Description:

CreatePimIpv6GroupsCommand Writable Attributes

Writable Attribute
Description
DeviceList
Type: handle
Default: 0
EnablingPruning
Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
FALSE
GroupType
Type: enum
Default: STARG
Possible Values:
Value
Description
STARG
SG
STARSTARRP
JoinSrcAddr
Type: ipv6
Default: 2000::1
JoinSrcAddrStep
Type: ipv6
Default: ::
JoinSrcPrefix
Type: u8
Default: 64
Range: 1 - 128
MulticastGroupList
Type: handle
Default: 0
PruneSrcAddr
Type: ipv6
Default: 2000::1
PruneSrcAddrStep
Type: ipv6
Default: ::
367
Writable Attribute
Description
PruneSrcPrefix
Type: u8
Default: 64
Range: 1 - 128
RpIpAddr
Type: ipv6
Default: 2000::1
RpIpAddrStep
Type: ipv6
Default: ::
CreatePimIpv6GroupsCommand Read-Only Attributes

Read-Only Attribute
Description

PimGroupList
Type: handle
Default: 0
Description:

CreatePimIpv6MapCommand Writable Attributes

Writable Attribute
Description
DeviceList
Type: handle
Default: 0
MulticastGroupList
Type: handle
Default: 0
RpHoldTime
Type: u16
Default: 150
Range: 1 - 65535
RpIpAddr
Type: ipv6
Default: 2000::1
RpIpAddrStep
Type: ipv6
Default: ::
RpPriority
Type: u8
Default: 0
368
CreatePosPhyCommand
CreatePimIpv6MapCommand Read-Only Attributes

Read-Only Attribute
Description

PimMapList
Type: handle
Default: 0
CreatePosPhyCommand
Description:

Parents: Sequencer
CreatePosPhyCommand Writable Attributes

Writable Attribute
Description
CreateClassId
Type: classId
Default: 0
CreateCount
Type: u32
Default: 1
ParentList
Type: handle
Default: 0
Port
Type: handle
Default: 0
CreatePosPhyCommand Read-Only Attributes

Read-Only Attribute
Description
ReturnList
Type: handle
Default: 0
CreatorCommand
Description:
Creates multiple objects at the same time. This command object does the same thing as the create function, except that with this command object you can
create multiple child objects under multiple parent objects with one command.

369
cred
CreatorCommand Writable Attributes

Writable Attribute
Description
CreateClassId
The name of the type of object to create. Examples: Port, Host, Ipv4If.
Type: classId
Default: 0
CreateCount
The number of objects to create under each parent object. You specify the parent object or objects with the
ParentList attribute.
Type: u32
Default: 1
ParentList
A list of the handles of the parent objects to create objects under. There can be one or more handles. If you
specify just one, all objects will be created under that object.
Type: handle
Default: 0
CreatorCommand Read-Only Attributes

Read-Only Attribute
Description

ReturnList
A list of the newly-created objects.

Type: handle
Default: 0
cred
Description:
Parents: CallBody, CallBody, AcceptedReply
Children: body
cred Attributes
Attribute
Description
flavor
Type: AuthFlavor
Default: 0
Possible Values:
Value Description
Name
AUTH_NONE
AUTH_SYS
AUTH_SHORT
AUTH_DH
RPCSEC_GSS
information.
Type: string
370
CSMachineStats
CSMachineStats
Description:
Hardware information on the Spirent TestCenter LS. This object is automatically created. To access this object, you must be connected to a Spirent TestCenter
LS (use CSServerConnectCommand). You can get the handle of this object by querying its parent CSServer object.

Parents: CSServer
CSMachineStats Writable Attributes

CSMachineStats Read-Only Attributes

Read-Only Attribute
Description
CpuUsagePercent
Percentage of CPU capacity in use.

Type: double
Default: 0.0
PhysicalMemoryUsagePercent
Percentage of memory in use.

Type: double
Default: 0.0
TotalPhysicalMemory
Total memory installed.

Type: double
Default: 0.0
CSProcessStats
Description:
If this object is a child of a CSServer object, it shows statistics for the LS server process. If it is a child of a CSTestSession object, it shows statistics for the
test session process.
This object is automatically created. To access this object, you must be connected to a Spirent TestCenter LS (use CSServerConnectCommand). You can
get the handle of this object by querying its parent object.

Parents: CSServer, CSTestSession
CSProcessStats Writable Attributes

CSProcessStats Read-Only Attributes

Read-Only Attribute
Description
CpuUsagePercent
Percentage of CPU capacity in use for this process.

Type: double
Default: 0.0
PhysicalMemoryUsagePercent
Percentage of memory in use for this process.

Type: double
Default: 0.0
371
csrc
csrc
Description:
Parents: RtpHeader
Children: CSRC
csrc Attributes
Attribute
Description
Name
information.
Type: string
CSRC
Description:
Parents: csrc
Children: None
CSRC Attributes
Attribute
Description
csrc
Type: OCTETSTRING
Default: 00000000
Name
information.
Type: string
CSServer
Description:
Gives information on the management software on the Spirent TestCenter LS. To access this object, you must be connected to a Spirent TestCenter LS (use
CSServerConnectCommand).
You can get information on test sessions by accessing the child CSTestSession objects.

Children: CSMachineStats, CSProcessStats, CSTestSession
CSServer Writable Attributes

Writable Attribute
Description
Active, Name
372
CSServerConnectCommand
CSServer Read-Only Attributes

Read-Only Attribute
Description
FileTransferPort
The TCP port used by the FTP daemon.

Type: u32
Default: 40007
Host
The IP address or DNS name of the Spirent TestCenter LS.

Type: string
Port
The port being used by the LS process.

Type: u32
Default: 40006
SessionRootDirectory
A relative directory to the base work directory on the LS. Files generated by the LS will be placed here. Also, all
the test sessions managed by this LS will write files to their own subdirectories under here.
Type: string
CSServerConnectCommand
Description:
Connect to a Spirent TestCenter LS. You have to do this before you can access the following objects: CSServer, CSMachineStats, CSProcessStats,
CSTestSession.

CSServerConnectCommand Writable Attributes

Writable Attribute
Description
Host
The IPv4 address or DNS name of the Spirent TestCenter LS.

Type: string
Default: localhost
CSServerConnectCommand Read-Only Attributes

CSServerDisconnectCommand
Description:
Disconnect the current Spirent TestCenter LS connection.

CSServerDisconnectCommand Writable Attributes

373
CSSynchronizeFilesCommand
CSServerDisconnectCommand Read-Only Attributes

CSSynchronizeFilesCommand
Description:
Copy test session files from the Spirent TestCenter LS to the client PC. The command will use the settings of the TestResultSetting object, which you can use
to specify the results directory.
Some command objects automatically copy files to the client PC when they complete, without using this command. These command objects have an attribute
whose type is outputFilePath. Example: SaveAsTclCommand and its FileName attribute. However, if the file was created while the Sequencer was running,
or while the client was disconnected, you will need to use CSSynchronizeFilesCommand to download the file.

CSSynchronizeFilesCommand Writable Attributes

Writable Attribute
Description
DefaultDownloadDir
The directory to copy files to on the client PC when the command cannot find a directory on the client PC that corresponds
to the directory on the Spirent TestCenter LS. This could happen, for example, if the files were saved to an absolute path
on the D drive on the Spirent TestCenter LS, but the client PC does not have a D drive.
On Windows, the default user working directory is usually C:\Documents and Settings\user-id, where user-id is your
Windows user ID. On Linux this is usually /home/user-id.
Type: string
Default: User working directory
CSSynchronizeFilesCommand Read-Only Attributes

CSTestSession
Description:
Gives information on a test session on a Spirent TestCenter LS. You create this object on the LS with CSTestSessionConnectCommand.
This command is available only when the client is connected to a Spirent TestCenter LS (use CSServerConnectCommand).

Parents: CSServer
Children: CSProcessStats
CSTestSession Writable Attributes

Writable Attribute
Description
Active, Name
374
CSTestSessionConnectCommand
CSTestSession Read-Only Attributes

Read-Only Attribute
Description
DetailStatus
Detailed status of the test session.

Type: string
Host
The IP address of the Spirent TestCenter LS.

Type: string
OwnerId
The user ID of the user who created this test session.

Type: string
Port
The port used by this test session to communicate to the client.

Type: u32
Default: 40008
ProcessId
The process ID of the test session process.

Type: s32
Default: 0
SessionDirectory
The directory on the Spirent TestCenter LS where files generated by this test session are written.
Type: string
TestSessionState
The state of the test session.

Type: enum
Default: NONE
Possible Values:
Value
Description
NONE
None.
STARTING
Starting.
SEQUENCER_IDLE
Sequencer is idle.
SEQUENCER_RUNNING Sequencer is running.
Version
TERMINATING
Test process is terminating.
TERMINATED
Test process has terminated.
UNKNOWN_ERROR
Unknown or internal error.
The version of Spirent TestCenter being used.

Type: string
CSTestSessionConnectCommand
Description:
Creates a new test session on the Spirent TestCenter LS and connects to it, or connects to an existing test session on the LS. The automation client will
connect as a controller, not as a viewer.
NOTE: An automation client must always be the controller on a test session. It cannot be a viewer. If another client is already the controller on a test session,
this command will fail.
Tcl examples:
Create a new test session and connect to the test session (uses default TestSessionName and OwnerId):
stc::perform CSTestSessionConnectCommand -Host 1.1.1.1 -CreateNewTestSession TRUE
Connect to an existing test session when you have its handle:
stc::perform CSTestSessionConnectCommand -Host 1.1.1.1 -TestSession $csTestSessionHandle
Connect to an existing test session when you know its name and its owner's ID:
stc::perform CSTestSessionConnectCommand -Host 1.1.1.1 -TestSessionName MySession -OwnerId MyId
375
CSTestSessionDisconnectCommand

CSTestSessionConnectCommand Writable Attributes

Writable Attribute
Description
CreateNewTestSession
Whether to create a new test session on the Spirent TestCenter LS.

Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
Create a new test session that uses the name specified by the TestSessionName attribute. If nothing is specified
for TestSessionName, the session will be named AutoCreatedSession_XX, where XX is the lowest decimal number
that results in a unique test session name on the LS.
When you create a new test session, it creates a new CSTestSession object on the LS, and then starts the test
session.
FALSE Do not create a new test session.

Host
The IPv4 address or DNS name of the Spirent TestCenter LS.

Type: string
Default: localhost
OwnerId
If the CreateNewTestSession attribute is FALSE, this must match the user ID of the user that created the test session. This
is the OwnerId attribute of the CSTestSession object.
If CreateNewTestSession is TRUE, this attribute will become the OwnerId attribute of the new CSTestSession object.
Type: string
Default: Current user's user ID
TestSession
The handle of an existing CSTestSession object on the Spirent TestCenter LS. To get this handle you must query the Spirent
TestCenter LS.
This attribute is ignored if CreateNewTestSession is TRUE.
Type: handle
Default: 0
TestSessionName
If the CreateNewTestSession attribute is FALSE, the command will attempt to connect to a test session of this name on the
LS.
If CreateNewTestSession is TRUE, the command will create a new test session of this name. If another test session with the
same name already exists, the command will fail.
Type: string
CSTestSessionConnectCommand Read-Only Attributes

CSTestSessionDisconnectCommand
Description:
Disconnect from a test session. If you want to re-connect to the test session later, leave the Terminate attribute at its default setting.

376
ctags
CSTestSessionDisconnectCommand Writable Attributes

Writable Attribute
Description
Terminate
Whether to terminate the test session when disconnecting.

Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
Terminate the test session when disconnecting.

WARNING: If you terminate the test session, all files associated with the test session will be deleted from the LS.
Make sure you have downloaded them before you terminate the test session, if you want them. Use
CSSynchronizeFilesCommand.
FALSE Disconnect without terminating the test session.
CSTestSessionDisconnectCommand Read-Only Attributes

ctags
Description:
Parents: TagList
Children: None
ctags Attributes
Attribute
Description
CFI
Type: BITSTRING
Default: 0
Name
more information.
Type: string
PCP
Type: BITSTRING
Default: 000
Type
Type: OCTETSTRING
Default: 8100
VID
Type: INTEGER
Default: 0
ctIuPreamble (overloaded)
ctIuPreamble (fc) - Object definition for the following paths:
StreamBlock.FCoE.fc.fcPayloads.FCPayload-Choice.gsRequestWithPortIdentifier.ctIuPreamble
StreamBlock.FCoE.fc.fcPayloads.FCPayload-Choice.gaNxtAccept.ctIuPreamble
StreamBlock.FCoE.fc.fcPayloads.FCPayload-Choice.gpnIdAccept.ctIuPreamble
StreamBlock.FCoE.fc.fcPayloads.FCPayload-Choice.gnnIdAccept.ctIuPreamble
StreamBlock.FCoE.fc.fcPayloads.FCPayload-Choice.gcsIdAccept.ctIuPreamble
StreamBlock.FCoE.fc.fcPayloads.FCPayload-Choice.gftIdAccept.ctIuPreamble
StreamBlock.FCoE.fc.fcPayloads.FCPayload-Choice.gspnIdAccept.ctIuPreamble
377
ctIuPreamble
StreamBlock.FCoE.fc.fcPayloads.FCPayload-Choice.gptIdAccept.ctIuPreamble
StreamBlock.FCoE.fc.fcPayloads.FCPayload-Choice.gfpnIdAccept.ctIuPreamble
StreamBlock.FCoE.fc.fcPayloads.FCPayload-Choice.gffIdAccept.ctIuPreamble
StreamBlock.FCoE.fc.fcPayloads.FCPayload-Choice.gsRequestWithPortName.ctIuPreamble
StreamBlock.FCoE.fc.fcPayloads.FCPayload-Choice.gidPnAccept.ctIuPreamble
StreamBlock.FCoE.fc.fcPayloads.FCPayload-Choice.gsRequestWithNodeName.ctIuPreamble
StreamBlock.FCoE.fc.fcPayloads.FCPayload-Choice.gidNnAccept.ctIuPreamble
StreamBlock.FCoE.fc.fcPayloads.FCPayload-Choice.gsnnNnAccept.ctIuPreamble
StreamBlock.FCoE.fc.fcPayloads.FCPayload-Choice.gsRequestWithFc4Type.ctIuPreamble
StreamBlock.FCoE.fc.fcPayloads.FCPayload-Choice.gidFtAccept.ctIuPreamble
StreamBlock.FCoE.fc.fcPayloads.FCPayload-Choice.gpnFtAccept.ctIuPreamble
StreamBlock.FCoE.fc.fcPayloads.FCPayload-Choice.gnnFtAccept.ctIuPreamble
StreamBlock.FCoE.fc.fcPayloads.FCPayload-Choice.gsRequestWithPortType.ctIuPreamble
StreamBlock.FCoE.fc.fcPayloads.FCPayload-Choice.gidPtAccept.ctIuPreamble
StreamBlock.FCoE.fc.fcPayloads.FCPayload-Choice.gsAccept.ctIuPreamble
StreamBlock.FCoE.fc.fcPayloads.FCPayload-Choice.rpnId.ctIuPreamble
StreamBlock.FCoE.fc.fcPayloads.FCPayload-Choice.rnnId.ctIuPreamble
StreamBlock.FCoE.fc.fcPayloads.FCPayload-Choice.rcsId.ctIuPreamble
StreamBlock.FCoE.fc.fcPayloads.FCPayload-Choice.rftId.ctIuPreamble
StreamBlock.FCoE.fc.fcPayloads.FCPayload-Choice.rptId.ctIuPreamble
StreamBlock.FCoE.fc.fcPayloads.FCPayload-Choice.rspnId.ctIuPreamble
StreamBlock.FCoE.fc.fcPayloads.FCPayload-Choice.rffId.ctIuPreamble
StreamBlock.FCoE.fc.fcPayloads.FCPayload-Choice.rsnnNn.ctIuPreamble
StreamBlock.FCoE.fc.fcPayloads.FCPayload-Choice.daId.ctIuPreamble
StreamBlock.FCoE.fc.fcPayloads.FCPayload-Choice.gtin.ctIuPreamble
StreamBlock.FCoE.fc.fcPayloads.FCPayload-Choice.gtinAccept.ctIuPreamble
StreamBlock.FCoE.fc.fcPayloads.FCPayload-Choice.giel.ctIuPreamble
StreamBlock.FCoE.fc.fcPayloads.FCPayload-Choice.gielAccept.ctIuPreamble
StreamBlock.FCoE.fc.fcPayloads.FCPayload-Choice.gsRequestWithInterconnectElementName.ctIuPreamble
StreamBlock.FCoE.fc.fcPayloads.FCPayload-Choice.gietAccept.ctIuPreamble
StreamBlock.FCoE.fc.fcPayloads.FCPayload-Choice.gdidAccept.ctIuPreamble
StreamBlock.FCoE.fc.fcPayloads.FCPayload-Choice.gmidAccept.ctIuPreamble
StreamBlock.FCoE.fc.fcPayloads.FCPayload-Choice.gfnAccept.ctIuPreamble
StreamBlock.FCoE.fc.fcPayloads.FCPayload-Choice.gielnAccept.ctIuPreamble
StreamBlock.FCoE.fc.fcPayloads.FCPayload-Choice.gmalAccept.ctIuPreamble
StreamBlock.FCoE.fc.fcPayloads.FCPayload-Choice.gieilAccept.ctIuPreamble
StreamBlock.FCoE.fc.fcPayloads.FCPayload-Choice.gplAccept.ctIuPreamble
StreamBlock.FCoE.fc.fcPayloads.FCPayload-Choice.gptAccept.ctIuPreamble
StreamBlock.FCoE.fc.fcPayloads.FCPayload-Choice.gppnAccept.ctIuPreamble
StreamBlock.FCoE.fc.fcPayloads.FCPayload-Choice.gapnlAccept.ctIuPreamble
StreamBlock.FCoE.fc.fcPayloads.FCPayload-Choice.gpsAccept.ctIuPreamble
StreamBlock.FCoE.fc.fcPayloads.FCPayload-Choice.gpscAccept.ctIuPreamble
StreamBlock.FCoE.fc.fcPayloads.FCPayload-Choice.gatin.ctIuPreamble
StreamBlock.FCoE.fc.fcPayloads.FCPayload-Choice.gatinAccept.ctIuPreamble
StreamBlock.FCoE.fc.fcPayloads.FCPayload-Choice.gsesAccept.ctIuPreamble
StreamBlock.FCoE.fc.fcPayloads.FCPayload-Choice.gsRequestWithPlatformName.ctIuPreamble
StreamBlock.FCoE.fc.fcPayloads.FCPayload-Choice.gplnlAccept.ctIuPreamble
StreamBlock.FCoE.fc.fcPayloads.FCPayload-Choice.gpltAccept.ctIuPreamble
StreamBlock.FCoE.fc.fcPayloads.FCPayload-Choice.gplmlAccept.ctIuPreamble
StreamBlock.FCoE.fc.fcPayloads.FCPayload-Choice.gpabAccept.ctIuPreamble
StreamBlock.FCoE.fc.fcPayloads.FCPayload-Choice.gnpl.ctIuPreamble
StreamBlock.FCoE.fc.fcPayloads.FCPayload-Choice.gnplAccept.ctIuPreamble
StreamBlock.FCoE.fc.fcPayloads.FCPayload-Choice.gpnl.ctIuPreamble
StreamBlock.FCoE.fc.fcPayloads.FCPayload-Choice.gpnlAccept.ctIuPreamble
StreamBlock.FCoE.fc.fcPayloads.FCPayload-Choice.gpfcpAccept.ctIuPreamble
StreamBlock.FCoE.fc.fcPayloads.FCPayload-Choice.gpliAccept.ctIuPreamble
StreamBlock.FCoE.fc.fcPayloads.FCPayload-Choice.gnid.ctIuPreamble
StreamBlock.FCoE.fc.fcPayloads.FCPayload-Choice.gnidAccept.ctIuPreamble
StreamBlock.FCoE.fc.fcPayloads.FCPayload-Choice.rieln.ctIuPreamble
StreamBlock.FCoE.fc.fcPayloads.FCPayload-Choice.rpl.ctIuPreamble
StreamBlock.FCoE.fc.fcPayloads.FCPayload-Choice.rpln.ctIuPreamble
StreamBlock.FCoE.fc.fcPayloads.FCPayload-Choice.rplt.ctIuPreamble
StreamBlock.FCoE.fc.fcPayloads.FCPayload-Choice.rplm.ctIuPreamble
StreamBlock.FCoE.fc.fcPayloads.FCPayload-Choice.rpab.ctIuPreamble
StreamBlock.FCoE.fc.fcPayloads.FCPayload-Choice.rpfcp.ctIuPreamble
StreamBlock.FCoE.fc.fcPayloads.FCPayload-Choice.rpli.ctIuPreamble
StreamBlock.FCoE.fc.fcPayloads.FCPayload-Choice.dpl.ctIuPreamble
StreamBlock.FCoE.fc.fcPayloads.FCPayload-Choice.dpln.ctIuPreamble
StreamBlock.FCoE.fc.fcPayloads.FCPayload-Choice.dplm.ctIuPreamble
StreamBlock.FCoE.fc.fcPayloads.FCPayload-Choice.gsDeregisterWithPlatformName.ctIuPreamble
StreamBlock.FCoE.fc.fcPayloads.FCPayload-Choice.dpall.ctIuPreamble
StreamBlock.FCoE.fc.fcPayloads.FCPayload-Choice.ftr.ctIuPreamble
StreamBlock.FCoE.fc.fcPayloads.FCPayload-Choice.ftrAccept.ctIuPreamble
StreamBlock.FCoE.fc.fcPayloads.FCPayload-Choice.fpng.ctIuPreamble
StreamBlock.FCoE.fc.fcPayloads.FCPayload-Choice.fpngAccept.ctIuPreamble
ctIuPreamble (fc) - Object definition for the following paths:
StreamBlock.FCoE.fc.fcPayloads.FCPayload-Choice.gsReject.ctIuPreamble
ctIuPreamble (fcgs) - Object definition for the following paths:
378
ctIuPreamble
StreamBlock.GsRequestWithPortIdentifier.ctIuPreamble
StreamBlock.GaNxtAccept.ctIuPreamble
StreamBlock.GpnIdAccept.ctIuPreamble
StreamBlock.GnnIdAccept.ctIuPreamble
StreamBlock.GcsIdAccept.ctIuPreamble
StreamBlock.GftIdAccept.ctIuPreamble
StreamBlock.GspnIdAccept.ctIuPreamble
StreamBlock.GptIdAccept.ctIuPreamble
StreamBlock.GfpnIdAccept.ctIuPreamble
StreamBlock.GffIdAccept.ctIuPreamble
StreamBlock.GsRequestWithPortName.ctIuPreamble
StreamBlock.GidPnAccept.ctIuPreamble
StreamBlock.GsRequestWithNodeName.ctIuPreamble
StreamBlock.GidNnAccept.ctIuPreamble
StreamBlock.GsnnNnAccept.ctIuPreamble
StreamBlock.GsRequestWithFc4Type.ctIuPreamble
StreamBlock.GidFtAccept.ctIuPreamble
StreamBlock.GpnFtAccept.ctIuPreamble
StreamBlock.GnnFtAccept.ctIuPreamble
StreamBlock.GsRequestWithPortType.ctIuPreamble
StreamBlock.GidPtAccept.ctIuPreamble
StreamBlock.GsAccept.ctIuPreamble
StreamBlock.RpnId.ctIuPreamble
StreamBlock.RnnId.ctIuPreamble
StreamBlock.RcsId.ctIuPreamble
StreamBlock.RftId.ctIuPreamble
StreamBlock.RptId.ctIuPreamble
StreamBlock.RspnId.ctIuPreamble
StreamBlock.RffId.ctIuPreamble
StreamBlock.RsnnNn.ctIuPreamble
StreamBlock.DaId.ctIuPreamble
StreamBlock.Gtin.ctIuPreamble
StreamBlock.GtinAccept.ctIuPreamble
StreamBlock.Giel.ctIuPreamble
StreamBlock.GielAccept.ctIuPreamble
StreamBlock.GsRequestWithInterconnectElementName.ctIuPreamble
StreamBlock.GietAccept.ctIuPreamble
StreamBlock.GdidAccept.ctIuPreamble
StreamBlock.GmidAccept.ctIuPreamble
StreamBlock.GfnAccept.ctIuPreamble
StreamBlock.GielnAccept.ctIuPreamble
StreamBlock.GmalAccept.ctIuPreamble
StreamBlock.GieilAccept.ctIuPreamble
StreamBlock.GplAccept.ctIuPreamble
StreamBlock.GptAccept.ctIuPreamble
StreamBlock.GppnAccept.ctIuPreamble
StreamBlock.GapnlAccept.ctIuPreamble
StreamBlock.GpsAccept.ctIuPreamble
StreamBlock.GpscAccept.ctIuPreamble
StreamBlock.Gatin.ctIuPreamble
StreamBlock.GatinAccept.ctIuPreamble
StreamBlock.GsesAccept.ctIuPreamble
StreamBlock.GsRequestWithPlatformName.ctIuPreamble
StreamBlock.GplnlAccept.ctIuPreamble
StreamBlock.GpltAccept.ctIuPreamble
StreamBlock.GplmlAccept.ctIuPreamble
StreamBlock.GpabAccept.ctIuPreamble
StreamBlock.Gnpl.ctIuPreamble
StreamBlock.GnplAccept.ctIuPreamble
StreamBlock.Gpnl.ctIuPreamble
StreamBlock.GpnlAccept.ctIuPreamble
StreamBlock.GpfcpAccept.ctIuPreamble
StreamBlock.GpliAccept.ctIuPreamble
StreamBlock.Gnid.ctIuPreamble
StreamBlock.GnidAccept.ctIuPreamble
StreamBlock.Rieln.ctIuPreamble
StreamBlock.Rpl.ctIuPreamble
StreamBlock.Rpln.ctIuPreamble
StreamBlock.Rplt.ctIuPreamble
StreamBlock.Rplm.ctIuPreamble
StreamBlock.Rpab.ctIuPreamble
StreamBlock.Rpfcp.ctIuPreamble
StreamBlock.Rpli.ctIuPreamble
StreamBlock.Dpl.ctIuPreamble
StreamBlock.Dpln.ctIuPreamble
StreamBlock.Dplm.ctIuPreamble
StreamBlock.GsDeregisterWithPlatformName.ctIuPreamble
StreamBlock.Dpall.ctIuPreamble
StreamBlock.Ftr.ctIuPreamble
379
ctIuPreamble
StreamBlock.FtrAccept.ctIuPreamble
StreamBlock.Fpng.ctIuPreamble
StreamBlock.FpngAccept.ctIuPreamble
ctIuPreamble (fcgs) - Object definition for the following paths:
StreamBlock.GsReject.ctIuPreamble
ctIuPreamble Object (fc PDU library)

Description:
Parents: gsRequestWithPortIdentifier (StreamBlock.FCoE.fc.fcPayloads.FCPayload-Choice.gsRequestWithPortIdentifier)

gaNxtAccept (StreamBlock.FCoE.fc.fcPayloads.FCPayload-Choice.gaNxtAccept)
gpnIdAccept (StreamBlock.FCoE.fc.fcPayloads.FCPayload-Choice.gpnIdAccept)
gnnIdAccept (StreamBlock.FCoE.fc.fcPayloads.FCPayload-Choice.gnnIdAccept)
gcsIdAccept (StreamBlock.FCoE.fc.fcPayloads.FCPayload-Choice.gcsIdAccept)
gftIdAccept (StreamBlock.FCoE.fc.fcPayloads.FCPayload-Choice.gftIdAccept)
gspnIdAccept (StreamBlock.FCoE.fc.fcPayloads.FCPayload-Choice.gspnIdAccept)
gptIdAccept (StreamBlock.FCoE.fc.fcPayloads.FCPayload-Choice.gptIdAccept)
gfpnIdAccept (StreamBlock.FCoE.fc.fcPayloads.FCPayload-Choice.gfpnIdAccept)
gffIdAccept (StreamBlock.FCoE.fc.fcPayloads.FCPayload-Choice.gffIdAccept)
gsRequestWithPortName (StreamBlock.FCoE.fc.fcPayloads.FCPayload-Choice.gsRequestWithPortName)
gidPnAccept (StreamBlock.FCoE.fc.fcPayloads.FCPayload-Choice.gidPnAccept)
gsRequestWithNodeName (StreamBlock.FCoE.fc.fcPayloads.FCPayload-Choice.gsRequestWithNodeName)
gidNnAccept (StreamBlock.FCoE.fc.fcPayloads.FCPayload-Choice.gidNnAccept)
gsnnNnAccept (StreamBlock.FCoE.fc.fcPayloads.FCPayload-Choice.gsnnNnAccept)
gsRequestWithFc4Type (StreamBlock.FCoE.fc.fcPayloads.FCPayload-Choice.gsRequestWithFc4Type)
gidFtAccept (StreamBlock.FCoE.fc.fcPayloads.FCPayload-Choice.gidFtAccept)
gpnFtAccept (StreamBlock.FCoE.fc.fcPayloads.FCPayload-Choice.gpnFtAccept)
gnnFtAccept (StreamBlock.FCoE.fc.fcPayloads.FCPayload-Choice.gnnFtAccept)
gsRequestWithPortType (StreamBlock.FCoE.fc.fcPayloads.FCPayload-Choice.gsRequestWithPortType)
gidPtAccept (StreamBlock.FCoE.fc.fcPayloads.FCPayload-Choice.gidPtAccept)
gsAccept (StreamBlock.FCoE.fc.fcPayloads.FCPayload-Choice.gsAccept)
rpnId (StreamBlock.FCoE.fc.fcPayloads.FCPayload-Choice.rpnId)
rnnId (StreamBlock.FCoE.fc.fcPayloads.FCPayload-Choice.rnnId)
rcsId (StreamBlock.FCoE.fc.fcPayloads.FCPayload-Choice.rcsId)
rftId (StreamBlock.FCoE.fc.fcPayloads.FCPayload-Choice.rftId)
rptId (StreamBlock.FCoE.fc.fcPayloads.FCPayload-Choice.rptId)
rspnId (StreamBlock.FCoE.fc.fcPayloads.FCPayload-Choice.rspnId)
rffId (StreamBlock.FCoE.fc.fcPayloads.FCPayload-Choice.rffId)
rsnnNn (StreamBlock.FCoE.fc.fcPayloads.FCPayload-Choice.rsnnNn)
daId (StreamBlock.FCoE.fc.fcPayloads.FCPayload-Choice.daId)
gtin (StreamBlock.FCoE.fc.fcPayloads.FCPayload-Choice.gtin)
gtinAccept (StreamBlock.FCoE.fc.fcPayloads.FCPayload-Choice.gtinAccept)
giel (StreamBlock.FCoE.fc.fcPayloads.FCPayload-Choice.giel)
gielAccept (StreamBlock.FCoE.fc.fcPayloads.FCPayload-Choice.gielAccept)
gsRequestWithInterconnectElementName (StreamBlock.FCoE.fc.fcPayloads.FCPayload-Choice.gsRequestWithInterconnectElementName)
gietAccept (StreamBlock.FCoE.fc.fcPayloads.FCPayload-Choice.gietAccept)
gdidAccept (StreamBlock.FCoE.fc.fcPayloads.FCPayload-Choice.gdidAccept)
gmidAccept (StreamBlock.FCoE.fc.fcPayloads.FCPayload-Choice.gmidAccept)
gfnAccept (StreamBlock.FCoE.fc.fcPayloads.FCPayload-Choice.gfnAccept)
gielnAccept (StreamBlock.FCoE.fc.fcPayloads.FCPayload-Choice.gielnAccept)
gmalAccept (StreamBlock.FCoE.fc.fcPayloads.FCPayload-Choice.gmalAccept)
gieilAccept (StreamBlock.FCoE.fc.fcPayloads.FCPayload-Choice.gieilAccept)
gplAccept (StreamBlock.FCoE.fc.fcPayloads.FCPayload-Choice.gplAccept)
gptAccept (StreamBlock.FCoE.fc.fcPayloads.FCPayload-Choice.gptAccept)
gppnAccept (StreamBlock.FCoE.fc.fcPayloads.FCPayload-Choice.gppnAccept)
gapnlAccept (StreamBlock.FCoE.fc.fcPayloads.FCPayload-Choice.gapnlAccept)
gpsAccept (StreamBlock.FCoE.fc.fcPayloads.FCPayload-Choice.gpsAccept)
gpscAccept (StreamBlock.FCoE.fc.fcPayloads.FCPayload-Choice.gpscAccept)
gatin (StreamBlock.FCoE.fc.fcPayloads.FCPayload-Choice.gatin)
gatinAccept (StreamBlock.FCoE.fc.fcPayloads.FCPayload-Choice.gatinAccept)
gsesAccept (StreamBlock.FCoE.fc.fcPayloads.FCPayload-Choice.gsesAccept)
gsRequestWithPlatformName (StreamBlock.FCoE.fc.fcPayloads.FCPayload-Choice.gsRequestWithPlatformName)
gplnlAccept (StreamBlock.FCoE.fc.fcPayloads.FCPayload-Choice.gplnlAccept)
gpltAccept (StreamBlock.FCoE.fc.fcPayloads.FCPayload-Choice.gpltAccept)
gplmlAccept (StreamBlock.FCoE.fc.fcPayloads.FCPayload-Choice.gplmlAccept)
gpabAccept (StreamBlock.FCoE.fc.fcPayloads.FCPayload-Choice.gpabAccept)
gnpl (StreamBlock.FCoE.fc.fcPayloads.FCPayload-Choice.gnpl)
gnplAccept (StreamBlock.FCoE.fc.fcPayloads.FCPayload-Choice.gnplAccept)
380
ctIuPreamble
gpnl (StreamBlock.FCoE.fc.fcPayloads.FCPayload-Choice.gpnl)
gpnlAccept (StreamBlock.FCoE.fc.fcPayloads.FCPayload-Choice.gpnlAccept)
gpfcpAccept (StreamBlock.FCoE.fc.fcPayloads.FCPayload-Choice.gpfcpAccept)
gpliAccept (StreamBlock.FCoE.fc.fcPayloads.FCPayload-Choice.gpliAccept)
gnid (StreamBlock.FCoE.fc.fcPayloads.FCPayload-Choice.gnid)
gnidAccept (StreamBlock.FCoE.fc.fcPayloads.FCPayload-Choice.gnidAccept)
rieln (StreamBlock.FCoE.fc.fcPayloads.FCPayload-Choice.rieln)
rpl (StreamBlock.FCoE.fc.fcPayloads.FCPayload-Choice.rpl)
rpln (StreamBlock.FCoE.fc.fcPayloads.FCPayload-Choice.rpln)
rplt (StreamBlock.FCoE.fc.fcPayloads.FCPayload-Choice.rplt)
rplm (StreamBlock.FCoE.fc.fcPayloads.FCPayload-Choice.rplm)
rpab (StreamBlock.FCoE.fc.fcPayloads.FCPayload-Choice.rpab)
rpfcp (StreamBlock.FCoE.fc.fcPayloads.FCPayload-Choice.rpfcp)
rpli (StreamBlock.FCoE.fc.fcPayloads.FCPayload-Choice.rpli)
dpl (StreamBlock.FCoE.fc.fcPayloads.FCPayload-Choice.dpl)
dpln (StreamBlock.FCoE.fc.fcPayloads.FCPayload-Choice.dpln)
dplm (StreamBlock.FCoE.fc.fcPayloads.FCPayload-Choice.dplm)
gsDeregisterWithPlatformName (StreamBlock.FCoE.fc.fcPayloads.FCPayload-Choice.gsDeregisterWithPlatformName)
dpall (StreamBlock.FCoE.fc.fcPayloads.FCPayload-Choice.dpall)
ftr (StreamBlock.FCoE.fc.fcPayloads.FCPayload-Choice.ftr)
ftrAccept (StreamBlock.FCoE.fc.fcPayloads.FCPayload-Choice.ftrAccept)
fpng (StreamBlock.FCoE.fc.fcPayloads.FCPayload-Choice.fpng)
fpngAccept (StreamBlock.FCoE.fc.fcPayloads.FCPayload-Choice.fpngAccept)
Children: None
ctIuPreamble Attributes
Attribute
Description
commandRespondCode
Type: OCTETSTRING
Default: 0000
fragmentId
Type: OCTETSTRING
Default: 00
gsSubType
Type: OCTETSTRING
Default: 02
gsType
Type: OCTETSTRING
Default: FC
inId
Type: OCTETSTRING
Default: 000000
maximumResidualSize
Type: OCTETSTRING
Default: 0000
Name
Type: string
options
Type: OCTETSTRING
Default: 00
reserved
Type: OCTETSTRING
Default: 00
reserved
Type: OCTETSTRING
Default: 000000
revision
Type: OCTETSTRING
Default: 01
381
ctIuPreamble
ctIuPreamble Object (fc PDU library)

Description:
Parents: gsReject (StreamBlock.FCoE.fc.fcPayloads.FCPayload-Choice.gsReject)

Children: None
Attribute
Description
commandRespondCode
Type: OCTETSTRING
Default: 8001
fragmentId
Type: OCTETSTRING
Default: 00
gsSubType
Type: OCTETSTRING
Default: 02
gsType
Type: OCTETSTRING
Default: FC
inId
Type: OCTETSTRING
Default: 000000
maximumResidualSize
Type: OCTETSTRING
Default: 0000
Name
Type: string
options
Type: OCTETSTRING
Default: 00
reasonCode
Type: OCTETSTRING
Default: 00
reasonCodeExplanation
Type: OCTETSTRING
Default: 00
reserved
Type: OCTETSTRING
Default: 00
revision
Type: OCTETSTRING
Default: 01
vendorSpecific
Type: OCTETSTRING
Default: 00
ctIuPreamble Object (fcgs PDU library)

Description:
Parents: gsRequestWithPortIdentifier (StreamBlock.GsRequestWithPortIdentifier)

gaNxtAccept (StreamBlock.GaNxtAccept)
gpnIdAccept (StreamBlock.GpnIdAccept)
gnnIdAccept (StreamBlock.GnnIdAccept)
gcsIdAccept (StreamBlock.GcsIdAccept)
382
ctIuPreamble
gftIdAccept (StreamBlock.GftIdAccept)
gspnIdAccept (StreamBlock.GspnIdAccept)
gptIdAccept (StreamBlock.GptIdAccept)
gfpnIdAccept (StreamBlock.GfpnIdAccept)
gffIdAccept (StreamBlock.GffIdAccept)
gsRequestWithPortName (StreamBlock.GsRequestWithPortName)
gidPnAccept (StreamBlock.GidPnAccept)
gsRequestWithNodeName (StreamBlock.GsRequestWithNodeName)
gidNnAccept (StreamBlock.GidNnAccept)
gsnnNnAccept (StreamBlock.GsnnNnAccept)
gsRequestWithFc4Type (StreamBlock.GsRequestWithFc4Type)
gidFtAccept (StreamBlock.GidFtAccept)
gpnFtAccept (StreamBlock.GpnFtAccept)
gnnFtAccept (StreamBlock.GnnFtAccept)
gsRequestWithPortType (StreamBlock.GsRequestWithPortType)
gidPtAccept (StreamBlock.GidPtAccept)
gsAccept (StreamBlock.GsAccept)
rpnId (StreamBlock.RpnId)
rnnId (StreamBlock.RnnId)
rcsId (StreamBlock.RcsId)
rftId (StreamBlock.RftId)
rptId (StreamBlock.RptId)
rspnId (StreamBlock.RspnId)
rffId (StreamBlock.RffId)
rsnnNn (StreamBlock.RsnnNn)
daId (StreamBlock.DaId)
gtin (StreamBlock.Gtin)
gtinAccept (StreamBlock.GtinAccept)
giel (StreamBlock.Giel)
gielAccept (StreamBlock.GielAccept)
gsRequestWithInterconnectElementName (StreamBlock.GsRequestWithInterconnectElementName)
gietAccept (StreamBlock.GietAccept)
gdidAccept (StreamBlock.GdidAccept)
gmidAccept (StreamBlock.GmidAccept)
gfnAccept (StreamBlock.GfnAccept)
gielnAccept (StreamBlock.GielnAccept)
gmalAccept (StreamBlock.GmalAccept)
gieilAccept (StreamBlock.GieilAccept)
gplAccept (StreamBlock.GplAccept)
gptAccept (StreamBlock.GptAccept)
gppnAccept (StreamBlock.GppnAccept)
gapnlAccept (StreamBlock.GapnlAccept)
gpsAccept (StreamBlock.GpsAccept)
gpscAccept (StreamBlock.GpscAccept)
gatin (StreamBlock.Gatin)
gatinAccept (StreamBlock.GatinAccept)
gsesAccept (StreamBlock.GsesAccept)
gsRequestWithPlatformName (StreamBlock.GsRequestWithPlatformName)
gplnlAccept (StreamBlock.GplnlAccept)
gpltAccept (StreamBlock.GpltAccept)
gplmlAccept (StreamBlock.GplmlAccept)
gpabAccept (StreamBlock.GpabAccept)
gnpl (StreamBlock.Gnpl)
gnplAccept (StreamBlock.GnplAccept)
gpnl (StreamBlock.Gpnl)
gpnlAccept (StreamBlock.GpnlAccept)
gpfcpAccept (StreamBlock.GpfcpAccept)
gpliAccept (StreamBlock.GpliAccept)
gnid (StreamBlock.Gnid)
gnidAccept (StreamBlock.GnidAccept)
rieln (StreamBlock.Rieln)
rpl (StreamBlock.Rpl)
rpln (StreamBlock.Rpln)
rplt (StreamBlock.Rplt)
rplm (StreamBlock.Rplm)
rpab (StreamBlock.Rpab)
rpfcp (StreamBlock.Rpfcp)
rpli (StreamBlock.Rpli)
dpl (StreamBlock.Dpl)
dpln (StreamBlock.Dpln)
dplm (StreamBlock.Dplm)
gsDeregisterWithPlatformName (StreamBlock.GsDeregisterWithPlatformName)
dpall (StreamBlock.Dpall)
ftr (StreamBlock.Ftr)
ftrAccept (StreamBlock.FtrAccept)
fpng (StreamBlock.Fpng)
fpngAccept (StreamBlock.FpngAccept)
Children: None
383
ctIuPreamble
Attribute
Description
commandRespondCode
Type: OCTETSTRING
Default: 0000
fragmentId
Type: OCTETSTRING
Default: 00
gsSubType
Type: OCTETSTRING
Default: 02
gsType
Type: OCTETSTRING
Default: FC
inId
Type: OCTETSTRING
Default: 000000
maximumResidualSize
Type: OCTETSTRING
Default: 0000
Name
Type: string
options
Type: OCTETSTRING
Default: 00
reserved
Type: OCTETSTRING
Default: 00
reserved
Type: OCTETSTRING
Default: 000000
revision
Type: OCTETSTRING
Default: 01
ctIuPreamble Object (fcgs PDU library)

Description:
Parents: gsReject (StreamBlock.GsReject)

Children: None
Attribute
Description
commandRespondCode
Type: OCTETSTRING
Default: 8001
fragmentId
Type: OCTETSTRING
Default: 00
gsSubType
Type: OCTETSTRING
Default: 02
384
CtrlChanCapTLV
Attribute
Description
gsType
Type: OCTETSTRING
Default: FC
inId
Type: OCTETSTRING
Default: 000000
maximumResidualSize
Type: OCTETSTRING
Default: 0000
Name
Type: string
options
Type: OCTETSTRING
Default: 00
reasonCode
Type: OCTETSTRING
Default: 00
reasonCodeExplanation
Type: OCTETSTRING
Default: 00
reserved
Type: OCTETSTRING
Default: 00
revision
Type: OCTETSTRING
Default: 01
vendorSpecific
Type: OCTETSTRING
Default: 00
CtrlChanCapTLV (VICTLV:CtrlChanCapTLV)
Description:
Children: CapabilityFlags
Next headers: VICTLV:CtrlChanCapTLV, VICTLV:MsgTypeArrayTLV, VICTLV:ResourceLimitCapTLV, VICTLV:EthernetCapTLV, VICTLV:FcoeCapTLV,
VICTLV:CustomTLV
CtrlChanCapTLV Attributes
Attribute
Description
Length
Type: INTEGER
Default: 6
MaxCredit
Type: INTEGER
Default: 1
MaxMsgSize
Type: INTEGER
Default: 1518
Name
Type: string
385
custom
Attribute
Description
Reserved
Type: OCTETSTRING
Default: 00
Type
Type: INTEGER
Default: 17
custom (overloaded)
custom (ipv6)
custom (lldp)
custom Object (ipv6 PDU library)

Description:
Parents: Ipv6HopByHopOption (StreamBlock.Ipv6HopByHopHeader.options.Ipv6HopByHopOption)

Ipv6DestinationOption (StreamBlock.Ipv6DestinationHeader.options.Ipv6DestinationOption)
Children: None
custom Attributes
Attribute
Description
data
Type: OCTETSTRING
Default: 00
Name
more information.
Type: string
type
Type: INTEGER
Default: 15
custom Object (lldp PDU library)

Description:
Parents: chassisid (StreamBlock.ChassisIdTlv.chassisid)

Children: None
386
Custom
custom Attributes
Attribute
Description
id
Type: OCTETSTRING
Default: 00
Name
more information.
Type: string
subtype
Type: OCTETSTRING
Default: 00
Custom (custom:Custom)
Description:
Add a custom header field for a protocol not supported by Spirent TestCenter, or for the payload. The custom header is a sequence of bytes in hexadecimal
format that can be inserted anywhere in the protocol encapsulation. For example, you can copy and paste a header byte sequence from a capture file to create
a custom header.
Children: None
Next headers: mpls:Mpls, pppoe:PPPoEDiscovery, pppoe:PPPoESession, ipv4:IPv4, ipv6:IPv6, tcp:Tcp, udp:Udp, pim:Pimv4Hello, pim:Pimv4Register,
pim:Pimv4RegisterStop, pim:Pimv4JoinPrune, pim:Pimv4Assert, arp:ARP, arp:RARP, dhcp:Dhcpclientmsg, dhcp:Dhcpservermsg, rip:Ripv1, rip:Ripv2, rip:Ripng,
icmp:IcmpDestUnreach, icmp:IcmpTimeExceeded, icmp:IcmpParameterProblem, icmp:IcmpSourceQuench, icmp:IcmpRedirect, icmp:IcmpEchoRequest,
icmp:IcmpEchoReply, icmp:IcmpTimestampRequest, icmp:IcmpTimestampReply, icmp:IcmpInfoRequest, icmp:IcmpInfoReply, igmp:Igmpv1, igmp:Igmpv2,
igmp:Igmpv2Query, igmp:Igmpv2Report, igmp:Igmpv3Query, igmp:Igmpv3Report, gre:GreNoKeyNoSeq, gre:GreSeq, gre:GreKey, gre:GreKeySeq,
ospfv2:Ospfv2Unknown, ospfv2:Ospfv2Hello, ospfv2:Ospfv2DatabaseDescription, ospfv2:Ospfv2LinkStateRequest, ospfv2:Ospfv2LinkStateUpdate,
ospfv2:Ospfv2LinkStateAcknowledge, icmpv6:Icmpv6DestUnreach, icmpv6:Icmpv6PacketTooBig, icmpv6:Icmpv6TimeExceeded,
icmpv6:Icmpv6ParameterProblem, icmpv6:Icmpv6EchoRequest, icmpv6:Icmpv6EchoReply, icmpv6:MLDv1, icmpv6:MLDv2Query, icmpv6:MLDv2Report,
icmpv6:RouterSolicitation, icmpv6:RouterAdvertisement, icmpv6:NeighborSolicitation, icmpv6:NeighborAdvertisement, icmpv6:Redirect, pim:Pimv6Hello,
pim:Pimv6Register, pim:Pimv6RegisterStop, pim:Pimv6JoinPrune, pim:Pimv6Assert, custom:Custom
Custom Attributes
Attribute
Description
Name
information.
Type: string
pattern
Custom sequence of bytes in hexadecimal format

Type: OCTETSTRING
Default: 00
Custom (overloaded)
Custom (VICTLV)
Custom (serviceoam)
387
customAddr
Custom Object (VICTLV PDU library)

Description:
Parents: ProvList (StreamBlock.ProvisioningInfoTLV.Info.ProvList)

Children: None
Custom Attributes
Attribute
Description
Data
Type: OCTETSTRING
InfoType
Type: OCTETSTRING
Default: 00
Name
more information.
Type: string
Custom Object (serviceoam PDU library)

Description:
Parents: ChassisIDList (StreamBlock.SndrID.theChassisID.ChassisIDList)

ChassisIDList (StreamBlock.CCM.theCCMTLVS.CCMTLVList.SenderIDTLV.theChassisID.ChassisIDList)
ChassisIDList (StreamBlock.LBM.theLBMTLVs.LBMTLVList.SenderIDTLV.theChassisID.ChassisIDList)
ChassisIDList (StreamBlock.LBR.theLBRTLVs.LBMTLVList.SenderIDTLV.theChassisID.ChassisIDList)
ChassisIDList (StreamBlock.LTM.theLTMTLVs.LTMTLVList.SenderIDTLV.theChassisID.ChassisIDList)
ChassisIDList (StreamBlock.LTR.theLTRTLVs.LTRTLVList.SenderIDTLV.theChassisID.ChassisIDList)
Children: None
Custom Attributes
Attribute
Description
ChassisID
Type: OCTETSTRING
Default: 00
ChassisIDSubtype
Type: OCTETSTRING
Default: 00
Name
Type: string
customAddr
Description:
388
CustomLink
Parents: managementAddr
Children: None
customAddr Attributes
Attribute
Description
addrSubtype
Type: EnumManagementAddrSubtype
Default: 00
Possible Values:
Value Description
00
Other
01
IPv4
02
IPv6
03
nsap
04
hdlc
05
bbn1822
06
All 802
07
e163
08
e164
09
f69
0A
x121
0B
IPX
0C
Apple Talk
0D
DEC Net IV
0E
Banyan Vines
0F
E164 with NSAP
10
DNS
11
Distinguished Name
12
AS Number
13
XTP over IPv4
14
XTP over IPv6
15
XTP native mode XTP
16
Fibre Channel WWPN
17
Fibre Channel WWNN
18
Gateway Identifier
19
AFI
managementAddr
Type: OCTETSTRING
Name
information.
Type: string
CustomLink
Description:

Relations:
389
customOption
Side name
(Type)
Relative
Description
Container
(ContainedLink)
AncpCpeToDslamLink, Dhcpv4RelayAgentLink, EmulatedDevice,

L3ForwardingLink, VrfCustomerLink, VrfProviderLink
NetworkLinkDestination
(LinkDst)
Aal5If, EthIIIf, FcIf, GreIf, HdlcIf, Ipv4If, Ipv6If, ItagIf, L2tpv2If, MplsIf, PppIf,
PppoeIf, VlanIf, WimaxIf
LinkDstDevice
(LinkDstDevice)
EmulatedDevice
NetworkLinkSource
(LinkSrc)
CustomLink Writable Attributes

Writable Attribute
Description
Active, Name
IsArpNdCapabable
Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
FALSE
LinkTypeCategory
Type: enum
Default: LAYER2_TUNNEL_LINK
Possible Values:
Value
Description
ROUTED_LINK
L3_SWITCH_LINK
L2_SWITCH_LINK
LAYER3_TUNNEL_LINK
LAYER2_TUNNEL_LINK
CustomLink Read-Only Attributes

Read-Only Attribute
Description
LinkType
Type: string
customOption
Description:
Use this to insert a customized option into the DHCP options payload.
Parents: DHCPOption
Children: None
390
customPayload
customOption Attributes
Attribute
Description
length
Type: OCTETSTRING
Default: 01
Name
more information.
Type: string
type
Type: OCTETSTRING
Default: FE
value
The custom options payload

Type: OCTETSTRING
Default: 00
customPayload
Description:
Parents: FCPayload-Choice
Children: None
customPayload Attributes
Attribute
Description
Name
more information.
Type: string
payload
Type: OCTETSTRING
CustomPropertyCreateCommand
Description:

CustomPropertyCreateCommand Writable Attributes

Writable Attribute
Description
DynamicResultView
Type: handle
Default: 0
391
CustomPropertyUpdateCommand
Writable Attribute
Description
Expression
Type: string
ExpressionType
Type: enum
Default: MATH
Possible Values:
Value Description
MATH
BOOL
Precision
Type: u16
Default: 0
PropertyName
Type: string
CustomPropertyCreateCommand Read-Only Attributes

Read-Only Attribute
Description

CustomProperty
Type: handle
Default: 0
CustomPropertyUpdateCommand
Description:

CustomPropertyUpdateCommand Writable Attributes

Writable Attribute
Description
CustomProperty
Type: handle
Default: 0
CustomPropertyUpdateCommand Read-Only Attributes

Read-Only Attribute
Description

392
customSubTlvType
customSubTlvType
Description:
Children: None
customSubTlvType Attributes
Attribute
Description
length
Type: INTEGER
Default: 4
Name
Type: string
reserved
Type: ALIGNMENTPAD
Default: 0
type
Type: INTEGER
Default: 16
value
Type: OCTETSTRING
Default: 00000000
customTlv
Description:
Parents: DcbxSubTlvt1, DcbxSubTlvt2
Children: header
customTlv Attributes
Attribute
Description
Name
information.
Type: string
value
Type: OCTETSTRING
Default: 00
CustomTlv (ancp_draft0:CustomTlv)
Description:
Children: None
393
CustomTlv
CustomTlv Attributes
Attribute
Description
Data
Type: OCTETSTRING
Length
Type: INTEGER
Default: 0
MessageSelect
Default: 3
Possible Values:
Value Description
1
Port Up
Port Down
Port Up, Port Down
Name
more information.
Type: string
Pad
Type: ALIGNMENTPAD
Default: 0
Type
Type: OCTETSTRING
Default: 0001
CustomTlv (ancp_draft2:CustomTlv)
Description:
Children: None
Attribute
Description
Data
Type: OCTETSTRING
Length
Type: INTEGER
Default: 0
MessageSelect
Default: 3
Possible Values:
Value Description
Name
Port Up
Port Down
Port Up, Port Down
more information.
Type: string
394
CustomTlv
Attribute
Description
Pad
Type: ALIGNMENTPAD
Default: 0
Type
Type: OCTETSTRING
Default: 0001
CustomTlv (lldp:CustomTlv)
Description:
Children: None
lldp:PortAndProtocolVlanIdTlv, lldp:ProtocolIdentityTlv, lldp:OrganizationallySpecificTlv, lldp:DcbxTlvt1, lldp:DcbxTlvt2, lldp:TrafficClassesSupportedTlv,
lldp:PriorityBasedFlowControlTlv, lldp:ApplicationPriorityTlv, lldp:ETSConfigurationTlv, lldp:ETSRecommendationTlv, lldp:CongestionNotificationTlv,
lldp:NivSupportTlv
Attribute
Description
length
Type: INTEGER
Default: 0
Name
more information.
Type: string
type
Type: INTEGER
Default: 9
value
Type: OCTETSTRING
CustomTLV (VICTLV:CustomTLV)
Description:
Children: None
CustomTLV Attributes
Attribute
Description
Length
Type: INTEGER
Default: 0
Name
more information.
Type: string
395
CustomTlvType
Attribute
Description
Type
Type: INTEGER
Default: 0
Value
Type: OCTETSTRING
Default: 00
CustomTlvType
Description:
Parents: LspPingTlvs
Children: None
CustomTlvType Attributes
Attribute
Description
length
Type: INTEGER
Default: 4
Name
more information.
Type: string
type
Type: INTEGER
Default: 16
value
Type: OCTETSTRING
Default: 00000000
cVlan
Description:
Parents: cvlans
Children: None
cVlan Attributes
Attribute
Description
cfi
Type: BITSTRING
Default: 0
id
Type: INTEGER
Default: 100
Name
information.
Type: string
pcp
Type: BITSTRING
Default: 001
396
cvlans
Attribute
Description
type
Type: OCTETSTRING
Default: 8100
cvlans
Description:
Parents: EthernetII, Ethernet8023Raw, Ethernet8022, EthernetSnap, EncapEthernetII, EncapEthernet8023Raw, EncapEthernet8022, EncapEthernetSnap
Children: cVlan
cvlans Attributes
Attribute
Description
Name
information.
Type: string
daId
Description:
Children: ctIuPreamble
daId Attributes
Attribute
Description
Name
Type: string
portIdentifier
Type: OCTETSTRING
Default: 000000
reserved
Type: OCTETSTRING
Default: 00
DaId (fcgs:DaId)
Description:
397
Data
DaId Attributes
Attribute
Description
Name
Type: string
portIdentifier
Type: OCTETSTRING
Default: 000000
reserved
Type: OCTETSTRING
Default: 00
Data
Description:
Parents: theData
Children: None
Data Attributes
Attribute
Description
Data
Type: OCTETSTRING
Name
information.
Type: string
Data
Description:
Parents: theData, TestPattern
Children: None
Data Attributes
Attribute
Description
Data
Type: OCTETSTRING
Name
information.
Type: string
398
DataFrame
DataFrame (RPR:DataFrame)
Description:
Children: extendedHeader, fs, rch
DataFrame Attributes
Attribute
Description
Name
more information.
Type: string
protocolType
Type: INTEGER
Default: 1536
dataMin
Description:
Parents: fs, ControlFrameSize
Children: None
dataMin Attributes
Attribute
Description
min
Type: OCTETSTRING
Name
information.
Type: string
DataPad (overloaded)
DataPad (LinkOAM) - Object definition for the following paths:
StreamBlock.EventNoteOAMPDU.DataPad
StreamBlock.VariableRequestOAMPDU.DataPad
StreamBlock.VariableResponseOAMPDU.DataPad
StreamBlock.OrgSpecOAMPDU.DataPad
399
DataPad
DataPad Object (LinkOAM PDU library)

Description:
Parents: EventNoteOAMPDU (StreamBlock.EventNoteOAMPDU)

Children: EventTLV, thepadData
DataPad Attributes
Attribute
Description
Name
more information.
Type: string
SEQNumb
Type: INTEGER
Default: 0

Description:
Parents: VariableRequestOAMPDU (StreamBlock.VariableRequestOAMPDU)

Children: thepadData, VarDescTLV
DataPad Attributes
Attribute
Description
Name
information.
Type: string

Description:
Parents: VariableResponseOAMPDU (StreamBlock.VariableResponseOAMPDU)

Children: thepadData, VarRepoTLV
400
DataTLV
DataPad Attributes
Attribute
Description
Name
information.
Type: string

Description:
Parents: OrgSpecOAMPDU (StreamBlock.OrgSpecOAMPDU)

Children: None
DataPad Attributes
Attribute
Description
DataPad
Type: OCTETSTRING
Default: ( zeroes hexadecimal)
Name
more information.
Type: string
OUI
Type: OCTETSTRING
Default: 000000
DataTLV (EOAMTLV:DataTLV)
Description:
Children: theData
Next headers: EOAMTLV:SndrID, EOAMTLV:OrgSpec, EOAMTLV:PrtStat, EOAMTLV:IntStat, EOAMTLV:EndTLV, EOAMTLV:DataTLV, EOAMTLV:TestTLV,
EOAMTLV:LTMEgrID, EOAMTLV:LTREgrID, EOAMTLV:RplyIng, EOAMTLV:RplyEgr
DataTLV Attributes
Attribute
Description
Length
Type: OCTETSTRING
Default: 0000
Name
more information.
Type: string
401
DataTLV
Attribute
Description
Type
Type: OCTETSTRING
Default: 03
DataTLV (overloaded)
DataTLV (EOAM)
DataTLV (serviceoam)
DataTLV Object (EOAM PDU library)

Description:
Parents: LBMTLVList (StreamBlock.LBM.theLBMTLVs.LBMTLVList)

Children: theData
DataTLV Attributes
Attribute
Description
Length
Type: OCTETSTRING
Default: 0000
Name
more information.
Type: string
Type
Type: OCTETSTRING
Default: 03
DataTLV Object (serviceoam PDU library)

Description:
Parents: LBMTLVList (StreamBlock.LBM.theLBMTLVs.LBMTLVList)

LBMTLVList (StreamBlock.LBR.theLBRTLVs.LBMTLVList)
Children: theData
402
DbGetCommand
DataTLV Attributes
Attribute
Description
Length
Type: OCTETSTRING
Default: 0000
Name
more information.
Type: string
Type
Type: OCTETSTRING
Default: 03
DbGetCommand
Description:
NOTE: It is recommended that you do not use this command, because it accesses the underlying database tables directly, and these tables might change
from release to release. Therefore, Spirent cannot supply support for issues encountered by customers using DbGetCommand. It is recommended that you
use QueryResultCommand instead, because it protects customers from changes in the underlying tables through the use of pre-configured queries. Spirent
intends to maintain backwards compatibility for customers using QueryResultCommand to access results.

Parents: Sequencer
DbGetCommand Writable Attributes

Writable Attribute
Description
AttributeList
Specifies which attributes (columns) to return. Use a space-separated list of column names. The default (no argument)
returns all columns.
Type: string
DatabaseConnectionString
Name of the results database (summary database or iteration file) to open and query.
Type: string
Default: result.db
FileNamePrefix
If you want a CSV output file created, provide the filename prefix for the CSV file. The filename extension will be .csv. The
content of the CSV file matches what is returned in the Output attribute.
Type: string
Filter
Filters the rows that are returned. The default returns all rows. You can use the following comparison operators:
== (equals)
!= (does not equal)
> (greater than)
>= (greater than or equal to)
< (less than)
<= (less than or equal to)
Example: -filter "TotalTxFrameCount > 50"
This example will return rows that have TotalTxFrameCount values of 75 or 300, but not will not return rows with
TotalTxFrameCount values of 48 or 50.
Type: string
403
DcbBackToBackPerIterationResult
Writable Attribute
Description
Parent
If you set this to the handle of the parent of the table that is specified by the Table attribute, the command will return just
those rows under the parent.
Type: string
ShowGrandparent
Whether to show the grandparent (the parent of the parent) in the output. If the Parent attribute is not used, this attribute
is ignored.
Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
Show the grandparent in the output.
FALSE Do not show the grandparent in the output.

Table
Name of the table to query.

Type: string
DbGetCommand Read-Only Attributes

Read-Only Attribute
Description
Output
Output of the command in a CSV-formatted string.

Type: string
Description:
DCB back to back test per iteration result.

Result children (automatically created): BenchmarkTrafficGroupPerIterationResult, DcbTrafficGroupPerIterationResult, Rfc2544TrafficGroupPerIterationResult
DcbBackToBackPerIterationResult Writable Attributes

DcbBackToBackPerIterationResult Read-Only Attributes

Read-Only Attribute
Description
AvgInterarrivalTime
Average interarrival time in uSec.

Type: double
Default: 0
AvgJitter
Average jitter measurement in uSec.

Type: double
Default: 0
AvgLatency
Average latency value in uSec.

Type: double
Default: 0
ChecksumErrorCount
Number of frames with checksum errors received by the test tool.

Type: u64
Default: 0
404
Read-Only Attribute
Description
ClassificationGroupPassCount
Number of classification groups that meet the iteration pass criteria.

Type: u16
Default: 0
ClassificationGroupTotalCount
Number of classification groups in this test.

Type: u16
Default: 0
DroppedFrameCount
Number of frames dropped by the DUT.

Type: u64
Default: 0
DroppedFramePct
Percentage of frames dropped by the DUT.

Type: double
Default: 0
DuplicateFrameCount
Number of duplicate frames received by the test tool.

Type: u64
Default: 0
DurationInSec
Test duration in seconds.

Type: double
Default: 0
Number of test frames the test tool expected.

Type: u64
Default: 0
FcsErrorFrameCount
Number of frames with FCS errors received by the test tool.

Type: u64
Default: 0
FloodedFrameCount
Number of flooded frames received on this port.

Type: u64
Default: 0
ForwardingRate
Observed forwarding rate of the DUT in fps.

Type: double
Default: 0
IntendedLoad
Load configured by the test on the generator(s).

Type: double
Default: 0
IntendedMbpsLoad
Load, in Mbps, configured by the test on the generator(s).

Type: double
Default: 0
MaxInterarrivalTime
Maximum interarrival time in uSec.

Type: double
Default: 0
MaxJitter
Maximum jitter measurement in uSec.

Type: double
Default: 0
MaxLatency
Maximum latency value in uSec.

Type: double
Default: 0
MinInterarrivalTime
Minimum interarrival time in uSec.

Type: double
Default: 0
MinJitter
Minimum jitter measurement in uSec.

Type: double
Default: 0
405
Read-Only Attribute
Description
MinLatency
Minimum latency value in uSec.

Type: double
Default: 0
OfferedAvgFrameSize
Actual, average frame size transmitted by the generator(s) [SUM(Tx Octets)/SUM(Tx Frames)].
Type: double
Default: 0
OfferedLoad
Actual, measured load offered by the generator(s).

Type: double
Default: 0
OfferedMbpsLoad
Actual, measured load, in Mbps, offered by the generator(s).

Type: double
Default: 0
OtherFrameCount
Number of non-test frames received by the test tool, for example, router protocol traffic, bridge management
traffic, etc.
Type: u64
Default: 0
OutSeqFrameCount
Number of frames that were out of sequence.

Type: u64
Default: 0
PauseFrameCount
Number of pause frames received by the test tool.

Type: u64
Default: 0
PfcFrameCount
Number of PFC pause frames received by the test tool.

Type: u64
Default: 0
PfcPri0FrameCount
Indicates how many PFC frames were detected on priority 0.

Type: u64
Default: null
PfcPri0Quanta
Measured pause duration of the generator(s) on priority 0.

Type: u64
Default: null
PfcPri0TriggerCount
Indicates how many PFC frames were detected by port capture triggers on priority 0 (only used when the
hardware lacks PFC counter support).
Type: u64
Default: null
PfcPri1FrameCount

Type: u64
Default: null
PfcPri1Quanta

Type: u64
Default: null
PfcPri1TriggerCount
Type: u64
Default: null
PfcPri2FrameCount

Type: u64
Default: null
PfcPri2Quanta

Type: u64
Default: null
406
Read-Only Attribute
Description
PfcPri2TriggerCount
Type: u64
Default: null
PfcPri3FrameCount

Type: u64
Default: null
PfcPri3Quanta

Type: u64
Default: null
PfcPri3TriggerCount
Type: u64
Default: null
PfcPri4FrameCount

Type: u64
Default: null
PfcPri4Quanta

Type: u64
Default: null
PfcPri4TriggerCount
Type: u64
Default: null
PfcPri5FrameCount

Type: u64
Default: null
PfcPri5Quanta

Type: u64
Default: null
PfcPri5TriggerCount
Type: u64
Default: null
PfcPri6FrameCount

Type: u64
Default: null
PfcPri6Quanta

Type: u64
Default: null
PfcPri6TriggerCount
Type: u64
Default: null
PfcPri7FrameCount

Type: u64
Default: null
PfcPri7Quanta

Type: u64
Default: null
407
DcbBackToBackTestCaseConfig
Read-Only Attribute
Description
PfcPri7TriggerCount
Type: u64
Default: null
RxFrameCount
Number of test frames received by the test tool.

Type: u64
Default: 0
TrialNum
Trial number.
Type: u8
Default: 0
TxFrameCount
Number of test frames transmitted by the test tool.

Type: u64
Default: 0
TxFrameRate
Test tools transmission rate in fps. Note that this does not indicate the actual rate of test frames transmitted
by the test tool.
Type: double
Default: 0
Description:
DCB back-to-back test configuration.

Parents: DcbTestConfig
Children: DcbTrafficGroupWeightConfig
Relations:
Side name
(Type)
Relative
Description
GroupCollection
(AffiliationGroupCollection)
GroupCollection
This relation indicates which GroupCollection object contains

the test traffic for the test.
SequencerRootCommand
(TestCaseRootCommand)
SequencerGroupCommand
This relation indicates the root command for this test case in the
sequencer.
DcbBackToBackTestCaseConfig Writable Attributes

Writable Attribute
Description
Active, Name
Backoff
Backoff (%).
Type: double
Default: 50.0
Range: 0.00001 - 100.0
408
Writable Attribute
Description
BurstSizeIterationMode
This option configures how the burst size is iterated.

Type: enum
Default: FIXED
Possible Values:
Value
Description
FIXED
Use a single, FIXED burst size.
CUSTOM Use a CUSTOM list of burst sizes.

STEP
Increment burst sizes between a min and max value by a fixed STEP.
CustomBurstSizeList
Burst size values to use when iteration mode is CUSTOM.

Type: u16
Default: 0
Range: 1 - 65535
CustomFrameSizeList
Frame size values to use when iteration mode is CUSTOM.

Type: u16
Default: 0
Range: 40 - 16383
CustomLoadSizeList
List of loads to use for CUSTOM iteration mode.

Type: double
Default: 0
DurationInitial
Initial duration.
Type: double
Default: 1
Range: 0.000064 - 4294967296.0
DurationLowerLimit
Duration lower limit.

Type: double
Default: 1
Range: 0.000064 - 4294967296.0
DurationStep
Duration step.
Type: double
Default: 5
DurationUpperLimit
Duration upper limit.

Type: double
Default: 120
Range: 0.000064 - 4294967296.0
EnableMaxLoadDelta
Whether to enable maximum intended/offered load delta.

Type: bool
Default: TRUE
Possible Values:
Value Description
TRUE
Maximum intended/offered load delta is enabled.
FALSE Maximum intended/offered load delta is disabled.

EnablePfcFrameCountThreshold
Whether the PFC frame count threshold is enabled.

Type: bool
Default: TRUE
Possible Values:
Value Description
TRUE
PFC frame count threshold is enabled.
FALSE PFC frame count threshold is disabled.

FixedBurstSize
Burst size value to use when iteration mode is FIXED.

Type: u16
Default: 1
Range: 1 - 65535
409
Writable Attribute
Description
FixedFrameSize
Frame size to use when iteration mode is FIXED.

Type: u16
Default: 128
Range: 40 - 16383
FixedLoadSize
Load to use for FIXED iteration mode.

Type: double
Default: 10
FrameSizeIterationMode
This option configures how the frame size is iterated.

Type: enum
Default: FIXED
Possible Values:
Value
Description
FIXED
Use a single, FIXED frame size.
CUSTOM Use a CUSTOM list of frame sizes.

STEP
STEP frame sizes by a fixed amount between a min and max frame size.
RANDOM Use a uniform, RANDOM distribution of frames bounded by a min and max value [min, max].
InterFrameGap
IFG to use within a burst when InterFrameGapConfigMode is set to USER.

Type: u32
Default: 12
Range: 11 - 16383
InterFrameGapConfigMode
This option configures the Inter-frame Gap (IFG) to use within a burst.
Type: enum
Default: MINIMUM
Possible Values:
Value
Description
MINIMUM Use the smallest IFG supported by the port.
USER
LoadSizeConfigMode
Use a user specified IFG.
Specifies which load configuration is to be used for this test case.

Type: enum
Default: WEIGHTED
Possible Values:
Value
Description
WEIGHTED Use a single aggregate load for each iteration of the test via the load properties on the test case
object. Requires a DcbTrafficGroupWeightConfig for each TrafficGroup object in the test.
DISCRETE Configure discrete loads for each TrafficGroup individually via the TrafficGroup's child
TrafficGroupLoadSizeProfile object.
LoadSizeIterationMode
This option configures how the load is iterated.

Type: enum
Default: STEP
Possible Values:
Value
Description
FIXED
Use a single, FIXED load.
CUSTOM Use a CUSTOM list of loads.

STEP
LoadUnits
Increment loads between a min and max value by a fixed STEP.
Units used for the load value.

Type: enum
Possible Values:
Value
Description
PERCENT_LINE_RATE
Percent line rate.
MEGABITS_PER_SECOND Megabits per second (Mbps).

KILOBITS_PER_SECOND
Kilobits per second (Kbps).
BITS_PER_SECOND
Bits per second (bps).
410
Writable Attribute
Description
MaxLoadDelta
Maximum intended/offered load delta.

Type: double
Default: 0.1
Range: 0.01 - 100.0
PfcFrameCountThreshold
PFC frame count threshold.

Type: u64
Default: 0
PfcPauseQueueConfigMode
Indicates how the test should configure the hardware to respond to PFC frames from the DUT.
Type: enum
Default: MANUAL
Possible Values:
Value
Description
AUTOMATIC
Create DCBx devices to match the current test configuration.
NEGOTIATE_VIA_DCBX Use existing DCBx configs to negotiate PFC pause queues with the DUT.
MANUAL
Manually enable/disable pause response via the PriorityFlowControlArray property.
Specifies which priorities will be paused in response to a PFC frame from the DUT.
Type: bool
Default: TRUE
Possible Values:
Value Description
TRUE
Enable PFC pausing for the corresponding priority.
FALSE Disable PFC pausing for the corresponding priority.

RandomMaxFrameSize
Maximum frame size to use when iteration mode is RANDOM.

Type: u16
Default: 256
Range: 40 - 16383
RandomMinFrameSize
Minimum frame size to use when iteration mode is RANDOM.

Type: u16
Default: 128
Range: 40 - 16383
Resolution
Search resolution.
Type: double
Default: 1
Range: 0.000064 - 4294967296.0
ResultViewMode
Specifies which set of hardware counters will be used during the test run.
Type: enum
Default: LATENCY_JITTER
Possible Values:
Value
Description
BASIC
Use the BASIC result mode. This mode provides Advanced Sequencing.
HISTOGRAM
Use the HISTOGRAM result mode.
JITTER
Use the JITTER result mode.
INTERARRIVALTIME Use the INTERARRIVALTIME result mode.
SearchMode
FORWARDING
Use the FORWARDING result mode. This mode provides Advanced Sequencing.
LATENCY_JITTER
Use the LATENCY_JITTER result mode.
Duration search mode.

Type: enum
Default: BINARY
Possible Values:
Value
Description
BINARY Binary duration search mode.
COMBO Combo duration search mode.
STEP
Step duration search mode.
411
Writable Attribute
Description
StepBurstSizeEnd
Final burst size value to use when iteration mode is STEP.

Type: u16
Default: 1000
Range: 1 - 65535
StepBurstSizeStart
Initial burst size value to use when iteration mode is STEP.

Type: u16
Default: 100
Range: 1 - 65535
StepBurstSizeStep
Burst size step value to use when iteration mode is STEP.

Type: u16
Default: 100
Range: 1 - 65535
StepFrameSizeEnd
Final frame size to use when iteration mode is STEP.

Type: u16
Default: 1518
Range: 40 - 16383
StepFrameSizeStart
Initial frame size to use when iteration mode is STEP.

Type: u16
Default: 128
Range: 40 - 16383
StepFrameSizeStep
Frame size step value to use when iteration mode is STEP.

Type: u16
Default: 128
Range: 1 - 16383
StepLoadSizeEnd
Final load to use for STEP iteration mode.

Type: double
Default: 10
StepLoadSizeStart
Initial load to use for STEP iteration mode.

Type: double
Default: 100
StepLoadSizeStep
Load value to increment by for STEP iteration mode.

Type: double
Default: 10
Range: 0.001 - 100000000000.0
DcbBackToBackTestCaseConfig Read-Only Attributes

Read-Only Attribute
Description
ConfigIsValid
Indicates whether the test case currently has a valid configuration or not.
Type: bool
Default: TRUE
Possible Values:
Value Description
TRUE
Current configuration is valid.
FALSE Current configuration is not valid.

ConfigValidationErrors
Provides validation errors when the test case determines that the configuration is invalid.
Type: string
Default: 0
412
DcbCongestionControlPerIterationResult
Read-Only Attribute
Description
FrameSizeIsValid
Indicates whether the test case currently has a valid frame size configuration or not.
Type: bool
Default: TRUE
Possible Values:
Value Description
TRUE
Current frame size configuration is valid.
FALSE Current frame size configuration is not valid.

FrameSizeValidationErrors
Provides frame size validation errors when the test case determines that the frame size configuration is invalid.
Type: string
Default: 0
LoadIsValid
Indicates whether the test case currently has a valid load configuration or not. An invalid load indicates that a port
is oversubscribed.
Type: bool
Default: TRUE
Possible Values:
Value Description
TRUE
Current load configuration is valid.
FALSE Current load configuration is invalid.

LoadValidationErrors
Provides load validation errors when the test case determines that the load configuration is invalid.
Type: string
Default: 0
Description:
DCB congestion control test per iteration result.

DcbCongestionControlPerIterationResult Writable Attributes

DcbCongestionControlPerIterationResult Read-Only Attributes

Read-Only Attribute
Description
BackPressureExists
Whether back pressure is present.

Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
Back pressure is present.
FALSE Back pressure is not present.

BurstSize
Burst size.
Type: u64
Default: 0
ChecksumErrorCount

Type: u64
Default: 0
413
Read-Only Attribute
Description
DroppedFrameCount

Type: u64
Default: 0
DroppedFramePct

Type: double
Default: 0
DuplicateFrameCount

Type: u64
Default: 0
DurationInSec

Type: double
Default: 0

Type: u64
Default: 0
FcsErrorFrameCount

Type: u64
Default: 0
FloodedFrameCount

Type: u64
Default: 0
FrameSizeType
Frame size type.

Type: string
Default: 0
HolbExists
Whether head of line blocking is present.

Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
Head of line blocking is present.
FALSE Head of line blocking is not present.

Intended average frame size.

Type: double
Default: 0
IntendedLoad

Type: double
Default: 0
IntendedMbpsLoad

Type: double
Default: 0
OfferedAvgFrameSize
Type: double
Default: 0
OfferedLoad

Type: double
Default: 0
OfferedMbpsLoad

Type: double
Default: 0
414
Read-Only Attribute
Description
OtherFrameCount
traffic, etc.
Type: u64
Default: 0
PauseFrameCount

Type: u64
Default: 0
PfcFrameCount

Type: u64
Default: 0
PfcPri0FrameCount

Type: u64
Default: null
PfcPri0Quanta

Type: u64
Default: null
PfcPri0TriggerCount
Type: u64
Default: null
PfcPri1FrameCount

Type: u64
Default: null
PfcPri1Quanta

Type: u64
Default: null
PfcPri1TriggerCount
Type: u64
Default: null
PfcPri2FrameCount

Type: u64
Default: null
PfcPri2Quanta

Type: u64
Default: null
PfcPri2TriggerCount
Type: u64
Default: null
PfcPri3FrameCount

Type: u64
Default: null
PfcPri3Quanta

Type: u64
Default: null
PfcPri3TriggerCount
Type: u64
Default: null
PfcPri4FrameCount

Type: u64
Default: null
415
Read-Only Attribute
Description
PfcPri4Quanta

Type: u64
Default: null
PfcPri4TriggerCount
Type: u64
Default: null
PfcPri5FrameCount

Type: u64
Default: null
PfcPri5Quanta

Type: u64
Default: null
PfcPri5TriggerCount
Type: u64
Default: null
PfcPri6FrameCount

Type: u64
Default: null
PfcPri6Quanta

Type: u64
Default: null
PfcPri6TriggerCount
Type: u64
Default: null
PfcPri7FrameCount

Type: u64
Default: null
PfcPri7Quanta

Type: u64
Default: null
PfcPri7TriggerCount
Type: u64
Default: null
RxFrameCount

Type: u64
Default: 0
TrialNum
Trial number.
Type: u8
Default: 0
TxFrameCount

Type: u64
Default: 0
TxFrameRate
by the test tool.
Type: double
Default: 0
416
DcbCongestionControlPerPortResult
Description:
DCB congestion control test per port result.

DcbCongestionControlPerPortResult Writable Attributes

DcbCongestionControlPerPortResult Read-Only Attributes

Read-Only Attribute
Description
BackPressureExists
Whether back pressure is present.

Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
Back pressure is present.
FALSE Back pressure is not present.

BurstSize
Burst size.
Type: u64
Default: 0
ChecksumErrorCount

Type: u64
Default: 0
DroppedFrameCount

Type: u64
Default: 0
DroppedFramePct

Type: double
Default: 0
DuplicateFrameCount

Type: u64
Default: 0
DurationInSec

Type: double
Default: 0

Type: u64
Default: 0
FcsErrorFrameCount

Type: u64
Default: 0
FloodedFrameCount

Type: u64
Default: 0
FrameSizeType
Frame size type.

Type: string
Default: 0
417
Read-Only Attribute
Description
HolbExists
Whether head of line blocking is present.

Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
Head of line blocking is present.
FALSE Head of line blocking is not present.


Type: double
Default: 0
IntendedLoad

Type: double
Default: 0
IntendedMbpsLoad

Type: double
Default: 0
OfferedAvgFrameSize
Type: double
Default: 0
OfferedLoad

Type: double
Default: 0
OfferedMbpsLoad

Type: double
Default: 0
OtherFrameCount
traffic, etc.
Type: u64
Default: 0
PauseFrameCount

Type: u64
Default: 0
PfcFrameCount

Type: u64
Default: 0
PfcPri0FrameCount

Type: u64
Default: null
PfcPri0Quanta

Type: u64
Default: null
PfcPri0TriggerCount
Type: u64
Default: null
PfcPri1FrameCount

Type: u64
Default: null
PfcPri1Quanta

Type: u64
Default: null
418
Read-Only Attribute
Description
PfcPri1TriggerCount
Type: u64
Default: null
PfcPri2FrameCount

Type: u64
Default: null
PfcPri2Quanta

Type: u64
Default: null
PfcPri2TriggerCount
Type: u64
Default: null
PfcPri3FrameCount

Type: u64
Default: null
PfcPri3Quanta

Type: u64
Default: null
PfcPri3TriggerCount
Type: u64
Default: null
PfcPri4FrameCount

Type: u64
Default: null
PfcPri4Quanta

Type: u64
Default: null
PfcPri4TriggerCount
Type: u64
Default: null
PfcPri5FrameCount

Type: u64
Default: null
PfcPri5Quanta

Type: u64
Default: null
PfcPri5TriggerCount
Type: u64
Default: null
PfcPri6FrameCount

Type: u64
Default: null
PfcPri6Quanta

Type: u64
Default: null
419
DcbCongestionControlTestCaseConfig
Read-Only Attribute
Description
PfcPri6TriggerCount
Type: u64
Default: null
PfcPri7FrameCount

Type: u64
Default: null
PfcPri7Quanta

Type: u64
Default: null
PfcPri7TriggerCount
Type: u64
Default: null
PortName
Port name.
Type: string
PortType
Port type.
Type: string
Default: -
RxFrameCount

Type: u64
Default: 0
TrialNum
Trial number.
Type: u8
Default: 0
TxFrameCount

Type: u64
Default: 0
TxFrameRate
by the test tool.
Type: double
Default: 0
Description:
DCB congestion control test configuration.

Relations:
Side name
(Type)
Relative
Description
This relation indicates the root command for this test

case in the sequencer.
TrafficDescriptorGroup
(TrafficDescriptorGroupBinding)
Traffic descriptor group binding.
420
DcbCongestionControlTestCaseConfig Writable Attributes

Writable Attribute
Description
Active, Name

Type: enum
Default: FIXED
Possible Values:
Value
Description
FIXED

STEP
CustomBurstSizeList

Type: u16
Default: 0
Range: 1 - 65535
CustomFrameSizeList

Type: u16
Default: 0
Range: 40 - 16383
CustomLoadSizeList

Type: double
Default: 0
FixedBurstSize

Type: u16
Default: 1
Range: 1 - 65535
FixedFrameSize

Type: u16
Default: 128
Range: 40 - 16383
FixedLoadSize

Type: double
Default: 10

Type: enum
Default: FIXED
Possible Values:
Value
Description
FIXED

STEP
InterFrameGap

Type: u32
Default: 12
Range: 11 - 16383
Type: enum
Default: MINIMUM
Possible Values:
Value
Description
USER
421
Writable Attribute
Description

Type: enum
Default: STEP
Possible Values:
Value
Description
FIXED

STEP
RANDOM Random load size iteration mode.

LoadUnits

Type: enum
Possible Values:
Value
Description
PERCENT_LINE_RATE
Percent line rate.
KILOBITS_PER_SECOND
BITS_PER_SECOND
Type: enum
Default: MANUAL
Possible Values:
Value
Description
AUTOMATIC
MANUAL
Type: bool
Default: TRUE
Possible Values:
Value Description
TRUE

RandomMaxFrameSize

Type: u16
Default: 256
Range: 40 - 16383
RandomMaxLoadSize
Maximum random load size.

Type: double
Default: 100
RandomMinFrameSize

Type: u16
Default: 128
Range: 40 - 16383
RandomMinLoadSize
Minimum random load size.

Type: double
Default: 1
StepBurstSizeEnd

Type: u16
Default: 1000
Range: 1 - 65535
422
DcbErroredFramesFilteringPerIterationResult
Writable Attribute
Description
StepBurstSizeStart

Type: u16
Default: 100
Range: 1 - 65535
StepBurstSizeStep

Type: u16
Default: 100
Range: 1 - 65535
StepFrameSizeEnd

Type: u16
Default: 1518
Range: 40 - 16383
StepFrameSizeStart

Type: u16
Default: 128
Range: 40 - 16383
StepFrameSizeStep

Type: u16
Default: 128
Range: 1 - 16383
StepLoadSizeEnd

Type: double
Default: 10
StepLoadSizeStart

Type: double
Default: 100
StepLoadSizeStep

Type: double
Default: 10
Range: 0.001 - 100000000000.0
DcbCongestionControlTestCaseConfig Read-Only Attributes

Description:
DCB errored frames filtering test per iteration result.

DcbErroredFramesFilteringPerIterationResult Writable Attributes

423
DcbErroredFramesFilteringPerIterationResult Read-Only Attributes

Read-Only Attribute
Description
BurstSize
Burst size.
Type: u64
Default: 0
ChecksumErrorCount

Type: u64
Default: 0
CrcErrorCount
Number of frames with CRC errors.

Type: u64
Default: 0
DroppedFrameCount

Type: u64
Default: 0
DroppedFramePct

Type: double
Default: 0
DuplicateFrameCount

Type: u64
Default: 0
DurationInSec

Type: double
Default: 0
ErroredFrameType
Errored frame type.

Type: string

Type: u64
Default: 0
FcsErrorFrameCount

Type: u64
Default: 0
FloodedFrameCount

Type: u64
Default: 0
FrameSizeType
Frame size type.

Type: string
Default: 0

Type: double
Default: 0
IntendedLoad

Type: double
Default: 0
IntendedMbpsLoad

Type: double
Default: 0
OfferedAvgFrameSize
Type: double
Default: 0
424
Read-Only Attribute
Description
OfferedLoad

Type: double
Default: 0
OfferedMbpsLoad

Type: double
Default: 0
OtherFrameCount
traffic, etc.
Type: u64
Default: 0
OversizeCount
Number of oversize frames.

Type: u64
Default: 0
Passed
Passed or failed.
Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
Passed.
FALSE Failed.
PauseFrameCount

Type: u64
Default: 0
PfcFrameCount

Type: u64
Default: 0
PfcPri0FrameCount

Type: u64
Default: null
PfcPri0Quanta

Type: u64
Default: null
PfcPri0TriggerCount
Type: u64
Default: null
PfcPri1FrameCount

Type: u64
Default: null
PfcPri1Quanta

Type: u64
Default: null
PfcPri1TriggerCount
Type: u64
Default: null
PfcPri2FrameCount

Type: u64
Default: null
PfcPri2Quanta

Type: u64
Default: null
425
Read-Only Attribute
Description
PfcPri2TriggerCount
Type: u64
Default: null
PfcPri3FrameCount

Type: u64
Default: null
PfcPri3Quanta

Type: u64
Default: null
PfcPri3TriggerCount
Type: u64
Default: null
PfcPri4FrameCount

Type: u64
Default: null
PfcPri4Quanta

Type: u64
Default: null
PfcPri4TriggerCount
Type: u64
Default: null
PfcPri5FrameCount

Type: u64
Default: null
PfcPri5Quanta

Type: u64
Default: null
PfcPri5TriggerCount
Type: u64
Default: null
PfcPri6FrameCount

Type: u64
Default: null
PfcPri6Quanta

Type: u64
Default: null
PfcPri6TriggerCount
Type: u64
Default: null
PfcPri7FrameCount

Type: u64
Default: null
PfcPri7Quanta

Type: u64
Default: null
426
DcbErroredFramesFilteringTestCaseConfig
Read-Only Attribute
Description
PfcPri7TriggerCount
Type: u64
Default: null
RxFrameCount

Type: u64
Default: 0
TrialNum
Trial number.
Type: u8
Default: 0
TxFrameCount

Type: u64
Default: 0
TxFrameRate
by the test tool.
Type: double
Default: 0
TxNonSigFrameCount
CRC error frame count.

Type: u64
Default: 0
Description:
DCB errored frames filtering test configuration.

Relations:
Side name
(Type)
Relative
Description
TestTraffic
(AffiliationTestTraffic)
StreamBlock
Affiliation test traffic.
This relation indicates the root command for this test case
in the sequencer.
DcbErroredFramesFilteringTestCaseConfig Writable Attributes

Writable Attribute
Description
Active, Name

Type: enum
Default: FIXED
Possible Values:
Value
Description
FIXED

STEP
427
Writable Attribute
Description
CustomBurstSizeList

Type: u16
Default: 0
Range: 1 - 65535
CustomFrameSizeList

Type: u16
Default: 0
Range: 40 - 16383
CustomLoadSizeList

Type: double
Default: 0
FixedBurstSize

Type: u16
Default: 1
Range: 1 - 65535
FixedFrameSize

Type: u16
Default: 128
Range: 40 - 16383
FixedLoadSize

Type: double
Default: 10

Type: enum
Default: FIXED
Possible Values:
Value
Description
FIXED

STEP
InterFrameGap

Type: u32
Default: 12
Range: 11 - 16383
Type: enum
Default: MINIMUM
Possible Values:
Value
Description
USER

Type: enum
Default: STEP
Possible Values:
Value
Description
FIXED

STEP
RANDOM Random load size iteration mode.
428
Writable Attribute
Description
LoadUnits

Type: enum
Possible Values:
Value
Description
PERCENT_LINE_RATE
Percent line rate.
KILOBITS_PER_SECOND
BITS_PER_SECOND
Type: enum
Default: MANUAL
Possible Values:
Value
Description
AUTOMATIC
MANUAL
Type: bool
Default: TRUE
Possible Values:
Value Description
TRUE

RandomMaxFrameSize

Type: u16
Default: 256
Range: 40 - 16383
RandomMaxLoadSize
Maximum random load size.

Type: double
Default: 100
RandomMinFrameSize

Type: u16
Default: 128
Range: 40 - 16383
RandomMinLoadSize
Minimum random load size.

Type: double
Default: 1
StepBurstSizeEnd

Type: u16
Default: 1000
Range: 1 - 65535
StepBurstSizeStart

Type: u16
Default: 100
Range: 1 - 65535
StepBurstSizeStep

Type: u16
Default: 100
Range: 1 - 65535
StepFrameSizeEnd

Type: u16
Default: 1518
Range: 40 - 16383
429
DcbExpandConfigCommand
Writable Attribute
Description
StepFrameSizeStart

Type: u16
Default: 128
Range: 40 - 16383
StepFrameSizeStep

Type: u16
Default: 128
Range: 1 - 16383
StepLoadSizeEnd

Type: double
Default: 10
StepLoadSizeStart

Type: double
Default: 100
StepLoadSizeStep

Type: double
Default: 10
Range: 0.001 - 100000000000.0
DcbErroredFramesFilteringTestCaseConfig Read-Only Attributes

DcbExpandConfigCommand
Description:
Command that expands a DCB test configuration into sequencer commands.

DcbExpandConfigCommand Writable Attributes

Writable Attribute
Description
Config
Configuration to expand.
Type: handle
Default: 0
DcbExpandConfigCommand Read-Only Attributes

Read-Only Attribute
Description

430
DcbIteratePfcPauseTimeCommand
Description:
DCB iterate PFC pause time command.

Parents: Sequencer
DcbIteratePfcPauseTimeCommand Writable Attributes

Writable Attribute
Description
CustomPauseRateList
List of pause rates for Custom pause rate iteration mode.

Type: u32
Default: 0
Range: 1 - 1000
CustomPauseTimeList
List of pause times for Custom pause time iteration mode.

Type: u32
Default: 0
Range: 1 - 67108863
CustomQuantaList
List of quanta values for Custom quanta iteration mode.

Type: u16
Default: 0
DeviceList
List of devices to use as PFC sources.

Type: handle
Default: 0
EnableXonXoffFlowControl
Enable sendng of XON/XOFF PFC frame pairs.

Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
Enable sendng of XON/XOFF PFC frame pairs.
FALSE Disable sendng of XON/XOFF PFC frame pairs.

FixedPauseRate
Value for all pause rates for Fixed pause rate iteration mode.
Type: u32
Default: 100
Range: 1 - 1000
FixedPauseTime
Pause time for FIxed pause time iteration mode.

Type: u32
Default: 1024
Range: 1 - 67108863
FixedQuanta
Value for all qunata in Fixed quanta iteration mode.

Type: u16
Default: 65535
PauseRateIterationMode
Iteration mode for pause rate.

Type: enum
Default: FIXED
Possible Values:
Value
Description
CUSTOM Specify a list of pause rates.
FIXED
Specify a value for all pause rates.
STEP
Increment through a series of pause rates.
431
Writable Attribute
Description
PauseTimeIterationMode
Iteration mode for pause time.

Type: enum
Default: FIXED
Possible Values:
Value
Description
CUSTOM Specify a list of pause times.
PauseTimeUnit
FIXED
Set a fixed value for all pause times.
STEP
Increment through a series of pause times.
The unit for pause time.

Type: enum
Default: QUANTA
Possible Values:
Value
Description
QUANTA Pause time is specified in quanta.
BYTES
Pause time is specified in bytes.
List of PFC queues on which to send pause frames.

Type: bool
Default: TRUE
Possible Values:
Value Description
TRUE
Send pause frames on this queue.
FALSE Do not send pause frames on this queue.

QuantaIterationMode
Iteration mode for quanta.

Type: enum
Default: FIXED
Possible Values:
Value
Description
CUSTOM Specify a list of quanta.
FIXED
Specify a value for all quanta.
STEP
Increment through a series of quanta values.
QuantaOverlap
Percentage of overlap of pause time for sequential XOFF frames.

Type: double
Default: 50
Range: 10 - 90
StepPauseRateEnd
Final pause rate value for Step pause rate iteration mode.
Type: u32
Default: 200
Range: 1 - 1000
StepPauseRateStart
Initial pause rate value for Step pause rate iteration mode.
Type: u32
Default: 50
Range: 1 - 1000
StepPauseRateStep
Increment value for Step pause rate iteration mode.

Type: u32
Default: 50
Range: 1 - 1000
StepPauseTimeEnd
Final pause time for Step pause time iteration mode.

Type: u32
Default: 32768
Range: 1 - 67108863
StepPauseTimeStart
Initial pause time for Step pause time iteration mode.

Type: u32
Default: 1024
Range: 1 - 67108863
432
DcbIteratePfcQuantaValueCommand
Writable Attribute
Description
StepPauseTimeStep
Increment value for Step pause time iteration mode.

Type: u32
Default: 1024
Range: 1 - 67108863
StepQuantaEnd
Final quanta value for Step quanta iteration mode.

Type: u16
Default: 1024
StepQuantaStart
Initial quanta value for Step quanta iteration mode.

Type: u16
Default: 0
StepQuantaStep
Increment value for Step quanta iteration mode.

Type: u16
Default: 128
Range: 1 - 65535
DcbIteratePfcPauseTimeCommand Read-Only Attributes

Description:
This command creates and iterates PFC Pause Quanta values on the specified ports.

Parents: Sequencer
DcbIteratePfcQuantaValueCommand Writable Attributes

Writable Attribute
Description
CustomQuantaList
Quanta values to use when iteration mode is CUSTOM.

Type: u16
Default: 0
CustomXonDelayList
XON delay values to use when iteration mode is CUSTOM.

Type: u32
Default: 0
Range: 1 - 67108863
DeviceList
List of devices to use as PFC sources.

Type: handle
Default: 0
Configures whether to transmit a XON frame at the end of each pause or not.
Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
Transmit XON frame.
FALSE Do not transmit XON frame.

FixedQuanta
Quanta value to use when iteration mode is FIXED.

Type: u16
Default: 65535
433
Writable Attribute
Description
FixedXonDelay
XON delay value to use when iteration mode is FIXED.

Type: u32
Default: 1024
Range: 1 - 67108863
PfcPauseTxRate
Pause transmission rate (in pauses per second, per device).

Type: u32
Default: 1
Range: 1 - 1000
Type: bool
Default: TRUE
Possible Values:
Value Description
TRUE

QuantaIterationMode
This option configures how the PFC quanta value is iterated.

Type: enum
Default: FIXED
Possible Values:
Value
Description
CUSTOM Use a CUSTOM list of quanta values.
FIXED
Use a single, FIXED quanta value.
STEP
STEP quanta values by a fixed amount between a min and max quanta value.
RANDOM Use a uniform, RANDOM distribution of quanta values between 0 and 65535.
StepQuantaEnd
Final quanta value to use when iteration mode is STEP.

Type: u16
Default: 1024
StepQuantaStart
Initial quanta value to use when iteration mode is STEP.

Type: u16
Default: 0
StepQuantaStep
Quanta step value to use when iteration mode is STEP.

Type: u16
Default: 128
Range: 1 - 65535
StepXonDelayEnd
Final XON delay value to use when iteration mode is STEP.

Type: u32
Default: 32768
Range: 1 - 67108863
StepXonDelayStart
Initial XON delay value to use when iteration mode is STEP.

Type: u32
Default: 1024
Range: 1 - 67108863
StepXonDelayStep
Step XON delay values by this value when iteration mode is STEP.
Type: u32
Default: 1024
Range: 1 - 67108863
XonDelayIterationMode
This option configures how the XON Delay is iterated. Only applicable when EnableXonXoffFlowControl is TRUE.
Type: enum
Default: FIXED
Possible Values:
Value
Description
CUSTOM Use a CUSTOM list of XON delay values.
FIXED
Use a single, FIXED XON delay value.
STEP
STEP XON delay values by a fixed amount between a min and max delay value.
434
DcbIteratePfcResponseTimeCommand
Writable Attribute
Description
XonDelayUnit
This options specifies what units are used to describe XON delay.
Type: enum
Default: QUANTA
Possible Values:
Value
Description
QUANTA XON delay is in quanta.
BYTES
XON delay is in bytes.
DcbIteratePfcQuantaValueCommand Read-Only Attributes

Description:
DCB iterate Pfc response time command.

Parents: Sequencer
DcbIteratePfcResponseTimeCommand Writable Attributes

Writable Attribute
Description
CustomQuantaList

Type: u16
Default: 0
CustomXonDelayList

Type: u32
Default: 0
Range: 1 - 67108863
Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
Transmit XON frame.

FixedQuanta

Type: u16
Default: 65535
FixedXonDelay

Type: u32
Default: 1024
Range: 1 - 67108863
PortList
Ports to use for this command.

Type: handle
Default: 0
435
Writable Attribute
Description
Type: bool
Default: TRUE
Possible Values:
Value Description
TRUE

QuantaIterationMode

Type: enum
Default: FIXED
Possible Values:
Value
Description
FIXED
STEP
StepQuantaEnd

Type: u16
Default: 1024
StepQuantaStart

Type: u16
Default: 0
StepQuantaStep

Type: u16
Default: 128
Range: 1 - 65535
StepXonDelayEnd

Type: u32
Default: 32768
Range: 1 - 67108863
StepXonDelayStart

Type: u32
Default: 1024
Range: 1 - 67108863
StepXonDelayStep
Type: u32
Default: 1024
Range: 1 - 67108863
Type: enum
Default: FIXED
Possible Values:
Value
Description
XonDelayUnit
FIXED
STEP
Type: enum
Default: QUANTA
Possible Values:
Value
Description
BYTES
436
DcbMaximumForwardingRatePerIterationResult
DcbIteratePfcResponseTimeCommand Read-Only Attributes

Description:
DCB maximum forwarding rate test per iteration result.

DcbMaximumForwardingRatePerIterationResult Writable Attributes

DcbMaximumForwardingRatePerIterationResult Read-Only Attributes

Read-Only Attribute
Description
AvgInterarrivalTime

Type: double
Default: 0
AvgJitter

Type: double
Default: 0
AvgLatency

Type: double
Default: 0
ChecksumErrorCount

Type: u64
Default: 0
DroppedFrameCount

Type: u64
Default: 0
DroppedFramePct

Type: double
Default: 0
DuplicateFrameCount

Type: u64
Default: 0
DurationInSec

Type: double
Default: 0

Type: u64
Default: 0
FcsErrorFrameCount

Type: u64
Default: 0
437
Read-Only Attribute
Description
FloodedFrameCount

Type: u64
Default: 0
ForwardingRate

Type: double
Default: 0
IntendedLoad

Type: double
Default: 0
IntendedMbpsLoad

Type: double
Default: 0
MaxInterarrivalTime

Type: double
Default: 0
MaxJitter

Type: double
Default: 0
MaxLatency

Type: double
Default: 0
MinInterarrivalTime

Type: double
Default: 0
MinJitter

Type: double
Default: 0
MinLatency

Type: double
Default: 0
OfferedAvgFrameSize
Type: double
Default: 0
OfferedLoad

Type: double
Default: 0
OfferedMbpsLoad

Type: double
Default: 0
OtherFrameCount
traffic, etc.
Type: u64
Default: 0
OutSeqFrameCount

Type: u64
Default: 0
PauseFrameCount

Type: u64
Default: 0
438
Read-Only Attribute
Description
PfcFrameCount

Type: u64
Default: 0
PfcPri0FrameCount

Type: u64
Default: null
PfcPri0Quanta

Type: u64
Default: null
PfcPri0TriggerCount
Type: u64
Default: null
PfcPri1FrameCount

Type: u64
Default: null
PfcPri1Quanta

Type: u64
Default: null
PfcPri1TriggerCount
Type: u64
Default: null
PfcPri2FrameCount

Type: u64
Default: null
PfcPri2Quanta

Type: u64
Default: null
PfcPri2TriggerCount
Type: u64
Default: null
PfcPri3FrameCount

Type: u64
Default: null
PfcPri3Quanta

Type: u64
Default: null
PfcPri3TriggerCount
Type: u64
Default: null
PfcPri4FrameCount

Type: u64
Default: null
PfcPri4Quanta

Type: u64
Default: null
PfcPri4TriggerCount
Type: u64
Default: null
439
DcbMaximumForwardingRateTestCaseConfig
Read-Only Attribute
Description
PfcPri5FrameCount

Type: u64
Default: null
PfcPri5Quanta

Type: u64
Default: null
PfcPri5TriggerCount
Type: u64
Default: null
PfcPri6FrameCount

Type: u64
Default: null
PfcPri6Quanta

Type: u64
Default: null
PfcPri6TriggerCount
Type: u64
Default: null
PfcPri7FrameCount

Type: u64
Default: null
PfcPri7Quanta

Type: u64
Default: null
PfcPri7TriggerCount
Type: u64
Default: null
RxFrameCount

Type: u64
Default: 0
TrialNum
Trial number.
Type: u8
Default: 0
TxFrameCount

Type: u64
Default: 0
TxFrameRate
by the test tool.
Type: double
Default: 0
Description:
DCB maximum forwarding rate test configuration.
440
Relations:
Side name
(Type)
Relative
Description
GroupCollection
GroupCollection

sequencer.
DcbMaximumForwardingRateTestCaseConfig Writable Attributes

Writable Attribute
Description
Active, Name

Type: enum
Default: FIXED
Possible Values:
Value
Description
FIXED

STEP
CustomBurstSizeList

Type: u16
Default: 0
Range: 1 - 65535
CustomFrameSizeList

Type: u16
Default: 0
Range: 40 - 16383
CustomLoadSizeList

Type: double
Default: 0
FixedBurstSize

Type: u16
Default: 1
Range: 1 - 65535
FixedFrameSize

Type: u16
Default: 128
Range: 40 - 16383
FixedLoadSize

Type: double
Default: 10

Type: enum
Default: FIXED
Possible Values:
Value
Description
FIXED

STEP
441
Writable Attribute
Description
InterFrameGap

Type: u32
Default: 12
Range: 11 - 16383
Type: enum
Default: MINIMUM
Possible Values:
Value
Description
USER
LoadSizeConfigMode

Type: enum
Default: WEIGHTED
Possible Values:
Value
Description

Type: enum
Default: STEP
Possible Values:
Value
Description
FIXED

STEP
LoadUnits

Type: enum
Possible Values:
Value
Description
PERCENT_LINE_RATE
Percent line rate.
KILOBITS_PER_SECOND
BITS_PER_SECOND
Type: enum
Default: MANUAL
Possible Values:
Value
Description
AUTOMATIC
MANUAL
Type: bool
Default: TRUE
Possible Values:
Value Description
TRUE
442
Writable Attribute
Description
RandomMaxFrameSize

Type: u16
Default: 256
Range: 40 - 16383
RandomMinFrameSize

Type: u16
Default: 128
Range: 40 - 16383
ResultViewMode
Type: enum
Possible Values:
Value
Description
BASIC
HISTOGRAM
JITTER

FORWARDING
LATENCY_JITTER
StepBurstSizeEnd

Type: u16
Default: 1000
Range: 1 - 65535
StepBurstSizeStart

Type: u16
Default: 100
Range: 1 - 65535
StepBurstSizeStep

Type: u16
Default: 100
Range: 1 - 65535
StepFrameSizeEnd

Type: u16
Default: 1518
Range: 40 - 16383
StepFrameSizeStart

Type: u16
Default: 128
Range: 40 - 16383
StepFrameSizeStep

Type: u16
Default: 128
Range: 1 - 16383
StepLoadSizeEnd

Type: double
Default: 10
StepLoadSizeStart

Type: double
Default: 100
StepLoadSizeStep

Type: double
Default: 10
Range: 0.001 - 100000000000.0
443
DcbPfcBufferingAndLatencyPerIterationResult
DcbMaximumForwardingRateTestCaseConfig Read-Only Attributes

Read-Only Attribute
Description
ConfigIsValid
Type: bool
Default: TRUE
Possible Values:
Value Description
TRUE

Type: string
Default: 0
FrameSizeIsValid
Type: bool
Default: TRUE
Possible Values:
Value Description
TRUE

Type: string
Default: 0
LoadIsValid
is oversubscribed.
Type: bool
Default: TRUE
Possible Values:
Value Description
TRUE

Type: string
Default: 0
Description:
DCB PFC buffering and latency test per iteration result.

DcbPfcBufferingAndLatencyPerIterationResult Writable Attributes

444
DcbPfcBufferingAndLatencyPerIterationResult Read-Only Attributes

Read-Only Attribute
Description
AvgInterarrivalTime

Type: double
Default: 0
AvgJitter

Type: double
Default: 0
AvgLatency

Type: double
Default: 0
ChecksumErrorCount

Type: u64
Default: 0
DroppedFrameCount

Type: u64
Default: 0
DroppedFramePct

Type: double
Default: 0
DuplicateFrameCount

Type: u64
Default: 0
DurationInSec

Type: double
Default: 0

Type: u64
Default: 0
FcsErrorFrameCount

Type: u64
Default: 0
FloodedFrameCount

Type: u64
Default: 0
ForwardingRate

Type: double
Default: 0
HistBin10Count
Bucket 10.
Type: u64
Default: 0
HistBin10Label
Latency range (us) for bucket 10.

Type: string
Default: N/A
HistBin11Count
Bucket 11.
Type: u64
Default: 0
HistBin11Label

Type: string
Default: N/A
445
Read-Only Attribute
Description
HistBin12Count
Bucket 12.
Type: u64
Default: 0
HistBin12Label

Type: string
Default: N/A
HistBin13Count
Bucket 13.
Type: u64
Default: 0
HistBin13Label

Type: string
Default: N/A
HistBin14Count
Bucket 14.
Type: u64
Default: 0
HistBin14Label

Type: string
Default: N/A
HistBin15Count
Bucket 15.
Type: u64
Default: 0
HistBin15Label

Type: string
Default: N/A
HistBin16Count
Bucket 16.
Type: u64
Default: 0
HistBin16Label

Type: string
Default: N/A
HistBin1Count
Bucket 1.
Type: u64
Default: 0
HistBin1Label

Type: string
Default: N/A
HistBin2Count
Bucket 2.
Type: u64
Default: 0
HistBin2Label

Type: string
Default: N/A
HistBin3Count
Bucket 3.
Type: u64
Default: 0
HistBin3Label

Type: string
Default: N/A
HistBin4Count
Bucket 4.
Type: u64
Default: 0
446
Read-Only Attribute
Description
HistBin4Label

Type: string
Default: N/A
HistBin5Count
Bucket 5.
Type: u64
Default: 0
HistBin5Label

Type: string
Default: N/A
HistBin6Count
Bucket 6.
Type: u64
Default: 0
HistBin6Label

Type: string
Default: N/A
HistBin7Count
Bucket 7.
Type: u64
Default: 0
HistBin7Label

Type: string
Default: N/A
HistBin8Count
Bucket 8.
Type: u64
Default: 0
HistBin8Label

Type: string
Default: N/A
HistBin9Count
Bucket 9.
Type: u64
Default: 0
HistBin9Label

Type: string
Default: N/A
IntendedLoad

Type: double
Default: 0
IntendedMbpsLoad

Type: double
Default: 0
MaxInterarrivalTime

Type: double
Default: 0
MaxJitter

Type: double
Default: 0
MaxLatency

Type: double
Default: 0
MinInterarrivalTime

Type: double
Default: 0
447
Read-Only Attribute
Description
MinJitter

Type: double
Default: 0
MinLatency

Type: double
Default: 0
OfferedAvgFrameSize
Type: double
Default: 0
OfferedLoad

Type: double
Default: 0
OfferedMbpsLoad

Type: double
Default: 0
OtherFrameCount
traffic, etc.
Type: u64
Default: 0
OutSeqFrameCount

Type: u64
Default: 0
PauseFrameCount

Type: u64
Default: 0
PfcFrameCount

Type: u64
Default: 0
PfcPri0FrameCount

Type: u64
Default: null
PfcPri0Quanta

Type: u64
Default: null
PfcPri0TriggerCount
Type: u64
Default: null
PfcPri1FrameCount

Type: u64
Default: null
PfcPri1Quanta

Type: u64
Default: null
PfcPri1TriggerCount
Type: u64
Default: null
PfcPri2FrameCount

Type: u64
Default: null
448
Read-Only Attribute
Description
PfcPri2Quanta

Type: u64
Default: null
PfcPri2TriggerCount
Type: u64
Default: null
PfcPri3FrameCount

Type: u64
Default: null
PfcPri3Quanta

Type: u64
Default: null
PfcPri3TriggerCount
Type: u64
Default: null
PfcPri4FrameCount

Type: u64
Default: null
PfcPri4Quanta

Type: u64
Default: null
PfcPri4TriggerCount
Type: u64
Default: null
PfcPri5FrameCount

Type: u64
Default: null
PfcPri5Quanta

Type: u64
Default: null
PfcPri5TriggerCount
Type: u64
Default: null
PfcPri6FrameCount

Type: u64
Default: null
PfcPri6Quanta

Type: u64
Default: null
PfcPri6TriggerCount
Type: u64
Default: null
PfcPri7FrameCount

Type: u64
Default: null
PfcPri7Quanta

Type: u64
Default: null
449
DcbPfcBufferingAndLatencyTestCaseConfig
Read-Only Attribute
Description
PfcPri7TriggerCount
Type: u64
Default: null
PfcTxPauseRate
Pause transmission rate.

Type: u32
Default: 0
PfcTxPauseTime
Duration of each PFC pause.

Type: u32
Default: 0
PfcTxQuantum
Transmitted PFC quanta value.

Type: s32
Default: 0
PfcTxXonDelay
XON delay value.

Type: u32
Default: 0
PfcTxXonEnabled
Indicates whether the test transmitted XON frames or not.

Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
XON frames were transmitted.
FALSE XON frames were NOT transmitted.

RxFrameCount

Type: u64
Default: 0
TrialNum
Trial number.
Type: u8
Default: 0
TxFrameCount

Type: u64
Default: 0
TxFrameRate
by the test tool.
Type: double
Default: 0
Description:
DCB PFC buffering and latency test configuration.

Relations:
450
Side name
(Type)
Relative
Description
GroupCollection
GroupCollection
This relation indicates which GroupCollection object contains the

test traffic for the test.
PauseDevice
(PfcPauseDeviceBinding)
EmulatedDevice
This relation indicates which devices will send PFC pause frames
during the test.
sequencer.
DcbPfcBufferingAndLatencyTestCaseConfig Writable Attributes

Writable Attribute
Description
Active, Name

Type: enum
Default: FIXED
Possible Values:
Value
Description
FIXED

STEP
CustomBurstSizeList

Type: u16
Default: 0
Range: 1 - 65535
CustomFrameSizeList

Type: u16
Default: 0
Range: 40 - 16383
CustomLoadSizeList

Type: double
Default: 0
CustomPauseRateList
Pause Rate values to use when iteration mode is CUSTOM.

Type: u32
Default: 0
Range: 1 - 1000
CustomPauseTimeList
Pause Time values to use when iteration mode is CUSTOM.

Type: u32
Default: 0
Range: 1 - 67108863
CustomQuantaList

Type: u16
Default: 0
CustomXonDelayList
not use it.
Type: u32
Default: 0
Range: 1 - 67108863
451
Writable Attribute
Description
Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
Transmit XON frame.

FixedBurstSize

Type: u16
Default: 1
Range: 1 - 65535
FixedFrameSize

Type: u16
Default: 128
Range: 40 - 16383
FixedLoadSize

Type: double
Default: 10
FixedPauseRate
Pause Rate to use when iteration mode is FIXED.

Type: u32
Default: 100
Range: 1 - 1000
FixedPauseTime
Pause Time value to use when iteration mode is FIXED.

Type: u32
Default: 1024
Range: 1 - 67108863
FixedQuanta

Type: u16
Default: 65535
FixedXonDelay
not use it.
Type: u32
Default: 1024
Range: 1 - 67108863

Type: enum
Default: FIXED
Possible Values:
Value
Description
FIXED

STEP
InterFrameGap

Type: u32
Default: 12
Range: 11 - 16383
Type: enum
Default: MINIMUM
Possible Values:
Value
Description
USER
452
Writable Attribute
Description
LatencyHistogramCalibrationDuration
Latency histogram calibration duration in seconds.

Type: u32
Default: 10
LatencyHistogramDistributionMode
Latency histogram distribution mode.

Type: enum
Default: LINEAR
Possible Values:
Value
Description
EXPONENTIAL Exponential latency histogram distribution mode.
LINEAR
LoadSizeConfigMode
Linear latency histogram distribution mode.

Type: enum
Default: WEIGHTED
Possible Values:
Value
Description

Type: enum
Default: STEP
Possible Values:
Value
Description
FIXED

STEP
LoadUnits

Type: enum
Possible Values:
Value
Description
PERCENT_LINE_RATE
Percent line rate.
KILOBITS_PER_SECOND
BITS_PER_SECOND
This option configures how the PFC Pause Rate is iterated.

Type: enum
Default: FIXED
Possible Values:
Value
Description
CUSTOM Use a CUSTOM list of pause rates.
FIXED
Use a single, FIXED pause rate.
STEP
STEP pause rate values by a fixed amount between a min and max rate.
This option configures how the PFC Pause Time is iterated.

Type: enum
Default: FIXED
Possible Values:
Value
Description
CUSTOM Use a CUSTOM list of pause times.
FIXED
Use a single, FIXED pause time.
STEP
STEP pause time values by a fixed amount between a min and max pause time value.
453
Writable Attribute
Description
PauseTimeUnit
This options specifies what units are used to describe Pause Time.
Type: enum
Default: QUANTA
Possible Values:
Value
Description
QUANTA Pause Time is in quanta.
BYTES
Pause Time is in bytes.
Type: enum
Default: MANUAL
Possible Values:
Value
Description
AUTOMATIC
MANUAL
PfcPauseTxRate
not use it.
Type: u32
Default: 1
Range: 1 - 1000
Type: bool
Default: TRUE
Possible Values:
Value Description
TRUE

PriorityFlowControlTxArray
Specifies which Priorities will be paused by PFC frames transmitted from the test tool.
Type: bool
Default: TRUE
Possible Values:
Value Description
TRUE

QuantaIterationMode

Type: enum
Default: FIXED
Possible Values:
Value
Description
FIXED
STEP
QuantaOverlap
Adjusts the gap between sequential non-zero PFC pause frames.

Type: double
Default: 50
Range: 10 - 90
RandomMaxFrameSize

Type: u16
Default: 256
Range: 40 - 16383
454
Writable Attribute
Description
RandomMinFrameSize

Type: u16
Default: 128
Range: 40 - 16383
ResultViewMode
Type: enum
Possible Values:
Value
Description
BASIC
HISTOGRAM
JITTER

FORWARDING
LATENCY_JITTER
StepBurstSizeEnd

Type: u16
Default: 1000
Range: 1 - 65535
StepBurstSizeStart

Type: u16
Default: 100
Range: 1 - 65535
StepBurstSizeStep

Type: u16
Default: 100
Range: 1 - 65535
StepFrameSizeEnd

Type: u16
Default: 1518
Range: 40 - 16383
StepFrameSizeStart

Type: u16
Default: 128
Range: 40 - 16383
StepFrameSizeStep

Type: u16
Default: 128
Range: 1 - 16383
StepLoadSizeEnd

Type: double
Default: 10
StepLoadSizeStart

Type: double
Default: 100
StepLoadSizeStep

Type: double
Default: 10
Range: 0.001 - 100000000000.0
StepPauseRateEnd
Final pause rate to use when iteration mode is STEP.

Type: u32
Default: 200
Range: 1 - 1000
455
Writable Attribute
Description
StepPauseRateStart
Initial pause rate to use when iteration mode is STEP.

Type: u32
Default: 50
Range: 1 - 1000
StepPauseRateStep
Pause rate step to use when iteration mode is STEP.

Type: u32
Default: 50
Range: 1 - 1000
StepPauseTimeEnd
Final pause time value to use when iteration mode is STEP.

Type: u32
Default: 32768
Range: 1 - 67108863
StepPauseTimeStart
Initial pause time value to use when iteration mode is STEP.

Type: u32
Default: 1024
Range: 1 - 67108863
StepPauseTimeStep
Pause time step value to use when iteration mode is STEP.

Type: u32
Default: 1024
Range: 1 - 67108863
StepQuantaEnd

Type: u16
Default: 1024
StepQuantaStart

Type: u16
Default: 0
StepQuantaStep

Type: u16
Default: 128
Range: 1 - 65535
StepXonDelayEnd
not use it.
Type: u32
Default: 32768
Range: 1 - 67108863
StepXonDelayStart
not use it.
Type: u32
Default: 1024
Range: 1 - 67108863
StepXonDelayStep
not use it.
Type: u32
Default: 1024
Range: 1 - 67108863
456
Writable Attribute
Description
not use it.
Type: enum
Default: FIXED
Possible Values:
Value
Description
XonDelayUnit
FIXED
STEP
not use it.
Type: enum
Default: QUANTA
Possible Values:
Value
Description
BYTES
DcbPfcBufferingAndLatencyTestCaseConfig Read-Only Attributes

Read-Only Attribute
Description
ConfigIsValid
Type: bool
Default: TRUE
Possible Values:
Value Description
TRUE

Type: string
Default: 0
FrameSizeIsValid
Type: bool
Default: TRUE
Possible Values:
Value Description
TRUE

Type: string
Default: 0
LoadIsValid
is oversubscribed.
Type: bool
Default: TRUE
Possible Values:
Value Description
TRUE

Type: string
Default: 0
457
DcbPfcBufferingPerIterationResult
Description:
DCB PFC buffering test per iteration result.

DcbPfcBufferingPerIterationResult Writable Attributes

DcbPfcBufferingPerIterationResult Read-Only Attributes

Read-Only Attribute
Description
AvgInterarrivalTime

Type: double
Default: 0
AvgJitter

Type: double
Default: 0
AvgLatency

Type: double
Default: 0
ChecksumErrorCount

Type: u64
Default: 0
DroppedFrameCount

Type: u64
Default: 0
DroppedFramePct

Type: double
Default: 0
DuplicateFrameCount

Type: u64
Default: 0
DurationInSec

Type: double
Default: 0

Type: u64
Default: 0
FcsErrorFrameCount

Type: u64
Default: 0
FloodedFrameCount

Type: u64
Default: 0
ForwardingRate

Type: double
Default: 0
IntendedLoad

Type: double
Default: 0
458
Read-Only Attribute
Description
IntendedMbpsLoad

Type: double
Default: 0
MaxInterarrivalTime

Type: double
Default: 0
MaxJitter

Type: double
Default: 0
MaxLatency

Type: double
Default: 0
MinInterarrivalTime

Type: double
Default: 0
MinJitter

Type: double
Default: 0
MinLatency

Type: double
Default: 0
OfferedAvgFrameSize
Type: double
Default: 0
OfferedLoad

Type: double
Default: 0
OfferedMbpsLoad

Type: double
Default: 0
OtherFrameCount
traffic, etc.
Type: u64
Default: 0
OutSeqFrameCount

Type: u64
Default: 0
PauseFrameCount

Type: u64
Default: 0
PfcFrameCount

Type: u64
Default: 0
PfcPri0FrameCount

Type: u64
Default: null
PfcPri0Quanta

Type: u64
Default: null
459
Read-Only Attribute
Description
PfcPri0TriggerCount
Type: u64
Default: null
PfcPri1FrameCount

Type: u64
Default: null
PfcPri1Quanta

Type: u64
Default: null
PfcPri1TriggerCount
Type: u64
Default: null
PfcPri2FrameCount

Type: u64
Default: null
PfcPri2Quanta

Type: u64
Default: null
PfcPri2TriggerCount
Type: u64
Default: null
PfcPri3FrameCount

Type: u64
Default: null
PfcPri3Quanta

Type: u64
Default: null
PfcPri3TriggerCount
Type: u64
Default: null
PfcPri4FrameCount

Type: u64
Default: null
PfcPri4Quanta

Type: u64
Default: null
PfcPri4TriggerCount
Type: u64
Default: null
PfcPri5FrameCount

Type: u64
Default: null
PfcPri5Quanta

Type: u64
Default: null
460
Read-Only Attribute
Description
PfcPri5TriggerCount
Type: u64
Default: null
PfcPri6FrameCount

Type: u64
Default: null
PfcPri6Quanta

Type: u64
Default: null
PfcPri6TriggerCount
Type: u64
Default: null
PfcPri7FrameCount

Type: u64
Default: null
PfcPri7Quanta

Type: u64
Default: null
PfcPri7TriggerCount
Type: u64
Default: null
PfcTxPauseRate

Type: u32
Default: 0
PfcTxPauseTime

Type: u32
Default: 0
PfcTxQuantum

Type: s32
Default: 0
PfcTxXonDelay
XON delay value.

Type: u32
Default: 0
PfcTxXonEnabled

Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE

RxFrameCount

Type: u64
Default: 0
TrialNum
Trial number.
Type: u8
Default: 0
TxFrameCount

Type: u64
Default: 0
461
DcbPfcBufferingTestCaseConfig
Read-Only Attribute
Description
TxFrameRate
by the test tool.
Type: double
Default: 0
Description:
DCB PFC buffering test configuration.

Relations:
Side name
(Type)
Relative
Description
GroupCollection
GroupCollection

PauseDevice
EmulatedDevice
during the test.
sequencer.
DcbPfcBufferingTestCaseConfig Writable Attributes

Writable Attribute
Description
Active, Name

Type: enum
Default: FIXED
Possible Values:
Value
Description
FIXED

STEP
CustomBurstSizeList

Type: u16
Default: 0
Range: 1 - 65535
CustomFrameSizeList

Type: u16
Default: 0
Range: 40 - 16383
CustomLoadSizeList

Type: double
Default: 0
462
Writable Attribute
Description
CustomPauseRateList

Type: u32
Default: 0
Range: 1 - 1000
CustomPauseTimeList

Type: u32
Default: 0
Range: 1 - 67108863
CustomQuantaList

Type: u16
Default: 0
CustomXonDelayList
NOTE: This is deprecated. It will be removed in subsequent releases, so it is recommended that you do not
use it.
Type: u32
Default: 0
Range: 1 - 67108863
Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
Transmit XON frame.

FixedBurstSize

Type: u16
Default: 1
Range: 1 - 65535
FixedFrameSize

Type: u16
Default: 128
Range: 40 - 16383
FixedLoadSize

Type: double
Default: 10
FixedPauseRate

Type: u32
Default: 100
Range: 1 - 1000
FixedPauseTime

Type: u32
Default: 1024
Range: 1 - 67108863
FixedQuanta

Type: u16
Default: 65535
FixedXonDelay
use it.
Type: u32
Default: 1024
Range: 1 - 67108863
463
Writable Attribute
Description

Type: enum
Default: FIXED
Possible Values:
Value
Description
FIXED

STEP
InterFrameGap

Type: u32
Default: 12
Range: 11 - 16383
Type: enum
Default: MINIMUM
Possible Values:
Value
Description
USER
LoadSizeConfigMode

Type: enum
Default: WEIGHTED
Possible Values:
Value
Description

Type: enum
Default: STEP
Possible Values:
Value
Description
FIXED

STEP
LoadUnits

Type: enum
Possible Values:
Value
Description
PERCENT_LINE_RATE
Percent line rate.
KILOBITS_PER_SECOND
BITS_PER_SECOND

Type: enum
Default: FIXED
Possible Values:
Value
Description
FIXED
STEP
464
Writable Attribute
Description

Type: enum
Default: FIXED
Possible Values:
Value
Description
PauseTimeUnit
FIXED
STEP
Type: enum
Default: QUANTA
Possible Values:
Value
Description
BYTES
Type: enum
Default: MANUAL
Possible Values:
Value
Description
AUTOMATIC
MANUAL
PfcPauseTxRate
use it.
Type: u32
Default: 1
Range: 1 - 1000
Type: bool
Default: TRUE
Possible Values:
Value Description
TRUE

Type: bool
Default: TRUE
Possible Values:
Value Description
TRUE

QuantaIterationMode

Type: enum
Default: FIXED
Possible Values:
Value
Description
FIXED
STEP
465
Writable Attribute
Description
QuantaOverlap

Type: double
Default: 50
Range: 10 - 90
RandomMaxFrameSize

Type: u16
Default: 256
Range: 40 - 16383
RandomMinFrameSize

Type: u16
Default: 128
Range: 40 - 16383
ResultViewMode
Type: enum
Possible Values:
Value
Description
BASIC
HISTOGRAM
JITTER

FORWARDING
LATENCY_JITTER
StepBurstSizeEnd

Type: u16
Default: 1000
Range: 1 - 65535
StepBurstSizeStart

Type: u16
Default: 100
Range: 1 - 65535
StepBurstSizeStep

Type: u16
Default: 100
Range: 1 - 65535
StepFrameSizeEnd

Type: u16
Default: 1518
Range: 40 - 16383
StepFrameSizeStart

Type: u16
Default: 128
Range: 40 - 16383
StepFrameSizeStep

Type: u16
Default: 128
Range: 1 - 16383
StepLoadSizeEnd

Type: double
Default: 10
StepLoadSizeStart

Type: double
Default: 100
466
Writable Attribute
Description
StepLoadSizeStep

Type: double
Default: 10
Range: 0.001 - 100000000000.0
StepPauseRateEnd

Type: u32
Default: 200
Range: 1 - 1000
StepPauseRateStart

Type: u32
Default: 50
Range: 1 - 1000
StepPauseRateStep

Type: u32
Default: 50
Range: 1 - 1000
StepPauseTimeEnd

Type: u32
Default: 32768
Range: 1 - 67108863
StepPauseTimeStart

Type: u32
Default: 1024
Range: 1 - 67108863
StepPauseTimeStep

Type: u32
Default: 1024
Range: 1 - 67108863
StepQuantaEnd

Type: u16
Default: 1024
StepQuantaStart

Type: u16
Default: 0
StepQuantaStep

Type: u16
Default: 128
Range: 1 - 65535
StepXonDelayEnd
use it.
Type: u32
Default: 32768
Range: 1 - 67108863
StepXonDelayStart
use it.
Type: u32
Default: 1024
Range: 1 - 67108863
StepXonDelayStep
use it.
Type: u32
Default: 1024
Range: 1 - 67108863
467
Writable Attribute
Description
use it.
Type: enum
Default: FIXED
Possible Values:
Value
Description
XonDelayUnit
FIXED
STEP
use it.
Type: enum
Default: QUANTA
Possible Values:
Value
Description
BYTES
DcbPfcBufferingTestCaseConfig Read-Only Attributes

Read-Only Attribute
Description
ConfigIsValid
Type: bool
Default: TRUE
Possible Values:
Value Description
TRUE

Type: string
Default: 0
FrameSizeIsValid
Type: bool
Default: TRUE
Possible Values:
Value Description
TRUE

Type: string
Default: 0
LoadIsValid
is oversubscribed.
Type: bool
Default: TRUE
Possible Values:
Value Description
TRUE

Type: string
Default: 0
468
DcbPfcLoadValidationPerIterationPerPortResult
Description:
PFC Load Validation per iteration, per port result
DcbPfcLoadValidationPerIterationPerPortResult Writable Attributes

DcbPfcLoadValidationPerIterationPerPortResult Read-Only Attributes

Read-Only Attribute
Description
AnaRxFrameCount
Total number of frames received by the analyzer.

Type: u64
Default: 0
AnaRxNonSigFrameCount
Total number of non-test frames received by the analyzer.

Type: u64
Default: 0
AnaRxOctetCount
Total number of octets received by the analyzer.

Type: u64
Default: 0
AnaRxPauseFrameCount
Total number of pause frames received by the analyzer.

Type: u64
Default: 0
AnaRxPfcFrameCount
Total number of PFC Pause frames received by the analyzer.

Type: u64
Default: 0
AnaRxSigFrameCount
Total number of test frames received by the analyzer.

Type: u64
Default: 0
FloodedFrameCount

Type: u64
Default: 0
GenTxFrameCount
Total number of frames transmitted by the generator.

Type: u64
Default: 0
GenTxNonSigFrameCount
Total number of non-test frames transmitted by the generator.

Type: u64
Default: 0
GenTxOctetCount
Total number of octets transmitted by the generator.

Type: u64
Default: 0
GenTxPfcPri0FrameCount
Number of PFC Pause frames generated for priority 0.

Type: u64
Default: 0
GenTxPfcPri0Quanta
Total quanta transmitted by this port for priority 0.

Type: u64
Default: 0

Type: u64
Default: 0
469
Read-Only Attribute
Description
GenTxPfcPri1Quanta

Type: u64
Default: 0

Type: u64
Default: 0
GenTxPfcPri2Quanta

Type: u64
Default: 0

Type: u64
Default: 0
GenTxPfcPri3Quanta

Type: u64
Default: 0

Type: u64
Default: 0
GenTxPfcPri4Quanta

Type: u64
Default: 0

Type: u64
Default: 0
GenTxPfcPri5Quanta

Type: u64
Default: 0

Type: u64
Default: 0
GenTxPfcPri6Quanta

Type: u64
Default: 0

Type: u64
Default: 0
GenTxPfcPri7Quanta

Type: u64
Default: 0
GenTxSigFrameCount
Total number of test frames transmitted by the generator.

Type: u64
Default: 0
Port
Port name.
Type: string
Default: Test
470
Read-Only Attribute
Description
PortResult
Specifies the result for this test case for this port.
Type: enum
Default: UNDETERMINED
Possible Values:
Value
Description
VALID
Measured load is within the configured bounds (expected +/- tolerance).
INVALID
Measured load is not within the configured bounds (expected +/- tolerance).
UNDETERMINED Test logic was unable to determine if the load is within the configured bounds
(probably due to insufficient tx load).
Pri0Result
Specifies the result of priority 0 for this test case on this port.
Type: enum
Possible Values:
Value
Description
VALID
INVALID
Pri1Result
Type: enum
Possible Values:
Value
Description
VALID
INVALID
Pri2Result
Type: enum
Possible Values:
Value
Description
VALID
INVALID
Pri3Result
Type: enum
Possible Values:
Value
Description
VALID
INVALID
Pri4Result
Type: enum
Possible Values:
Value
Description
VALID
INVALID
471
Read-Only Attribute
Description
Pri5Result
Type: enum
Possible Values:
Value
Description
VALID
INVALID
Pri6Result
Type: enum
Possible Values:
Value
Description
VALID
INVALID
Pri7Result
Type: enum
Possible Values:
Value
Description
VALID
INVALID
StreamDroppedFrameCount
Number of dropped frames detected by the hardware on this port.

Type: u64
Default: 0
StreamDroppedFramePct
Percentage of lost frames on this port.

Type: double
Default: 0
StreamDuplicateFrameCount
Number of duplicate frames detected by the hardware on this port.

Type: u64
Default: 0
StreamExpectedRxFrameCount
Number of test frames expected to be received on this port.

Type: u64
Default: 0
StreamExpectedRxOctetCount
Number of test octets expected to be received on this port.

Type: u64
Default: 0
StreamExpectedRxPri0FrameCount
Number of test frames expected for priority 0 on this port.

Type: u64
Default: 0
StreamExpectedRxPri0OctetCount
Number of test octets expected for priority 0 on this port.

Type: u64
Default: 0

Type: u64
Default: 1
472
Read-Only Attribute
Description

Type: u64
Default: 1

Type: u64
Default: 2

Type: u64
Default: 2

Type: u64
Default: 3

Type: u64
Default: 3

Type: u64
Default: 4

Type: u64
Default: 4

Type: u64
Default: 5

Type: u64
Default: 5

Type: u64
Default: 6

Type: u64
Default: 6

Type: u64
Default: 7

Type: u64
Default: 7
StreamFirstArrivalTime
System timestamp for the first received test frame on this port.
Type: double
Default: 0
StreamLastArrivalTime
System timestamp for the last received test frame on this port.
Type: double
Default: 0
StreamMaxValidRxPri0OfferedLoad
Maximum allowed load transmitted by the DUT for priority 0 that is considered a pass on this port.
Type: double
Default: null
Type: double
Default: null
473
Read-Only Attribute
Description
Type: double
Default: null
Type: double
Default: null
Type: double
Default: null
Type: double
Default: null
Type: double
Default: null
Type: double
Default: null
StreamMinValidRxPri0OfferedLoad
Minimum allowed load transmitted by the DUT for priority 0 that is considered a pass on this port.
Type: double
Default: null
Type: double
Default: null
Type: double
Default: null
Type: double
Default: null
Type: double
Default: null
Type: double
Default: null
Type: double
Default: null
Type: double
Default: null
StreamRxFrameCount
Number of test frames received on this port.

Type: u64
Default: 0
StreamRxOctetCount
Number of test octets received on this port.

Type: u64
Default: 0
StreamRxPri0FrameCount
Number of test frames received for priority 0 on this port.

Type: u64
Default: 0
474
Read-Only Attribute
Description
StreamRxPri0IntendedLoad
Load for priority 0 expected on this port.

Type: double
Default: 0
StreamRxPri0OctetCount
Number of test octets received for priority 0 on this port.

Type: u64
Default: 0
StreamRxPri0OfferedLoad
Load transmitted by the DUT for priority 0 on this port.

Type: double
Default: 0

Type: u64
Default: 1

Type: double
Default: 0

Type: u64
Default: 0

Type: double
Default: 0

Type: u64
Default: 2

Type: double
Default: 0

Type: u64
Default: 0

Type: double
Default: 0

Type: u64
Default: 3

Type: double
Default: 0

Type: u64
Default: 0

Type: double
Default: 0

Type: u64
Default: 4

Type: double
Default: 0
475
DcbPfcLoadValidationPerIterationResult
Read-Only Attribute
Description

Type: u64
Default: 0

Type: double
Default: 0

Type: u64
Default: 5

Type: double
Default: 0

Type: u64
Default: 0

Type: double
Default: 0

Type: u64
Default: 6

Type: double
Default: 0

Type: u64
Default: 0

Type: double
Default: 0

Type: u64
Default: 7

Type: double
Default: 0

Type: u64
Default: 0

Type: double
Default: 0
Description:
DCB Pfc load validation per iteration result.
476

DcbPfcLoadValidationPerIterationResult Writable Attributes

DcbPfcLoadValidationPerIterationResult Read-Only Attributes

Read-Only Attribute
Description
AvgInterarrivalTime

Type: double
Default: 0
AvgJitter

Type: double
Default: 0
AvgLatency

Type: double
Default: 0
ChecksumErrorCount

Type: u64
Default: 0
DroppedFrameCount

Type: u64
Default: 0
DroppedFramePct

Type: double
Default: 0
DuplicateFrameCount

Type: u64
Default: 0
DurationInSec

Type: double
Default: 0

Type: u64
Default: 0
FcsErrorFrameCount

Type: u64
Default: 0
FloodedFrameCount

Type: u64
Default: 0
ForwardingRate

Type: double
Default: 0
IntendedLoad

Type: double
Default: 0
IntendedMbpsLoad

Type: double
Default: 0
477
Read-Only Attribute
Description
MaxInterarrivalTime

Type: double
Default: 0
MaxJitter

Type: double
Default: 0
MaxLatency

Type: double
Default: 0
MinInterarrivalTime

Type: double
Default: 0
MinJitter

Type: double
Default: 0
MinLatency

Type: double
Default: 0
OfferedAvgFrameSize
Type: double
Default: 0
OfferedLoad

Type: double
Default: 0
OfferedMbpsLoad

Type: double
Default: 0
OtherFrameCount
traffic, etc.
Type: u64
Default: 0
OutSeqFrameCount

Type: u64
Default: 0
PauseFrameCount

Type: u64
Default: 0
PfcFrameCount

Type: u64
Default: 0
PfcPri0FrameCount

Type: u64
Default: null
PfcPri0Quanta

Type: u64
Default: null
PfcPri0TriggerCount
Type: u64
Default: null
478
Read-Only Attribute
Description
PfcPri1FrameCount

Type: u64
Default: null
PfcPri1Quanta

Type: u64
Default: null
PfcPri1TriggerCount
Type: u64
Default: null
PfcPri2FrameCount

Type: u64
Default: null
PfcPri2Quanta

Type: u64
Default: null
PfcPri2TriggerCount
Type: u64
Default: null
PfcPri3FrameCount

Type: u64
Default: null
PfcPri3Quanta

Type: u64
Default: null
PfcPri3TriggerCount
Type: u64
Default: null
PfcPri4FrameCount

Type: u64
Default: null
PfcPri4Quanta

Type: u64
Default: null
PfcPri4TriggerCount
Type: u64
Default: null
PfcPri5FrameCount

Type: u64
Default: null
PfcPri5Quanta

Type: u64
Default: null
PfcPri5TriggerCount
Type: u64
Default: null
PfcPri6FrameCount

Type: u64
Default: null
479
Read-Only Attribute
Description
PfcPri6Quanta

Type: u64
Default: null
PfcPri6TriggerCount
Type: u64
Default: null
PfcPri7FrameCount

Type: u64
Default: null
PfcPri7Quanta

Type: u64
Default: null
PfcPri7TriggerCount
Type: u64
Default: null
PfcTxPauseRate

Type: u32
Default: 0
PfcTxPauseTime

Type: u32
Default: 0
PfcTxQuantum

Type: s32
Default: 0
PfcTxXonDelay
XON delay value.

Type: u32
Default: 0
PfcTxXonEnabled

Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE

Result
Specifies the result for this test case.

Type: enum
Possible Values:
Value
Description
VALID
INVALID
UNDETERMINED Test logic was unable to determine if the load is within the configured bounds (probably
due to insufficient tx load).
RxFrameCount

Type: u64
Default: 0
TrialNum
Trial number.
Type: u8
Default: 0
480
DcbPfcLoadValidationTestCaseConfig
Read-Only Attribute
Description
TxFrameCount

Type: u64
Default: 0
TxFrameRate
by the test tool.
Type: double
Default: 0
Description:
DCB PFC load validation test configuration.

Relations:
Side name
(Type)
Relative
Description
GroupCollection
GroupCollection

PauseDevice
EmulatedDevice
during the test.
sequencer.
DcbPfcLoadValidationTestCaseConfig Writable Attributes

Writable Attribute
Description
Active, Name

Type: enum
Default: FIXED
Possible Values:
Value
Description
FIXED

STEP
CustomBurstSizeList

Type: u16
Default: 0
Range: 1 - 65535
CustomFrameSizeList

Type: u16
Default: 0
Range: 40 - 16383
CustomLoadSizeList

Type: double
Default: 0
481
Writable Attribute
Description
CustomPauseRateList

Type: u32
Default: 0
Range: 1 - 1000
CustomPauseTimeList

Type: u32
Default: 0
Range: 1 - 67108863
CustomQuantaList

Type: u16
Default: 0
CustomXonDelayList
use it.
Type: u32
Default: 0
Range: 1 - 67108863
Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
Transmit XON frame.

FixedBurstSize

Type: u16
Default: 1
Range: 1 - 65535
FixedFrameSize

Type: u16
Default: 128
Range: 40 - 16383
FixedLoadSize

Type: double
Default: 10
FixedPauseRate

Type: u32
Default: 100
Range: 1 - 1000
FixedPauseTime

Type: u32
Default: 1024
Range: 1 - 67108863
FixedQuanta

Type: u16
Default: 65535
FixedXonDelay
use it.
Type: u32
Default: 1024
Range: 1 - 67108863
482
Writable Attribute
Description

Type: enum
Default: FIXED
Possible Values:
Value
Description
FIXED

STEP
InterFrameGap

Type: u32
Default: 12
Range: 11 - 16383
Type: enum
Default: MINIMUM
Possible Values:
Value
Description
USER
LoadSizeConfigMode

Type: enum
Default: WEIGHTED
Possible Values:
Value
Description

Type: enum
Default: STEP
Possible Values:
Value
Description
FIXED

STEP
LoadUnits

Type: enum
Possible Values:
Value
Description
PERCENT_LINE_RATE
Percent line rate.
KILOBITS_PER_SECOND
BITS_PER_SECOND

Type: enum
Default: FIXED
Possible Values:
Value
Description
FIXED
STEP
483
Writable Attribute
Description

Type: enum
Default: FIXED
Possible Values:
Value
Description
PauseTimeUnit
FIXED
STEP
Type: enum
Default: QUANTA
Possible Values:
Value
Description
BYTES
Type: enum
Default: MANUAL
Possible Values:
Value
Description
AUTOMATIC
MANUAL
PfcPauseTxRate
use it.
Type: u32
Default: 1
Range: 1 - 1000
Type: bool
Default: TRUE
Possible Values:
Value Description
TRUE

Type: bool
Default: TRUE
Possible Values:
Value Description
TRUE

QuantaIterationMode

Type: enum
Default: FIXED
Possible Values:
Value
Description
FIXED
STEP
484
Writable Attribute
Description
QuantaOverlap

Type: double
Default: 50
Range: 10 - 90
RandomMaxFrameSize

Type: u16
Default: 256
Range: 40 - 16383
RandomMinFrameSize

Type: u16
Default: 128
Range: 40 - 16383
ResultViewMode
Type: enum
Possible Values:
Value
Description
BASIC
HISTOGRAM
JITTER

FORWARDING
LATENCY_JITTER
StepBurstSizeEnd

Type: u16
Default: 1000
Range: 1 - 65535
StepBurstSizeStart

Type: u16
Default: 100
Range: 1 - 65535
StepBurstSizeStep

Type: u16
Default: 100
Range: 1 - 65535
StepFrameSizeEnd

Type: u16
Default: 1518
Range: 40 - 16383
StepFrameSizeStart

Type: u16
Default: 128
Range: 40 - 16383
StepFrameSizeStep

Type: u16
Default: 128
Range: 1 - 16383
StepLoadSizeEnd

Type: double
Default: 10
StepLoadSizeStart

Type: double
Default: 100
485
Writable Attribute
Description
StepLoadSizeStep

Type: double
Default: 10
Range: 0.001 - 100000000000.0
StepPauseRateEnd

Type: u32
Default: 200
Range: 1 - 1000
StepPauseRateStart

Type: u32
Default: 50
Range: 1 - 1000
StepPauseRateStep

Type: u32
Default: 50
Range: 1 - 1000
StepPauseTimeEnd

Type: u32
Default: 32768
Range: 1 - 67108863
StepPauseTimeStart

Type: u32
Default: 1024
Range: 1 - 67108863
StepPauseTimeStep

Type: u32
Default: 1024
Range: 1 - 67108863
StepQuantaEnd

Type: u16
Default: 1024
StepQuantaStart

Type: u16
Default: 0
StepQuantaStep

Type: u16
Default: 128
Range: 1 - 65535
StepXonDelayEnd
use it.
Type: u32
Default: 32768
Range: 1 - 67108863
StepXonDelayStart
use it.
Type: u32
Default: 1024
Range: 1 - 67108863
StepXonDelayStep
use it.
Type: u32
Default: 1024
Range: 1 - 67108863
486
Writable Attribute
Description
Tolerance
Specifies the range of values considered a pass for this test case (in % of line rate).
Type: double
Default: 1.0
Range: 0.001 - 10.0
use it.
Type: enum
Default: FIXED
Possible Values:
Value
Description
XonDelayUnit
FIXED
STEP
use it.
Type: enum
Default: QUANTA
Possible Values:
Value
Description
BYTES
DcbPfcLoadValidationTestCaseConfig Read-Only Attributes

Read-Only Attribute
Description
ConfigIsValid
Type: bool
Default: TRUE
Possible Values:
Value Description
TRUE

Type: string
Default: 0
FrameSizeIsValid
Type: bool
Default: TRUE
Possible Values:
Value Description
TRUE

Type: string
Default: 0
LoadIsValid
is oversubscribed.
Type: bool
Default: TRUE
Possible Values:
Value Description
TRUE
487
DcbPfcResponseTimePerIterationPerPortResult
Read-Only Attribute
Description
Type: string
Default: 0
Description:
PFC Response Time per iteration, per port result.
DcbPfcResponseTimePerIterationPerPortResult Writable Attributes

DcbPfcResponseTimePerIterationPerPortResult Read-Only Attributes

Read-Only Attribute
Description
AnaRxFrameCount
Total number of frames received by the analyzer.

Type: u64
Default: 0
AnaRxNonSigFrameCount
Total number of non-test frames received by the analyzer.

Type: u64
Default: 0
AnaRxOctetCount
Total number of octets received by the analyzer.

Type: u64
Default: 0
AnaRxPauseFrameCount
Total number of pause frames received by the analyzer.

Type: u64
Default: 0
AnaRxPfcFrameCount
Total number of PFC Pause frames received by the analyzer.

Type: u64
Default: 0
AnaRxSigFrameCount
Total number of test frames received by the analyzer.

Type: u64
Default: 0
FloodedFrameCount

Type: u64
Default: 0
GenTxFrameCount
Total number of frames transmitted by the generator.

Type: u64
Default: 0
GenTxNonSigFrameCount
Total number of non-test frames transmitted by the generator.

Type: u64
Default: 0
GenTxOctetCount
Total number of octets transmitted by the generator.

Type: u64
Default: 0
488
Read-Only Attribute
Description
GenTxSigFrameCount
Total number of test frames transmitted by the generator.

Type: u64
Default: 0
Port
Port name.
Type: string
Default: Test
PortSpeedInBps
Port PHY speed in Bits Per Second (bps).

Type: double
Default: 0
Pri0ActualPauseTime
Measured pause time for priority 0 on this port.

Type: u64
Default: null
Pri0RequestPauseTime
Pause time requested by the hardware for priority 0 on this port.

Type: u64
Default: 0
Pri0ResponseTime
Measured response time for priority 0 on this port.

Type: u64
Default: null
Pri0XonResponseTime
Measured XON response time for priority 0 on this port.

Type: u64
Default: null
Pri1ActualPauseTime

Type: u64
Default: null

Type: u64
Default: 0
Pri1ResponseTime

Type: u64
Default: null
Pri1XonResponseTime

Type: u64
Default: null
Pri2ActualPauseTime

Type: u64
Default: null

Type: u64
Default: 0
Pri2ResponseTime

Type: u64
Default: null
Pri2XonResponseTime

Type: u64
Default: null
Pri3ActualPauseTime

Type: u64
Default: null

Type: u64
Default: 0
489
Read-Only Attribute
Description
Pri3ResponseTime

Type: u64
Default: null
Pri3XonResponseTime

Type: u64
Default: null
Pri4ActualPauseTime

Type: u64
Default: null

Type: u64
Default: 0
Pri4ResponseTime

Type: u64
Default: null
Pri4XonResponseTime

Type: u64
Default: null
Pri5ActualPauseTime

Type: u64
Default: null

Type: u64
Default: 0
Pri5ResponseTime

Type: u64
Default: null
Pri5XonResponseTime

Type: u64
Default: null
Pri6ActualPauseTime

Type: u64
Default: null

Type: u64
Default: 0
Pri6ResponseTime

Type: u64
Default: null
Pri6XonResponseTime

Type: u64
Default: null
Pri7ActualPauseTime

Type: u64
Default: null

Type: u64
Default: 0
Pri7ResponseTime

Type: u64
Default: null
490
Read-Only Attribute
Description
Pri7XonResponseTime

Type: u64
Default: null
StreamDroppedFrameCount
Number of dropped frames detected by the hardware on this port.

Type: u64
Default: 0
StreamDroppedFramePct
Percentage of lost frames on this port.

Type: double
Default: 0
StreamDuplicateFrameCount
Number of duplicate frames detected by the hardware on this port.

Type: u64
Default: 0
StreamExpectedRxFrameCount
Number of test frames expected to be received on this port.

Type: u64
Default: 0
StreamExpectedRxOctetCount
Number of test octets expected to be received on this port.

Type: u64
Default: 0
StreamRxFrameCount
Number of test frames received on this port.

Type: u64
Default: 0
StreamRxOctetCount
Number of test octets received on this port.

Type: u64
Default: 0
TotalTxPfcFrameCount
Total number of PFC frames transmitted on the port.

Type: u64
Default: 0
TxPri0FrameCount
Total number of PFC frames transmitted on priority 0 by the port.

Type: u64
Default: 0
TxPri1FrameCount

Type: u64
Default: 0
TxPri2FrameCount

Type: u64
Default: 0
TxPri3FrameCount

Type: u64
Default: 0
TxPri4FrameCount

Type: u64
Default: 0
TxPri5FrameCount

Type: u64
Default: 0
TxPri6FrameCount

Type: u64
Default: 0
TxPri7FrameCount

Type: u64
Default: 0
491
DcbPfcResponseTimePerIterationResult
Description:
PFC Response Time per iteration result.

DcbPfcResponseTimePerIterationResult Writable Attributes

DcbPfcResponseTimePerIterationResult Read-Only Attributes

Read-Only Attribute
Description
AvgInterarrivalTime

Type: double
Default: 0
AvgJitter

Type: double
Default: 0
AvgLatency

Type: double
Default: 0
AvgPri0ActualPauseTime
Average measured pause time for priority 0.

Type: u64
Default: null
AvgPri0RequestPauseTime
Average requested pause time for priority 0.

Type: u64
Default: 0
AvgPri0ResponseTime
Average measured response time for priority 0.

Type: u64
Default: null
AvgPri0XonResponseTime
Average measured XON response time for priority 0.

Type: u64
Default: null

Type: u64
Default: null

Type: u64
Default: 0
AvgPri1ResponseTime

Type: u64
Default: null

Type: u64
Default: null

Type: u64
Default: null

Type: u64
Default: 0
492
Read-Only Attribute
Description
AvgPri2ResponseTime

Type: u64
Default: null

Type: u64
Default: null

Type: u64
Default: null

Type: u64
Default: 0
AvgPri3ResponseTime

Type: u64
Default: null

Type: u64
Default: null

Type: u64
Default: null

Type: u64
Default: 0
AvgPri4ResponseTime

Type: u64
Default: null

Type: u64
Default: null

Type: u64
Default: null

Type: u64
Default: 0
AvgPri5ResponseTime

Type: u64
Default: null

Type: u64
Default: null

Type: u64
Default: null

Type: u64
Default: 0
AvgPri6ResponseTime

Type: u64
Default: null
493
Read-Only Attribute
Description

Type: u64
Default: null

Type: u64
Default: null

Type: u64
Default: 0
AvgPri7ResponseTime

Type: u64
Default: null

Type: u64
Default: null
ChecksumErrorCount

Type: u64
Default: 0
DroppedFrameCount

Type: u64
Default: 0
DroppedFramePct

Type: double
Default: 0
DuplicateFrameCount

Type: u64
Default: 0
DurationInSec

Type: double
Default: 0

Type: u64
Default: 0
FcsErrorFrameCount

Type: u64
Default: 0
FloodedFrameCount

Type: u64
Default: 0
ForwardingRate

Type: double
Default: 0
IntendedLoad

Type: double
Default: 0
IntendedMbpsLoad

Type: double
Default: 0
MaxInterarrivalTime

Type: double
Default: 0
494
Read-Only Attribute
Description
MaxJitter

Type: double
Default: 0
MaxLatency

Type: double
Default: 0
MaxPri0ActualPauseTime
Maximum measured pause time for priority 0.

Type: u64
Default: null
MaxPri0RequestPauseTime
Maximum requested pause time for priority 0.

Type: u64
Default: 0
MaxPri0ResponseTime
Maximum measured response time for priority 0.

Type: u64
Default: null
MaxPri0XonResponseTime
Maximum measured XON response time for priority 0.

Type: u64
Default: null

Type: u64
Default: null

Type: u64
Default: 0
MaxPri1ResponseTime

Type: u64
Default: null

Type: u64
Default: null

Type: u64
Default: null

Type: u64
Default: 0
MaxPri2ResponseTime

Type: u64
Default: null

Type: u64
Default: null

Type: u64
Default: null

Type: u64
Default: 0
MaxPri3ResponseTime

Type: u64
Default: null
495
Read-Only Attribute
Description

Type: u64
Default: null

Type: u64
Default: null

Type: u64
Default: 0
MaxPri4ResponseTime

Type: u64
Default: null

Type: u64
Default: null

Type: u64
Default: null

Type: u64
Default: 0
MaxPri5ResponseTime

Type: u64
Default: null

Type: u64
Default: null

Type: u64
Default: null

Type: u64
Default: 0
MaxPri6ResponseTime

Type: u64
Default: null

Type: u64
Default: null

Type: u64
Default: null

Type: u64
Default: 0
MaxPri7ResponseTime

Type: u64
Default: null

Type: u64
Default: null
496
Read-Only Attribute
Description
MinInterarrivalTime

Type: double
Default: 0
MinJitter

Type: double
Default: 0
MinLatency

Type: double
Default: 0
MinPri0ActualPauseTime
Minimum measured pause time for priority 0.

Type: u64
Default: null
MinPri0RequestPauseTime
Minimum requested pause time for priority 0.

Type: u64
Default: 0
MinPri0ResponseTime
Minimum measured response time for priority 0.

Type: u64
Default: null
MinPri0XonResponseTime
Minimum measured XON response time for priority 0.

Type: u64
Default: null

Type: u64
Default: null

Type: u64
Default: 0
MinPri1ResponseTime

Type: u64
Default: null

Type: u64
Default: null

Type: u64
Default: null

Type: u64
Default: 0
MinPri2ResponseTime

Type: u64
Default: null

Type: u64
Default: null

Type: u64
Default: null

Type: u64
Default: 0
497
Read-Only Attribute
Description
MinPri3ResponseTime

Type: u64
Default: null

Type: u64
Default: null

Type: u64
Default: null

Type: u64
Default: 0
MinPri4ResponseTime

Type: u64
Default: null

Type: u64
Default: null

Type: u64
Default: null

Type: u64
Default: 0
MinPri5ResponseTime

Type: u64
Default: null

Type: u64
Default: null

Type: u64
Default: null

Type: u64
Default: 0
MinPri6ResponseTime

Type: u64
Default: null

Type: u64
Default: null

Type: u64
Default: null

Type: u64
Default: 0
MinPri7ResponseTime

Type: u64
Default: null
498
Read-Only Attribute
Description

Type: u64
Default: null
OfferedAvgFrameSize
Type: double
Default: 0
OfferedLoad

Type: double
Default: 0
OfferedMbpsLoad

Type: double
Default: 0
OtherFrameCount
Number of non-test frames received by the test tool, for example, router protocol traffic, bridge
management traffic, etc.
Type: u64
Default: 0
OutSeqFrameCount

Type: u64
Default: 0
PauseFrameCount

Type: u64
Default: 0
PfcFrameCount

Type: u64
Default: 0
PfcPri0FrameCount

Type: u64
Default: null
PfcPri0Quanta

Type: u64
Default: null
PfcPri0TriggerCount
Indicates how many PFC frames were detected by port capture triggers on priority 0 (only used when
the hardware lacks PFC counter support).
Type: u64
Default: null
PfcPri1FrameCount

Type: u64
Default: null
PfcPri1Quanta

Type: u64
Default: null
PfcPri1TriggerCount
Type: u64
Default: null
PfcPri2FrameCount

Type: u64
Default: null
PfcPri2Quanta

Type: u64
Default: null
499
Read-Only Attribute
Description
PfcPri2TriggerCount
Type: u64
Default: null
PfcPri3FrameCount

Type: u64
Default: null
PfcPri3Quanta

Type: u64
Default: null
PfcPri3TriggerCount
Type: u64
Default: null
PfcPri4FrameCount

Type: u64
Default: null
PfcPri4Quanta

Type: u64
Default: null
PfcPri4TriggerCount
Type: u64
Default: null
PfcPri5FrameCount

Type: u64
Default: null
PfcPri5Quanta

Type: u64
Default: null
PfcPri5TriggerCount
Type: u64
Default: null
PfcPri6FrameCount

Type: u64
Default: null
PfcPri6Quanta

Type: u64
Default: null
PfcPri6TriggerCount
Type: u64
Default: null
PfcPri7FrameCount

Type: u64
Default: null
PfcPri7Quanta

Type: u64
Default: null
500
DcbPfcResponseTimeTestCaseConfig
Read-Only Attribute
Description
PfcPri7TriggerCount
Type: u64
Default: null
PfcTxPauseRate

Type: u32
Default: 0
PfcTxPauseTime

Type: u32
Default: 0
PfcTxQuantum

Type: s32
Default: 0
PfcTxXonDelay
XON delay value.

Type: u32
Default: 0
PfcTxXonEnabled

Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE

RxFrameCount

Type: u64
Default: 0
TrialNum
Trial number.
Type: u8
Default: 0
TxFrameCount

Type: u64
Default: 0
TxFrameRate
Test tools transmission rate in fps. Note that this does not indicate the actual rate of test frames
transmitted by the test tool.
Type: double
Default: 0
Description:
PFC response time test configuration.

Relations:
501
Side name
(Type)
Relative
Description
GroupCollection
GroupCollection

PauseDevice
EmulatedDevice
during the test.
sequencer.
DcbPfcResponseTimeTestCaseConfig Writable Attributes

Writable Attribute
Description
Active, Name

Type: enum
Default: FIXED
Possible Values:
Value
Description
FIXED

STEP
CustomBurstSizeList

Type: u16
Default: 0
Range: 1 - 65535
CustomFrameSizeList

Type: u16
Default: 0
Range: 40 - 16383
CustomLoadSizeList

Type: double
Default: 0
CustomQuantaList

Type: u16
Default: 0
CustomXonDelayList

Type: u32
Default: 0
Range: 1 - 67108863
Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
Transmit XON frame.

FixedBurstSize

Type: u16
Default: 1
Range: 1 - 65535
FixedFrameSize

Type: u16
Default: 128
Range: 40 - 16383
502
Writable Attribute
Description
FixedLoadSize

Type: double
Default: 10
FixedQuanta

Type: u16
Default: 65535
FixedXonDelay

Type: u32
Default: 1024
Range: 1 - 67108863

Type: enum
Default: FIXED
Possible Values:
Value
Description
FIXED

STEP
InterFrameGap

Type: u32
Default: 12
Range: 11 - 16383
Type: enum
Default: MINIMUM
Possible Values:
Value
Description
USER
LoadSizeConfigMode

Type: enum
Default: WEIGHTED
Possible Values:
Value
Description

Type: enum
Default: STEP
Possible Values:
Value
Description
FIXED

STEP
503
Writable Attribute
Description
LoadUnits

Type: enum
Possible Values:
Value
Description
PERCENT_LINE_RATE
Percent line rate.

KILOBITS_PER_SECOND
BITS_PER_SECOND
PauseTxDelay
Specifies the delay between traffic start and pause frame transmission.
Type: double
Default: 30.0
Range: 10.0 - 3600.0
Type: enum
Default: MANUAL
Possible Values:
Value
Description
AUTOMATIC
MANUAL
Type: bool
Default: TRUE
Possible Values:
Value Description
TRUE

Type: bool
Default: TRUE
Possible Values:
Value Description
TRUE

QuantaIterationMode

Type: enum
Default: FIXED
Possible Values:
Value
Description
FIXED
STEP
RandomMaxFrameSize

Type: u16
Default: 256
Range: 40 - 16383
RandomMinFrameSize

Type: u16
Default: 128
Range: 40 - 16383
504
Writable Attribute
Description
ResultViewMode
Type: enum
Possible Values:
Value
Description
BASIC
HISTOGRAM
JITTER

FORWARDING
LATENCY_JITTER
StepBurstSizeEnd

Type: u16
Default: 1000
Range: 1 - 65535
StepBurstSizeStart

Type: u16
Default: 100
Range: 1 - 65535
StepBurstSizeStep

Type: u16
Default: 100
Range: 1 - 65535
StepFrameSizeEnd

Type: u16
Default: 1518
Range: 40 - 16383
StepFrameSizeStart

Type: u16
Default: 128
Range: 40 - 16383
StepFrameSizeStep

Type: u16
Default: 128
Range: 1 - 16383
StepLoadSizeEnd

Type: double
Default: 10
StepLoadSizeStart

Type: double
Default: 100
StepLoadSizeStep

Type: double
Default: 10
Range: 0.001 - 100000000000.0
StepQuantaEnd

Type: u16
Default: 1024
StepQuantaStart

Type: u16
Default: 0
505
Writable Attribute
Description
StepQuantaStep

Type: u16
Default: 128
Range: 1 - 65535
StepXonDelayEnd

Type: u32
Default: 32768
Range: 1 - 67108863
StepXonDelayStart

Type: u32
Default: 1024
Range: 1 - 67108863
StepXonDelayStep
Type: u32
Default: 1024
Range: 1 - 67108863
Type: enum
Default: FIXED
Possible Values:
Value
Description
XonDelayUnit
FIXED
STEP
Type: enum
Default: QUANTA
Possible Values:
Value
Description
BYTES
DcbPfcResponseTimeTestCaseConfig Read-Only Attributes

Read-Only Attribute
Description
ConfigIsValid
Type: bool
Default: TRUE
Possible Values:
Value Description
TRUE

Type: string
Default: 0
FrameSizeIsValid
Type: bool
Default: TRUE
Possible Values:
Value Description
TRUE
506
DcbQueueputPerIterationResult
Read-Only Attribute
Description
Type: string
Default: 0
LoadIsValid
is oversubscribed.
Type: bool
Default: TRUE
Possible Values:
Value Description
TRUE

Type: string
Default: 0
Description:
DCB queueput per iteration result.

DcbQueueputPerIterationResult Writable Attributes

DcbQueueputPerIterationResult Read-Only Attributes

Read-Only Attribute
Description
AvgInterarrivalTime

Type: double
Default: 0
AvgJitter

Type: double
Default: 0
AvgLatency

Type: double
Default: 0
ChecksumErrorCount

Type: u64
Default: 0

Type: u16
Default: 0

Type: u16
Default: 0
507
Read-Only Attribute
Description
DroppedFrameCount

Type: u64
Default: 0
DroppedFramePct

Type: double
Default: 0
DuplicateFrameCount

Type: u64
Default: 0
DurationInSec

Type: double
Default: 0

Type: u64
Default: 0
FcsErrorFrameCount

Type: u64
Default: 0
FloodedFrameCount

Type: u64
Default: 0
ForwardingRate

Type: double
Default: 0
IntendedLoad

Type: double
Default: 0
IntendedMbpsLoad

Type: double
Default: 0
MaxInterarrivalTime

Type: double
Default: 0
MaxJitter

Type: double
Default: 0
MaxLatency

Type: double
Default: 0
MinInterarrivalTime

Type: double
Default: 0
MinJitter

Type: double
Default: 0
MinLatency

Type: double
Default: 0
OfferedAvgFrameSize
Type: double
Default: 0
508
Read-Only Attribute
Description
OfferedLoad

Type: double
Default: 0
OfferedMbpsLoad

Type: double
Default: 0
OtherFrameCount
traffic, etc.
Type: u64
Default: 0
OutSeqFrameCount

Type: u64
Default: 0
PauseFrameCount

Type: u64
Default: 0
PfcFrameCount

Type: u64
Default: 0
PfcPri0FrameCount

Type: u64
Default: null
PfcPri0Quanta

Type: u64
Default: null
PfcPri0TriggerCount
Type: u64
Default: null
PfcPri1FrameCount

Type: u64
Default: null
PfcPri1Quanta

Type: u64
Default: null
PfcPri1TriggerCount
Type: u64
Default: null
PfcPri2FrameCount

Type: u64
Default: null
PfcPri2Quanta

Type: u64
Default: null
PfcPri2TriggerCount
Type: u64
Default: null
PfcPri3FrameCount

Type: u64
Default: null
509
Read-Only Attribute
Description
PfcPri3Quanta

Type: u64
Default: null
PfcPri3TriggerCount
Type: u64
Default: null
PfcPri4FrameCount

Type: u64
Default: null
PfcPri4Quanta

Type: u64
Default: null
PfcPri4TriggerCount
Type: u64
Default: null
PfcPri5FrameCount

Type: u64
Default: null
PfcPri5Quanta

Type: u64
Default: null
PfcPri5TriggerCount
Type: u64
Default: null
PfcPri6FrameCount

Type: u64
Default: null
PfcPri6Quanta

Type: u64
Default: null
PfcPri6TriggerCount
Type: u64
Default: null
PfcPri7FrameCount

Type: u64
Default: null
PfcPri7Quanta

Type: u64
Default: null
PfcPri7TriggerCount
Type: u64
Default: null
RxFrameCount

Type: u64
Default: 0
TrialNum
Trial number.
Type: u8
Default: 0
510
DcbQueueputTestCaseConfig
Read-Only Attribute
Description
TxFrameCount

Type: u64
Default: 0
TxFrameRate
by the test tool.
Type: double
Default: 0
Description:
DCB queueput test configuration.

Relations:
Side name
(Type)
Relative
Description
GroupCollection
GroupCollection

sequencer.
DcbQueueputTestCaseConfig Writable Attributes

Writable Attribute
Description
Active, Name
Backoff
Rate backoff percentage.

Type: double
Default: 50.0
Range: 0.001 - 99.999

Type: enum
Default: FIXED
Possible Values:
Value
Description
FIXED

STEP
CustomBurstSizeList

Type: u16
Default: 0
Range: 1 - 65535
CustomFrameSizeList

Type: u16
Default: 0
Range: 40 - 16383
511
Writable Attribute
Description
EnableMaxLoadDelta
Option to enable maximum intended/offered load delta.

Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE


Type: bool
Default: TRUE
Possible Values:
Value Description
TRUE

EnableServiceClassThresholds
use it.
Whether service class thresholds is enabled.
Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
Service class thresholds is enabled.
FALSE Service class thresholds is disabled.

FixedBurstSize

Type: u16
Default: 1
Range: 1 - 65535
FixedFrameSize

Type: u16
Default: 128
Range: 40 - 16383

Type: enum
Default: FIXED
Possible Values:
Value
Description
FIXED

STEP
InterFrameGap

Type: u32
Default: 12
Range: 11 - 16383
Type: enum
Default: MINIMUM
Possible Values:
Value
Description
USER
512
Writable Attribute
Description
LoadSizeConfigMode

Type: enum
Default: WEIGHTED
Possible Values:
Value
Description
LoadUnits

Type: enum
Possible Values:
Value
Description
PERCENT_LINE_RATE
Percent line rate.

KILOBITS_PER_SECOND
BITS_PER_SECOND
MaxLoadDelta

Type: double
Default: 0.1
Range: 0.01 - 100.0

Type: u64
Default: 0
Type: enum
Default: MANUAL
Possible Values:
Value
Description
AUTOMATIC
MANUAL
Type: bool
Default: TRUE
Possible Values:
Value Description
TRUE

RandomMaxFrameSize

Type: u16
Default: 256
Range: 40 - 16383
RandomMinFrameSize

Type: u16
Default: 128
Range: 40 - 16383
RateInitial
Initial rate.
Type: double
Default: 10.0
RateLowerLimit
Minimum rate value.

Type: double
Default: 10.0
513
Writable Attribute
Description
RateStep
Rate increment.
Type: double
Default: 10.0
Range: 0.001 - 100000000000.0
RateUpperLimit
Maximum rate value.

Type: double
Default: 100.0
Resolution
Rate resolution.
Type: double
Default: 1.0
Range: 0.001 - 1000.0
ResultViewMode
Type: enum
Possible Values:
Value
Description
BASIC
HISTOGRAM
JITTER
SearchMode
FORWARDING
LATENCY_JITTER
Load search mode.

Type: enum
Default: BINARY
Possible Values:
Value
Description
BINARY Binary search mode.
COMBO Combo search mode.
STEP
Step search mode.
StepBurstSizeEnd

Type: u16
Default: 1000
Range: 1 - 65535
StepBurstSizeStart

Type: u16
Default: 100
Range: 1 - 65535
StepBurstSizeStep

Type: u16
Default: 100
Range: 1 - 65535
StepFrameSizeEnd

Type: u16
Default: 1518
Range: 40 - 16383
StepFrameSizeStart

Type: u16
Default: 128
Range: 40 - 16383
StepFrameSizeStep

Type: u16
Default: 128
Range: 1 - 16383
514
DcbStepPerIterationResult
DcbQueueputTestCaseConfig Read-Only Attributes

Read-Only Attribute
Description
ConfigIsValid
Type: bool
Default: TRUE
Possible Values:
Value Description
TRUE

Type: string
Default: 0
FrameSizeIsValid
Type: bool
Default: TRUE
Possible Values:
Value Description
TRUE

Type: string
Default: 0
LoadIsValid
is oversubscribed.
Type: bool
Default: TRUE
Possible Values:
Value Description
TRUE

Type: string
Default: 0
Description:
DCB step test per iteration result.

DcbStepPerIterationResult Writable Attributes

515
DcbStepPerIterationResult Read-Only Attributes

Read-Only Attribute
Description
AvgInterarrivalTime

Type: double
Default: 0
AvgJitter

Type: double
Default: 0
AvgLatency

Type: double
Default: 0
ChecksumErrorCount

Type: u64
Default: 0

Type: u16
Default: 0

Type: u16
Default: 0
DroppedFrameCount

Type: u64
Default: 0
DroppedFramePct

Type: double
Default: 0
DuplicateFrameCount

Type: u64
Default: 0
DurationInSec

Type: double
Default: 0

Type: u64
Default: 0
FcsErrorFrameCount

Type: u64
Default: 0
FloodedFrameCount

Type: u64
Default: 0
ForwardingRate

Type: double
Default: 0
IntendedLoad

Type: double
Default: 0
IntendedMbpsLoad

Type: double
Default: 0
516
Read-Only Attribute
Description
MaxInterarrivalTime

Type: double
Default: 0
MaxJitter

Type: double
Default: 0
MaxLatency

Type: double
Default: 0
MinInterarrivalTime

Type: double
Default: 0
MinJitter

Type: double
Default: 0
MinLatency

Type: double
Default: 0
OfferedAvgFrameSize
Type: double
Default: 0
OfferedLoad

Type: double
Default: 0
OfferedMbpsLoad

Type: double
Default: 0
OtherFrameCount
traffic, etc.
Type: u64
Default: 0
OutSeqFrameCount

Type: u64
Default: 0
PauseFrameCount

Type: u64
Default: 0
PfcFrameCount

Type: u64
Default: 0
PfcPri0FrameCount

Type: u64
Default: null
PfcPri0Quanta

Type: u64
Default: null
PfcPri0TriggerCount
Type: u64
Default: null
517
Read-Only Attribute
Description
PfcPri1FrameCount

Type: u64
Default: null
PfcPri1Quanta

Type: u64
Default: null
PfcPri1TriggerCount
Type: u64
Default: null
PfcPri2FrameCount

Type: u64
Default: null
PfcPri2Quanta

Type: u64
Default: null
PfcPri2TriggerCount
Type: u64
Default: null
PfcPri3FrameCount

Type: u64
Default: null
PfcPri3Quanta

Type: u64
Default: null
PfcPri3TriggerCount
Type: u64
Default: null
PfcPri4FrameCount

Type: u64
Default: null
PfcPri4Quanta

Type: u64
Default: null
PfcPri4TriggerCount
Type: u64
Default: null
PfcPri5FrameCount

Type: u64
Default: null
PfcPri5Quanta

Type: u64
Default: null
PfcPri5TriggerCount
Type: u64
Default: null
PfcPri6FrameCount

Type: u64
Default: null
518
DcbStepTestCaseConfig
Read-Only Attribute
Description
PfcPri6Quanta

Type: u64
Default: null
PfcPri6TriggerCount
Type: u64
Default: null
PfcPri7FrameCount

Type: u64
Default: null
PfcPri7Quanta

Type: u64
Default: null
PfcPri7TriggerCount
Type: u64
Default: null
RxFrameCount

Type: u64
Default: 0
TrialNum
Trial number.
Type: u8
Default: 0
TxFrameCount

Type: u64
Default: 0
TxFrameRate
by the test tool.
Type: double
Default: 0
Description:
DCB step test configuration.

Relations:
Side name
(Type)
Relative
Description
GroupCollection
GroupCollection

sequencer.
519
DcbStepTestCaseConfig Writable Attributes

Writable Attribute
Description
Active, Name

Type: enum
Default: FIXED
Possible Values:
Value
Description
FIXED

STEP
CustomBurstSizeList

Type: u16
Default: 0
Range: 1 - 65535
CustomFrameSizeList

Type: u16
Default: 0
Range: 40 - 16383
CustomLoadSizeList

Type: double
Default: 0
EnableLoadLoopShortCircuit
Whether to halt load iteration loop after multiple PASS iterations.

Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
Halt load iteration loop after multiple PASS iterations.
FALSE Do not halt load iteration loop after multiple PASS iterations.
EnableMaxLoadDelta
Option to enable maximum intended/offered load delta.

Type: bool
Default: TRUE
Possible Values:
Value Description
TRUE


Type: bool
Default: TRUE
Possible Values:
Value Description
TRUE

FixedBurstSize

Type: u16
Default: 1
Range: 1 - 65535
FixedFrameSize

Type: u16
Default: 128
Range: 40 - 16383
520
Writable Attribute
Description
FixedLoadSize

Type: double
Default: 10

Type: enum
Default: FIXED
Possible Values:
Value
Description
FIXED

STEP
InterFrameGap

Type: u32
Default: 12
Range: 11 - 16383
Type: enum
Default: MINIMUM
Possible Values:
Value
Description
USER
LoadSizeConfigMode

Type: enum
Default: WEIGHTED
Possible Values:
Value
Description

Type: enum
Default: STEP
Possible Values:
Value
Description
FIXED

STEP
LoadUnits

Type: enum
Possible Values:
Value
Description
PERCENT_LINE_RATE
Percent line rate.
MaxLoadDelta
KILOBITS_PER_SECOND
BITS_PER_SECOND

Type: double
Default: 0.1
Range: 0.01 - 100.0
521
Writable Attribute
Description
PassLoadLoopCount
Number of passed load loops.

Type: u16
Default: 2

Type: u64
Default: 0
Type: enum
Default: MANUAL
Possible Values:
Value
Description
AUTOMATIC
MANUAL
Type: bool
Default: TRUE
Possible Values:
Value Description
TRUE

RandomMaxFrameSize

Type: u16
Default: 256
Range: 40 - 16383
RandomMinFrameSize

Type: u16
Default: 128
Range: 40 - 16383
ResultViewMode
Type: enum
Possible Values:
Value
Description
BASIC
HISTOGRAM
JITTER

FORWARDING
LATENCY_JITTER
StepBurstSizeEnd

Type: u16
Default: 1000
Range: 1 - 65535
StepBurstSizeStart

Type: u16
Default: 100
Range: 1 - 65535
StepBurstSizeStep

Type: u16
Default: 100
Range: 1 - 65535
522
Writable Attribute
Description
StepFrameSizeEnd

Type: u16
Default: 1518
Range: 40 - 16383
StepFrameSizeStart

Type: u16
Default: 128
Range: 40 - 16383
StepFrameSizeStep

Type: u16
Default: 128
Range: 1 - 16383
StepLoadSizeEnd

Type: double
Default: 10
StepLoadSizeStart

Type: double
Default: 100
StepLoadSizeStep

Type: double
Default: 10
Range: 0.001 - 100000000000.0
DcbStepTestCaseConfig Read-Only Attributes

Read-Only Attribute
Description
ConfigIsValid
Type: bool
Default: TRUE
Possible Values:
Value Description
TRUE

Type: string
Default: 0
FrameSizeIsValid
Type: bool
Default: TRUE
Possible Values:
Value Description
TRUE

Type: string
Default: 0
LoadIsValid
is oversubscribed.
Type: bool
Default: TRUE
Possible Values:
Value Description
TRUE
523
DcbTestConfig
Read-Only Attribute
Description
Type: string
Default: 0
DcbTestConfig
Description:
DCB test configuration that contains general test parameters.

Parents: Project
Children: BenchmarkEthernet10GigPortConfig, DcbBackToBackTestCaseConfig, DcbCongestionControlTestCaseConfig,
DcbErroredFramesFilteringTestCaseConfig, DcbMaximumForwardingRateTestCaseConfig, DcbPfcBufferingAndLatencyTestCaseConfig,
DcbPfcBufferingTestCaseConfig, DcbPfcLoadValidationTestCaseConfig, DcbPfcResponseTimeTestCaseConfig, DcbQueueputTestCaseConfig,
DcbTestConfig Writable Attributes

Writable Attribute
Description
Active, Name
Duration
Duration.
Type: u32
Default: 60
DurationMode
Duration mode.
Type: enum
Default: SECONDS
Possible Values:
Value
Description
SECONDS Seconds
DutPfcPauseQuantaValue
PFC pause quanta value expected from DUT.

Type: u16
Default: 65535
L2LearningFrameRate
L2 learning frame rate.

Type: u32
Default: 1000
L2LearningFrameSize
L2 learning frame size.

Type: u16
Default: 128
Range: 64 - 16383
L2LearningFrameSizeMode
L2 learning frame size mode.

Type: enum
Default: SAME_AS_STREAM
Possible Values:
Value
Description
FIXED
FIXED.
SAME_AS_STREAM Same as stream.

L2LearningRepeatCount
L2 learning repeat count.

Type: u16
Default: 5
524
DcbTestConfig
Writable Attribute
Description
LatencyMode
Latency measurement mode.

Type: enum
Default: LILO
Possible Values:
Value Description
LIFO
LIFO
LILO
LILO
FIFO FIFO
FILO
LearningFreqMode
FILO
Learning frequency mode.

Type: enum
Default: LEARN_ONCE
Possible Values:
Value
Description
NONE
None.
LEARN_ONCE
Learn once.
LEARN_EVERY_ITERATION Learn every iteration.

NumOfTrials
Number of trials.
Type: u16
Default: 1
Range: 1 - 60
ResultsCollectionDelay
Results collection delay.

Type: u32
Default: 15
TestStartDelay
Test start delay.

Type: u32
Default: 2
TrafficVerificationFailMode
Traffic verification failure mode.

Type: enum
Default: ABORT
Possible Values:
Value
Description
CONTINUE Continue test on fail.
ABORT
TrafficVerificationFreqMode
Abort test on fail.
Traffic verification frequency mode.

Type: enum
Default: NONE
Possible Values:
Value
Description
NONE
None.
VERIFY_ONCE
Verify once.
VERIFY_EVERY_ITERATION Verify every iteration.

TrafficVerificationTxFrameCount
Traffic verification Number of transmitted frames.

Type: u32
Default: 1000
Range: 1 - 32767
TrafficVerificationTxFrameRate
Traffic verification Tx frame rate.

Type: u32
Default: 1000
Range: 1 - 14880952
DcbTestConfig Read-Only Attributes

525
DcbTrafficGroupCodePointTag
DcbTrafficGroupCodePointTag
Description:
DCB traffic group code point tag.

Parents: TrafficGroup
DcbTrafficGroupCodePointTag Writable Attributes

Writable Attribute
Description
Active, Name
CodePoint
Code point tag.

Type: enum
Default: VLAN_PRIORITY
Possible Values:
Value
Description
NONE
Code point enumeration.
VLAN_PRIORITY VLAN priority.

IsLossless
Indicates whether this Traffic Group should be considered as "lossless".

Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
Consider this Traffic Group to be lossless.
FALSE Consider this Traffic Group to be lossy.

VlanPriority
VLAN priority of the traffic group.

Type: u8
Default: 3
Range: 0 - 7
DcbTrafficGroupCodePointTag Read-Only Attributes

DcbTrafficGroupPerIterationResult
Description:
DCB traffic group per iteration result.

DcbTrafficGroupPerIterationResult Writable Attributes

526
DcbTrafficGroupPerIterationResult Read-Only Attributes

Read-Only Attribute
Description
AvgInterarrivalTime

Type: double
Default: 0
AvgJitter

Type: double
Default: 0
AvgLatency

Type: double
Default: 0
BurstSize
Burst size.
Type: u32
Default: 0
DroppedFrameCount

Type: u64
Default: 0
DroppedFramePct

Type: double
Default: 0
DuplicateFrameCount

Type: u64
Default: 0

Type: u64
Default: 0
FcsErrorFrameCount

Type: u64
Default: 0
FcTxCreditUnavailableCount
Number of times STC was unable to transmit FC frames.

Type: u64
Default: null
ForwardingRate

Type: double
Default: 0
Indicates the frame length distribution used (if applicable).

Type: string
Default: N/A
FrameSizeType
Frame size type.

Type: string
Default: N/A
Average frame size.

Type: double
Default: 0
IntendedLoad

Type: double
Default: 0
IntendedMbpsLoad

Type: double
Default: 0
527
Read-Only Attribute
Description
IsConformant
Conformant.
Type: bool
Default: TRUE
Possible Values:
Value Description
TRUE
Is conformant.
FALSE Is not conformant.

LateFrameCount
Late frame count.

Type: u64
Default: 0
MaxInterarrivalTime

Type: double
Default: 0
MaxJitter

Type: double
Default: 0
MaxLatency

Type: double
Default: 0
MbpsForwardingRate
Forwarding rate in megabits per second.

Type: double
Default: 0
MinInterarrivalTime

Type: double
Default: 0
MinJitter

Type: double
Default: 0
MinLatency

Type: double
Default: 0
OfferedAvgFrameSize
Type: double
Default: 0
OfferedLoad

Type: double
Default: 0
OfferedMbpsLoad

Type: double
Default: 0
OutSeqFrameCount

Type: u64
Default: 0
PfcRxFrameCount
PFC number of received frames.

Type: u64
Default: null
PfcRxTotalQuanta
PFC Rx pause duration (quanta).

Type: u64
Default: null
528
DcbTrafficGroupWeightConfig
Read-Only Attribute
Description
PfcRxTriggerCount
PFC Rx trigger count.

Type: u64
Default: 0
PrbsBitErrorCount
PRBS bit error count.

Type: u64
Default: 0
ReorderedFrameCount
Reordered frame count.

Type: u64
Default: 0
RxFrameCount

Type: u64
Default: 0
TrafficGroupName
Traffic group name.

Type: string
Default: 0
TrialNum
Trial number.
Type: u8
Default: 0
TxFrameCount

Type: u64
Default: 0
TxFrameRate
Test tools transmission rate in fps. Note that this does not indicate the actual rate of test frames
transmitted by the test tool.
Type: double
Default: 0
VlanPriority
Assigned VLAN priority of the traffic group.

Type: u8
Default: null
DcbTrafficGroupWeightConfig
Description:
DCB traffic group weight configuration.

Parents: DcbBackToBackTestCaseConfig, DcbCongestionControlTestCaseConfig, DcbErroredFramesFilteringTestCaseConfig,
DcbMaximumForwardingRateTestCaseConfig, DcbPfcBufferingAndLatencyTestCaseConfig, DcbPfcBufferingTestCaseConfig,
DcbPfcLoadValidationTestCaseConfig, DcbPfcResponseTimeTestCaseConfig, DcbQueueputTestCaseConfig, DcbStepTestCaseConfig
Relations:
Side name
(Type)
Relative
Description
TrafficGroup
(DcbTrafficGroupBinding)
TrafficGroup
This relation indicates which TrafficGroup is modified by this

configuration object.
DcbTrafficGroupWeightConfig Writable Attributes

Writable Attribute
Description
Active, Name
529
DcbUpdateConfigCommand
Writable Attribute
Description
WeightList
Weights to iterate through for this TrafficGroup.

Type: u64
Default: 0
DcbTrafficGroupWeightConfig Read-Only Attributes

DcbUpdateConfigCommand
Description:
Command to update existing DCB test sequence.

DcbUpdateConfigCommand Writable Attributes

Writable Attribute
Description
Config
Configuration to update.
Type: handle
Default: 0
TestCaseRootCommandList
Root command of the test in the sequencer to update.

Type: handle
Default: 0
DcbUpdateConfigCommand Read-Only Attributes

Read-Only Attribute
Description

DcbxBandwidthAllocationResult
Description:
DCBX Bandwidth Allocation Result.

Parents: LldpNodeConfig
Relations:
Side name
(Type)
Relative
Description
ResultParent
(ResultChild)
LldpNodeConfig
530
DcbxBcnModeResult
DcbxBandwidthAllocationResult Writable Attributes

DcbxBandwidthAllocationResult Read-Only Attributes

Read-Only Attribute
Description
BandwidthPercentage
Negotiated bandwidth percentage.

Type: u8
Default: 0
DesiredBandwidthPercentage
Locally configured bandwidth percentage on the system.

Type: u8
Default: 0
PeerBandwidthPercentage
Bandwidth percentage configured on the peer system.

Type: u8
Default: 0
PriorityGroupId
Priority Group ID.

Type: u8
Default: 0
DcbxBcnModeResult
Description:
DCBX BCN Mode Result.

Relations:
Side name
(Type)
Relative
Description
ResultParent
(ResultChild)
LldpNodeConfig
DcbxBcnModeResult Writable Attributes

DcbxBcnModeResult Read-Only Attributes

Read-Only Attribute
Description
CpAdminMode
Operating CP admin mode.

Type: u8
Default: 0
DesiredCpAdminMode
Desired CP admin mode of the emulated device.

Type: u8
Default: 0
DesiredRemoveTagOperationalMode
Desired Remove CM tag operational mode of the emulated device.

Type: u8
Default: 0
531
DcbxBcnParameterResult
Read-Only Attribute
Description
DesiredRpAdminMode
Desired RP admin mode of the emulated device.

Type: u8
Default: 0
DesiredRpOperatingMode
Desired RP operational mode of the emulated device.

Type: u8
Default: 0
PeerCpAdminMode
Peer CP admin mode in the TLV from the DUT.

Type: u8
Default: 0
PeerRemoveTagOperationalMode
Peer Remove CM tag operational mode in the TLV from the DUT.
Type: u8
Default: 0
PeerRpAdminMode
Peer RP admin mode in the TLV from the DUT.

Type: u8
Default: 0
PeerRpOperatingMode
Peer RP operational mode in the TLV from the DUT.

Type: u8
Default: 0
Priority
Priority
Type: u8
Default: 0
RemoveTagOperationalMode
Operating remove CM tag operational mode.

Type: u8
Default: 0
RpAdminMode
Operating RP admin mode.

Type: u8
Default: 0
RpOperatingMode
Operating RP operational mode.

Type: u8
Default: 0
DcbxBcnParameterResult
Description:
DCBX BCN Parameter Result.

Relations:
Side name
(Type)
Relative
Description
ResultParent
(ResultChild)
LldpNodeConfig
DcbxBcnParameterResult Writable Attributes

532
dcbxCtlTlv
DcbxBcnParameterResult Read-Only Attributes

Read-Only Attribute
Description
Bcna
CM-Tag BCNA field.

Type: string
Default: 0
CpSf
CP sampling interval fixed.

Type: u32
Default: 0
RpAlpha
RP max decrease factor.

Type: string
Default: 0
RpBeta
RP max increase factor.

Type: string
Default: 0
RpGd
RP decrement coefficient.
Type: string
Default: 0
RpGi
RP increment coefficient.
Type: string
Default: 0
Rprd
RP drift factor.
Type: u8
Default: 0
RpRmin
RP default rate after 1st BCN0.

Type: u16
Default: 0
RpTd
RP drift interval.
Type: u16
Default: 0
RpTmax
RP max time to backoff after BCN0.

Type: u32
Default: 0
Rpw
RP derivative rate.
Type: u8
Default: 0
Type
Defines whether the parameter is the operating configuration, the local configuration or the peer configuration.
Type: enum
Default: Operating
Possible Values:
Value
Description
Operating Operating
Peer
Peer
Desired
Desired
dcbxCtlTlv
Description:
Children: None
533
DcbxFcoePriorityResult
dcbxCtlTlv Attributes
Attribute
Description
ackNo
Type: INTEGER
Default: 0
length
Type: INTEGER
Default: 10
maxVer
Type: INTEGER
Default: 0
Name
Type: string
operVer
Type: INTEGER
Default: 0
seqNo
Type: INTEGER
Default: 0
type
Type: INTEGER
Default: 1
DcbxFcoePriorityResult
Description:
DCBX FCoE Priority Result.

Relations:
Side name
(Type)
Relative
Description
ResultParent
(ResultChild)
LldpNodeConfig
DcbxFcoePriorityResult Writable Attributes

DcbxFcoePriorityResult Read-Only Attributes

Read-Only Attribute
Description
DesiredPriorityMap
Locally configured priority map on the system.

Type: string
Default: 00000000
PeerPriorityMap
Priority map configured on the peer system.

Type: string
Default: 00000000
PriorityMap
Negotiated priority map.

Type: string
Default: 00000000
534
DcbxLogicalLinkResult
Read-Only Attribute
Description
ProtocolId
Protocol ID.
Type: string
Default: 00000000
SelectorField
Selector Field in the Application TLV.

Type: string
Default: 00000000
DcbxLogicalLinkResult
Description:
DCBX Logical Link Status result.

Relations:
Side name
(Type)
Relative
Description
ResultParent
(ResultChild)
LldpNodeConfig
DcbxLogicalLinkResult Writable Attributes

DcbxLogicalLinkResult Read-Only Attributes

Read-Only Attribute
Description
PeerStatus
Link status on the peer system.

Type: u8
Default: 0
Status
Link status on the system.

Type: u8
Default: 0
Type
SubType defined for the Logical Link Status TLV.

Type: u8
Default: 0
DcbxNivResult
Description:

Relations:
535
DcbxPriorityAllocationResult
Side name
(Type)
Relative
Description
ResultParent
(ResultChild)
LldpNodeConfig
DcbxNivResult Writable Attributes

DcbxNivResult Read-Only Attributes

Read-Only Attribute
Description
ControlChannelMacAddr
Type: string
Default: 00:00:00:00:00:00
ControlChannelVifId
Type: u16
Default: 0
DesiredControlChannelVifId
Type: u16
Default: 0
PeerControlChannelMacAddr
Type: string
Default: 00:00:00:00:00:00
PeerControlChannelVifId
Type: u16
Default: 0
PeerVnTagVersion
Type: enum
Default: 0
Possible Values:
Value
Description
Version0
Version1
Version2
Version3
SupportedVnTagVersion
Type: enum
Default: 0
Possible Values:
Value
Description
Version0
Version1
Version2
Version3
VnTagVersion
Type: enum
Default: 0
Possible Values:
Value
Description
Version0
Version1
Version2
Version3
DcbxPriorityAllocationResult
536
DcbxPriorityFlowControlResult
Description:
DCBX Priority Allocation Result.

Relations:
Side name
(Type)
Relative
Description
ResultParent
(ResultChild)
LldpNodeConfig
DcbxPriorityAllocationResult Writable Attributes

DcbxPriorityAllocationResult Read-Only Attributes

Read-Only Attribute
Description
DesiredPriorityGroupId
Locally configured Priority Group ID on the emualted device.

Type: u8
Default: 0
PeerPriorityGroupId
Priority Group ID configured on the peer system from the DUT TLV.
Type: u8
Default: 0
Priority
Priority
Type: u8
Default: 0
PriorityGroupId
Negotiated Priority Group ID.

Type: u8
Default: 0
DcbxPriorityFlowControlResult
Description:
DCBX Priority Flow Control Result.

Relations:
Side name
(Type)
Relative
Description
ResultParent
(ResultChild)
LldpNodeConfig
DcbxPriorityFlowControlResult Writable Attributes

537
DcbxSubTlvt1
DcbxPriorityFlowControlResult Read-Only Attributes

Read-Only Attribute
Description
DesiredStatus
Locally configured PFC status on the emualted device.

Type: u8
Default: 0
PeerStatus
PFC status on the peer system (DUT).

Type: u8
Default: 0
Priority
Priority
Type: u8
Default: 0
Status
Negotiated PFC status (enabled nor not).

Type: u8
Default: 0
DcbxSubTlvt1
Description:
Parents: value
Children: applicatonTlv, bcnTlv, customTlv, dcbxCtlTlv, logicLinkDownTlv, nivTlv, pfcTlv, pgTlv
DcbxSubTlvt1 Attributes
Attribute
Description
Name
information.
Type: string
DcbxSubTlvt2
Description:
Parents: value
Children: applicatonTlv, customTlv, dcbxCtlTlv, nivTlv, pfcTlv, pgTlv
DcbxSubTlvt2 Attributes
Attribute
Description
Name
information.
Type: string
538
DcbxTlvt1
DcbxTlvt1 (lldp:DcbxTlvt1)
Description:
Children: value
lldp:PortAndProtocolVlanIdTlv, lldp:ProtocolIdentityTlv, lldp:OrganizationallySpecificTlv, lldp:NivSupportTlv
DcbxTlvt1 Attributes
Attribute
Description
length
Type: INTEGER
Default: 0
Name
more information.
Type: string
oui
Type: OCTETSTRING
Default: 001B21
subtype
Type: OCTETSTRING
Default: 01
type
Type: INTEGER
Default: 127
DcbxTlvt2 (lldp:DcbxTlvt2)
Description:
Children: value
lldp:PortAndProtocolVlanIdTlv, lldp:ProtocolIdentityTlv, lldp:OrganizationallySpecificTlv, lldp:NivSupportTlv
DcbxTlvt2 Attributes
Attribute
Description
length
Type: INTEGER
Default: 0
Name
more information.
Type: string
oui
Type: OCTETSTRING
Default: 001B21
subtype
Type: OCTETSTRING
Default: 02
type
Type: INTEGER
Default: 127
539
ddOptions
ddOptions
Description:
OSPFv2 Database Description packet Options field. See RFC 2328.
Parents: Ospfv2Hello, Ospfv2DatabaseDescription, header, header, header, header, header
Children: None
ddOptions Attributes
Attribute
Description
dcBit
Type: BITSTRING
Default: 0
eaBit
Type: BITSTRING
Default: 0
eBit
Type: BITSTRING
Default: 0
mcBit
Type: BITSTRING
Default: 0
Name
Type: string
npBit
Type: BITSTRING
Default: 0
reserved0
Type: BITSTRING
Default: 0
reserved6
Type: BITSTRING
Default: 0
reserved7
Type: BITSTRING
Default: 0
ddSpecificOptions
Description:
Parents: Ospfv2DatabaseDescription
Children: None
ddSpecificOptions Attributes
Attribute
Description
iBit
Type: BITSTRING
Default: 0
mBit
Type: BITSTRING
Default: 0
msBit
Type: BITSTRING
Default: 0
540
DebugResultRenderer
Attribute
Description
Name
Type: string
reserved3
Type: BITSTRING
Default: 0
reserved4
Type: BITSTRING
Default: 0
reserved5
Type: BITSTRING
Default: 0
reserved6
Type: BITSTRING
Default: 0
reserved7
Type: BITSTRING
Default: 0
DebugResultRenderer
Description:

Parents: Project
DebugResultRenderer Writable Attributes

Writable Attribute
Description
Active, Name
ResultView
Type: handle
Default: 0
DebugResultRenderer Read-Only Attributes

DefineDynamicResultViewCommand
Description:

DefineDynamicResultViewCommand Writable Attributes

Writable Attribute
Description
541
DeleteCommand
Writable Attribute
Description
ArchivingInterval
Type: u32
Default: 10
ArchivingOption
Type: enum
Default: NONE
Possible Values:
Value
Description
NONE
PERIODIC
UPDATE
Query
Type: string
Target
Type: handle
Default: 0
DefineDynamicResultViewCommand Read-Only Attributes

Read-Only Attribute
Description

DynamicResultView
Type: handle
Default: 0
DeleteCommand
Description:
Used for the bulk deletion of objects. This works like the delete function, except you can delete multiple objects at once.

DeleteCommand Writable Attributes

Writable Attribute
Description
ConfigList
A list of the handles of objects to be deleted.

NOTE: This will also delete all child objects of the deleted objects.
Type: handle
Default: 0
WarnOnAdditionalDelete
Do not use this attribute.

Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
FALSE
542
DeleteFileCommand
DeleteCommand Read-Only Attributes

Read-Only Attribute
Description

DeleteFileCommand
Description:
Delete a file from one or more chassis or port group.

DeleteFileCommand Writable Attributes

Writable Attribute
Description
EquipmentList
List of one or more chassis or port group to delete a file from.

Type: handle
Default: 0
FileName
Full path of the file to delete.

Type: string
DeleteFileCommand Read-Only Attributes

Read-Only Attribute
Description

destinationPortsFabricEgressPathInformation (overloaded)
destinationPortsFabricEgressPathInformation (fc)
destinationPortsFabricEgressPathInformation (fcgs)
destinationPortsFabricEgressPathInformation Object (fc PDU library)

Description:
Parents: ftrAccept (StreamBlock.FCoE.fc.fcPayloads.FCPayload-Choice.ftrAccept)
543
destinationPortsFabricIngressPathInformation
Children: PathInformation
destinationPortsFabricEgressPathInformation Attributes
Attribute
Description
Name
information.
Type: string
destinationPortsFabricEgressPathInformation Object (fcgs PDU library)

Description:
Parents: ftrAccept (StreamBlock.FtrAccept)

destinationPortsFabricEgressPathInformation Attributes
Attribute
Description
Name
information.
Type: string
destinationPortsFabricIngressPathInformation (overloaded)
destinationPortsFabricIngressPathInformation (fc)
destinationPortsFabricIngressPathInformation (fcgs)
destinationPortsFabricIngressPathInformation Object (fc PDU library)

Description:
Parents: intermediateSwitchsPathInformation (StreamBlock.FCoE.fc.fcPayloads.FCPayload-Choice.ftrAccept.intermediateSwitchsPathInformation)

intermediateSwitchsPathInformation (StreamBlock.FCoE.fc.fcPayloads.FCPayload-Choice.ftrAccept.destinationPortsFabricEgressPathInformation)
Children: None
544
destinationPortsFabricIngressPathInformation
destinationPortsFabricIngressPathInformation Attributes
Attribute
Description
domainId
Type: OCTETSTRING
Default: 00000000
egressPhysicalPortNumber
Type: OCTETSTRING
Default: 00000000
egressPortName
Type: WWN
Default: 20:00:10:94:00:00:00:00
ingressPhysicalPortNumber
Type: OCTETSTRING
Default: 00000000
ingressPortName
Type: WWN
Default: 20:00:10:94:00:00:00:00
Name
Type: string
switchName
Type: WWN
Default: 10:00:10:94:00:00:00:00
destinationPortsFabricIngressPathInformation Object (fcgs PDU library)

Description:
Parents: intermediateSwitchsPathInformation (StreamBlock.FtrAccept.intermediateSwitchsPathInformation)

intermediateSwitchsPathInformation (StreamBlock.FtrAccept.destinationPortsFabricEgressPathInformation)
Children: None
destinationPortsFabricIngressPathInformation Attributes
Attribute
Description
domainId
Type: OCTETSTRING
Default: 00000000
Type: OCTETSTRING
Default: 00000000
egressPortName
Type: WWN
Default: 20:00:10:94:00:00:00:00
Type: OCTETSTRING
Default: 00000000
ingressPortName
Type: WWN
Default: 20:00:10:94:00:00:00:00
Name
Type: string
545
DetachPortsCommand
Attribute
Description
switchName
Type: WWN
Default: 10:00:10:94:00:00:00:00
DetachPortsCommand
Description:
Unmap and release one or more ports.

DetachPortsCommand Writable Attributes

Writable Attribute
Description
PortList
List of one or more ports to unmap and release.

Type: handle
Default: 0
DetachPortsCommand Read-Only Attributes

Read-Only Attribute
Description

DetectSourceMacCommand
Description:

DetectSourceMacCommand Writable Attributes

Writable Attribute
Description
PortList
Type: handle
Default: 0
546
DeviceAddrOptions
DetectSourceMacCommand Read-Only Attributes

Read-Only Attribute
Description

DeviceAddrOptions
Description:
Device address options. This object is used to specify start and increment addresses for host and router interfaces.

DeviceAddrOptions Writable Attributes

Writable Attribute
Description
Active, Name
DefaultIpv4Prefix
Default IPv4 address prefix.

Type: u8
Default: 24
Range: 1 - 32
DefaultIpv6Prefix
Default IPv6 address prefix.

Type: u8
Default: 64
Range: 1 - 128
Ipv4Increment
IPv4 address increment.

Type: ip
Default: 0.0.1.0
Ipv6Increment

Type: ipv6
Default: 0::1:0
MacIncrement
MAC address increment.

Type: mac
Default: 00:00:00:00:00:01
NextIpv4
Next IPv4 address.

Type: ip
Default: 192.85.1.3
NextIpv6
Next IPv6 address.

Type: ipv6
Default: 2000::3
NextMac
Next MAC address.

Type: mac
Default: 00:10:94:00:00:02
NextRouterId
Next router ID value.

Type: ip
Default: 192.0.0.1
RouterIdIncrement
Router ID increment value.

Type: ip
Default: 0.0.1.0
547
DeviceCreateCommand
DeviceAddrOptions Read-Only Attributes

DeviceCreateCommand
Description:
Creates a router or host or other device.

Parents: Sequencer
DeviceCreateCommand Writable Attributes

Writable Attribute
Description
AffiliatedDevice
Type: handle
Default: 0
CreateClassId
Class ID of the object to be created. (This parameter is ignored).

Type: classId
Default: 0
CreateCount
Number of device objects to be created.

Type: u32
Default: 1
DeviceCount
Number of devices to be represented by this object. Use 1 for router and N for host.
Type: u32
Default: 1
DeviceRole
Type: string
DeviceType
String representing the device type to create - router or host.

Type: string
Default: Router
IfCount
Interface block count for each of the elements specified in the IfStack attribute. Must have the same list count as
the IfStack attribute.
Type: u32
Default: 1
IfStack
Interface stack to be added to the device.

Use a list of strings, such as Ipv4If, EthIIIf, and so on, in appropriate order.
Type: string
LoopbackIf
Whether the specified interface stack refers to a loopback interface.

Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
Interface stack refers to a loopback interface.
FALSE Interface stack does not refer to a loopback interface.

ParentList
Parent project under which the device needs to be created. Only a single parent project can be specified.
Type: handle
Default: 0
548
DeviceGenAal5IfParams
Writable Attribute
Description
Port
Logical port to which this device is affiliated.

Type: handle
Default: 0
DeviceCreateCommand Read-Only Attributes

Read-Only Attribute
Description
ReturnList
Handles of created devices.

Type: handle
Default: 0
DeviceGenAal5IfParams
Description:

Relations:
Side name
(Type)
Relative
Description
StackedOn
(DeviceGenStackedOnIf)
DeviceGenAal5IfParams, DeviceGenEthIIIfParams,
DeviceGenFcIfParams, DeviceGenGreIfParams,
DeviceGenHdlcIfParams, DeviceGenIpv4IfParams,
DeviceGenIpv6IfParams, DeviceGenPppIfParams,
DeviceGenPppoeIfParams, DeviceGenVlanIfParams
The next interface below this interface in the

interface stack.
TopLevelIfSource
(DeviceGenTopLevelIf)
EmulatedDeviceGenParams, HostGenParams, RouterGenParams
Used to assign the top level interface

parameters in the device generator.
DeviceGenAal5IfParams Writable Attributes

Writable Attribute
Description
Active, Name
VcEncapsulation
VC encapsulation.
Type: enum
Default: VC_MULTIPLEXED
Possible Values:
Value
Description
VC_MULTIPLEXED
VC multiplexed.
LLC_ENCAPSULATED LLC encapsulation.

Vci
Virtual channel identifier start.

Type: u16
Default: 32
Range: 0 - 65535
VciCount
Virtual channel identifier count.

Type: u32
Default: 1
Range: 1 - 65535
549
DeviceGenConfigExpandCommand
Writable Attribute
Description
VciRepeatMode
Virtual channel identifier repeat mode.

Type: enum
Default: REPEAT_ACROSS_PORT
Possible Values:
Value
Description
NO_REPEAT
No repeat.
REPEAT_ACROSS_PORT
Repeat virtual channel identifier across ports.
REPEAT_ACROSS_OUTER Repeat virtual channel identifier across outer interface.

VciStep
Virtual channel identifier step.

Type: s16
Default: 1
Vpi
Virtual path identifier start.

Type: u16
Default: 0
Range: 0 - 4095
VpiCount
Virtual path identifier count.

Type: u32
Default: 1
Range: 1 - 4095
VpiRepeatMode
Virtual path identifier repeat mode.

Type: enum
Possible Values:
Value
Description
NO_REPEAT
No repeat.
REPEAT_ACROSS_PORT
Repeat virtual path identifier across ports.
REPEAT_ACROSS_OUTER Repeat virtual path identifier across outer interface.

VpiStep
Virtual path identifier step.

Type: s16
Default: 1
DeviceGenAal5IfParams Read-Only Attributes

DeviceGenConfigExpandCommand
Description:
Expands the specified Router/Host generator parameters into Router/Host objects.

Children: EmulatedDeviceGenParams, HostGenParams, RouterGenParams
DeviceGenConfigExpandCommand Writable Attributes

Writable Attribute
Description
550
DeviceGenConfigPreviewCommand
Writable Attribute
Description
DeleteExisting
Determines if preexisting Router/Host objects on the selected ports should be deleted when the parameters are
expanded.
Type: enum
Default: PROMPT
Possible Values:
Value
Description
PROMPT Prompt user for YES/NO response.
GenParams
YES
Delete preexisting objects.
NO
Keep preexisting objects. Note: This may create an inconsistent configuration if the parameters being
applied conflict with the existing configuration.
Router/Host parameters to expand.

Type: handle
Default: 0
DeviceGenConfigExpandCommand Read-Only Attributes

Read-Only Attribute
Description

ReturnList
Type: handle
Default: 0
DeviceGenConfigPreviewCommand
Description:
Generates a preview of the expanded Routers/Hosts.

DeviceGenConfigPreviewCommand Writable Attributes

Writable Attribute
Description
DeviceOffset
Expanded Router/Host offset where the preview should start.

Type: u64
Default: 1
Range: 1 - 0xffffffffffffffff
GenParams
Router/Host parameters to expand.

Type: handle
Default: 0
DeviceGenConfigPreviewCommand Read-Only Attributes

Read-Only Attribute
Description

551
DeviceGenEthIIIfParams
Read-Only Attribute
Description
PreviewResult
Results of the preview command. This is a list of strings that contain comma separated values (CSV). The 1st
string contains the names of the values. Each subsequent string represents a router or host. Note: The host
generator preview shows the fully expanded Host objects.
Type: string
DeviceGenEthIIIfParams
Description:
Device generator Ethernet interface parameters.

Relations:
Side name
(Type)
Relative
Description
StackedOn

interface stack.
TopLevelIfSource

DeviceGenEthIIIfParams Writable Attributes

Writable Attribute
Description
Active, Name
EnableRfc4814Addresses
Enable generation of MAC addresses according to RFC 4814.

Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
Generate RFC 4814 MAC addresses.
FALSE Generate MAC addresses using the user specified start and step values.
RandomSeedValue
Seed value for the random number generator used in generating RFC 4814 MAC addresses.
Type: u32
Default: 4814
SrcMac
Source MAC address.

Type: mac
Default: 00:10:94:00:00:01
SrcMacStep
Source MAC step value.

Type: mac
Default: 00:00:00:00:00:01
552
DeviceGenFcIfParams
Writable Attribute
Description
UseDefaultPhyMac
Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
FALSE
DeviceGenEthIIIfParams Read-Only Attributes

DeviceGenFcIfParams
Description:

Relations:
Side name
(Type)
Relative
Description
StackedOn
DeviceGenAal5IfParams, DeviceGenEthIIIfParams, DeviceGenFcIfParams,

DeviceGenGreIfParams, DeviceGenHdlcIfParams, DeviceGenIpv4IfParams,
TopLevelIfSource
DeviceGenFcIfParams Writable Attributes

Writable Attribute
Description
Active, Name
WorldWideName
Type: wwn
Default: 20:00:10:94:00:00:00:01
WorldWideNameStep
Type: wwn
Default: 00:00:00:00:00:00:00:01
DeviceGenFcIfParams Read-Only Attributes

DeviceGenGreIfParams
Description:
Device generator GRE interface parameters.
553

DeviceGenGreIfParams

Relations:
Side name
(Type)
Relative
Description
StackedOn

interface stack.
TopLevelIfSource

DeviceGenGreIfParams Writable Attributes

Writable Attribute
Description
Active, Name
ChecksumEnabled
Whether checksum should be enabled.

Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
Checksum should be enabled.
FALSE Checksum should be disabled.

Count
Number of GRE tunnels per port/VLAN.

Type: u16
Default: 1
Range: 1 - 4095
EnableKeepAlive
Whether GRE keepalive messages should be enabled.

Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
Use keepalive messages.
FALSE Do not use keepalive messages.

InFlowKeyFieldEnabled
Whether incoming GRE key field should be enabled.

Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
GRE key field should be enabled.
FALSE GRE key field should be disabled.

KeepAlivePeriod
Period between keepalive messages.

Type: u16
Default: 10
KeepAliveRetryCount
Keepalive retry count.

Type: u8
Default: 3
OutFlowKeyFieldEnabled
Whether outgoing GRE key field should be enabled.

Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
554
DeviceGenGroupParams
Writable Attribute
Description
RemoteTunnelEndPointV4
Remote tunnel endpoint IPv4 address.

Type: ip
Default: 192.0.0.1
RemoteTunnelEndPointV4Step
Remote tunnel endpoint IPv4 address step per device.

Type: ip
Default: 0.0.0.0

Type: ipv6
Default: 2000::2
RemoteTunnelEndPointV6Step
Remote tunnel endpoint IPv6 address step per device.

Type: ipv6
Default: ::0
RxFlowKeyField
Incoming key field value.

Type: u32
Default: 0
SeqNumEnabled
Whether sequence number should be enabled.

Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
Sequence number should be enabled.
FALSE Sequence number should be disabled.

TxFlowKeyField
Outgoing key field value.

Type: u32
Default: 0
UseGatewayAsRemoteTunnelEndPoint
Determines if the gateway address should be used as the remote tunnel endpoint address.
Type: bool
Default: TRUE
Possible Values:
Value Description
TRUE
Use the gateway as the remote tunnel endpoint address.
FALSE Use the configured remote tunnel endpoint address.
DeviceGenGreIfParams Read-Only Attributes

DeviceGenGroupParams
Description:
Device generator group parameters. If a DeviceGenGroupParams object is added as a child of the Device generator the generated Device objects will be
assigned to DeviceGroup(s). You can create multiple grouping levels by adding nested DeviceGenGroupParams child objects.

Children: DeviceGenGroupParams
555
DeviceGenHdlcIfParams
DeviceGenGroupParams Writable Attributes

Writable Attribute
Description
Active, Name
Count
Number of groups per port (or parent group if nested).

Type: u32
Default: 1
Range: 1 - 10000
CountPerGroup
Number of ports per group.

Type: u32
Default: 1
Range: 1 - 4294967295
GroupName
Name of the RouterGroup/HostGroup objects that the generated Routers/Hosts will be assigned to.
Type: string
GroupType
Name of the GroupType object that the RouterGroup(s)/HostGroup(s) correspond to.

Type: string
Index
Starting group index appended to the GroupName.

Type: u32
Default: 1
Step
Step value applied to the index for each subsequent group.

Type: u32
Default: 1
Range: 1 - 4294967295
DeviceGenGroupParams Read-Only Attributes

DeviceGenHdlcIfParams
Description:
Device generator HDLC interface parameters.
Note: The device generator will create either a PPP or HDLC interface depending on the SONET Mode that is enabled on the port.

Relations:
Side name
(Type)
Relative
Description
StackedOn

interface stack.
TopLevelIfSource

556
DeviceGenIpv4IfParams
DeviceGenHdlcIfParams Writable Attributes

Writable Attribute
Description
Active, Name
ProtocolType
The next level protocol ID of the interface above HDLC.

Type: enum
Default: HDLC_PROTOCOL_TYPE_IPV4
Possible Values:
Value
Description
HDLC_PROTOCOL_TYPE_IPV4
IPv4 protocol ID.
IPv6 protocol ID.
HDLC_PROTOCOL_TYPE_MPLS MPLS protocol ID.
DeviceGenHdlcIfParams Read-Only Attributes

Description:
Device generator IPv4 interface parameters.

Relations:
Side name
(Type)
Relative
Description
StackedOn

interface stack.
TopLevelIfSource

DeviceGenIpv4IfParams Writable Attributes

Writable Attribute
Description
Active, Name
Addr
IPv4 address.
Type: ip
Default: 192.85.1.3
AddrStep
IPv4 address step value.

Type: ip
Default: 0.0.0.1
Gateway
IPv4 gateway address.

Type: ip
Default: 192.85.1.1
557
Writable Attribute
Description
GatewayStep
IPv4 gateway address step value.

Type: ip
Default: 0.0.0.0
PrefixLength
IPv4 address prefix length.

Type: u8
Default: 24
Range: 0 - 32
Tos
TOS value used in the IP header.

Type: u8
Default: 192
Range: 0 - 255
TosType
Formatting of the TOS value.

Type: enum
Default: TOS
Possible Values:
Value
Description
TOS
TOS
DIFFSERV DiffServ
DeviceGenIpv4IfParams Read-Only Attributes

Description:
Device generator IPv6 interface parameters.

Relations:
Side name
(Type)
Relative
Description
StackedOn

interface stack.
TopLevelIfSource

DeviceGenIpv6IfParams Writable Attributes

Writable Attribute
Description
Active, Name
Addr
IPv6 address value.

Type: ipv6
Default: 2000::2
558
DeviceGenLinkedStep
Writable Attribute
Description
AddrStep
IPv6 address step value.

Type: ipv6
Default: 0000::1
AddrType
Type of IPv6 address.

Type: enum
Default: NON_LINK_LOCAL
Possible Values:
Value
Description
NON_LINK_LOCAL Non-Link Local IPv6 address.
LINK_LOCAL
AutoAddrEnable
Link Local IPv6 address.
Auto assign link local address.

Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
Auto assign link local address.
FALSE Do not auto assign link local address.

EnableGatewayLearning
Whether to enable IPv6 learning for the gateway IP and MAC addresses. Learning begins when the ARP/ND
command is issued. If the learned value is not the same as the configured IPv6 gateway address, the learned
value is used instead.
Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
Enable gateway learning.
FALSE Disable gateway learning.

Gateway
IPv6 gateway address.

Type: ipv6
Default: 2000::1
GatewayStep
IPv6 gateway address step value.

Type: ipv6
Default: ::0
PrefixLength

Type: u8
Default: 64
Range: 0 - 128
DeviceGenIpv6IfParams Read-Only Attributes

DeviceGenLinkedStep
Description:
Device generator linked step parameters. Link step is used to increment fields when looping over interfaces with counts (VLAN).

Parents: AbstPppoeDeviceGenProtocolParams, AncpDeviceGenProtocolParams, BfdDeviceGenProtocolParams, BgpDeviceGenProtocolParams,
DeviceGenAal5IfParams, DeviceGenEthIIIfParams, DeviceGenFcIfParams, DeviceGenGreIfParams, DeviceGenHdlcIfParams, DeviceGenIpv4IfParams,
DeviceGenIpv6IfParams, DeviceGenPppIfParams, DeviceGenPppoeIfParams, DeviceGenVlanIfParams, Dhcpv4DeviceGenProtocolParams,
Dhcpv4ServerDeviceGenProtocolParams, Dhcpv6DeviceGenProtocolParams, Dhcpv6ServerDeviceGenProtocolParams, Dot1xDeviceGenProtocolParams,
EmulatedDeviceGenParams, FcDeviceGenProtocolParams, FcoeDeviceGenProtocolParams, HostGenParams, IsisDeviceGenProtocolParams,
L2tpv2DeviceGenProtocolParams, LdpDeviceGenProtocolParams, LldpDeviceGenProtocolParams, MulticastDeviceGenProtocolParams,
559
DeviceGenPppIfParams
MulticastHostGenProtocolParams, MulticastRouterGenProtocolParams, Ospfv2DeviceGenProtocolParams, Ospfv3DeviceGenProtocolParams,

PimDeviceGenProtocolParams, PppoaDeviceGenProtocolParams, PppoeDeviceGenProtocolParams, PppoeoaDeviceGenProtocolParams,
PppoL2tpv2DeviceGenProtocolParams, RipDeviceGenProtocolParams, RouterGenParams, RsvpDeviceGenProtocolParams, SaaDeviceGenProtocolParams,
StpDeviceGenProtocolParams
DeviceGenLinkedStep Writable Attributes

Writable Attribute
Description
Active, Name
LinkToId
Interface type and index to link to (for example, VlanIf1).

Type: string
PropertyId
Property name in the parent object to increment (for example, Addr).

Type: string
Step
Step value to apply to the property.

Type: string
DeviceGenLinkedStep Read-Only Attributes

DeviceGenPppIfParams
Description:
Device generator PPP interface parameters.
Note: The Device generator will create either a PPP or HDLC interface depending on the SONET Mode that is enabled on the port.

Relations:
Side name
(Type)
Relative
Description
StackedOn

interface stack.
TopLevelIfSource

DeviceGenPppIfParams Writable Attributes

Writable Attribute
Description
Active, Name
560
DeviceGenPppoeIfParams
Writable Attribute
Description
ProtocolId
The next level protocol ID of the interface above PPP.

Type: enum
Default: PPP_PROTOCOL_ID_IPV4
Possible Values:
Value
Description
PPP_PROTOCOL_ID_IPV6
IPv6 protocol ID.
IPv4 protocol ID.
PPP_PROTOCOL_ID_MPLS MPLS protocol ID.
DeviceGenPppIfParams Read-Only Attributes

DeviceGenPppoeIfParams
Description:
Device generator PPPoE interface parameters.

Relations:
Side name
(Type)
Relative
Description
StackedOn

interface stack.
TopLevelIfSource

DeviceGenPppoeIfParams Writable Attributes

Writable Attribute
Description
Active, Name
DeviceGenPppoeIfParams Read-Only Attributes

DeviceGenVlanIfParams
Description:
Device generator VLAN interface parameters.

561
DeviceGroup
Relations:
Side name
(Type)
Relative
Description
StackedOn

interface stack.
TopLevelIfSource

DeviceGenVlanIfParams Writable Attributes

Writable Attribute
Description
Active, Name
Count
Number of VLAN IDs.

Type: u16
Default: 1
Range: 1 - 4095
IdStep
VLAN ID step value.

Type: s16
Default: 1
Priority
VLAN priority.
Type: u8
Default: 7
Range: 0 - 7
RepeatMode
Determines how VLAN IDs are repeated.

Type: enum
Possible Values:
Value
Description
NO_REPEAT
VLAN IDs are not repeated.
REPEAT_ACROSS_PORT
VLAN IDs are repeated from the starting VLAN ID on all ports.
REPEAT_ACROSS_LOWER_IF VLAN IDs are repeated from the starting VLAN ID when the next lower level
interface (or port) changes.
Tpid
Tag protocol identifier.

Type: u16
Default: 33024
VlanId
VLAN ID.
Type: u16
Default: 100
Range: 0 - 4095
DeviceGenVlanIfParams Read-Only Attributes

DeviceGroup
Description:
Used to define a grouping of device objects.
562
DeviceRole

Parents: Project
Relations:
Side name
(Type)
Relative
Description
MemberOfGroup
(GroupMembership)
DeviceGroup, EmulatedDevice, HostGroup
GroupTypeSource
(GroupOfType)
GroupType
DeviceGroup Writable Attributes

Writable Attribute
Description
Active, Name
GroupName
Name of the group.

Type: string
DeviceGroup Read-Only Attributes

DeviceRole
Description:
Identifies the role of a device (for example, Host, Router).

Parents: Project
Relations:
Side name
(Type)
Relative
Device
(AssociatedDeviceRole)
EmulatedDevice
Description
DeviceRole Writable Attributes

Writable Attribute
Description
Active, Name
DeviceRole Read-Only Attributes

DevicesStartAllCommand
Description:
563
DevicesStopAllCommand
Starts all devices.

DevicesStartAllCommand Writable Attributes

Writable Attribute
Description
ProtocolStartOrder
Specifies how the protocols need to be started.

Type: enum
Default: START_PROTOCOLS_SERIALLY
Possible Values:
Value
Description
START_PROTOCOLS_SERIALLY
Start protocols serially.
START_PROTOCOLS_INTERLEAVED Start protocols in an interleaved fashion.
DevicesStartAllCommand Read-Only Attributes

Read-Only Attribute
Description

DevicesStopAllCommand
Description:
Stops all devices under the specified project.

DevicesStopAllCommand Writable Attributes

Writable Attribute
Description
DevicesStopAllCommand Read-Only Attributes

Read-Only Attribute
Description

DeviceStartCommand
Description:
564
DeviceStopCommand
Starts all protocols on specified device.

DeviceStartCommand Writable Attributes

Writable Attribute
Description
DeviceList
Devices which need to be started.

Type: handle
Default: 0
ProtocolStartOrder
Specifies how the protocols on a device need to be started.

Type: enum
Default: START_PROTOCOLS_SERIALLY
Possible Values:
Value
Description
START_PROTOCOLS_SERIALLY
Start protocols serially.
START_PROTOCOLS_INTERLEAVED Start protocols in an interleaved fashion.
DeviceStartCommand Read-Only Attributes

Read-Only Attribute
Description

DeviceStopCommand
Description:
Stops all protocols on specified device.

DeviceStopCommand Writable Attributes

Writable Attribute
Description
DeviceList
Devices which need to be started.

Type: handle
Default: 0
DeviceStopCommand Read-Only Attributes

Read-Only Attribute
Description

565
Dhcpclientmsg
Dhcpclientmsg (dhcp:Dhcpclientmsg)
Description:
Use this object for the DHCPv4 client message.
Children: options
Dhcpclientmsg Attributes
Attribute
Description
bootfilename
Type: OCTETSTRING
bootpflags
Type: OCTETSTRING
Default: 8000
clientAddr
Type: IPV4ADDR
Default: 192.85.1.2
clientHWPad
Type: OCTETSTRING
clientMac
Type: MACADDR
Default: 00:00:01:00:00:02
elapsed
Type: INTEGER
Default: 0
haddrLen
Type: INTEGER
Default: 6
hardwareType
Type: INTEGER
Default: 1
hops
Type: INTEGER
Default: 0
magiccookie
Type: OCTETSTRING
Default: 63825363
messageType
Type: INTEGER
Default: 1
Name
Type: string
nextservAddr
Type: IPV4ADDR
Default: 0.0.0.0
relayagentAddr
Type: IPV4ADDR
Default: 0.0.0.0
serverhostname
Type: OCTETSTRING
xid
Type: INTEGER
Default: 1
yourAddr
Type: IPV4ADDR
Default: 0.0.0.0
566
DHCPOption
DHCPOption
Description:
Parent of the options objects for DHCP
Parents: options
Children: clientIdHW, clientIdnonHW, customOption, endOfOptions, hostName, leaseTime, message, messageSize, messageType, optionOverload, paramReqList,
reqAddr, serverId
DHCPOption Attributes
Attribute
Description
Name
information.
Type: string
Dhcpservermsg (dhcp:Dhcpservermsg)
Description:
Use this object for the DHCPv4 server message.
Children: options
Dhcpservermsg Attributes
Attribute
Description
bootfilename
Type: OCTETSTRING
bootpflags
Type: OCTETSTRING
Default: 8000
clientAddr
Type: IPV4ADDR
Default: 0.0.0.0
clientHWPad
Type: OCTETSTRING
clientMac
Type: MACADDR
Default: 00:00:01:00:00:02
elapsed
Type: INTEGER
Default: 0
haddrLen
Type: INTEGER
Default: 6
hardwareType
Type: INTEGER
Default: 1
hops
Type: INTEGER
Default: 0
magiccookie
Type: OCTETSTRING
Default: 63825363
messageType
Type: INTEGER
Default: 2
567
Dhcpv4AbortCommand
Attribute
Description
Name
Type: string
nextservAddr
Type: IPV4ADDR
Default: 0.0.0.0
relayagentAddr
Type: IPV4ADDR
Default: 0.0.0.0
serverhostname
Type: OCTETSTRING
xid
Type: INTEGER
Default: 1
yourAddr
Type: IPV4ADDR
Default: 0.0.0.0
Dhcpv4AbortCommand
Description:
Reset DHCP emulation on the DHCP port.

Dhcpv4AbortCommand Writable Attributes

Writable Attribute
Description
BlockList
List of Dhcpv4BlockConfig object handles.

Type: handle
Default: 0
Dhcpv4AbortCommand Read-Only Attributes

Read-Only Attribute
Description

Dhcpv4AbortServerCommand
Description:
Reset DHCP emulation on the DHCP server.

568
Dhcpv4BindCommand
Dhcpv4AbortServerCommand Writable Attributes

Writable Attribute
Description
ServerList
List of DHCPv4 server handles to reset emulation on.

Type: handle
Default: 0
Dhcpv4AbortServerCommand Read-Only Attributes

Read-Only Attribute
Description

Dhcpv4BindCommand
Description:
Reset DHCPv4 emulation on the DHCP session block.

Dhcpv4BindCommand Writable Attributes

Writable Attribute
Description
BlockList

Type: handle
Default: 0
Dhcpv4BindCommand Read-Only Attributes

Read-Only Attribute
Description

Dhcpv4BindWaitCommand
Description:
Wait for sessions to be bound. Command will return when the sessions are bound or when the wait time has expired.

Parents: Sequencer
569
Dhcpv4BlockConfig
Dhcpv4BindWaitCommand Writable Attributes

Writable Attribute
Description
ErrorOnFailure
ObjectList
List of object handles (that is, Project, Port, or EmulatedDevice) to wait for bound state on.
Type: handle
Default: 0
WaitTime
Maximum amount of time in seconds we should wait for sessions to go into bound state.
Type: double
Default: 30.0
Range: 0.005 - 2147483647.0
Dhcpv4BindWaitCommand Read-Only Attributes

Read-Only Attribute
Description
Dhcpv4BlockConfig
Description:
DHCPv4 block configuration settings.

Children: Dhcpv4MsgOption
Result children (automatically created): Dhcpv4BlockResults, Dhcpv4SessionResults
Relations:
Side name
(Type)
Relative
Description
ArpProxyIf
(ArpProxyIf)

RelayAgentIf
(RelayIf)

Relation to an extra layer 3 interface to be used when

the DHCPv4 block operates in relay agent mode.
ResultChild
(ResultChild)
Dhcpv4BlockResults
UsesIf
(UsesIf)


Dhcpv4BlockConfig Writable Attributes

Writable Attribute
Description
Active, Name
570
Dhcpv4BlockConfig
Writable Attribute
Description
CircuitId
Specify the Circuit ID field in the message sent by the relay agent. Use wildcard characters to make each circuit ID
unique:
@s - Session index associated with the DHCP client.
@p - Port name.
@m - MAC address of the DHCP client.
@@ - This must be used to include the "@" symbol in the string.
The EnableCircuitId attribute must be set to TRUE for this attribute to take effect.
Type: string
Default: circuitId_@p
ClientRelayAgent
Not exposed in the GUI.

Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
Enable Client Relay agent.
FALSE Disable Client Relay agent.

EnableArpServerId
Enable or disable ARP on the Server ID.

Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
Enable ARP on the Server ID.
FALSE Disable ARP on the Server ID.

EnableAutoRetry
Enable auto retry. Auto retry will retry sessions that fail to initially come up.
Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
Enable auto retry. Failed sessions will be retried automatically.
FALSE Disable auto retry.

EnableCircuitId
Enable the circuit ID sub-option in the DHCP messages that are sent from the emulated relay agent. The circuit ID
sub-option is described in RFC 3046.
Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
Include the circuit ID sub-option.
FALSE Do not include the circuit ID sub-option.

EnableRelayAgent
Enables or disables the relay agent option specified in RFC 3046.

Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
Send all client bind requests as if they were passing through a relay agent.
FALSE Do not use a relay agent.
571
Dhcpv4BlockConfig
Writable Attribute
Description
EnableRemoteId
Enable the remote ID sub-option in the DHCP messages that are sent from the emulated relay agent. The remote ID
sub-option is described in RFC 3046.
Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
Include the remote ID sub-option.
FALSE Do not include the remote ID sub-option.

EnableRouterOption
Enable the router option (option 3) specified in RFC 2132.

Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
Enable router option.
FALSE Disable router option.

HostName
Unique hostname of emulated client. Use wildcard characters to make each hostname unique:
@p - Port name.
Type: string
Default: client_@p-@b-@s
OptionList
A space-separated list of Option 55 numbers for the DHCP request messages on each session block. This attribute can
have one or more of the following values:
1 - Subnet Mask Option.
3 - Router Option.
6 - Domain Name Servers Option.
15 - Domain Name Option.
33 - Static Routes Option.
44 - NetBIOS Name Servers Option.
46 - NetBIOS Node Type Option.
47 - NetBIOS Scope Option.
51 - IP Address Lease Time Option.
54 - Server Identifier Option.
58 - Renewal Time (T1) Option.
59 - Rebinding Time (T2) Option.
Tcl example: -optionList "1 6 15 33 44 51".
NOTE: The correct default for this attribute is 1 6 15 33 44.
Type: u8
Default: 1
RelayAgentIpv4Addr
Source IP address of the relay agent message, and the "giaddr" field in the DHCP message.
Type: ip
Default: 0.0.0.0
RelayAgentIpv4AddrMask
IP Mask to apply to the Relay Local IP address.

Type: ip
Default: 255.255.0.0
RelayAgentIpv4AddrStep
IP Step to be applied to the Relay Local IP address.

Type: ip
Default: 0.0.0.1
572
Dhcpv4BlockConfig
Writable Attribute
Description
RelayClientMacAddrMask
MAC mask that will be applied to the Relay Client MAC address.
Type: mac
Default: 00-00-00-ff-ff-ff
RelayClientMacAddrStart
Starting value for the MAC address.

Type: mac
Default: 00-10-01-00-00-01
RelayClientMacAddrStep
MAC step that will be applied to the Relay Client MAC address.
Type: mac
Default: 00-00-00-00-00-01
RelayPoolIpv4Addr
Number of Relay Agent networks.

Type: ip
Default: 0.0.0.0
RelayPoolIpv4AddrStep
Relay pool IPv4 address step.

Type: ip
Default: 0.0.1.0
RelayServerIpv4Addr
Destination IP address for the relay agent message.

Type: ip
Default: 0.0.0.0
RelayServerIpv4AddrStep
IP Step to be applied to the Relay Server IP address.

Type: ip
Default: 0.0.0.1
RemoteId
Use wildcard characters to make each remote ID unique:

@p - Port name.
The EnableRemoteId attribute must be set to TRUE for this to take effect.
Type: string
Default: remoteId_@p-@b-@s
RetryAttempts
Number of times to retry the session after the initial failure (each retry will use a new transaction ID).
Type: u32
Default: 4
Range: 1 - 4294967295
UseBroadcastFlag
Enable/disable broadcast bit in DHCP control plane packets.

Type: bool
Default: TRUE
Possible Values:
Value Description
TRUE
Enable broadcast bit.
FALSE Disable broadcast bit.

UseClientMacAddrForDataplane
Use client MAC address for dataplane.

Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
Enable use of the client's MAC address for traffic.
FALSE Disable use of the client's MAC address for traffic (uses the Relay Agent's MAC instead).
573
Dhcpv4BlockResults
Writable Attribute
Description
Flag indicating partial block state as used.

Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
Dhcpv4BlockConfig Read-Only Attributes

Read-Only
Attribute
Description
BlockState
Aggregate status of the DHCP host block. If all hosts in the block are not in the same state, their aggregate state is determined based on
rules of precedence. Idle and Bound are the only stable states. All other states are considered transitional. In determining the aggregate
state, any hosts in a transitional state take precedence over those that are already bound.
Type: enum
Default: IDLE
Possible Values:
Value
Description
IDLE
Host block is not currently active (no commands have been issued). No DHCP sessions are active. This state is entered
if the hosts were manually released.
REQUEST
At least one session associated with the host block is in the process of being established. The hosts are either sending
an initial DHCPDISCOVER broadcast message to obtain a DHCP lease, or sending a DHCPREQUEST message requesting
an IP address. The messages use 255.255.255.255 as the destination address and 0.0.0.0 as the source address. The
remaining hosts may be in either the Bound state or the Idle state, but not the Releasing state.
RELEASE
At least one host in the host block no longer needs to use the IP address leased to it and is in the process of sending a
DHCPRELEASE message to the DHCP server.
RENEW
At least one host in the block is in the process of renewing the lease by sending another DHCPREQUEST message.
Other hosts can be in the Bound or Idle state. NOTE: The Renewing state only refers to leases that were manually renewed
(using the Renew DHCP Host command). It does not refer to the automatic renewal that occurs when the T1 timer has
expired.
REBIND
At least one session is rebinding as the lease has expired.
AUTORENEW At least one session is in the process of being autorenewed.

GROUPREQ
Intermediate state within the binding state.
BOUND
The DHCPDISCOVER, DHCPOFFER, DHCPREQUEST, and DHCPACK messages between the DHCP host and server
have resulted in retrieving an IP address for at least one host in the block. No other hosts are requesting or releasing IP
addresses, but they may be automatically renewing expired leases.
Dhcpv4BlockResults
Description:
DHCPv4 Block Results.

Parents: Dhcpv4BlockConfig
Relations:
Side name
(Type)
Relative
Description
ResultParent
(ResultChild)
Dhcpv4BlockConfig
Dhcpv4BlockResults Writable Attributes

574
Dhcpv4BlockResults
Dhcpv4BlockResults Read-Only Attributes

Read-Only Attribute
Description
ElapsedTime
AttemptRate
Attempt rate in sessions per second.

Type: double
Default: 0
BindRate
Binding rate in sessions per second.

Type: double
Default: 0
CurrentAttemptCount
Number of hosts in the block that are in the process of attempting to bind and are sending or receiving
DHCP messages.
Type: u32
Default: 0
CurrentBoundCount
Number of DHCP sessions that are currently bound. This statistic should match the DUT's "Leased Count"
statistic.
Type: u32
Default: 0
CurrentIdleCount
Number of DHCP sessions currently in the Idle state (sessions that have been programmed but are not
being attempted).
Type: u32
Default: 0
RxAckCount
Number of DHCPACK messages received.

Type: u32
Default: 0
RxForceRenewCount
Number of DHCP Force Renews (unicast DHCPREQUEST messages) received.

Type: u32
Default: 0
RxNakCount
Number of DHCPNAK messages received.

Type: u32
Default: 0
RxOfferCount
Number of DHCPOFFER messages received.

Type: u32
Default: 0
TotalAttemptCount
Total number of sessions attempted (both past and current).

Type: u32
Default: 0
TotalBoundCount
Total number of bound sessions (both past and current).

Type: u32
Default: 0
TotalFailedCount
Total number of DHCP hosts in the block that have failed to bind (both past and current). Failures may be
due to DUT overload, a T1 timer expiration, or reaching the number of retries for the session.
Type: u32
Default: 0
TotalRenewedCount
Total number of renewed sessions.

Type: u32
Default: 0
TotalRetriedCount
Total number of times DHCPDISCOVER and DHCPREQUEST messages have been retried.
Type: u32
Default: 0
TxDiscoverCount
Number of DHCPDISCOVER messages sent.

Type: u32
Default: 0
575
Dhcpv4CopyOptionsCommand
Read-Only Attribute
Description
TxRebindCount
Number of DHCP Rebinds (broadcast DHCPREQUEST messages).

Type: u32
Default: 0
TxReleaseCount
Number of DHCPRELEASE messages sent.

Type: u32
Default: 0
TxRenewCount
Number of DHCP Renews (unicast DHCPREQUEST messages).

Type: u32
Default: 0
TxRequestCount
Number of DHCPREQUEST messages sent.

Type: u32
Default: 0
Dhcpv4CopyOptionsCommand
Description:
Optimized DHCPv4 copy custom options command. The SrcOptionList will overwrite existing server custom message options.

Parents: Sequencer
Dhcpv4CopyOptionsCommand Writable Attributes

Writable Attribute
Description
DstList
List of DHCPv4 server handles.

Type: handle
Default: 0
SrcOptionList
List of DCHPv4 server message option handles.

Type: handle
Default: 0
Dhcpv4CopyOptionsCommand Read-Only Attributes

Dhcpv4DeviceGenProtocolParams
Description:
Specifies the DHCP specific Host generator parameters.

Parents: AncpAccessLoopGenParams, EmulatedDeviceGenParams, HostGenParams, RouterGenParams
576
Dhcpv4DeviceGenProtocolParams Writable Attributes

Writable Attribute
Description
Active, Name
CircuitId
Specifies the circuit ID.

Type: string
Default: circuitId_@p
ClientsPerRelayAgent
Clients per relay agent.

Type: u32
Default: 1
Range: 1 - 65535
EnableAutoRetry
Enable auto retry. Auto retry will retry sessions that fail to initially come up.
Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
Enable auto retry. Failed sessions will be retried automatically.

EnableCircuitId
Enable circuit ID.

Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
Include the circuit ID sub-option.
FALSE Do not include the circuit ID sub-option.

EnableRelayAgent
Enable relay agent emulation.

Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
Emulate a client behind a relay agent.
FALSE Client is not behind a relay agent.

EnableRemoteId
Enable remote ID sub-option in DHCP messages sent from emulated relay agent.
Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
Include the remote ID sub-option.
FALSE Do not include the remote ID sub-option.

EnableRouterOption
Enable the router option (option 3) specified in RFC 2132.

Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
Enable the router option.
FALSE Disable the router option.
577
Writable Attribute
Description
HostName
Unique hostname of emulated client. Use wildcard characters to make each hostname unique:
@p - Port name.
Type: string
Default: client_@p-@b-@s
OptionList
A space-separated list of Option 55 numbers for the DHCP request messages on each session block. This attribute
can have one or more of the following values:
1 - Subnet Mask Option.
3 - Router Option.
6 - Domain Name Servers Option.
15 - Domain Name Option.
33 - Static Routes Option.
44 - NetBIOS Name Servers Option.
46 - NetBIOS Node Type Option.
47 - NetBIOS Scope Option.
51 - IP Address Lease Time Option.
54 - Server Identifier Option.
58 - Renewal Time (T1) Option.
59 - Rebinding Time (T2) Option.
Tcl example: -optionList "1 6 15 33 44 51".
Type: u8
Default: 1
RelayClientMacAddrMask
Relay agent client MAC address mask.

Type: mac
RelayClientMacAddrStart
Relay agent client starting MAC address.

Type: mac
Default: 00-10-01-00-00-01
RelayClientMacAddrStep
Relay agent client MAC address step.

Type: mac
Default: 00-00-00-00-00-01
RelayPoolIpv4Addr
Relay agent pool IPv4 address.

Type: ip
Default: 0.0.0.0
RelayPoolIpv4AddrStep
Relay agent pool IPv4 address step.

Type: ip
Default: 0.0.1.0
RelayServerIpv4Addr
Specifies the relay agent server IPv4 address if UseGatewayAsRelayServerIpv4Addr is true.

Type: ip
Default: 0.0.0.0
RelayServerIpv4AddrStep
Specifies the relay agent server IPv4 address step if UseGatewayAsRelayServerIpv4Addr is true.
Type: ip
Default: 0.0.0.1
RemoteId
Specifies the remote ID.

Type: string
Default: remoteId_@p-@b-@s
578
Dhcpv4ForceRenewFromServerCommand
Writable Attribute
Description
RetryAttempts
Number of times to retry the session after the initial failure (each retry will use a new transaction ID).
Type: u32
Default: 4
Range: 1 - 4294967295
UseClientMacAddrForDataplane
Use the client's MAC address for traffic.

Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
Enable use of the client's MAC address for traffic.
FALSE Disable use of the client's MAC address for traffic (uses the Relay Agent's MAC instead).
UseGatewayAsRelayServerIpv4Addr
Use the gateway address as the relay agent server IPv4 address.
Type: bool
Default: TRUE
Possible Values:
Value Description
TRUE
Use the gateway address as the relay agent server IPv4 address.
FALSE Use the RelayServerIpv4Addr address field for the server IPv4 address.
Dhcpv4DeviceGenProtocolParams Read-Only Attributes

Dhcpv4ForceRenewFromServerCommand
Description:
Force DHCP renew (unicast DHCPFORCERENEW) on bound sessions.

Dhcpv4ForceRenewFromServerCommand Writable Attributes

Writable Attribute
Description
ServerList
List of servers to do a force renew on.

Type: handle
Default: 0
Dhcpv4ForceRenewFromServerCommand Read-Only Attributes

Read-Only Attribute
Description

579
Dhcpv4MsgOption
Dhcpv4MsgOption
Description:
Allows you to specify custom DHCP options.

Dhcpv4MsgOption Writable Attributes

Writable Attribute
Description
Active, Name
EnableWildcards
Expand wildcards in the message option.

Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
Wildcards in the message option will be substituted for values.
FALSE Wildcards in the message option will not be substituted for values.
HexValue
Indicate the string should/should not be treated as hexadecimal.

Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
String is in hexadecimal format.
FALSE String is not in hexadecimal format.

MsgType
Includes the message option in DISCOVER, REQUEST, or BOTH.

Type: enum
Default: BOTH
Possible Values:
Value
Description
DISCOVER Include the message option in the DISCOVER message.
REQUEST Include the message option in the REQUEST message.
BOTH
Include the message option in both DISCOVER and REQUEST messages.
OptionType
Option value.
Type: u8
Default: 0
Range: 0 - 255
Payload

@p - Port name.
Type: string
580
Dhcpv4Options
Writable Attribute
Description
Remove
Remove the options in the payload.

Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
Remove the specified option(s).
FALSE Do not remove the specified option(s).
Dhcpv4MsgOption Read-Only Attributes

Dhcpv4Options
Description:
Project-wide DHCPv4 settings.

Dhcpv4Options Writable Attributes

Writable Attribute
Description
Active, Name
EnableServerRouting
Enable the server to route packets through the gateway.

Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
Enable server routing of packets through the gateway.
FALSE Disable server routing of packets through the gateway.

TrafficBehavior
Traffic behavior in relation to failed sessions.

Type: enum
Default: REQUIRE_ALL_SESSIONS_BOUND
Possible Values:
Value
Description
REQUIRE_ALL_SESSIONS_BOUND Start traffic only if all sessions are bound.
IGNORE_FAILED_SESSIONS
Start traffic while ignoring sessions that failed to bind.
Dhcpv4Options Read-Only Attributes

Dhcpv4PortConfig
Description:
Defines characteristics of the communication between emulated DHCP clients and the DHCP server (the DUT).
581
Dhcpv4PortConfig
You can create only one DhcpPort object under an Ethernet object. The values defined by the DhcpPort object are applied to all DHCP sessions defined by
all DhcpSessionBlock objects that are children of the same Ethernet object.

Parents: AccessTestGenPortParams
Result children (automatically created): Dhcpv4PortResults
Relations:
Side name
(Type)
Relative
Description
ResultChild
(ResultChild)
Dhcpv4PortResults
Dhcpv4PortConfig Writable Attributes

Writable Attribute
Description
Active, Name
LeaseTime
Suggested lease time in seconds at the DHCP port level.

Type: u32
Default: 60
Range: 10 - 4294967295
MaxMsgSize
Used to negotiate the maximum DHCP message size, in bytes. This is option 57 for the options field of the DHCP
message, as described in RFC 2132.
Type: u16
Default: 576
Range: 264 - 1500
MsgTimeout
Message timeout in seconds.

Type: u32
Default: 60
Range: 1 - 99999
OutstandingSessionCount
Number of DHCP sessions to resolve at a time.

Type: u32
Default: 1000
Range: 1 - 2048
ReleaseRate
Number of DHCP sessions that are released per second. This value applies to all sessions on the port (all sessions
defined by all DhcpSessionBlock objects that ReleaseRate are children of the Ethernet object). Use the Release
operation to release DHCP sessions.
Type: double
Default: 100.0
Range: 1 - 10000
RequestRate
Requests per second for DHCP client leases or lease renewals. This value applies to all sessions on the port (all
sessions defined by all DhcpSessionBlock objects that are children of the Ethernet object).
Type: double
Default: 100.0
Range: 1.0 - 10000.0
RetryCount
Number of retries allowed.

Type: u16
Default: 4
Range: 0 - 65535
SeqType
Port-level sequence type that determines in what order sessions are attempted.
Type: enum
Default: SEQUENTIAL
Possible Values:
Value
Description
SEQUENTIAL Sessions are attempted sequentially across host blocks under the port.
PARALLEL
Sessions are attempted in parallel across host blocks under the port.
582
Dhcpv4PortResults
Writable Attribute
Description
StartingXid
Starting transaction ID for sessions on this port.

Type: u32
Default: 0
Dhcpv4PortConfig Read-Only Attributes

Read-Only
Attribute
Description
PortState
Aggregate status of all DHCP hosts on the port. If all hosts on the port are not in the same state, their aggregate state is determined
based on rules of precedence. Idle and Bound are the only stable states. All other states are considered transitional. In determining
the aggregate state, any hosts in a transitional state take precedence over those that are already bound.
Type: enum
Default: IDLE
Possible Values:
Value
Description
IDLE
No host blocks are currently active (no commands have been issued). No DHCP sessions are active. This
state is entered if all hosts were manually released.
ESTABLISH
At least one of the session blocks is doing a bind.
RELEASE
At least one host on the port no longer needs to use the IP address leased to it and is in the process of
sending a DHCPRELEASE message to the DHCP server.
ESTABLISH_RELEASE At least one session block is binding, and at least one session block is releasing an IP address.
BOUND
The DHCPDISCOVER, DHCPOFFER, DHCPREQUEST, and DHCPACK messages between the DHCP
host and server have resulted in retrieving an IP address for at least one host on the port. No other hosts
are requesting or releasing IP addresses, but they may be automatically renewing expired leases.
Dhcpv4PortResults
Description:
DHCPv4 port results.

Parents: Dhcpv4PortConfig
Relations:
Side name
(Type)
Relative
Description
ResultParent
(ResultChild)
Dhcpv4PortConfig
Dhcpv4PortResults Writable Attributes

Dhcpv4PortResults Read-Only Attributes

Read-Only Attribute
Description
AttemptRate
Rate of attempts (in sessions/second) for the binding of DHCP client leases for all sessions on the port.
Type: double
Default: 0
AvgSetupTime
Average setup time that was required to bind a session (in milliseconds).
Type: double
Default: 0
583
Dhcpv4PortResults
Read-Only Attribute
Description
BindRate
Rate of binding (in sessions/second) of DHCP client leases or lease renewals for all sessions on the port.
Type: double
Default: 0
CurrentBoundCount
Number of DHCP hosts on the port that are bound (have been assigned an IP address). This statistic
corresponds to the DUT's Leased Count statistic.
Type: u32
Default: 0
CurrentIdleCount
Number of DHCP hosts on the port that are in the Idle state.
Type: u32
Default: 0
MaxSetupTime
Maximum setup time that was required to bind a session (in milliseconds).
Type: double
Default: 0
MinSetupTime
Minimum setup time that was required to bind a session (in milliseconds).
Type: double
Default: 0
RxAckCount
Number of DHCPACK messages received.

Type: u32
Default: 0
RxForceRenewCount
Number of DHCP Force Renews (unicast DHCPREQUEST messages) received.

Type: u32
Default: 0
RxNakCount
Number of DHCPNAK messages received.

Type: u32
Default: 0
RxOfferCount
Number of DHCPOFFER messages received.

Type: u32
Default: 0
SuccessPercent
Percentage of all sessions on the port that have been successfully bound and have obtained DHCP client
leases or lease renewals.
Type: double
Default: 0
TotalAttemptCount
Total number of DHCP hosts on the port that have attempted to bind (both past and current).
Type: u32
Default: 0
TotalBoundCount
Total number of DHCP hosts on the port that are bound (both past and current).
Type: u32
Default: 0
TotalFailedCount
Total number of DHCP hosts on the port that have failed to bind (both past and current). Failures may be due
to DUT overload, a T1 timer expiration, or reaching the number of retries for the session.
Type: u32
Default: 0
TotalRenewedCount
Total number of DHCP hosts on the port that renewed a lease.

Type: u32
Default: 0
TotalRetriedCount
Total number of DHCP hosts on the port that have retried to bind (both past and current).
Type: u32
Default: 0
TxDiscoverCount
Number of DHCPDISCOVER messages sent.

Type: u32
Default: 0
584
Dhcpv4RebindCommand
Read-Only Attribute
Description
TxRebindCount
Number of DHCP Rebinds (broadcast DHCPREQUEST messages).

Type: u32
Default: 0
TxReleaseCount
Number of DHCPRELEASE messages sent.

Type: u32
Default: 0
TxRenewCount
Number of DHCP Renews (unicast DHCPREQUEST messages).

Type: u32
Default: 0
TxRequestCount
Number of DHCPREQUEST messages sent.

Type: u32
Default: 0
Dhcpv4RebindCommand
Description:
Rebind DHCP sessions (broadcast DHCPREQUEST).

Dhcpv4RebindCommand Writable Attributes

Writable Attribute
Description
BlockList
List of blocks to do a DHCP Rebind on.

Type: handle
Default: 0
Dhcpv4RebindCommand Read-Only Attributes

Read-Only Attribute
Description

Dhcpv4RelayAgentLink
Description:
DHCPv4 relay agent Link between relay agents and DHCPv4 sessions.

Relations:
585
Dhcpv4ReleaseCommand
Side name
(Type)
Relative
Description
ContainedLink
(ContainedLink)
AncpCpeToDslamLink, CustomLink, Dhcpv4RelayAgentLink, EoamLink, EthernetBridgeLink,

IpForwardingLink, ItagServiceLink, L3ForwardingLink, MplsForwardingLink,
MplsHierarchicalLink, MplsIpv4VpnCeToPeLink, MplsIpv6VpnCeToPeLink,
MplsL2VpnPeToPLink, MplsL3VpnPeToPLink, MVpnGreCeToPeLink, MVpnGrePeToPLink,
VifToVicLink, VlanSwitchLink, VplsBgpCeToPeLink, VplsLdpCeToPeLink, VrfCustomerLink,
VrfProviderLink
Container
(ContainedLink)
EmulatedDevice
LinkDstDevice
(LinkDstDevice)
EmulatedDevice
Dhcpv4RelayAgentLink Writable Attributes

Writable Attribute
Description
Active, Name
Dhcpv4RelayAgentLink Read-Only Attributes

Read-Only Attribute
Description
LinkType
Name of the link type (Dhcpv4RelayAgentLink).

Type: string
Description:
Release all DHCP clients on the DHCP port.

Dhcpv4ReleaseCommand Writable Attributes

Writable Attribute
Description
BlockList

Type: handle
Default: 0
Dhcpv4ReleaseCommand Read-Only Attributes

Read-Only Attribute
Description

586
Dhcpv4ReleaseWaitCommand
Description:
Wait for sessions to be released. Command will return when the sessions are idle or when the wait time has expired.

Parents: Sequencer
Dhcpv4ReleaseWaitCommand Writable Attributes

Writable Attribute
Description
ErrorOnFailure
ObjectList
List of object handles (that is, Project, Port, or EmulatedDevice) to wait for idle state on.
Type: handle
Default: 0
WaitTime
Maximum amount of time in seconds to wait for sessions to go into idle state.
Type: double
Default: 30.0
Range: 0.005 - 2147483647.0
Dhcpv4ReleaseWaitCommand Read-Only Attributes

Read-Only Attribute
Description
Dhcpv4RenewCommand
Description:
Renew network configuration parameters with the DHCP server (particularly network IP address).

Dhcpv4RenewCommand Writable Attributes

Writable Attribute
Description
BlockList

Type: handle
Default: 0
Dhcpv4RenewCommand Read-Only Attributes

Read-Only Attribute
Description

587
Dhcpv4ServerConfig
Dhcpv4ServerConfig
Description:
DHCPv4 server configuration settings.

Parents: Dhcpv4ServerPoolConfig, EmulatedDevice
Children: Dhcpv4ServerMsgOption
Automatically created from: Dhcpv4ServerDefaultPoolConfig
Result children (automatically created): Dhcpv4ServerResults
Relations:
Side name
(Type)
Relative
Description
ResultChild
(ResultChild)
Dhcpv4ServerResults
UsesIf
(UsesIf)


Dhcpv4ServerConfig Writable Attributes

Writable Attribute
Description
Active, Name
DeclineReserveTime
Time in seconds an address will be reserved after it is declined by the client.

Type: u32
Default: 10
HostName
Server host name.

Type: string
Default: server_@p-@b-@s
LeaseTime
Default lease time in seconds.

Type: u32
Default: 3600
MinAllowedLeaseTime
Minimum allowed lease time in seconds.

Type: u32
Default: 600
OfferReserveTime
Time in seconds an address will be reserved while the server is waiting for a response for an offer.
Type: u32
Default: 10
RebindingTimePercent
(T2) Percent of the lease time at which the client should begin the rebinding process.
Type: double
Default: 87.5
Range: 0.0 - 200.0
RenewalTimePercent
(T1) Percent of the lease time at which the client should begin the renewal process.
Type: double
Default: 50.0
Range: 0.0 - 200.0
588
Dhcpv4ServerDefaultPoolConfig
Writable Attribute
Description

Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
Dhcpv4ServerConfig Read-Only Attributes

Read-Only Attribute
Description
ServerState
Current state of the DHCPv4 server.

Type: enum
Default: NONE
Possible Values:
Value Description
NONE Servers not started.
UP
Servers are up.
Description:
Default server pool.

Parents: EmulatedDevice, ExternalDevice, ExternalDevicePort, Host, IptvChannelBlock, Port, Router, SUT
Automatically created from: Dhcpv4ServerConfig
Relations:
Side name
(Type)
Relative
Description
DstBoundTo
(DstBinding)
PathDescriptor, StreamBlock

StreamBlock.
EncapsulationSource
(Encapsulation)
PathDescriptor
MemberOfVpn
(MemberOfVpn)
VpnIdGroup, VpnSiteInfo6Pe, VpnSiteInfoRfc2547,

VpnSiteInfoVplsBgp, VpnSiteInfoVplsLdp
Port
Traffic sent to this end point is expected to be

received as multicast traffic by any of the ports
connected through this relation.

Dhcpv6ServerDefaultPrefixPoolConfig,
Dhcpv6ServerPrefixPoolConfig, EthIIIf, FcIf, GreIf, HdlcIf, Ipv4If,
Ipv4NetworkBlock, Ipv6If, Ipv6NetworkBlock, ItagIf, L2tpv2If,
MacBlock, MplsIf, Pimv4JoinSrc, Pimv4PruneSrc, Pimv6JoinSrc,
PppoxServerIpv4PeerPool, PppoxServerIpv6PeerPool, VlanBlock,
VlanIf, WimaxIf
Specifies an optionally-selected lower interface in

the stack. Selection is controlled by protocol
implementations which decide based on other
criteria whether they should include the target
SrcBoundTo
(SrcBinding)

StreamBlock.
589
Side name
(Type)
Relative
Description
StackedOn
(StackedOnEndpoint)

VlanIf, WimaxIf
Port

received as unicast traffic by any of the ports
Dhcpv4ServerDefaultPoolConfig Writable Attributes

Writable Attribute
Description
Active, Name
AddrIncrement
Pool address network increment.

Type: u32
Default: 1
DomainName
Domain name (option 15).

Type: string
DomainNameServerList
Domain name servers (option 6).

Type: ip
Default: 0
HostAddrCount
Number of addresses in a pool.

Type: u32
Default: 254
HostAddrStep
Pool host address step.

Type: ip
Default: 0.0.0.1
LimitHostAddrCount
Limit host address count.

Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
Use the host address count to limit pool size.
FALSE Host address count will automatically be calculated.

NetworkCount
Number of pools.
Type: u32
Default: 1
PrefixLength
Pool prefix length.

Type: u8
Default: 24
Range: 0 - 32
RouterList
Router addresses (option 3).

Type: ip
Default: 0
StartIpList
Pool starting IP address.

Type: ip
Default: 192.0.1.0
590
Dhcpv4ServerDeviceGenProtocolParams
Dhcpv4ServerDefaultPoolConfig Read-Only Attributes

Description:
Specifies the DHCP server specific Host generator parameters.

Dhcpv4ServerDeviceGenProtocolParams Writable Attributes

Writable Attribute
Description
Active, Name
Dhcpv4ServerDeviceGenProtocolParams Read-Only Attributes

Dhcpv4ServerMsgOption
Description:
Allows you to specify custom DHCP server options.

Parents: Dhcpv4ServerConfig, Dhcpv4ServerDefaultPoolConfig, Dhcpv4ServerPoolConfig
Dhcpv4ServerMsgOption Writable Attributes

Writable Attribute
Description
Active, Name
EnableWildcards
Expand wildcards in the message option.

Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
Wildcards in the message option will be substituted for values.
FALSE Wildcards in the message option will not be substituted for values.
HexValue
Indicate the string should/should not be treated as hexadecimal.

Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
String is in hexadecimal format.
FALSE String is not in hexadecimal format.
591
Dhcpv4ServerPoolConfig
Writable Attribute
Description
MsgType
Include the message option in OFFER, ACK, or NAK.

Type: enum
Default: OFFER|ACK
Possible Values:
Value Description
OFFER Include the message option in the OFFER message.
ACK
Include the message option in the ACK message.
NAK
Include the message option in the NAK message.
OptionType
Option value.
Type: u8
Default: 0
Range: 0 - 255
Payload
Specifies the ASCII message option. Wildcards can be used.

Type: string
Dhcpv4ServerMsgOption Read-Only Attributes

Description:
DHCP server pool config for relay agent pools.

Parents: Dhcpv4ServerConfig, EmulatedDevice, ExternalDevice, ExternalDevicePort, Host, IptvChannelBlock, Port, Router, SUT
Relations:
Side name
(Type)
Relative
Description
DstBoundTo
(DstBinding)

StreamBlock.
EncapsulationSource
(Encapsulation)
PathDescriptor
MemberOfVpn
(MemberOfVpn)

Port


VlanIf, WimaxIf

SrcBoundTo
(SrcBinding)

StreamBlock.
592
Side name
(Type)
Relative
Description
StackedOn
(StackedOnEndpoint)

VlanIf, WimaxIf
Port

Dhcpv4ServerPoolConfig Writable Attributes

Writable Attribute
Description
Active, Name
AddrIncrement
Pool address network increment.

Type: u32
Default: 1
DomainName
Domain name (option 15).

Type: string
DomainNameServerList
Domain name servers (option 6).

Type: ip
Default: 0
HostAddrCount
Number of addresses in a pool.

Type: u32
Default: 254
HostAddrStep
Pool host address step.

Type: ip
Default: 0.0.0.1
LimitHostAddrCount
Limit host address count.

Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
Use the host address count to limit pool size.
FALSE Host address count will automatically be calculated.

NetworkCount
Pool prefix length.

Type: u32
Default: 1
PrefixLength
Pool prefix length.

Type: u8
Default: 24
Range: 0 - 32
RouterList
Router addresses (option 3).

Type: ip
Default: 0
StartIpList
Pool starting IP address.

Type: ip
Default: 192.0.1.0
593
Dhcpv4ServerResults
Dhcpv4ServerPoolConfig Read-Only Attributes

Dhcpv4ServerResults
Description:
DHCPv4 server results.

Parents: Dhcpv4ServerConfig
Relations:
Side name
(Type)
Relative
Description
ResultParent
(ResultChild)
Dhcpv4ServerConfig
Dhcpv4ServerResults Writable Attributes

Dhcpv4ServerResults Read-Only Attributes

Read-Only Attribute
Description
CurrentBoundCount
Number of sessions that are currently bound.

Type: u32
Default: 0
RxDeclineCount
Number of DHCPDECLINE messages received.

Type: u32
Default: 0
RxDiscoverCount
Number of DHCPDISCOVER messages received.

Type: u32
Default: 0
RxInformCount
Number of DHCPINFORM messages received.

Type: u32
Default: 0
RxReleaseCount
Number of DHCPRELEASE messages received.

Type: u32
Default: 0
RxRequestCount
Number of DHCPREQUEST messages received.

Type: u32
Default: 0
TotalBoundCount
Total number of bound sessions.

Type: u32
Default: 0
TotalExpiredCount
Total number of expired offers or sessions.

Type: u32
Default: 0
TotalReleasedCount
Total number of sessions released by clients.

Type: u32
Default: 0
594
Dhcpv4SessionInfoCommand
Read-Only Attribute
Description
TotalRenewedCount

Type: u32
Default: 0
TxAckCount
Number of ACK messages sent.

Type: u32
Default: 0
TxForceRenewCount
Number of DHCP Force Renews (unicast DHCPREQUEST messages) transmitted.

Type: u32
Default: 0
TxNakCount
Number of NAK messages sent.

Type: u32
Default: 0
TxOfferCount
Number of OFFER messages sent.

Type: u32
Default: 0
Description:
Get DHCPv4 session info.

Dhcpv4SessionInfoCommand Writable Attributes

Writable Attribute
Description
BlockList

Type: handle
Default: 0
FileName
Filename to save DHCPv4 session info results to.

Default: sessions.csv
SaveToFile
Flag to indicate session info results to be saved to file.

Type: bool
Default: TRUE
Possible Values:
Value Description
TRUE
Save DHCPv4 session info results to file.
FALSE Do not save DHCPv4 session info results to file.

TimestampFilename
Flag to indicate if a timestamp should be included as part of the filename.

Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
Include a timestamp as part of the filename.
FALSE Do not include a timestamp as part of the filename.
595
Dhcpv4SessionResults
Dhcpv4SessionInfoCommand Read-Only Attributes

Read-Only Attribute
Description

Description:
DHCPv4 session results.

Dhcpv4SessionResults Writable Attributes

Writable Attribute
Description
Active, Name
Dhcpv4SessionResults Read-Only Attributes

Read-Only Attribute
Description
DiscRespTime
Length of time between a Discover message and receiving a response.

Type: double
Default: 0
ErrorStatus
Displays the cause for the session failing to bind or release.

Type: enum
Default: OK
Possible Values:
Value
Description
OK
No error.
DISCOVER_TIMEOUT DISCOVER timeout.

REQUEST_TIMEOUT REQUEST timeout.
REJECT
Request rejected.
RENEW_TIMEOUT
Renew timeout.
RENEW_REJECT
Renew rejected.
InnerVlanId
Inner VLAN ID for this DHCP session.

Type: u16
Default: 1
Ipv4Addr
IP address for this DHCP session.

Type: ip
Default: 0.0.0.0
LeaseLeft
Lease time left.

Type: double
Default: 0
LeaseRx
Lease time received from DHCP Server.

Type: u32
Default: 0
596
Dhcpv4ShowSessionInfoCommand
Read-Only Attribute
Description
MacAddr
MAC address for this session.

Type: mac
Default: 00-00-00-00-00-00
RequestRespTime
Length of time between a Request message and receiving a response.

Type: double
Default: 0
SessionState
State of the DHCP session.

Type: enum
Default: IDLE
Possible Values:
Value
Description
IDLE
Session is idle.
SELECTING
Session is waiting for offers.
REQUESTING Session is sending request.

BOUND
Session is bound.
RENEWING
Session is renewing.
REBINDING
Session is rebinding.
RELEASING
Session is releasing.
FAILURE
Session has failed to bind. Reason is given in Error Status.
Vci
VCI
Type: u16
Default: 32
VlanId
VLAN ID for this DHCP session.

Type: u16
Default: 1
Vpi
VPI
Type: u16
Default: 0
Description:
Show the DHCPv4 session info (GUI only).

Dhcpv4ShowSessionInfoCommand Writable Attributes

Writable Attribute
Description
BlockList
List of Dhcpv4BlockConfig object handles on which to show session info.

Type: handle
Default: 0
597
Dhcpv4StartServerCommand
Dhcpv4ShowSessionInfoCommand Read-Only Attributes

Read-Only Attribute
Description

Description:
Start DHCPv4 server on the server block.

Dhcpv4StartServerCommand Writable Attributes

Writable Attribute
Description
ServerList
List of server handles to start.

Type: handle
Default: 0
Dhcpv4StartServerCommand Read-Only Attributes

Read-Only Attribute
Description

Dhcpv4StopServerCommand
Description:
Stop DHCPv4 server on the server block.

Dhcpv4StopServerCommand Writable Attributes

Writable Attribute
Description
ServerList
List of server handles to stop.

Type: handle
Default: 0
598
Dhcpv6AbortCommand
Dhcpv4StopServerCommand Read-Only Attributes

Read-Only Attribute
Description

Dhcpv6AbortCommand
Description:
Abort DHCPv6 emulation on specified blocks.

Dhcpv6AbortCommand Writable Attributes

Writable Attribute
Description
BlockList
List of Dhcpv6PdBlockConfig and/or Dhcpv6BlockConfig object handles.

Type: handle
Default: 0
Dhcpv6AbortCommand Read-Only Attributes

Read-Only Attribute
Description

Dhcpv6AbortServerCommand
Description:
Aborts the DHCPv6 servers.

Dhcpv6AbortServerCommand Writable Attributes

Writable Attribute
Description
ServerList
List of DHCPv6 servers to abort.

Type: handle
Default: 0
599
Dhcpv6BaseMsgOption
Dhcpv6AbortServerCommand Read-Only Attributes

Read-Only Attribute
Description

Dhcpv6BaseMsgOption
Description:
DHCPv6 Base Message Option configuration settings.
Dhcpv6BaseMsgOption Writable Attributes

Writable Attribute
Description
Active, Name
Dhcpv6BaseMsgOption Read-Only Attributes

Dhcpv6BindCommand
Description:
Bind DHCPv6 sessions on specified blocks.

Dhcpv6BindCommand Writable Attributes

Writable Attribute
Description
BlockList

Type: handle
Default: 0
Dhcpv6BindCommand Read-Only Attributes

Read-Only Attribute
Description

600
Description:
Wait for the sessions to go into a bound state after a Dhcpv6 Bind command. Command will return when the sessions are bound or the wait time is reached.

Parents: Sequencer
Dhcpv6BindWaitCommand Writable Attributes

Writable Attribute
Description
ErrorOnFailure
ObjectList
List of object handles (that is, Project, Port, or EmulatedDevice) to wait for bound state on.
Type: handle
Default: 0
WaitTime
Maximum amount of time in seconds to wait.

Type: double
Default: 30.0
Range: 0.005 - 2147483647.0
Dhcpv6BindWaitCommand Read-Only Attributes

Read-Only Attribute
Description
Dhcpv6BlockConfig
Description:
DHCPv6 client block configuration settings.

Children: Dhcpv6DelayedAuthKey, Dhcpv6MsgOption
Relations:
Side name
(Type)
Relative
Description
ResultChild
(ResultChild)
Dhcpv6BlockResults
UsesIf
(UsesIf)


Dhcpv6BlockConfig Writable Attributes

Writable Attribute
Description
Active, Name
601
Dhcpv6BlockConfig
Writable Attribute
Description
AuthProtocol
Protocol used to generate the authentication information carried in the option.

Type: enum
Default: DELAYED_AUTH
Possible Values:
Value
Description
DELAYED_AUTH Use the delayed authentication protocol.
RECONFIG_KEY Use the reconfigure key authentication protocol.
DadTimeout
Length of time in seconds that must elapse before the Neighbor Solicit times out.
Type: u32
Default: 1
Range: 1 - 4294967295
DadTransmits
Number of Neighbor Solicit messages to send out per session during duplicate address detection.
Type: u32
Default: 1
Range: 1 - 4294967295
DhcpRealm
DHCP realm that identifies the key used to generate the HMAC-MD5 value when using delayed authentication.
Type: string
Default: spirent.com
DuidEnterprise
Enterprise number to be used in the DUID. This is only applicable when DuidType is set to EN.
Type: u32
Default: 3456
DuidStart
Starting DUID value.

Type: string
Default: 0001
DuidStep
DUID step value.

Type: string
Default: 1
DuidType
DHCPv6 unique identifier type.

Type: enum
Default: LLT
Possible Values:
Value
Description
LLT
Link-layer address plus time.
EN
Vendor-assigned unique ID based on enterprise number.
LL
Link-layer address.
CUSTOM Custom type.

DuidValue
Custom DUID value.

Type: u16
Default: 1
Range: 0 - 65535
EnableAuth
Specifies whether to use the DHCP message authentication option used to reliably identify the source of a DHCP message
and to confirm that the contents of the DHCP message have not been tampered with.
Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
Enables authentication option on DHCP clients.
FALSE Disables authentication option on DHCP clients.
602
Dhcpv6BlockConfig
Writable Attribute
Description
EnableDad
Enable duplicate address detection. Note that the session will not go bound until the duplicate address detection is complete.
If duplicate address detection fails, the address will be declined and the session will go idle.
Type: bool
Default: TRUE
Possible Values:
Value Description
TRUE
Enables duplicate address detection for this session block.
FALSE Disables duplicate address detection for this session block.

EnableRebind
Specifies whether the host sends a REBIND message to the delegating router when the DHCPv6/PD session's T2 time
has expired. The lifetime of the prefixes (DHCPv6-PD) or addresses (DHCPv6 client) continues until the Valid Lifetime
value is reached.
Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
Specifies that the host will send a REBIND message when T2 expires.
FALSE Specifies that the host will not send a REBIND message when T2 expires.
EnableReconfigAccept
Specifies whether the client is willing to accept Reconfigure messages from the server. The default behavior, in the absence
of this option, means unwillingness to accept Reconfigure messages.
Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
Specifies that the client is willing to accept Reconfigure messages from the server.
FALSE Specifies that the client is unwilling to accept Reconfigure messages from the server.
EnableRenew
Specifies whether the host sends a RENEW message to the delegating router when the DHCPv6/PD session's T1 time
has expired. The host enters the Renewing state when the elapsed lease lifetime is between T1 and T2, but the State field
does not change accordingly.
Type: bool
Default: TRUE
Possible Values:
Value Description
TRUE
Specifies that host will send a RENEW message when T1 expires.
FALSE Specifies that host will not send a RENEW message when T1 expires.
PreferredLifetime
Preferred lifetime in seconds for the addresses.

Type: u32
Default: 604800
Range: 0 - 4294967295
RapidCommitMode
Select the rapid commit operation mode (Disable, Enable, Server).

Type: enum
Default: DISABLE
Possible Values:
Value
Description
DISABLE Disable rapid commit mode.
ENABLE Enable rapid commit mode and only honor replies with the Rapid Commit option.
SERVER Enable rapid commit mode and continue binding process whether or not the server responds with a Rapid
Commit option.
RequestedAddrStart
DHCPv6 client requested starting address.

Type: ipv6
Default: ::
T1Timer
Time in seconds at which the client contacts the server from which the addresses were obtained to extend the lifetimes of
the assigned addresses.
Type: u32
Default: 302400
Range: 0 - 2147483647
603
Dhcpv6BlockResults
Writable Attribute
Description
T2Timer
Time in seconds at which the client contacts any available server to extend the lifetimes of the assigned addresses.
Type: u32
Default: 483840
Range: 0 - 2147483647

Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE

ValidLifetime
Valid lifetime in seconds for the addresses.

Type: u32
Default: 2592000
Range: 0 - 4294967295
Dhcpv6BlockConfig Read-Only Attributes

Read-Only
Attribute
Description
BlockState
Aggregate status of all hosts (home gateways) in the block. If all hosts in the block are not in the same state, the aggregate state is determined
based on rules of precedence. There are three stable states: Idle, Bound, or None. All other states are considered transitional. In determining
the aggregate state, any hosts in a transitional state take precedence over those that are already bound.
Type: enum
Default: IDLE
Possible Values:
Value
Description
IDLE
No hosts are currently active (no commands have been issued). No DHCPv6/PD sessions are active. This state is entered
if the hosts were manually released.
REQUEST
At least one session in the block is in the process of being established. At least one host is sending a SOLICIT message
to obtain a DHCPv6/PD lease or a REQUEST message requesting an IPv6 prefix. The remaining hosts may be in either
the Bound or Idle state, but not the Releasing state.
RELEASE
At least one host in the block no longer needs to use the IPv6 prefix leased to it and either is in the process of sending a
RELEASE message to the delegating router or is awaiting a REPLY message from the delegating router in response to
a RELEASE message.
RENEW
At least one host in the block is in the process of renewing the lease by sending a RENEW message. Other hosts can be
in the Bound or Idle state. NOTE: The Renewing state refers only to leases that were manually renewed (using the Renew
DHCPv6/PD Host command). It does not refer to the automatic renewal that occurs when the T1 timer has expired.
REBIND
At least one host in the block is in the process of being rebound. When the prefix's elapsed lease lifetime is between T2
and the end of the lease (valid lifetime), the emulated home gateways are in the process of sending a REBIND message.

GROUPREQ
BOUND
The SOLICIT, ADVERTISE, REQUEST, and REPLY messages between the host and delegating router have resulted in
retrieving an IPv6 prefix for at least one host in the block. No other hosts are requesting or releasing prefixes, but they
may be automatically renewing expired leases.
Dhcpv6BlockResults
Description:
DHCPv6 block results.

Parents: Dhcpv6BlockConfig, Dhcpv6PdBlockConfig
Relations:
604
Dhcpv6BlockResults
Side name
(Type)
Relative
Description
ResultParent
(ResultChild)
Dhcpv6BlockConfig, Dhcpv6PdBlockConfig
Dhcpv6BlockResults Writable Attributes

Dhcpv6BlockResults Read-Only Attributes

Read-Only Attribute
Description
ElapsedTime
AttemptRate

Type: double
Default: 0
AvgRebindReplTime
Average amount of time (in milliseconds) that elapsed between when a REBIND message was sent by a host
and a REPLY message was received from the delegating server.
Type: double
Default: 0
AvgReleaseReplTime
Average amount of time (in milliseconds) that elapsed between when a RELEASE message was sent by a host
Type: double
Default: 0
AvgRenewReplTime
Average amount of time (in milliseconds) that elapsed between when a RENEW message was sent by a host
Type: double
Default: 0
AvgRequestReplTime
Average amount of time (in milliseconds) that elapsed between when a REQUEST message was sent by a
host and a REPLY message was received from the delegating server.
Type: double
Default: 0
AvgSoliAdvTime
Average amount of time (in milliseconds) that elapsed between when a SOLICIT message was sent by a host
and an ADVERTISE message was received from the delegating server.
Type: double
Default: 0
AvgSoliReplTime
Average amount of time (in milliseconds) that elapsed between when a SOLICIT message was sent by a host
Type: double
Default: 0
BindRate

Type: double
Default: 0
CurrentAttemptCount
Number of DHCPv6 sessions currently being attempted.

Type: u32
Default: 0
CurrentBoundCount
Number of DHCPv6 sessions that are currently bound. This statistic should match the DUT's "Leased Count"
statistic.
Type: u32
Default: 0
CurrentIdleCount
Number of DHCPv6 sessions currently in the Idle state (sessions that have been programmed but are not being
attempted).
Type: u32
Default: 0
605
Dhcpv6BlockResults
Read-Only Attribute
Description
MaxRebindReplTime
Maximum amount of time (in milliseconds) that elapsed between when a REBIND message was sent by a host
Type: double
Default: 0
MaxReleaseReplTime
Maximum amount of time (in milliseconds) that elapsed between when a RELEASE message was sent by a
Type: double
Default: 0
MaxRenewReplTime
Maximum amount of time (in milliseconds) that elapsed between when a RENEW message was sent by a host
Type: double
Default: 0
MaxRequestReplTime
Maximum amount of time (in milliseconds) that elapsed between when a REQUEST message was sent by a
Type: double
Default: 0
MaxSoliAdvTime
Maximum amount of time (in milliseconds) that elapsed between when a SOLICIT message was sent by a host
and an ADVERTISE message was received from the delegating server.
Type: double
Default: 0
MaxSoliReplTime
Maximum amount of time (in milliseconds) that elapsed between when a SOLICIT message was sent by a host
Type: double
Default: 0
MinRebindReplTime
Minimum amount of time (in milliseconds) that elapsed between when a REBIND message was sent by a host
Type: double
Default: 0
MinReleaseReplTime
Minimum amount of time (in milliseconds) that elapsed between when a RELEASE message was sent by a
Type: double
Default: 0
MinRenewReplTime
Minimum amount of time (in milliseconds) that elapsed between when a RENEW message was sent by a host
Type: double
Default: 0
MinRequestReplTime
Minimum amount of time (in milliseconds) that elapsed between when a REQUEST message was sent by a
Type: double
Default: 0
MinSoliAdvTime
Minimum time in milliseconds between the solicit and advertise.

Type: double
Default: 0
MinSoliReplTime
Minimum amount of time (in milliseconds) that elapsed between when a SOLICIT message was sent by a host
Type: double
Default: 0
PrefixCount
Number of prefixes allocated to the block.

Type: u32
Default: 0
RebindRate
Rebind rate in sessions per second.

Type: double
Default: 0
606
Dhcpv6BlockResults
Read-Only Attribute
Description
ReleaseRate
Release rate in sessions per second.

Type: double
Default: 0
RenewRate
Renew rate in sessions per second.

Type: double
Default: 0
RxAdvertiseCount
Number of ADVERTISE messages received.

Type: u32
Default: 0
RxReconfigureCount
Number of RECONFIGURE messages received.

Type: u32
Default: 0
RxReplyCount
Number of REPLY messages received.

Type: u32
Default: 0
TotalAttemptCount
Total number of sessions attempted.

Type: u32
Default: 0
TotalBoundCount
Total number of sessions bound.

Type: u32
Default: 0
TotalDeclinedCount
Total number of session declined.

Type: u32
Default: 0
TotalFailedCount
Number of hosts in the block that failed to bind. Failures may be due to DUT overload, a T1 or T2 timer expiration,
or reaching the number of retries for the session. Non-zero values are displayed in red.
Type: u32
Default: 0
TotalReboundCount
Total number of sessions rebound.

Type: u32
Default: 0
TotalReleasedCount
Total number of sessions released.

Type: u32
Default: 0
TotalReleaseRetriedCount
Number of RELEASE messages resent when no REPLY message was received by the associated timeout.
Type: u32
Default: 0
TotalRenewedCount
Total number of sessions renewed.

Type: u32
Default: 0
TotalRenewRetriedCount
Total number of RENEW messages resent.

Type: u32
Default: 0
TotalRetriedCount
Number of SOLICIT and REQUEST messages resent for all hosts in the block.
Type: u32
Default: 0
TxConfirmCount
Number of CONFIRM messages sent.

Type: u32
Default: 0
607
Dhcpv6ConfirmCommand
Read-Only Attribute
Description
TxDeclineCount
Number of DECLINE messages sent.

Type: u32
Default: 0
TxInfoRequestCount
Number of INFO-REQUEST messages sent.

Type: u32
Default: 0
TxRebindCount
Number of REBIND messages sent.

Type: u32
Default: 0
TxReleaseCount
Number of RELEASE messages sent.

Type: u32
Default: 0
TxRenewCount
Number of RENEW messages sent.

Type: u32
Default: 0
TxRequestCount
Number of REQUEST messages sent.

Type: u32
Default: 0
TxSolicitCount
Number of SOLICIT messages sent.

Type: u32
Default: 0
Dhcpv6ConfirmCommand
Description:
Confirm whether the addresses are still appropriate to the link to which the client is connected.

Dhcpv6ConfirmCommand Writable Attributes

Writable Attribute
Description
BlockList

Type: handle
Default: 0
Dhcpv6ConfirmCommand Read-Only Attributes

Read-Only Attribute
Description

608
Dhcpv6CopyAuthKeyListCommand
Dhcpv6CopyAuthKeyListCommand
Description:

Dhcpv6CopyAuthKeyListCommand Writable Attributes

Writable Attribute
Description
SrcDevice
Specifies the source device the keys will be copied from.

Type: handle
Default: 0
SrcDhcpv6EmulationMode
Specifies the emulation mode of the source device. Options are CLIENT and SERVER.
Type: enum
Default: CLIENT
Possible Values:
Value
Description
CLIENT
Source device is running the DHCPv6 client emulation.
SERVER Source device is running the DHCPv6 server emulation.

TargetDeviceList
Specifies a list of target devices the keys will be copied to.

Type: handle
Default: 0
TargetDhcpv6EmulationMode
Specifies the emulation mode of the target device. Options are CLIENT and SERVER.
Type: enum
Default: CLIENT
Possible Values:
Value
Description
CLIENT
Target device is running the DHCPv6 client emulation.
SERVER Target device is running the DHCPv6 server emulation.
Dhcpv6CopyAuthKeyListCommand Read-Only Attributes

Read-Only Attribute
Description

Dhcpv6DelayedAuthKey
Description:
DHCPv6 Delayed Authentication Key configuration.

Parents: Dhcpv6BlockConfig, Dhcpv6PdBlockConfig, Dhcpv6ServerConfig
609
Dhcpv6DelayedAuthKey Writable Attributes

Writable Attribute
Description
Active, Name
KeyId
Key identifier that identified the key used to generate the HMAC-MD5 value.
Type: u32
Default: 1
Range: 0 - 4294967295
KeyValue
Key used to generate the HMAC-MD5 value.

Type: string
Default: spirent123
KeyValueType
Type of the key.

Type: enum
Default: ASCII
Possible Values:
Value Description
ASCII Specifies that the key is specified in ASCII format.
HEX
Specifies that the key is specified in HEX format.
Dhcpv6DelayedAuthKey Read-Only Attributes

Description:
DHCP-PD specific Host generator parameters.

Dhcpv6DeviceGenProtocolParams Writable Attributes

Writable Attribute
Description
Active, Name
ClientMacAddrMask
DHCPv6 client MAC address mask.

Type: mac
ClientMacAddrStart
DHCPv6 client starting MAC address.

Type: mac
Default: 00-10-01-00-00-01
ClientMacAddrStep
DHCPv6 client MAC address step.

Type: mac
Default: 00-00-00-00-00-01
ClientsPerHomeGateway
Number of clients per home gateway.

Type: u32
Default: 1
Range: 1 - 65536
610
Writable Attribute
Description
ControlPlanePrefix
Control plane source for the IPv6 address prefix.

Type: enum
Default: LINKLOCAL
Possible Values:
Value
Description
LINKLOCAL
Use the Link-Local address.
ROUTERADVERTISEMENT Use the router advertisement.

DuidEnterprise
Type: u32
Default: 3456
DuidStart

Type: string
Default: 0001
DuidStep
DUID step value.

Type: string
Default: 1
DuidType

Type: enum
Default: LLT
Possible Values:
Value
Description
LLT
EN
LL
Link-layer address.
CUSTOM Custom type.

DuidValue
Custom DUID value.

Type: u16
Default: 1
Range: 0 - 65535
EnableRebind
Enable or disable rebind messages.

Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
Enable rebind messages.
FALSE Disable rebind messages.

EnableRenew
Enable or disable renew messages.

Type: bool
Default: TRUE
Possible Values:
Value Description
TRUE
Enable renew messages.
FALSE Disable renew messages.

ExportAddrToLinkedClients
Enables exporting resolved addresses to linked client blocks (through a home gateway Link).
Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
Enable exporting resolved addresses to linked client blocks.
FALSE Disable exporting resolved addresses to linked client blocks.
611
Dhcpv6InfoRequestCommand
Writable Attribute
Description
Mode
Specifies whether the device is emulating a DHCPv6-PD client or full DHCPv6 client.
Type: enum
Default: PD
Possible Values:
Value
Description
PD
Specifies that the device is emulating a DHCPv6-PD client.
CLIENT Specifies that the device is emulating a full DHCPv6 client.

PreferredLifetime

Type: u32
Default: 604800
Range: 0 - 4294967295
PrefixLength
DHCPv6 client requested prefix length.

Type: u8
Default: 0
Range: 0 - 64
PrefixStart
DHCPv6 client requested prefix starting address.

Type: ipv6
Default: ::
PrefixStep
DHCPv6 client requested prefix step.

Type: ipv6
Default: ::
RapidCommitMode

Type: enum
Default: DISABLE
Possible Values:
Value
Description
DISABLE Disables rapid commit mode.
SERVER Enable rapid commit mode and continue binding process whether or not the server responds with a
Rapid Commit option.
T1Timer
Time in seconds at which the client contacts the server from which the addresses were obtained to extend the
lifetimes of the assigned addresses.
Type: u32
Default: 302400
Range: 0 - 2147483647
T2Timer
Type: u32
Default: 483840
Range: 0 - 2147483647
ValidLifetime

Type: u32
Default: 2592000
Range: 0 - 4294967295
Dhcpv6DeviceGenProtocolParams Read-Only Attributes

Dhcpv6InfoRequestCommand
Description:
Sends an Information-request message to a server to request configuration parameters without the assignment of any IP addresses to the client.
612
Dhcpv6MsgOption

Dhcpv6InfoRequestCommand Writable Attributes

Writable Attribute
Description
BlockList

Type: handle
Default: 0
Dhcpv6InfoRequestCommand Read-Only Attributes

Read-Only Attribute
Description

Dhcpv6MsgOption
Description:
DHCPv6 Message Option configuration settings.

Dhcpv6MsgOption Writable Attributes

Writable Attribute
Description
Active, Name
EnableWildcards
Enable or disable wildcard expansion.

Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
Enable wildcard expansion.
FALSE Disable wildcard expansion.

HexValue
Enable or disable value as hexadecimal.

Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
Interpret value as hexadecimal.
FALSE Interpret value as a string.
613
Dhcpv6Options
Writable Attribute
Description
MsgType
use it.
Include option in message (SOLICIT, REQUEST, BOTH).
Type: enum
Default: BOTH
Possible Values:
Value
Description
SOLICIT
Include option in SOLICIT message.
REQUEST Include option in REQUEST message.

BOTH
Include option in both SOLICIT and REQUEST messages.
MsgTypeList
Specifies a combination of messages to include the option in.

Type: u8
Default: 1
OptionType
Option value.
Type: u16
Default: 0
Range: 0 - 255
Payload
Option payload string.

Type: string
Remove
Enable or disable removal of option.

Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
Enable remove option.
FALSE Disable remove option.
Dhcpv6MsgOption Read-Only Attributes

Dhcpv6Options
Description:
Project-wide DHCPv6 settings.

Dhcpv6Options Writable Attributes

Writable Attribute
Description
Active, Name
TrafficBehavior

Type: enum
Default: REQUIRE_ALL_SESSIONS_BOUND
Possible Values:
Value
Description
REQUIRE_ALL_SESSIONS_BOUND Start traffic only if all sessions are bound.
614
Start traffic while ignoring sessions that failed to bind.
Dhcpv6PdBlockConfig
Dhcpv6Options Read-Only Attributes

Dhcpv6PdBlockConfig
Description:
DHCPv6 PD block configuration settings.

Children: Dhcpv6DelayedAuthKey, Dhcpv6MsgOption
Relations:
Side name
(Type)
Relative
Description
ResultChild
(ResultChild)
Dhcpv6BlockResults
UsesIf
(UsesIf)


Dhcpv6PdBlockConfig Writable Attributes

Writable Attribute
Description
Active, Name
ClientMacAddrMask
DHCPv6 client MAC address mask.

Type: mac
ClientMacAddrStart
DHCPv6 client starting MAC address.

Type: mac
Default: 00-10-01-00-00-01
ClientMacAddrStep
DHCPv6 client MAC address step.

Type: mac
Default: 00-00-00-00-00-01
ControlPlanePrefix
Control plane source for the IPv6 address prefix.

Type: enum
Default: LINKLOCAL
Possible Values:
Value
Description
LINKLOCAL
Use the Link-Local address.
ROUTERADVERTISEMENT Use the router advertisement.

DuidEnterprise
Type: u32
Default: 3456
DuidStart

Type: string
Default: 0001
615
Dhcpv6PdBlockConfig
Writable Attribute
Description
DuidStep
DUID step value.

Type: string
Default: 1
DuidType

Type: enum
Default: LLT
Possible Values:
Value
Description
LLT
EN
LL
Link-layer address.
CUSTOM Custom type.

DuidValue
Custom DUID value.

Type: u16
Default: 1
Range: 0 - 65535
EnableRebind
Enable or disable rebind messages.

Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
Enable rebind messages.
FALSE Disable rebind messages.

EnableReconfigAccept
Specifies whether the client is willing to accept Reconfigure messages from the server. The default behavior, in the
absence of this option, means unwillingness to accept Reconfigure messages.
Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
Specifies that the client is willing to accept Reconfigure messages from the server.
FALSE Specifies that the client is unwilling to accept Reconfigure messages from the server.
EnableRenew
Enable or disable renew messages.

Type: bool
Default: TRUE
Possible Values:
Value Description
TRUE
Enable renew messages.
FALSE Disable renew messages.

PreferredLifetime

Type: u32
Default: 604800
Range: 0 - 4294967295
PrefixLength
DHCPv6 client requested prefix length.

Type: u8
Default: 0
Range: 0 - 64
PrefixStart
DHCPv6 client requested prefix starting address.

Type: ipv6
Default: ::
616
Dhcpv6PortConfig
Writable Attribute
Description
RapidCommitMode

Type: enum
Default: DISABLE
Possible Values:
Value
Description
DISABLE Disable rapid commit mode.
SERVER Enable rapid commit mode and continue binding process whether or not the server responds with a
Rapid Commit option.
T1Timer
Time in seconds at which the client contacts the server from which the addresses were obtained to extend the
lifetimes of the assigned addresses.
Type: u32
Default: 302400
Range: 0 - 2147483647
T2Timer
Type: u32
Default: 483840
Range: 0 - 2147483647

Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE

ValidLifetime

Type: u32
Default: 2592000
Range: 0 - 4294967295
Dhcpv6PdBlockConfig Read-Only Attributes

Read-Only Attribute
Description
BlockState
Current state of the DHCPv6 session block.

Type: enum
Default: IDLE
Possible Values:
Value
Description
IDLE
All sessions are idle.
REQUEST
At least one session is binding.
RELEASE
At least one session is releasing.
RENEW
At least one session is renewing.
REBIND
At least one session is rebinding.

GROUPREQ
BOUND
All sessions done binding.
Dhcpv6PortConfig
Description:
DHCPv6 port-level configuration settings.
617
Dhcpv6PortConfig

Result children (automatically created): Dhcpv6PortResults
Relations:
Side name
(Type)
Relative
Description
ResultChild
(ResultChild)
Dhcpv6PortResults
Dhcpv6PortConfig Writable Attributes

Writable Attribute
Description
Active, Name
ConfirmTimeout
Initial retransmission time of confirm messages.

Type: u32
Default: 1
Range: 1 - 99999
DeclineRetryCount
Number of decline retries.

Type: u16
Default: 5
Range: 1 - 32
DeclineTimeout
Decline message initial timeout in seconds.

Type: u32
Default: 1
Range: 1 - 99999
IndefReleaseRetry
Flag indicating release be retried indefinitely.

Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
Enable indefinite retry of release.
FALSE Disable indefinite retry of release.

IndefRequestRetry
Flag indicating requests will retried indefinitely.

Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
Enable indefinite retry of requests.
FALSE Disable indefinite retry of requests.

IndefSolicitRetry
Flag indicating solicits will be retried indefinitely.

Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
Enable indefinite retry of solicits.
FALSE Disable indefinite retry of solicits.

InfoRequestTimeout
Initial retransmission time of info-request messages.

Type: u32
Default: 1
Range: 1 - 99999
LeaseTime
Suggested lease time in seconds at the DHCPv6 port level.

Type: u32
Default: 86400
Range: 10 - 4294967295
618
Dhcpv6PortConfig
Writable Attribute
Description
MaxConfirmDuration
Specifies an upper bound on the length of time a client may retransmit the confirm message. The message
exchange fails once the duration is exceeded.
Type: u32
Default: 10
Range: 1 - 99999
MaxConfirmTimeout
Specifies an upper bound on the value of retransmission time of confirm messages.

Type: u32
Default: 4
Range: 1 - 99999
MaxInfoRequestTimeout
Specifies an upper bound on the value of retransmission time of info-request messages.

Type: u32
Default: 120
Range: 1 - 99999
MaxRebindRetryTimeout
Maximum rebind message retry timeout in seconds.

Type: u32
Default: 600
Range: 1 - 99999
MaxRenewRetryTimeout
Maximum renew message retry timeout in seconds.

Type: u32
Default: 600
Range: 1 - 99999
MaxRequestRetryTimeout
Maximum request message retry timeout in seconds.

Type: u32
Default: 30
Range: 1 - 99999
MaxSolicitRetryTimeout
Maximum solicit message retry timeout in seconds.

Type: u32
Default: 120
Range: 1 - 99999
OutstandingSessionCount
Number of DHCPv6 sessions to resolve at a time.

Type: u32
Default: 1000
Range: 1 - 2048
RebindTimeout
Rebind message initial timeout in seconds.

Type: u32
Default: 10
Range: 1 - 99999
ReleaseRate
Number of DHCPv6 sessions that are released per second. This value applies to all sessions on the port. Use
the Release operation to release DHCPv6 sessions.
Type: double
Default: 100.0
Range: 1.0 - 1000.0
ReleaseRetryCount
Number of release retries.

Type: u8
Default: 5
Range: 1 - 32
ReleaseTimeout
Release message initial timeout in seconds.

Type: u32
Default: 1
Range: 1 - 99999
RenewRate
Renewals per second for DHCPv6 client renewals. This value applies to all sessions on the port.
Type: double
Default: 100.0
Range: 1.0 - 1000.0
619
Dhcpv6PortConfig
Writable Attribute
Description
RenewTimeout
Renew message initial timeout in seconds.

Type: u32
Default: 10
Range: 1 - 99999
RequestRate
Requests per second for DHCPv6 client leases. This value applies to all sessions on the port.
Type: double
Default: 100.0
Range: 1.0 - 1000.0
RequestRetryCount
Number of request retries.

Type: u8
Default: 10
Range: 1 - 32
RequestTimeout
Request message initial timeout in seconds.

Type: u32
Default: 1
Range: 1 - 99999
SeqType
The port-level sequence type that determines in what order sessions are attempted.
Type: enum
Default: SEQUENTIAL
Possible Values:
Value
Description
PARALLEL
SolicitRetryCount
Number of solicit retries.

Type: u8
Default: 10
Range: 1 - 32
SolicitTimeout
Solicit message initial timeout in seconds.

Type: u32
Default: 1
Range: 1 - 99999
Dhcpv6PortConfig Read-Only Attributes

Read-Only
Attribute
Description
PortState
Aggregate status of all hosts (home gateways) on the DHCPv6/PD port. If all hosts on the port are not in the same state, the aggregate
state is determined based on rules of precedence. There are three stable states: Idle, Bound, or None. All other states are considered
transitional. In determining the aggregate state, any hosts on a port that are in a transitional state take precedence over those that are
already bound.
Type: enum
Default: IDLE
Possible Values:
Value
Description
IDLE
No host blocks are currently active (no commands have been issued). No DHCPv6/PD sessions are active.
This state is entered if all hosts were manually released.
ESTABLISH
At least one session on the port is in the process of being established. At least one host is sending a REQUEST
message requesting an IPv6 prefix. The remaining hosts may be in either the Bound or Idle state, but not the
Releasing state.
RELEASE
At least one host on the port no longer needs to use the IPv6 prefix leased to it and is in the process of sending
a RELEASE message to the delegating router or is awaiting a REPLY message from the delegating router in
response to a RELEASE message.
ESTABLISH_RELEASE If there is more than one host on the port, at least one host is requesting a prefix and at least one is releasing
a prefix.
BOUND
The SOLICIT, ADVERTISE, REQUEST, and REPLY messages between the host and delegating router have
resulted in retrieving an IPv6 prefix for at least one host on the port. No other hosts are requesting or releasing
prefixes, but they may be automatically renewing expired leases.
620
Dhcpv6PortResults
Dhcpv6PortResults
Description:
DHCPv6 port results.

Parents: Dhcpv6PortConfig
Relations:
Side name
(Type)
Relative
Description
ResultParent
(ResultChild)
Dhcpv6PortConfig
Dhcpv6PortResults Writable Attributes

Dhcpv6PortResults Read-Only Attributes

Read-Only Attribute
Description
AttemptRate

Type: double
Default: 0
AvgSetupTime
Average setup time that was required to bind a session (in milliseconds).
Type: double
Default: 0
BindRate

Type: double
Default: 0
CurrentAttemptCount
Number of sessions currently being attempted.

Type: u32
Default: 0
CurrentBoundCount
Number of sessions that are currently bound. This statistic should match the DUT's Leased Count
statistic.
Type: u32
Default: 0
CurrentIdleCount
Number of sessions currently in the idle state.

Type: u32
Default: 0
MaxSetupTime
Maximum setup time that was required to bind a session (in milliseconds).
Type: double
Default: 0
MinSetupTime
Minimum setup time that was required to bind a session (in milliseconds).
Type: double
Default: 0
ReleaseRate
Rate at which all sessions on the ports were released by initiating RELEASE messages.
Type: double
Default: 0
RxAdvertiseCount
Number of ADVERTISE messages received.

Type: u32
Default: 0
RxReconfigureCount
Number of RECONFIGURE messages received.

Type: u32
Default: 0
621
Dhcpv6PortResults
Read-Only Attribute
Description
RxReplyCount
Number of REPLY messages received.

Type: u32
Default: 0
SuccessPercent
Percentage of sessions that have successfully bound.

Type: double
Default: 0
TotalAttemptCount
Total number of sessions that were attempted.

Type: u32
Default: 0
TotalBoundCount
Total number of bound sessions.

Type: u32
Default: 0
TotalDeclinedCount
Total number of declined sessions.

Type: u32
Default: 0
TotalFailedCount
Number of hosts on the port that failed to bind.

Type: u32
Default: 0
TotalReboundCount
Total number of sessions that were rebound.

Type: u32
Default: 0
TotalReleasedCount
Total number of released sessions.

Type: u32
Default: 0
TotalReleaseRetriedCount
Total number of RENEW messages resent.

Type: u32
Default: 0
TotalRenewedCount

Type: u32
Default: 0
TotalRenewRetriedCount
Number of RELEASE messages resent when no REPLY message was received by the associated
timeout.
Type: u32
Default: 0
TotalRetriedCount
Number of SOLICIT and REQUEST messages resent for all hosts on the port.
Type: u32
Default: 0
TxConfirmCount
Number of CONFIRM messages sent.

Type: u32
Default: 0
TxDeclineCount
Number of DECLINE messages sent.

Type: u32
Default: 0
TxInfoRequestCount
Number of INFO-REQUEST messages sent.

Type: u32
Default: 0
TxRebindCount
Number of REBIND messages sent.

Type: u32
Default: 0
622
Dhcpv6RebindCommand
Read-Only Attribute
Description
TxReleaseCount
Number of RELEASE messages sent.

Type: u32
Default: 0
TxRenewCount
Number of RENEW messages sent.

Type: u32
Default: 0
TxRequestCount
Number of REQUEST messages sent.

Type: u32
Default: 0
TxSolicitCount
Number of SOLICIT messages sent.

Type: u32
Default: 0
Dhcpv6RebindCommand
Description:
Rebind DHCPv6 sessions.

Dhcpv6RebindCommand Writable Attributes

Writable Attribute
Description
BlockList

Type: handle
Default: 0
Dhcpv6RebindCommand Read-Only Attributes

Read-Only Attribute
Description

Description:
Release all DHCPv6 clients on specified blocks.

623
Dhcpv6ReleaseCommand Writable Attributes

Writable Attribute
Description
BlockList

Type: handle
Default: 0
Dhcpv6ReleaseCommand Read-Only Attributes

Read-Only Attribute
Description

Description:
Wait for sessions to go into idle state after a Dhcpv6 release command. Command will return when the sessions are idle or the wait time is reached.

Parents: Sequencer
Dhcpv6ReleaseWaitCommand Writable Attributes

Writable Attribute
Description
ErrorOnFailure
ObjectList
List of object handles (that is, Project, Port, or EmulatedDevice) to wait for idle state on.
Type: handle
Default: 0
WaitTime
Maximum amount of time in seconds to wait.

Type: double
Default: 30.0
Range: 0.005 - 2147483647.0
Dhcpv6ReleaseWaitCommand Read-Only Attributes

Read-Only Attribute
Description
Dhcpv6RenewCommand
Description:
Renew network configuration parameters with the DHCPv6 server (particularly network IP address).
624
Dhcpv6ServerAddrPoolConfig

Dhcpv6RenewCommand Writable Attributes

Writable Attribute
Description
BlockList

Type: handle
Default: 0
Dhcpv6RenewCommand Read-Only Attributes

Read-Only Attribute
Description

Dhcpv6ServerAddrPoolConfig
Description:

Relations:
Side name
(Type)
Relative
Description
DstBoundTo
(DstBinding)

StreamBlock.
EncapsulationSource
(Encapsulation)
PathDescriptor
MemberOfVpn
(MemberOfVpn)

Port


VlanIf, WimaxIf

SrcBoundTo
(SrcBinding)

StreamBlock.
625
Dhcpv6ServerConfig
Side name
(Type)
Relative
Description
StackedOn
(StackedOnEndpoint)

VlanIf, WimaxIf
Port

Dhcpv6ServerAddrPoolConfig Writable Attributes

Writable Attribute
Description
Active, Name
AddrIncrement
Type: u32
Default: 1
HostAddrStep
Type: ipv6
Default: ::1
NetworkCount
Type: u32
Default: 1
PrefixLength
Type: u8
Default: 64
Range: 0 - 128
StartIpList
Type: ipv6
Default: 2000::1
Dhcpv6ServerAddrPoolConfig Read-Only Attributes

Dhcpv6ServerConfig
Description:
DHCPv6 server configuration settings.

Parents: Dhcpv6ServerAddrPoolConfig, Dhcpv6ServerDefaultAddrPoolConfig, Dhcpv6ServerPrefixPoolConfig, EmulatedDevice
Children: Dhcpv6DelayedAuthKey, Dhcpv6ServerMsgOption
Automatically created from: Dhcpv6ServerDefaultPrefixPoolConfig
Result children (automatically created): Dhcpv6ServerResults
Relations:
Side name
(Type)
Relative
Description
ResultChild
(ResultChild)
Dhcpv6ServerResults
626
Dhcpv6ServerConfig
Side name
(Type)
Relative
Description
UsesIf
(UsesIf)


Dhcpv6ServerConfig Writable Attributes

Writable Attribute
Description
Active, Name
DhcpRealm
DHCP realm that identifies the key used to generate the HMAC-MD5 value when using delayed authentication.
Type: string
Default: spirent.com
EmulationMode
Server emulation mode.

Type: enum
Default: DHCPV6_PD
Possible Values:
Value
Description
DHCPV6
Server will emulate a full DHCPv6 server.
DHCPV6_PD Server will emulate only a DHCP-PD server.

EnableDelayedAuth
Enable delayed authentication.

Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
Enables delayed authentication.
FALSE Disables delayed authentication.

EnableReconfigureKey
Enable reconfigure key authentication.

Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
Enables reconfigure key authentication.
FALSE Disables reconfigure key authentication.

PreferredLifetime

Type: u32
Default: 604800
Rebinding lease time (T2) as a percentage of Lease Time.

Type: double
Default: 80.0
Range: 0.0 - 200.0
ReconfigureKey
Key used for reconfigure key authentication.

Type: string
Default: spirentcom123456
ReconfigureKeyValueType
Reconfigure key value type.

Type: enum
Default: ASCII
Possible Values:
Value Description
ASCII Reconfigure key value is specified in ASCII.
HEX
Reconfigure key value is specified in hexadecimal.
627
Dhcpv6ServerDefaultAddrPoolConfig
Writable Attribute
Description
RenewalTimePercent
Renewal lease time (T1) as a percentage of Lease Time.

Type: double
Default: 50.0
Range: 0.0 - 200.0
Flag indicating partial block state to be used.

Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE

ValidLifetime

Type: u32
Default: 2592000
Dhcpv6ServerConfig Read-Only Attributes

Read-Only Attribute
Description
ServerState
State of the server.

Type: enum
Default: NONE
Possible Values:
Value Description
NONE Server has no state.
UP
Server is up.
Dhcpv6ServerDefaultAddrPoolConfig
Description:
DHCPv6 server default address pool configuration.

Relations:
Side name
(Type)
Relative
Description
DstBoundTo
(DstBinding)

StreamBlock.
EncapsulationSource
(Encapsulation)
PathDescriptor
MemberOfVpn
(MemberOfVpn)

Port

628
Dhcpv6ServerDefaultPrefixPoolConfig
Side name
(Type)
Relative
Description

VlanIf, WimaxIf

SrcBoundTo
(SrcBinding)

StreamBlock.
StackedOn
(StackedOnEndpoint)

VlanIf, WimaxIf
Port

Dhcpv6ServerDefaultAddrPoolConfig Writable Attributes

Writable Attribute
Description
Active, Name
AddrIncrement
Address pool step per server.

Type: u32
Default: 1
HostAddrStep
Pool's host address step.

Type: ipv6
Default: ::1
NetworkCount
Number of addresses in the pool.

Type: u32
Default: 1
PrefixLength
Address prefix length.

Type: u8
Default: 64
Range: 0 - 128
StartIpList
Pool's starting address.

Type: ipv6
Default: 2000::1
Dhcpv6ServerDefaultAddrPoolConfig Read-Only Attributes

Description:
DHCPv6 server default prefix pool configuration.
629

Automatically created from: Dhcpv6ServerConfig
Relations:
Side name
(Type)
Relative
Description
DstBoundTo
(DstBinding)

StreamBlock.
EncapsulationSource
(Encapsulation)
PathDescriptor
MemberOfVpn
(MemberOfVpn)

Port


VlanIf, WimaxIf

SrcBoundTo
(SrcBinding)

StreamBlock.
StackedOn
(StackedOnEndpoint)

VlanIf, WimaxIf
Port

Dhcpv6ServerDefaultPrefixPoolConfig Writable Attributes

Writable Attribute
Description
Active, Name
AddrIncrement
Increment value for the next client IP address in a server.

Type: u32
Default: 1
NetworkCount
Number of prefix pools per server.

Type: u32
Default: 1
PrefixLength
Client prefix length.

Type: u8
Default: 64
Range: 0 - 128
ServerPrefixStep
Increment value for the next client address in the pool.

Type: ipv6
Default: 0:0:0:1::
630
Writable Attribute
Description
StartIpList
Starting network address assigned to clients.

Type: ipv6
Default: 2000::1
Dhcpv6ServerDefaultPrefixPoolConfig Read-Only Attributes

Description:
DHCPv6 server configuration settings for the wizard.

Dhcpv6ServerDeviceGenProtocolParams Writable Attributes

Writable Attribute
Description
Active, Name
AddrPoolCount
Number of addresses in the address pool.

Type: u32
Default: 200
Range: 1 - 32768
AddrPoolHostStep
Address pool host step.

Type: ipv6
Default: ::1
AddrPoolLength
Address pool prefix length.

Type: u8
Default: 64
Range: 1 - 128
AddrPoolStart
Address pool starting address.

Type: ipv6
Default: 2000::1
AddrPoolStep
Address pool step per server.

Type: ipv6
Default: ::
EmulationMode
DHCPv6 server's emulation mode.

Type: enum
Default: DHCPV6_PD
Possible Values:
Value
Description
DHCPV6
Server will emulate a full DHCPv6 server.
DHCPV6_PD Server will emulate only a DHCP-PD server.

PreferredLifetime

Type: u32
Default: 604800
631
Writable Attribute
Description
PrefixPoolCount
Number of prefixes in the prefix pool.

Type: u32
Default: 200
Range: 1 - 32768
PrefixPoolLength
Prefix pool length.

Type: u8
Default: 64
Range: 1 - 128
PrefixPoolStart
Prefix pool starting address.

Type: ipv6
Default: 2000::1
PrefixPoolStep
Prefix pool step.

Type: ipv6
Default: ::
Rebinding lease time (T2) as a percentage of Lease Time.

Type: double
Default: 80.0
Range: 0.0 - 200.0
RenewalTimePercent
Renewal lease time (T1) as a percentage of Lease Time.

Type: double
Default: 50.0
Range: 0.0 - 200.0
ValidLifetime

Type: u32
Default: 2592000
Dhcpv6ServerDeviceGenProtocolParams Read-Only Attributes

Description:
DHCPv6 Server message option config.

Parents: Dhcpv6ServerAddrPoolConfig, Dhcpv6ServerConfig, Dhcpv6ServerDefaultAddrPoolConfig, Dhcpv6ServerDefaultPrefixPoolConfig,
Dhcpv6ServerPrefixPoolConfig
Dhcpv6ServerMsgOption Writable Attributes

Writable Attribute
Description
Active, Name
EnableWildcards
Enable or disable wildcard expansion.

Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
Enable wildcard expansion.
FALSE Disable wildcard expansion.
632
Writable Attribute
Description
HexValue
Enable or disable value as hexadecimal.

Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
Interpret value as hexadecimal.
FALSE Interpret value as a string.

MsgType
Include option in message (ADVERTISE, REPLY, RECONFIGURE, RELAY_REPLY).

Type: enum
Default: ADVERTISE|REPLY
Possible Values:
Value
Description
ADVERTISE
Include option in the ADVERTISE message.
REPLY
Include option in the REPLY message.
RECONFIGURE Include option in the RECONFIGURE message.

RELAY_REPL
Include option in the RELAY_REPLY message.
OptionType
Option value.
Type: u16
Default: 0
Range: 0 - 255
Payload
Option payload string.

Type: string
Dhcpv6ServerMsgOption Read-Only Attributes

Description:
DHCPv6 server prefix pool configuration.

Relations:
Side name
(Type)
Relative
Description
DstBoundTo
(DstBinding)

StreamBlock.
EncapsulationSource
(Encapsulation)
PathDescriptor
MemberOfVpn
(MemberOfVpn)

Port

633
Dhcpv6ServerReconfigureRebindCommand
Side name
(Type)
Relative
Description

VlanIf, WimaxIf

SrcBoundTo
(SrcBinding)

StreamBlock.
StackedOn
(StackedOnEndpoint)

VlanIf, WimaxIf
Port

Dhcpv6ServerPrefixPoolConfig Writable Attributes

Writable Attribute
Description
Active, Name
AddrIncrement
Increment value for the next client IP address in a server.

Type: u32
Default: 1
NetworkCount
Number of prefix pools per server.

Type: u32
Default: 1
PrefixLength
Client prefix length.

Type: u8
Default: 64
Range: 0 - 128
ServerPrefixStep
Increment value for the next client address in the pool.

Type: ipv6
Default: 0:0:0:1::
StartIpList
Starting network address assigned to clients.

Type: ipv6
Default: 2000::1
Dhcpv6ServerPrefixPoolConfig Read-Only Attributes

Dhcpv6ServerReconfigureRebindCommand
Description:
Send a reconfigure rebind packet to the clients bound by the server.
634
Dhcpv6ServerReconfigureRenewCommand

Dhcpv6ServerReconfigureRebindCommand Writable Attributes

Writable Attribute
Description
ServerList
List of DHCPv6 servers to send reconfigure rebind packets from.

Type: handle
Default: 0
Dhcpv6ServerReconfigureRebindCommand Read-Only Attributes

Read-Only Attribute
Description

Dhcpv6ServerReconfigureRenewCommand
Description:
Send a reconfigure renew packet to the clients bound by the server.

Dhcpv6ServerReconfigureRenewCommand Writable Attributes

Writable Attribute
Description
ServerList
List of DHCPv6 servers to send reconfigure renew packets from.

Type: handle
Default: 0
Dhcpv6ServerReconfigureRenewCommand Read-Only Attributes

Read-Only Attribute
Description

Dhcpv6ServerResults
Description:
DHCPv6 server block results.

635
Dhcpv6ServerResults
Parents: Dhcpv6ServerConfig
Relations:
Side name
(Type)
Relative
Description
ResultParent
(ResultChild)
Dhcpv6ServerConfig
Dhcpv6ServerResults Writable Attributes

Dhcpv6ServerResults Read-Only Attributes

Read-Only Attribute
Description
CurrentBoundCount
Number of sessions currently bound.

Type: u32
Default: 0
RxConfirmCount
Number of Confirm messages received.

Type: u32
Default: 0
RxDeclineCount
Number of Decline messages received.

Type: u32
Default: 0
RxInfoRequestCount
Number of Information-Request messages received.

Type: u32
Default: 0
RxRebindCount
Number of Rebind messages received.

Type: u32
Default: 0
RxReleaseCount
Number of Release messages received.

Type: u32
Default: 0
RxRenewCount
Number of Renew messages received.

Type: u32
Default: 0
RxRequestCount
Number of Request messages received.

Type: u32
Default: 0
RxSolicitCount
Number of Solicit messages received.

Type: u32
Default: 0
TotalBoundCount
Total number of times a bound event occurred including renew events.

Type: u32
Default: 0
TotalExpiredCount
Total number of times an expired event occurred.

Type: u32
Default: 0
TotalReleasedCount
Total number of times a release event occurred.

Type: u32
Default: 0
TotalRenewedCount
Total number of times a renew event occurred.

Type: u32
Default: 0
636
Read-Only Attribute
Description
TxAdvertiseCount
Number of Advertise messages transmitted.

Type: u32
Default: 0
TxReconfigureCount
Number of Reconfigure messages transmitted.

Type: u32
Default: 0
TxReconfigureRebindCount
Number of Reconfigure Rebind messages transmitted.

Type: u32
Default: 0
TxReconfigureRenewCount
Number of Reconfigure Renew messages transmitted.

Type: u32
Default: 0
TxReplyCount
Number of Reply messages transmitted.

Type: u32
Default: 0
Description:
Get DHCPv6 session info.

Dhcpv6SessionInfoCommand Writable Attributes

Writable Attribute
Description
BlockList

Type: handle
Default: 0
FileName
Filename to save DHCPv6 session info results to.

SaveToFile

Type: bool
Default: TRUE
Possible Values:
Value Description
TRUE
Save session info results to file.
FALSE Do not save session info results to file.

TimestampFilename
Flag to indicate if a timestamp should be included as part of the filename.

Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
637
Dhcpv6SessionInfoCommand Read-Only Attributes

Read-Only Attribute
Description

Description:
DHCPv6 session results.

Dhcpv6SessionResults Writable Attributes

Writable Attribute
Description
Active, Name
Dhcpv6SessionResults Read-Only Attributes

Read-Only Attribute
Description
Ipv6Addr
IP address.
Type: ipv6
Default: ::
LeaseLeft
Lease remaining.
Type: double
Default: 0
LeaseRx
Lease received.
Type: u32
Default: 0
MacAddr
MAC address.
Type: mac
Default: 00-00-00-00-00-00
PrefixLength
Prefix length.
Type: u8
Default: 0
RequestRespTime
Request response time.

Type: double
Default: 0
638
Read-Only Attribute
Description
SessionState
State of the DHCPv6 session.

Type: enum
Default: IDLE
Possible Values:
Value
Description
IDLE
Session is idle.
SOLICITING
Session is soliciting.
REQUESTING
Session is requesting.
BOUND
Session is bound.
RENEWING
Session is renewing.
REBINDING
Session is rebinding.
RELEASING
Session is releasing.
DECLINING
Session is declining.
FAIL_SOLICIT
Session failed in solicit.
FAIL_REQUEST Session failed in request.

FAIL_RENEW
Session failed in renew.
FAIL_REBIND
Session failed in rebind.
FAIL_RELEASE Session failed in release.

SolicitRespTime
Solicit response time.

Type: double
Default: 0
StatusCode
Status of the session based on the state.

Type: enum
Default: OK
Possible Values:
Value
Description
OK
No failure.
UNSPECFAIL
Unspecified failure.
NOADDRSAVAIL No addresses available.

NOBINDING
No binding.
NOTONLINK
Not on link.
USEMULTICAST Use multicast address.

NOPREFIXAVAIL No prefix available.
StatusString
Status string.
Type: string
VlanId
VLAN ID.
Type: u16
Default: 1
Description:
Shows DHCPv6/PD session info.

639
Dhcpv6ShowSessionInfoCommand Writable Attributes

Writable Attribute
Description
BlockList

Type: handle
Default: 0
Dhcpv6ShowSessionInfoCommand Read-Only Attributes

Read-Only Attribute
Description

Description:
Starts the DHCPv6 servers.

Dhcpv6StartServerCommand Writable Attributes

Writable Attribute
Description
ServerList
List of DHCPv6 servers to start.

Type: handle
Default: 0
Dhcpv6StartServerCommand Read-Only Attributes

Read-Only Attribute
Description

Dhcpv6StopServerCommand
Description:
Stops the DHCPv6 Servers.

640
DiaAcc
Dhcpv6StopServerCommand Writable Attributes

Writable Attribute
Description
ServerList
List of DHCPv6 servers to stop.

Type: handle
Default: 0
Dhcpv6StopServerCommand Read-Only Attributes

Read-Only Attribute
Description

DiaAcc (fcsw:DiaAcc)
Description:
Children: None
DiaAcc Attributes
Attribute
Description
command
Type: OCTETSTRING
Default: 02000000
Name
Type: string
notMeaningful
Type: OCTETSTRING
Default: 00000000
respondingSwitchName
Type: WWN
Default: 20:00:10:94:00:00:00:01
diaAccept
Description:
Children: None
diaAccept Attributes
Attribute
Description
command
Type: OCTETSTRING
Default: 02000000
641
DiaReq
Attribute
Description
Name
Type: string
notMeaningful
Type: OCTETSTRING
Default: 00000000
respondingSwitchName
Type: WWN
Default: 20:00:10:94:00:00:00:01
DiaReq (fcsw:DiaReq)
Description:
Children: None
DiaReq Attributes
Attribute
Description
command
Type: OCTETSTRING
Default: 12000000
Name
Type: string
notMeaningful
Type: OCTETSTRING
Default: 00000000
originatingSwitchName
Type: WWN
Default: 20:00:10:94:00:00:00:01
diaRequest
Description:
Children: None
diaRequest Attributes
Attribute
Description
command
Type: OCTETSTRING
Default: 12000000
Name
Type: string
642
diffServ
Attribute
Description
notMeaningful
Type: OCTETSTRING
Default: 00000000
originatingSwitchName
Type: WWN
Default: 20:00:10:94:00:00:00:01
diffServ (overloaded)
diffServ (ip)
diffServ (ipv4)
diffServ Object (ip PDU library)

Description:
Parents: tosDiffserv (StreamBlock.IP.tosDiffserv)

Children: None
diffServ Attributes
Attribute
Description
dscpHigh
Type: INTEGER
Default: 0
dscpLow
Type: INTEGER
Default: 0
Name
Type: string
reserved
Type: BITSTRING
Default: 00
diffServ Object (ipv4 PDU library)

Description:
Parents: tosDiffserv (StreamBlock.IcmpDestUnreach.ipData.ipHdr.tosDiffserv)

tosDiffserv (StreamBlock.IcmpTimeExceeded.ipData.ipHdr.tosDiffserv)
tosDiffserv (StreamBlock.IcmpParameterProblem.ipData.ipHdr.tosDiffserv)
tosDiffserv (StreamBlock.IcmpSourceQuench.ipData.ipHdr.tosDiffserv)
tosDiffserv (StreamBlock.IcmpRedirect.ipData.ipHdr.tosDiffserv)
643
DiffServConfig
tosDiffserv (StreamBlock.IPv4.tosDiffserv)
Children: None
diffServ Attributes
Attribute
Description
dscpHigh
Type: INTEGER
Default: 0
dscpLow
Type: INTEGER
Default: 0
Name
Type: string
reserved
Type: BITSTRING
Default: 00
DiffServConfig
Description:
Analyzer Diffserv setting.

DiffServConfig Writable Attributes

Writable Attribute
Description
Active, Name
Ipv4DstAddr
IPv4 destination address.

Type: ip
Default: 0.0.0.0
Ipv6DstAddr
IPv6 destination address.

Type: ipv6
Default: FFFF::FFFF
QualifyIpv4DstAddr
Enable/disable qualify IPv4 address destination.

Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
Enable qualify IPv4 address destination.
FALSE Disable qualify IPv4 address destination.

QualifyIpv6DstAddr
Enable/disable qualify IPv6 address destination.

Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
Enable qualify IPv6 address destination.
FALSE Disable qualify IPv6 address destination.
644
DiffServResults
DiffServConfig Read-Only Attributes

DiffServResults
Description:
Result object to DiffServ result data per port. Handles bulk flows of data to guarantee quality of service for each ToS value.

Parents: Analyzer
Relations:
Side name
(Type)
Relative
Description
ResultParent
(ResultChild)
Analyzer
DiffServResults Writable Attributes

DiffServResults Read-Only Attributes

Read-Only Attribute
Description
CounterTimestamp

Type: u64
Default: 0
DiffServ
DiffServ value of received frame.

Type: string
Default: N/A
Ecn
ECN value of received frame.

Type: string
Default: N/A
IpPrecedence
IP Precedence value of received frame.

Type: string
Default: N/A
Ipv4FrameCount

Type: u64
Default: 0
Ipv4FrameRate

Type: u64
Default: 0
Ipv6FrameCount

Type: u64
Default: 0
Ipv6FrameRate

Type: u64
Default: 0
Qos
Type of Service (0-255).

Type: u8
Default: 0
645
DistributeNetworkCountCommand
Read-Only Attribute
Description
QosBinary
Type of Service in binary format.

Type: string
Default: N/A
DistributeNetworkCountCommand
Description:
Implementation class for distributing aggregate network counts among a set of network blocks.

DistributeNetworkCountCommand Writable Attributes

Writable Attribute
Description
DistributionType
Distributes aggregate network counts among a set of network blocks.

Type: enum
Default: EVEN
Possible Values:
Value
Description
EVEN
Even distribution between all associated multicast groups.
TRAFFIC_WEIGHTED Weighted distribution based on traffic rate to associated multicast groups.
DistributeNetworkCountCommand Read-Only Attributes

Read-Only Attribute
Description

TestStatus
Test status.
Type: string
DL
Description:
Parents: FIP
Children: DL-Choice
646
DL-Choice
DL Attributes
Attribute
Description
Name
information.
Type: string
DL-Choice
Description:
Parents: DL
Children: elpAccept, elpReject, elpRequest, fabricLogoAccept, fabricLogoReject, fabricLogoRequest, fabricName, fcMap, fkaAdvPeriod, flogiAccept, flogiReject,
flogiRequest, macAddr, maxRcvSize, nameId, npivFdiscAccept, npivFdiscReject, npivFdiscRequest, priority, vendorID, vlanDescriptor, vxPortId
DL-Choice Attributes
Attribute
Description
Name
information.
Type: string
DMM (EOAM:DMM)
Description:
Children: cfmHeader, EndTLV, MACPreamble
DMM Attributes
Attribute
Description
FirstTLVOffset
Type: OCTETSTRING
Default: 20
Flags
Type: INTEGER
Default: 00000000
Name
Type: string
OpCode
Type: OCTETSTRING
Default: 2F
RxTimeStampb
Type: OCTETSTRING
Default: 0000000000000000
RxTimeStampf
Type: OCTETSTRING
Default: 0000000000000000
647
DMM
Attribute
Description
TxTimeStampb
Type: OCTETSTRING
Default: 0000000000000000
TxTimeStampf
Type: OCTETSTRING
Default: 0000000000000000
DMM (serviceoam:DMM)
Description:
Children: cfmHeader, EndTLV
DMM Attributes
Attribute
Description
FirstTLVOffset
Type: OCTETSTRING
Default: 20
Flags
Type: INTEGER
Default: 00000000
Name
Type: string
OpCode
Type: OCTETSTRING
Default: 2F
RxTimeStampb
Type: OCTETSTRING
Default: 0000000000000000
RxTimeStampf
Type: OCTETSTRING
Default: 0000000000000000
TxTimeStampb
Type: OCTETSTRING
Default: 0000000000000000
TxTimeStampf
Type: OCTETSTRING
Default: 0000000000000000
DMR (EOAM:DMR)
Description:
648
DMR
DMR Attributes
Attribute
Description
FirstTLVOffset
Type: OCTETSTRING
Default: 20
Flags
Type: INTEGER
Default: 00000000
Name
Type: string
OpCode
Type: OCTETSTRING
Default: 2E
RxTimeStampb
Type: OCTETSTRING
Default: 0000000000000000
RxTimeStampf
Type: OCTETSTRING
Default: 0000000000000000
TxTimeStampb
Type: OCTETSTRING
Default: 0000000000000000
TxTimeStampf
Type: OCTETSTRING
Default: 0000000000000000
DMR (serviceoam:DMR)
Description:
DMR Attributes
Attribute
Description
FirstTLVOffset
Type: OCTETSTRING
Default: 20
Flags
Type: INTEGER
Default: 00000000
Name
Type: string
OpCode
Type: OCTETSTRING
Default: 2E
RxTimeStampb
Type: OCTETSTRING
Default: 0000000000000000
RxTimeStampf
Type: OCTETSTRING
Default: 0000000000000000
TxTimeStampb
Type: OCTETSTRING
Default: 0000000000000000
649
domainID
Attribute
Description
TxTimeStampf
Type: OCTETSTRING
Default: 0000000000000000
domainID (overloaded)
domainID (fc)
domainID (fcsw)
domainID Object (fc PDU library)

Description:
Parents: rdiRequest (StreamBlock.FCoE.fc.fcPayloads.FCPayload-Choice.rdiRequest)

rdiRequest (StreamBlock.FCoE.fc.fcPayloads.FCPayload-Choice.rdiAccept)
Children: RdiDomainId
domainID Attributes
Attribute
Description
Name
information.
Type: string
domainID Object (fcsw PDU library)

Description:
Parents: rdiRequest (StreamBlock.Rdi)

Children: RdiDomainId
domainID Attributes
Attribute
Description
Name
information.
Type: string
650
domainIDs
domainIDs (overloaded)
domainIDs (fc)
domainIDs (fcsw)
domainIDs Object (fc PDU library)

Description:
Parents: efpRequest (StreamBlock.FCoE.fc.fcPayloads.FCPayload-Choice.efpRequest)

efpAccept (StreamBlock.FCoE.fc.fcPayloads.FCPayload-Choice.efpAccept)
Children: EfpDomainIdRecord
domainIDs Attributes
Attribute
Description
Name
information.
Type: string
domainIDs Object (fcsw PDU library)

Description:
Parents: efpRequest (StreamBlock.EfpReq)

efpAccept (StreamBlock.EfpAcc)
Children: EfpDomainIdRecord
domainIDs Attributes
Attribute
Description
Name
information.
Type: string
Dot1xAbortAuthCommand
Description:
Abort supplicant authentication.
651
Dot1xDeleteAllCertificateCommand

Dot1xAbortAuthCommand Writable Attributes

Writable Attribute
Description
ObjectList
List of project, port, emulated device or supplicant block handles.

Type: handle
Default: 0
Dot1xAbortAuthCommand Read-Only Attributes

Read-Only Attribute
Description

Dot1xDeleteAllCertificateCommand
Description:
Delete all certificates/PAC key files from port(s).

Dot1xDeleteAllCertificateCommand Writable Attributes

Writable Attribute
Description
ObjectList

Type: handle
Default: 0
Dot1xDeleteAllCertificateCommand Read-Only Attributes

Read-Only Attribute
Description

Dot1xDeviceGenProtocolParams
Description:
802.1X device wizard settings.

652
Dot1xDeviceGenProtocolParams

Dot1xDeviceGenProtocolParams Writable Attributes

Writable Attribute
Description
Active, Name
AuthenticatorMac
MAC address of the authenticator DUT.

Type: mac
Default: 00:10:94:00:00:02
AuthRetryCount
Number of retries attempted when authentication fails.

Type: u32
Default: 10
AuthRetryIntervalInMsec
Authentication retry interval (in ms).

Type: u32
Default: 1000
Certificate
X.509 certificate(s) required for EAP-TLS authentication. The use of wildcard characters are supported to generate
a unique certificate name for each supplicant in a block (for example, 'spirent@s' where '@s' represents the supplicant
index).
Type: string
EapAuthMethod
EAP authentication method for supplicant(s).

Type: enum
Default: MD5
Possible Values:
Value Description
MD5
EAP-MD5 authentication method.
FAST EAP-FAST authentication method.

TLS
EAP-TLS authentication method.
PacKeyFileName
AC key file(s) required for EAP-FAST authentication. The use of wildcard characters are supported to generate a
unique filename for each supplicant in a block (for example, 'spirent@s' where '@s' represents the supplicant index).
Type: string
Password
Supplicant password(s). The use of wildcard characters are supported to generate a unique value for each supplicant
in a block (for example, 'spirent@s' where '@s' represents the supplicant index).
Type: string
Default: spirent
RetransmitCount
Number of retransmission attempts for EAPOL/EAP packets.

Type: u32
Default: 10
RetransmitIntervaInMsec
Retransmission interval (in ms) for EAPOL/EAP packets.

Type: u32
Default: 1000
UsePaeGroupMac
Indicates whether to use the PAE multicast MAC (that is, 01:80:C2:00:00:03) in transmitted EAPOL packets. Note
that 'AuthenticatorMac' will be ignored when this option is enabled.
Type: bool
Default: TRUE
Possible Values:
Value Description
TRUE
Use PAE multicast MAC address.
FALSE Use 'AuthenticatorMac' address.

UserId
Supplicant user id(s). The use of wildcard characters are supported to generate a unique value for each supplicant
Type: string
Default: spirent
653
Dot1xDownloadCertificateCommand
Dot1xDeviceGenProtocolParams Read-Only Attributes

Dot1xDownloadCertificateCommand
Description:
Download certificates/PAC key files to port(s).

Dot1xDownloadCertificateCommand Writable Attributes

Writable Attribute
Description
CertificateDir
Directory containing certificate(s) or PAC key file(s) to download. If the directory contains zip files, then these
file will be downloaded to the port(s) and unzipped. The zip formats/extensions currently supported are '.tar',
'.tgz' and '.tar.gz'.
Type: inputFilePath
ObjectList

Type: handle
Default: 0
Dot1xDownloadCertificateCommand Read-Only Attributes

Read-Only Attribute
Description

Dot1xEapAuthMethodResults
Description:
802.1X packet counters for the configured EAP authentication method.

Parents: Dot1xPortConfig, Dot1xSupplicantBlockConfig
Relations:
Side name
(Type)
Relative
Description
ResultParent
(ResultChild)
Dot1xPortConfig, Dot1xSupplicantBlockConfig
Dot1xEapAuthMethodResults Writable Attributes

654
Dot1xEapFastConfig
Dot1xEapAuthMethodResults Read-Only Attributes

Read-Only Attribute
Description
RxDroppedPktCount
Number of EAP Authentication Method packets dropped. Note that a packet will only be counted if it matches the
configured authentication method.
Type: u32
Default: 0
RxPktCount
Number of EAP Authentication Method packets received. Note that a packet will only be counted if it matches the
configured authentication method.
Type: u32
Default: 0
TxPktCount
Number of EAP Authentication Method packets transmitted. Note that a packet will only be counted if it matches
the configured authentication method.
Type: u32
Default: 0
Dot1xEapFastConfig
Description:
EAP-FAST settings for supplicant(s).

Parents: Dot1xSupplicantBlockConfig
Dot1xEapFastConfig Writable Attributes

Writable Attribute
Description
Active, Name
PacKeyFileName
PAC key file(s) required for EAP-FAST authentication. The use of wildcard characters are supported to generate a
unique filename for each supplicant in a block (for example, 'spirent@s' where '@s' represents the supplicant index).
Type: string
Password
Type: string
Default: spirent
UserId
Type: string
Default: spirent
Dot1xEapFastConfig Read-Only Attributes

Dot1xEapMd5Config
Description:
EAP-MD5 settings for supplicant(s).
655
Dot1xEapMethodResults

Dot1xEapMd5Config Writable Attributes

Writable Attribute
Description
Active, Name
Password
Supplicant password(s). The use of wildcard characters are supported to generate a unique value for each
supplicant in a block (for example, 'spirent@s' where '@s' represents the supplicant index).
Type: string
Default: spirent
UserId
Type: string
Default: spirent
Dot1xEapMd5Config Read-Only Attributes

Dot1xEapMethodResults
Description:
802.1X method packet counters.

Relations:
Side name
(Type)
Relative
Description
ResultParent
(ResultChild)
Dot1xEapMethodResults Writable Attributes

Dot1xEapMethodResults Read-Only Attributes

Read-Only Attribute
Description
RxExpandedTypesPktCount
Number of EAP-Response Expanded Types packets received.

Type: u32
Default: 0
RxIdentityPktCount
Number of EAP-Request Identity packets received.

Type: u32
Default: 0
RxMd5ChallengePktCount
Number of EAP-Response MD5 Challenge packets received.

Type: u32
Default: 0
RxNotificationPktCount
Number of EAP-Request Notification packets received.

Type: u32
Default: 0
656
Dot1xEapolResults
Read-Only Attribute
Description
RxOtherEapMethodPktCount
Number of other/unknown EAP method packets received.

Type: u32
Default: 0
TxExpandedNakPktCount
Number of EAP-Response Expanded NAK packets transmitted.

Type: u32
Default: 0
TxExpandedTypesPktCount
Number of EAP-Response Expanded Types packets transmitted.

Type: u32
Default: 0
TxIdentityPktCount
Number of EAP-Response Identity packets transmitted.

Type: u32
Default: 0
TxLegacyNakPktCount
Number of EAP-Response Legacy NAK packets transmitted.

Type: u32
Default: 0
TxMd5ChallengePktCount
Number of EAP-Response MD5 Challenge packets transmitted.

Type: u32
Default: 0
TxNotificationPktCount
Number of EAP-Response Notification packets transmitted.

Type: u32
Default: 0
TxOtherEapMethodPktCount
Number of other/unknown EAP method packets transmitted.

Type: u32
Default: 0
Dot1xEapolResults
Description:
EAPOL packet counters and rates.

Relations:
Side name
(Type)
Relative
Description
ResultParent
(ResultChild)
Dot1xEapolResults Writable Attributes

Dot1xEapolResults Read-Only Attributes

Read-Only Attribute
Description
AvgEapPktLatencyInMsec
Average latency for EAP packets in milliseconds.

Type: u64
Default: 0
657
Dot1xEapolResults
Read-Only Attribute
Description
AvgKeyPktLatencyInMsec
Average latency for EAPOL-Key packets in milliseconds (currently supported only at the supplicant block
level).
Type: u64
Default: 0
AvgLogoffPktLatencyInMsec
Average latency for EAPOL-Logoff packets in milliseconds (currently supported only at the supplicant
block level).
Type: u64
Default: 0
AvgStartPktLatencyInMsec
Average latency for EAPOL-Start packets in milliseconds (currently supported only at the supplicant
block level).
Type: u64
Default: 0
MaxEapPktLatencyInMsec
Maximum latency for EAP packets in milliseconds (currently supported only at the supplicant block level).
Type: u64
Default: 0
MaxKeyPktLatencyInMsec
Maximum latency for EAPOL-Key packets in milliseconds (currently supported only at the supplicant
block level).
Type: u64
Default: 0
MaxLogoffPktLatencyInMsec
Maximum latency for EAPOL-Logoff packets in milliseconds (currently supported only at the supplicant
block level).
Type: u64
Default: 0
MaxStartPktLatencyInMsec
Maximum latency for EAPOL-Start packets in milliseconds (currently supported only at the supplicant
block level).
Type: u64
Default: 0
MinEapPktLatencyInMsec
Minimum latency for EAP packets in milliseconds (currently supported only at the supplicant block level).
Type: u64
Default: 0
MinKeyPktLatencyInMsec
Minimum latency for EAPOL-Key packets in milliseconds (currently supported only at the supplicant
block level).
Type: u64
Default: 0
MinLogoffPktLatencyInMsec
Minimum latency for EAPOL-Logoff packets in milliseconds (currently supported only at the supplicant
block level).
Type: u64
Default: 0
MinStartPktLatencyInMsec
Minimum latency for EAPOL-Start packets in milliseconds (currently supported only at the supplicant
block level).
Type: u64
Default: 0
RxEapOctetCount
Number of EAP octets received.

Type: u32
Default: 0
RxEapPktCount
Number of EAP packets received.

Type: u32
Default: 0
RxInvalidPktCount
Number of invalid EAPOL packets received.

Type: u32
Default: 0
RxOtherOctetCount
Number of other/unknown EAPOL octets received.

Type: u32
Default: 0
658
Dot1xEapPktResults
Read-Only Attribute
Description
RxOtherPktCount
Number of other/unknown EAPOL packets received.

Type: u32
Default: 0
TxEapOctetCount
Number of EAP octets transmitted.

Type: u32
Default: 0
TxEapPktCount
Number of EAP packets transmitted.

Type: u32
Default: 0
TxKeyOctetCount
Number of EAPOL-Key octets transmitted.

Type: u32
Default: 0
TxKeyPktCount
Number of EAPOL-Key packets transmitted.

Type: u32
Default: 0
TxLogoffOctetCount
Number of EAPOL-Logoff octets transmitted.

Type: u32
Default: 0
TxLogoffPktCount
Number of EAPOL-Logoff packets transmitted.

Type: u32
Default: 0
TxOtherOctetCount
Number of other/unknown EAPOL octets transmitted.

Type: u32
Default: 0
TxOtherPktCount
Number of other/unknown EAPOL packets transmitted.

Type: u32
Default: 0
TxStartOctetCount
Number of EAPOL-Start octets transmitted.

Type: u32
Default: 0
TxStartPktCount
Number of EAPOL-Start packets transmitted.

Type: u32
Default: 0
Dot1xEapPktResults
Description:
802.1X EAP packet counters.

Relations:
Side name
(Type)
Relative
Description
ResultParent
(ResultChild)
659
Dot1xEapTlsConfig
Dot1xEapPktResults Writable Attributes

Dot1xEapPktResults Read-Only Attributes

Read-Only Attribute
Description
RxFailurePktCount
Number of EAP-Failure packets received.

Type: u32
Default: 0
RxLengthErrorPktCount
Number of EAP packets received with a length error.

Type: u32
Default: 0
RxOtherEapPktCount
Number of other/unknown EAP packets received.

Type: u32
Default: 0
RxRequestPktCount
Number of EAP-Request packets received.

Type: u32
Default: 0
RxResponsePktCount
Number of EAP-Response packets received.

Type: u32
Default: 0
RxSuccessPktCount
Number of EAP-Success packets received.

Type: u32
Default: 0
TxOtherEapPktCount
Number of other/unknown EAP packets transmitted.

Type: u32
Default: 0
TxRequestPktCount
Number of EAP-Request packets transmitted.

Type: u32
Default: 0
TxResponsePktCount
Number of EAP-Response packets transmitted.

Type: u32
Default: 0
Dot1xEapTlsConfig
Description:
EAP-TLS settings for supplicant(s).

Dot1xEapTlsConfig Writable Attributes

Writable Attribute
Description
Active, Name
660
Dot1xLogoutCommand
Writable Attribute
Description
Certificate
X.509 certificate(s) required for EAP-TLS authentication. The use of wildcard characters are supported to generate a
unique certificate name for each supplicant in a block (for example, 'spirent@s' where '@s' represents the supplicant
index).
Type: string
Password
Type: string
Default: spirent
UserId
Supplicant user id(s). The use of wildcard characters are supported to generate a unique value for each supplicant in
a block (for example, 'spirent@s' where '@s' represents the supplicant index).
Type: string
Default: spirent
Dot1xEapTlsConfig Read-Only Attributes

Dot1xLogoutCommand
Description:
Log out of the supplicant session.

Dot1xLogoutCommand Writable Attributes

Writable Attribute
Description
ObjectList

Type: handle
Default: 0
Dot1xLogoutCommand Read-Only Attributes

Read-Only Attribute
Description

Dot1xOptions
Description:
Global 802.1X settings.

661
Dot1xPortConfig
Dot1xOptions Writable Attributes

Writable Attribute
Description
Active, Name
TrafficStartOption
Options for how traffic should behave for a supplicant block depending upon the authentication status of each
supplicant in the block.
Type: enum
Default: REQUIRE_ALL_SUPPLICANT_AUTH
Possible Values:
Value
Description
REQUIRE_ALL_SUPPLICANT_AUTH
Start traffic only if all supplicants (in a block) are authenticated.
IGNORE_FAILED_SUPPLICANT_AUTH Ignore supplicants (in a block) that are not authenticated.
Dot1xOptions Read-Only Attributes

Dot1xPortConfig
Description:
Port level 802.1X settings.

Parents: Dot1xEapAuthMethodResults, Dot1xEapMethodResults, Dot1xEapolResults, Dot1xEapPktResults, Port
Result children (automatically created): Dot1xEapAuthMethodResults, Dot1xEapMethodResults, Dot1xEapolResults, Dot1xEapPktResults,
Dot1xSupplicantAuthResults
Relations:
Side name
(Type)
Relative
Description
ResultChild
(ResultChild)
Dot1xEapAuthMethodResults, Dot1xEapMethodResults,
Dot1xEapolResults, Dot1xEapPktResults,

object.
Dot1xPortConfig Writable Attributes

Writable Attribute
Description
Active, Name
MaxOutstandingSupplicantAuth
Maximum outstanding supplicant authentications that can occur at any given time.
Type: u32
Default: 100
Range: 1 - 32768
SupplicantAuthRate
Supplicant authentication rate (supplicants/sec).

Type: u32
Default: 100
Range: 1 - 32768
SupplicantAuthSchedulingOption
Scheduling options when authenticating and logging off supplicant sessions.

Type: enum
Default: SEQUENTIAL
Possible Values:
Value
Description
SEQUENTIAL Sequential
PARALLEL
Parallel
662
Dot1xStartAuthCommand
Writable Attribute
Description
SupplicantLogoffRate
Supplicant logoff rate (supplicants/sec).

Type: u32
Default: 100
Range: 1 - 32768
Dot1xPortConfig Read-Only Attributes

Dot1xStartAuthCommand
Description:
Start supplicant authentication.

Dot1xStartAuthCommand Writable Attributes

Writable Attribute
Description
ObjectList

Type: handle
Default: 0
Dot1xStartAuthCommand Read-Only Attributes

Read-Only Attribute
Description

Description:
802.1X authentication results.

Relations:
Side name
(Type)
Relative
Description
ResultParent
(ResultChild)
663
Dot1xSupplicantAuthResults Writable Attributes

Dot1xSupplicantAuthResults Read-Only Attributes

Read-Only Attribute
Description
AuthAbortCount
Total number of sessions aborted.

Type: u32
Default: 0
AuthAttemptCount
Total number of sessions initiated, including any retries.

Type: u32
Default: 0
AuthFailCount
Total number of sessions failed, including retries.

Type: u32
Default: 0
AuthSuccessCount
Total number of sessions successfully established.

Type: u32
Default: 0
AvgAuthSuccessDurationInMsec
Average duration of a successful authentication attempt in milliseconds (currently supported only at

the supplicant block level).
Type: u64
Default: 0
LogoffAttemptCount
Number of logoff attempts.

Type: u32
Default: 0
LogoffFailCount
Number of unsuccessful logoff attempts.

Type: u32
Default: 0
LogoffSuccessCount
Number of successful logoff attempts.

Type: u32
Default: 0
MaxAuthSuccessDurationInMsec
Maximum duration of a successful authentication attempt in milliseconds (currently supported only

at the supplicant block level).
Type: u64
Default: 0
MinAuthSuccessDurationInMsec
Minimum duration of a successful authentication attempt in milliseconds (currently supported only at

the supplicant block level).
Type: u64
Default: 0
ReAuthAttemptCount
Number of reauthentication attempts.

Type: u32
Default: 0
ReAuthFailCount
Number of unsuccessful reauthentication attempts.

Type: u32
Default: 0
ReAuthSuccessCount
Number of successful reauthentication attempts.

Type: u32
Default: 0
664
Dot1xSupplicantBlockConfig
Dot1xSupplicantBlockConfig
Description:
Supplicant block settings.

Children: Dot1xEapFastConfig, Dot1xEapMd5Config, Dot1xEapTlsConfig
Result children (automatically created): Dot1xEapAuthMethodResults, Dot1xEapMethodResults, Dot1xEapolResults, Dot1xEapPktResults,
Relations:
Side name
(Type)
Relative
Description
ResultChild
(ResultChild)
Dot1xEapAuthMethodResults, Dot1xEapMethodResults,
Dot1xEapolResults, Dot1xEapPktResults,
UsesIf
(UsesIf)
Aal5If, EthIIIf, FcIf, GreIf, HdlcIf, Ipv4If, Ipv6If, ItagIf, L2tpv2If,

MplsIf, PppIf, PppoeIf, VlanIf, WimaxIf

Dot1xSupplicantBlockConfig Writable Attributes

Writable Attribute
Description
Active, Name
AuthenticatorMac
MAC address of the authenticator DUT.

Type: mac
Default: 00:10:94:00:00:02
AuthRetryCount
Number of retries attempted when authentication fails.

Type: u32
Default: 10
AuthRetryIntervalInMsec
Authentication retry interval in ms.

Type: u32
Default: 1000
EapAuthMethod
EAP authentication method for supplicant(s).

Type: enum
Default: MD5
Possible Values:
Value Description
MD5
EAP-MD5 authentication method.
FAST EAP-FAST authentication method.

TLS
EAP-TLS authentication method.
RetransmitCount
Number of retransmission attempts for EAPOL/EAP packets.

Type: u32
Default: 10
RetransmitIntervaInMsec
Retransmission interval (in ms) for EAPOL/EAP packets.

Type: u32
Default: 1000
665
Dot1xWaitForAuthStateCommand
Writable Attribute
Description
UsePaeGroupMac
Indicates whether to use the PAE multicast MAC (that is, 01:80:C2:00:00:03) in transmitted EAPOL packets.
Note that 'AuthenticatorMac' will be ignored when this option is enabled.
Type: bool
Default: TRUE
Possible Values:
Value Description
TRUE
Use PAE multicast MAC address.
FALSE Use 'AuthenticatorMac' address.

Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
FALSE
Dot1xSupplicantBlockConfig Read-Only Attributes

Read-Only Attribute
Description
AuthState
Current authentication state for the supplicant block.

Type: enum
Default: UNAUTHORIZED
Possible Values:
Value
Description
UNAUTHORIZED
Supplicant is not authorized.
AUTHENTICATING
Supplicant is being authenticated.
REAUTHENTICATING Supplicant is being reauthenticated.

AUTH_SUCCESS
Supplicant was authenticated.
AUTH_FAILED
Supplicant was not authenticated.
LOGGING_OFF
Supplicant is logging off.
Dot1xWaitForAuthStateCommand
Description:
Wait for supplicant authentication (for example, AUTH_SUCCESS).

Parents: Sequencer
Dot1xWaitForAuthStateCommand Writable Attributes

Writable Attribute
Description
ErrorOnFailure
ObjectList

Type: handle
Default: 0
666
DownloadFileCommand
Writable Attribute
Description
WaitSupplicantState
Supplicant state for which to wait (for example, AUTH_SUCCESS).

Type: enum
Default: AUTH_SUCCESS
Possible Values:
Value
Description
UNAUTHORIZED
Supplicant is not authorized.
AUTHENTICATING
Supplicant is being authenticated.
REAUTHENTICATING Supplicant is being re-authenticated.
WaitTime
AUTH_SUCCESS
Supplicant has been authenticated.
AUTH_FAILED
Supplicant authentication has failed.
LOGGING_OFF
Supplicant is logging off.
Number of seconds to wait for authentication state change.

Type: double
Default: 30.0
Range: 0.005 - 2147483647.0
Dot1xWaitForAuthStateCommand Read-Only Attributes

Read-Only Attribute
Description
DownloadFileCommand
Description:
Download a file onto one or more port group or chassis.

DownloadFileCommand Writable Attributes

Writable Attribute
Description
DstDir
Directory on the chassis or port group(s) where a file will be downloaded to.
Type: string
EquipmentList
List of one or more port group or chassis to download a file onto.

Type: handle
Default: 0
FileName
Path for the file to download.

Type: inputFilePath
667
downstreamInterfaceAddress
DownloadFileCommand Read-Only Attributes

Read-Only Attribute
Description

downstreamInterfaceAddress
Description:
Parents: downstreamMappingTlv, downstreamMappingTlv, interfaceAndLabelStackTlv, interfaceAndLabelStackTlv
Children: None
downstreamInterfaceAddress Attributes
Attribute
Description
ipv4Address
Type: IPV4ADDR
Default: 192.168.1.1
ipv6Address
Type: IPV6ADDR
Default: 2000::1
Name
Type: string
downstreamIpAddress
Description:
Children: None
downstreamIpAddress Attributes
Attribute
Description
ipv4Address
Type: IPV4ADDR
Default: 192.168.1.1
ipv6Address
Type: IPV6ADDR
Default: 2000::1
Name
Type: string
668
downstreamLabelList
downstreamLabelList
Description:
Parents: downstreamMappingTlv
Children: DownstreamLabels
downstreamLabelList Attributes
Attribute
Description
Name
information.
Type: string
DownstreamLabels
Description:
Parents: downstreamLabelList
Children: None
DownstreamLabels Attributes
Attribute
Description
downstreamLabels
Type: INTEGER
Default: 16
Name
Type: string
protocol
Type: ProtocolType
Default: 0
Possible Values:
Value Description
0
0-Unknown
1-Static
2-BGP
3-LDP
4-RSVP-TE
downstreamMappingTlv
Description:
Children: downstreamInterfaceAddress, downstreamIpAddress, downstreamLabelList, dsFlag
669
dpall
downstreamMappingTlv Attributes
Attribute
Description
addressType
Type: AddressTypeType
Default: 1
Possible Values:
Value Description
1
1-IPv4 Numbered
2-IPv4 Unnumbered
3-IPv6 Numbered
4-IPv6 Unnumbered
depthLimit
Type: INTEGER
Default: 0
length
Type: INTEGER
Default: 20
mtu
Type: INTEGER
Default: 1500
multipathInformation
Type: OCTETSTRING
multiPathLength
Type: INTEGER
Default: 0
multiPathType
Type: MultiPathTypeType
Default: 0
Possible Values:
Value Description
0
0-no multipath
2-IP address
4-IP address range
8-Bit masked IP address set
9-Bit masked label set
Name
Type: string
type
Type: INTEGER
Default: 2
dpall
Description:
670
Dpall
dpall Attributes
Attribute
Description
Name
information.
Type: string
Dpall (fcgs:Dpall)
Description:
Dpall Attributes
Attribute
Description
Name
information.
Type: string
dpl
Description:
dpl Attributes
Attribute
Description
Name
Type: string
platformName
Type: ASCII
platformNameFormat
Type: OCTETSTRING
Default: 02
platformNameLength
Type: INTEGER
Default: 0
reserved1
Type: FIELDALIGNMENTPAD
671
Dpl
Dpl (fcgs:Dpl)
Description:
Dpl Attributes
Attribute
Description
Name
Type: string
platformName
Type: ASCII
platformNameFormat
Type: OCTETSTRING
Default: 02
platformNameLength
Type: INTEGER
Default: 0
reserved1
dplm
Description:
dplm Attributes
Attribute
Description
Name
Type: string
platformManagementAddressLength
Type: INTEGER
Default: 0
platformManagementAddressValue
Type: ASCII
platformName
Type: ASCII
platformNameFormat
Type: OCTETSTRING
Default: 02
platformNameLength
Type: INTEGER
Default: 0
reserved1
672
Dplm
Attribute
Description
reserved2
Dplm (fcgs:Dplm)
Description:
Dplm Attributes
Attribute
Description
Name
Type: string
Type: INTEGER
Default: 0
Type: ASCII
platformName
Type: ASCII
platformNameFormat
Type: OCTETSTRING
Default: 02
platformNameLength
Type: INTEGER
Default: 0
reserved1
reserved2
dpln
Description:
dpln Attributes
Attribute
Description
Name
Type: string
673
Dpln
Attribute
Description
platformNodeName
Type: WWN
Default: 10:00:10:94:00:00:00:00
Dpln (fcgs:Dpln)
Description:
Dpln Attributes
Attribute
Description
Name
Type: string
platformNodeName
Type: WWN
Default: 10:00:10:94:00:00:00:00
drPriority
Description:
The DR Priority option in the PIM Hello message. See RFC 3973.
Parents: Pimv4HelloOption, Pimv6HelloOption
Children: None
drPriority Attributes
Attribute
Description
length
Type: INTEGER
Default: 4
Name
more information.
Type: string
type
Type: INTEGER
Default: 19
value
Type: INTEGER
Default: 1
dsFlag
674
DslLineAttributesCustomTlv
Description:
Parents: downstreamMappingTlv
Children: None
dsFlag Attributes
Attribute
Description
interfaceAndLabelStackObjectRequest
Type: BITSTRING
Default: 0
Name
Type: string
reserved
Type: BITSTRING
Default: 000000
treatAsNonIpPacket
Type: BITSTRING
Default: 0
DslLineAttributesCustomTlv (ancp_draft0:DslLineAttributesCustomTlv)
Description:
Children: None
DslLineAttributesCustomTlv Attributes
Attribute
Description
Data
Type: OCTETSTRING
Length
Type: INTEGER
Default: 0
MessageSelect
Default: 3
Possible Values:
Value Description
1
Port Up
Port Down
Port Up, Port Down
Name
more information.
Type: string
Pad
Type: ALIGNMENTPAD
Default: 0
675
DslLineAttributesCustomTlv
Attribute
Description
Type
Type: OCTETSTRING
Default: 0001
DslLineAttributesCustomTlv (ancp_draft2:DslLineAttributesCustomTlv)
Description:
Children: None
DslLineAttributesCustomTlv Attributes
Attribute
Description
Data
Type: OCTETSTRING
Length
Type: INTEGER
Default: 0
MessageSelect
Default: 3
Possible Values:
Value Description
1
Port Up
Port Down
Port Up, Port Down
Name
more information.
Type: string
Pad
Type: ALIGNMENTPAD
Default: 0
Type
Type: OCTETSTRING
Default: 0001
DslTypeTlv (ancp_draft0:DslTypeTlv)
Description:
Children: None
676
DslTypeTlv

DslTypeTlv Attributes
Attribute
Description
DslType
Type: DslTypeValues
Default: 00000001
Possible Values:
Value
Description
00000001 01 - ADSL1
00000002 02 - ADSL2
00000003 03 - ADSL2+
00000004 04 - VDSL1
00000005 05 - VDSL2
00000006 06 - SDSL
00000007 07 - UNKNOWN
Length
Type: INTEGER
Default: 4
MessageSelect
Default: 3
Possible Values:
Value Description
1
Port Up
Port Down
Port Up, Port Down
Name
more information.
Type: string
Type
Type: OCTETSTRING
Default: 0090
DslTypeTlv (ancp_draft2:DslTypeTlv)
Description:
Children: None
677
dtag
DslTypeTlv Attributes
Attribute
Description
DslType
Type: DslTypeValues
Default: 00000001
Possible Values:
Value
Description
00000001 01 - ADSL1
00000002 02 - ADSL2
00000003 03 - ADSL2+
00000004 04 - VDSL1
00000005 05 - VDSL2
00000006 06 - SDSL
00000007 07 - UNKNOWN
Length
Type: INTEGER
Default: 4
MessageSelect
Default: 3
Possible Values:
Value Description
1
Port Up
Port Down
Port Up, Port Down
Name
more information.
Type: string
Type
Type: OCTETSTRING
Default: 0091
dtag
Description:
Parents: CiscoDCECiscoStag, CiscoDCE8021adSTag
Children: None
dtag Attributes
Attribute
Description
ftag
Type: INTEGER
Default: 1
Name
information.
Type: string
ttl
Type: INTEGER
Default: 1
678
DvsNameTlv
DvsNameTlv
Description:
Parents: VmWareSubTlvList
Children: None
DvsNameTlv Attributes
Attribute
Description
DvsName
Type: ASCII
Default: SPIRENT
Length
Type: INTEGER
Default: 0
Name
Type: string
Type
Type: INTEGER
Default: 7
DvsPortNameTlv
Description:
Children: None
DvsPortNameTlv Attributes
Attribute
Description
DvsPortName
Type: ASCII
Default: SPIRENT
Length
Type: INTEGER
Default: 0
Name
Type: string
Type
Type: INTEGER
Default: 4
DvsPortSetNameTlv
Description:
Children: None
679
DvsUuidTlv
DvsPortSetNameTlv Attributes
Attribute
Description
DvsPortSetName
Type: ASCII
Default: SPIRENT
Length
Type: INTEGER
Default: 0
Name
Type: string
Type
Type: INTEGER
Default: 6
DvsUuidTlv
Description:
Children: None
DvsUuidTlv Attributes
Attribute
Description
DvsUuid
Type: OCTETSTRING
Length
Type: INTEGER
Default: 0
Name
more information.
Type: string
Type
Type: INTEGER
Default: 5
DynamicChartResultView
Description:

Parents: Project
Result children (automatically created): ExternalEquationResultProperty, PresentationResultQuery
DynamicChartResultView Writable Attributes

Writable Attribute
Description
Active, Name
680
DynamicResultView
Writable Attribute
Description
Description
Type: string
Identifier
Type: string
Path
Type: string
ResultSourceClass
Type: string
ResultViewOwner
Type: enum
Default: SYSTEM
Possible Values:
Value
Description
SYSTEM
USER
XAxisLabel
Type: string
YAxisLabel
Type: string
ZAxisLabel
Type: string
DynamicChartResultView Read-Only Attributes

Read-Only Attribute
Description
ResultState
DynamicResultView
Description:
Used to contain dynamic result view related queries and properties.

Parents: Project
Children: ColumnDisplayProperties
Result children (automatically created): ExternalEquationResultProperty, PresentationResultQuery
DynamicResultView Writable Attributes

Writable Attribute
Description
Active, Name
Description
Type: string
Identifier
Type: string
Path
Type: string
681
Writable Attribute
Description
ResultSourceClass
Type: string
ResultViewOwner
Type: enum
Default: SYSTEM
Possible Values:
Value
Description
SYSTEM
USER
DynamicResultView Read-Only Attributes

Read-Only Attribute
Description
ResultState
Description:

Parents: LspPingProtocolConfig
Relations:
Side name
(Type)
Relative
Description
MplsRouteParam
BgpIpv4RouteConfig, BgpIpv4VplsConfig, BgpIpv6RouteConfig,

BgpIpv6VplsConfig, BgpVplsAdConfig, GeneralizedPwidLsp,
Ipv4IngressPrefixLsp, Ipv4PrefixLsp, VcLsp
EchoReplyErrorGeneration Writable Attributes

Writable Attribute
Description
Active, Name
ErrorScenario
Type: enum
Default: NO_REPLY
Possible Values:
Value
NO_REPLY
NO_MAPPING_FOR_FEC
MAPPING_MISMATCH
NO_LABEL_ENTRY
EchoReplyErrorGeneration Read-Only Attributes

682
Description
EfpAcc
EfpAcc (fcsw:EfpAcc)
Description:
Children: domainIDs
EfpAcc Attributes
Attribute
Description
command
Type: OCTETSTRING
Default: 02
length
Type: INTEGER
Default: 16
Name
Type: string
pageLength
Type: OCTETSTRING
Default: 10
principalSwitchName
Type: WWN
Default: 20:00:10:94:00:00:00:01
principalSwitchPriority
Type: OCTETSTRING
Default: FF
reserved
Type: OCTETSTRING
Default: 000000
efpAccept
Description:
Children: domainIDs
efpAccept Attributes
Attribute
Description
command
Type: OCTETSTRING
Default: 02
length
Type: INTEGER
Default: 16
Name
Type: string
pageLength
Type: OCTETSTRING
Default: 10
principalSwitchName
Type: WWN
Default: 20:00:10:94:00:00:00:01
683
EfpDomainIdRecord
Attribute
Description
Type: OCTETSTRING
Default: FF
reserved
Type: OCTETSTRING
Default: 000000
EfpDomainIdRecord
Description:
Parents: domainIDs
Children: None
EfpDomainIdRecord Attributes
Attribute
Description
domainID
Type: OCTETSTRING
Default: 00
Name
Type: string
recordType
Type: OCTETSTRING
Default: 01
reserved1
Type: OCTETSTRING
Default: 0000
reserved2
Type: OCTETSTRING
Default: 00000000
switchName
Type: WWN
Default: 20:00:10:94:00:00:00:01
EfpDomainIdRecord
Description:
Parents: domainIDs
Children: None
EfpDomainIdRecord Attributes
Attribute
Description
domainID
Type: OCTETSTRING
Default: 00
Name
Type: string
684
EfpMulticastIdRecord
Attribute
Description
recordType
Type: OCTETSTRING
Default: 01
reserved1
Type: OCTETSTRING
Default: 0000
reserved2
Type: OCTETSTRING
Default: 00000000
switchName
Type: WWN
Default: 20:00:10:94:00:00:00:01
Description:
Parents: multicastIDs
Children: None
EfpMulticastIdRecord Attributes
Attribute
Description
multicastGroupNumber
Type: INTEGER
Default: 0
Name
Type: string
recordType
Type: OCTETSTRING
Default: 02
reserved1
Type: OCTETSTRING
Default: 0000
reserved2
Type: OCTETSTRING
Description:
Parents: multicastIDs
Children: None
EfpMulticastIdRecord Attributes
Attribute
Description
multicastGroupNumber
Type: INTEGER
Default: 0
685
EfpReq
Attribute
Description
Name
Type: string
recordType
Type: OCTETSTRING
Default: 02
reserved1
Type: OCTETSTRING
Default: 0000
reserved2
Type: OCTETSTRING
EfpReq (fcsw:EfpReq)
Description:
Children: domainIDs, multicastIDs
EfpReq Attributes
Attribute
Description
command
Type: OCTETSTRING
Default: 11
length
Type: INTEGER
Default: 16
Name
Type: string
principalSwitchName
Type: WWN
Default: 20:00:10:94:00:00:00:01
Type: OCTETSTRING
Default: FF
recordLength
Type: OCTETSTRING
Default: 10
reserved
Type: OCTETSTRING
Default: 000000
efpRequest
Description:
Children: domainIDs, multicastIDs
686
Egress_Port_ID
efpRequest Attributes
Attribute
Description
command
Type: OCTETSTRING
Default: 11
length
Type: INTEGER
Default: 16
Name
Type: string
principalSwitchName
Type: WWN
Default: 20:00:10:94:00:00:00:01
Type: OCTETSTRING
Default: FF
recordLength
Type: OCTETSTRING
Default: 10
reserved
Type: OCTETSTRING
Default: 000000
Egress_Port_ID
Description:
Parents: theEPID
Children: None
Egress_Port_ID Attributes
Attribute
Description
EgressPortID
Type: OCTETSTRING
Name
more information.
Type: string
Egress_Port_ID_Length
Description:
Parents: theEPIDL
Children: None
687
Egress_Port_ID_Subtype
Egress_Port_ID_Length Attributes
Attribute
Description
EgressPortIDLength
Type: OCTETSTRING
Default: 00
Name
Type: string
Egress_Port_ID_Subtype
Description:
Parents: theEPIDLS
Children: None
Egress_Port_ID_Subtype Attributes
Attribute
Description
EgressPortIDLengthSub
Type: OCTETSTRING
Default: 00
Name
Type: string
EgressIdent (overloaded)
EgressIdent (EOAMTLV)
EgressIdent (serviceoam)
EgressIdent Object (EOAMTLV PDU library)

Description:
Parents: LTMEgrID (StreamBlock.LTMEgrID)

Children: None
688
elp
EgressIdent Attributes
Attribute
Description
Index
Type: OCTETSTRING
Default: 0000
MacAddr
Type: MACADDR
Default: 00:00:00:00:00:00
Name
more information.
Type: string
EgressIdent Object (serviceoam PDU library)

Description:
Parents: LTMEgressIdentTLV (StreamBlock.LTM.theLTMTLVs.LTMTLVList.LTMEgressIdentTLV)

LTREgressIdentTLV (StreamBlock.LTR.theLTRTLVs.LTRTLVList.LTREgressIdentTLV)
Children: None
EgressIdent Attributes
Attribute
Description
Index
Type: OCTETSTRING
Default: 0000
MacAddr
Type: MACADDR
Default: 00:00:00:00:00:00
Name
more information.
Type: string
elp
Description:
Parents: elpRequest, elpAccept
Children: class1InterConnectPortParams, class2InterConnectPortParams, class3InterConnectPortParams, classFSvcParams, fc, islFlowControl
elp Attributes
Attribute
Description
bbscn
Type: INTEGER
Default: 0
689
elpAccept
Attribute
Description
code
Type: OCTETSTRING
Default: 10000000
edtov
Type: INTEGER
Default: 2000
flags
Type: INTEGER
Default: 0
Name
Type: string
ratov
Type: INTEGER
Default: 10000
reqInterConnPortName
Type: WWN
Default: 20:00:10:94:00:00:00:01
reqSwitchName
Type: WWN
Default: 20:00:10:94:00:00:00:01
reserved
Type: OCTETSTRING
revision
Type: INTEGER
Default: 4
elpAccept
Description:
Parents: DL-Choice
Children: elp
elpAccept Attributes
Attribute
Description
length
Type: INTEGER
Default: 33
Name
more information.
Type: string
reserved
Type: OCTETSTRING
Default: 0000
type
Type: INTEGER
Default: 10
elpReject (overloaded)
690
elpReject
elpReject (fc) - Object definition for the following paths:

StreamBlock.FCoE.fc.fcPayloads.FCPayload-Choice.elpReject
elpReject (fc) - Object definition for the following paths:
StreamBlock.FIP.DL.DL-Choice.elpReject
elpReject Object (fc PDU library)

Description:
Parents: FCPayload-Choice (StreamBlock.FCoE.fc.fcPayloads.FCPayload-Choice)

Children: None
elpReject Attributes
Attribute
Description
command
Type: OCTETSTRING
Default: 01
Name
Type: string
reasonCode
Type: OCTETSTRING
Default: 3
reasonExplanation
Type: OCTETSTRING
Default: 0F
reserved1
Type: OCTETSTRING
Default: 00000000
vendorUnique
Type: OCTETSTRING
Default: 0
elpReject Object (fc PDU library)

Description:
Parents: DL-Choice (StreamBlock.FIP.DL.DL-Choice)

Children: elprjt
elpReject Attributes
Attribute
Description
length
Type: INTEGER
Default: 9
691
elpRequest
Attribute
Description
Name
more information.
Type: string
reserved
Type: OCTETSTRING
Default: 0000
type
Type: INTEGER
Default: 7
elpRequest
Description:
Parents: DL-Choice
Children: elp
elpRequest Attributes
Attribute
Description
length
Type: INTEGER
Default: 33
Name
more information.
Type: string
reserved
Type: OCTETSTRING
Default: 0000
type
Type: INTEGER
Default: 10
elpRequestAccept
Description:
Children: class1InterConnectPortParams, class2InterConnectPortParams, class3InterConnectPortParams, classFSvcParams, islFlowControl
elpRequestAccept Attributes
Attribute
Description
bbscn
Type: INTEGER
Default: 0
code
Type: OCTETSTRING
Default: 10000000
692
elprjt
Attribute
Description
edtov
Type: INTEGER
Default: 2000
flags
Type: INTEGER
Default: 0
Name
Type: string
ratov
Type: INTEGER
Default: 10000
reqInterConnPortName
Type: WWN
Default: 20:00:10:94:00:00:00:01
reqSwitchName
Type: WWN
Default: 20:00:10:94:00:00:00:01
reserved
Type: OCTETSTRING
revision
Type: INTEGER
Default: 4
elprjt
Description:
Parents: flogiReject, npivFdiscReject, fabricLogoReject, elpReject
Children: fc
elprjt Attributes
Attribute
Description
commandCode
Type: OCTETSTRING
Default: 01
explanationCode
Type: OCTETSTRING
Default: 0F
Name
Type: string
reasonCode
Type: OCTETSTRING
Default: 03
reserved1
Type: OCTETSTRING
Default: 000000
reserved2
Type: OCTETSTRING
Default: 00
vendorUnique
Type: OCTETSTRING
Default: 00
693
ELSFLOGI
ELSFLOGI (fc:ELSFLOGI)
Description:
Children: class1SvcParams, class2SvcParams, class3SvcParams, commSvcParams
Next headers: fc:ELSReserved, fc:ELSSvcAvailabilityAndLoginExtDataLength, custom:Custom
ELSFLOGI Attributes
Attribute
Description
command
Type: OCTETSTRING
Default: 04000000
Name
Type: string
nodeOrFabricName
Type: OCTETSTRING
Default: 0000000000000000
obsolete
Type: OCTETSTRING
portName
Type: OCTETSTRING
Default: 0000000000000000
vendorVersionLevel
Type: OCTETSTRING
ELSFLOGILSACC (fc:ELSFLOGILSACC)
Description:
ELSFLOGILSACC Attributes
Attribute
Description
command
Type: OCTETSTRING
Default: 02000000
Name
Type: string
nodeOrFabricName
Type: OCTETSTRING
Default: 0000000000000000
obsolete
Type: OCTETSTRING
portName
Type: OCTETSTRING
Default: 0000000000000000
vendorVersionLevel
Type: OCTETSTRING
694
ELSLOGO
ELSLOGO (fc:ELSLOGO)
Description:
Children: None
ELSLOGO Attributes
Attribute
Description
command
Type: OCTETSTRING
Default: 05000000
Name
Type: string
nPortId
Type: OCTETSTRING
Default: 000000
nPortName
Type: OCTETSTRING
Default: 0000000000000000
reserved
Type: OCTETSTRING
Default: 00
ELSLOGOLSACC (fc:ELSLOGOLSACC)
Description:
Children: None
ELSLOGOLSACC Attributes
Attribute
Description
command
Type: OCTETSTRING
Default: 02000000
Name
more information.
Type: string
ELSLSRJT (fc:ELSLSRJT)
Description:
Children: None
695
ELSPLOGI
ELSLSRJT Attributes
Attribute
Description
command
Type: OCTETSTRING
Default: 01000000
explanation
Type: OCTETSTRING
Default: 00
Name
Type: string
reason
Type: OCTETSTRING
Default: 00
reserved
Type: OCTETSTRING
Default: 00
vendorUnique
Type: OCTETSTRING
Default: 00
ELSPLOGI (fc:ELSPLOGI)
Description:
ELSPLOGI Attributes
Attribute
Description
command
Type: OCTETSTRING
Default: 03000000
Name
Type: string
nodeOrFabricName
Type: OCTETSTRING
Default: 0000000000000000
obsolete
Type: OCTETSTRING
portName
Type: OCTETSTRING
Default: 0000000000000000
vendorVersionLevel
Type: OCTETSTRING
ELSReserved (fc:ELSReserved)
696
ELSSvcAvailabilityAndLoginExtDataLength
Description:
Children: None
Next headers: fc:NPortClkSyncQos, fc:FxPortClkSyncQos, fip:FipPadding, custom:Custom
ELSReserved Attributes
Attribute
Description
Name
more information.
Type: string
reserved
Type: OCTETSTRING
ELSSvcAvailabilityAndLoginExtDataLength
(fc:ELSSvcAvailabilityAndLoginExtDataLength)
Description:
Children: None
Next headers: fc:ELSReserved, custom:Custom
ELSSvcAvailabilityAndLoginExtDataLength Attributes
Attribute
Description
loginExtDataLength
Type: INTEGER
Default: 0
Name
Type: string
svcAvailability
Type: OCTETSTRING
Default: 0000000000000000
EmulatedDevice
Description:

Parents: Project
Children: Aal5If, AncpAccessNodeConfig, AncpCpeToDslamLink, BfdRouterConfig, BgpRouterConfig, BridgePortConfig, CustomLink, Dhcpv4BlockConfig,
Dhcpv4RelayAgentLink, Dhcpv4ServerConfig, Dhcpv4ServerDefaultPoolConfig, Dhcpv4ServerPoolConfig, Dhcpv6BlockConfig, Dhcpv6PdBlockConfig,
Dhcpv6ServerAddrPoolConfig, Dhcpv6ServerConfig, Dhcpv6ServerDefaultAddrPoolConfig, Dhcpv6ServerDefaultPrefixPoolConfig, Dhcpv6ServerPrefixPoolConfig,
Dot1xSupplicantBlockConfig, EoamLink, EoamNodeConfig, EthernetBridgeLink, EthIIIf, FcFPortConfig, FcHostConfig, FcIf, FcoeHostConfig, FcoeVfPortConfig,
FtpClientProtocolConfig, FtpServerProtocolConfig, GreIf, HdlcIf, HttpClientProtocolConfig, HttpServerProtocolConfig, Ieee1588v2ClockConfig, IgmpHostConfig,
IgmpRouterConfig, IpForwardingLink, IptvStbBlockConfig, Ipv4If, Ipv4NetworkBlock, Ipv6If, Ipv6NetworkBlock, IsisRouterConfig, ItagIf, ItagServiceLink,
L2tpv2BlockConfig, L2tpv2If, L3ForwardingLink, LdpRouterConfig, LinkOamRouterConfig, LldpNodeConfig, LspPingProtocolConfig, MacBlock, MldHostConfig,
MldRouterConfig, MplsForwardingLink, MplsHierarchicalLink, MplsIf, MplsIpv4VpnCeToPeLink, MplsIpv6VpnCeToPeLink, MplsL2VpnPeToPLink,
MplsL3VpnPeToPLink, MplsRsvpLabelLookUpEntry, MVpnGreCeToPeLink, MVpnGrePeToPLink, Ospfv2RouterConfig, Ospfv3RouterConfig, PacketChannel,
PimRouterConfig, Pimv4JoinSrc, Pimv4PruneSrc, Pimv6JoinSrc, Pimv6PruneSrc, PppIf, PppoaClientBlockConfig, PppoaServerBlockConfig,
697
EmulatedDevice
PppoeClientBlockConfig, PppoeIf, PppoeServerBlockConfig, PppoeServerIpv4PeerPool, PppoL2tpv2ClientBlockConfig, PppoL2tpv2ServerBlockConfig,

PppoxServerIpv4PeerPool, PppoxServerIpv6PeerPool, RawTcpClientProtocolConfig, RawTcpServerProtocolConfig, RipRouterConfig, RsvpRouterConfig,
SaaDeviceConfig, SipUaProtocolConfig, SyncEthDeviceConfig, TwampClientConfig, TwampServerConfig, VicAdapterConfig, VideoClientProtocolConfig,
VideoServerProtocolConfig, VifConfig, VifToVicLink, VlanBlock, VlanIf, VlanSwitchLink, VplsBgpCeToPeLink, VplsLdpCeToPeLink, VqDeviceChannelBlock,
VrfCustomerLink, VrfProviderLink, WimaxIf
Relations:
Side name
(Type)
Relative
Description
AffiliatedAncpAccessNodeSource
(AffiliatedAncpAccessNode)
AffiliatedRouter
(AffiliatedRouter)
EmulatedDevice, Host, Router
AffiliatedPort
(AffiliationPort)
Port
Role
(AssociatedDeviceRole)
DeviceRole
ContainedLink
(ContainedLink)
AncpCpeToDslamLink, CustomLink, Dhcpv4RelayAgentLink, EoamLink,

EthernetBridgeLink, IpForwardingLink, ItagServiceLink, L3ForwardingLink,
MplsForwardingLink, MplsHierarchicalLink, MplsIpv4VpnCeToPeLink,
MVpnGreCeToPeLink, MVpnGrePeToPLink, VifToVicLink, VlanSwitchLink,
GroupSource
(GroupMembership)
DeviceGroup, HostGroup
TrafficDescriptorHostSrc
(HostBinding)
TrafficDescriptor
Link
(LinkDstDevice)
AncpCpeToDslamLink, CustomLink, Dhcpv4RelayAgentLink, EoamLink,

EthernetBridgeLink, IpForwardingLink, ItagServiceLink, L3ForwardingLink,
MplsForwardingLink, MplsHierarchicalLink, MplsIpv4VpnCeToPeLink,
MVpnGreCeToPeLink, MVpnGrePeToPLink, VifToVicLink, VlanSwitchLink,
MemberOfVpn
(MemberOfVpn)

VpnSiteInfoVplsLdp
DstBoundTo
(MulticastDstBinding)
Rfc3918Config
SrcBoundTo
(MulticastSrcBinding)
Rfc3918Config
Config
DcbPfcBufferingAndLatencyTestCaseConfig, DcbPfcBufferingTestCaseConfig,
DcbPfcLoadValidationTestCaseConfig, DcbPfcResponseTimeTestCaseConfig
PrimaryIf
(PrimaryIf)
BgpImportRouteTableParams, BgpRouteGenParams, IsisLspGenParams,

Ospfv2LsaGenParams, Ospfv3LsaGenParams, RipRouteGenParams
MulticastGroupMembership
(SubscribedSources)
IgmpGroupMembership, MldGroupMembership,
MulticastDeviceGenProtocolParams, MulticastHostGenProtocolParams
TopLevelIf
(TopLevelIf)
Channel
(TrafficSources)
IptvChannelBlock
VqAnalyzerUnicastDeviceGenParams
(VqAnaGenUnicastDevice)
VqAnalyzerUnicastDeviceGenParams
698
Do not use, to be
removed
Specifies if a top-level
interface is facing the
DUT.
Specifies the top-level

interface in the
interface stack.
EmulatedDeviceGenParams
EmulatedDevice Writable Attributes

Writable Attribute
Description
Active, Name
DeviceCount
Number of devices in the device block.

Type: u32
Default: 1
EnablePingResponse
Whether the emulated device will respond to ping.

Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
Respond to ping.
FALSE Do not respond to ping.

RouterId
Router ID.
Type: ip
Default: 192.0.0.1
EmulatedDevice Read-Only Attributes

Description:
Defines parameters for generating EmulatedDevice objects.

Parents: AccessConcentratorGenParams, AccessStabilityGenParams, AccessVplsGenCeDeviceParams, DeviceGenConfigExpandCommand,
FcDeviceGenProtocolParams, FcoeDeviceGenProtocolParams, LldpDeviceGenProtocolParams, Project, SaaDeviceGenProtocolParams, VqAnalyzerGenParams
Children: AbstPppoeDeviceGenProtocolParams, AncpDeviceGenProtocolParams, BfdDeviceGenProtocolParams, BgpDeviceGenProtocolParams,
DeviceGenAal5IfParams, DeviceGenEthIIIfParams, DeviceGenFcIfParams, DeviceGenGreIfParams, DeviceGenGroupParams, DeviceGenHdlcIfParams,
DeviceGenIpv4IfParams, DeviceGenIpv6IfParams, DeviceGenLinkedStep, DeviceGenPppIfParams, DeviceGenPppoeIfParams, DeviceGenVlanIfParams,
Dhcpv4DeviceGenProtocolParams, Dhcpv4ServerDeviceGenProtocolParams, Dhcpv6DeviceGenProtocolParams, Dhcpv6ServerDeviceGenProtocolParams,
Dot1xDeviceGenProtocolParams, IsisDeviceGenProtocolParams, L2tpv2DeviceGenProtocolParams, LdpDeviceGenProtocolParams,
MulticastDeviceGenProtocolParams, MulticastHostGenProtocolParams, MulticastRouterGenProtocolParams, Ospfv2DeviceGenProtocolParams,
Ospfv3DeviceGenProtocolParams, PimDeviceGenProtocolParams, PppoaDeviceGenProtocolParams, PppoeDeviceGenProtocolParams,
PppoeoaDeviceGenProtocolParams, PppoL2tpv2DeviceGenProtocolParams, RipDeviceGenProtocolParams, RsvpDeviceGenProtocolParams,
Relations:
Side name
(Type)
Relative
Description
TopLevelIf
Used to assign the top level interface parameters

in the device generator.
Port
(SelectedPort)
Port
The collection of ports to generate devices on.
EmulatedDeviceGenParams Writable Attributes

Writable Attribute
Description
Active, Name
699
Writable Attribute
Description
BlockIndex
Starting device block index.

Type: u32
Default: 1
BlockMode
EmulatedDevice objects may be used to represent a single device or a block of many devices for higher scalability.
EmulatedDevice blocks are not supported by all protocols (for example, routing protocols) and have less granularity
of control at the protocol level and in traffic configuration.
Type: enum
Default: ONE_NETWORK_PER_BLOCK
Possible Values:
Value
Description
ONE_HOST_PER_BLOCK
One EmulatedDevice block is created for each device (Deprecated).
ONE_DEVICE_PER_BLOCK
One EmulatedDevice block is created for each device.
ONE_NETWORK_PER_BLOCK
One EmulatedDevice block is created for each network.
MULTIPLE_NETWORKS_PER_BLOCK One EmulatedDevice block may represent multiple networks. Note:

There are limitations to what can be represented as a single
EmulatedDevice block using this mode.
Count
Number of routers to create per port/VLAN.

Type: u32
Default: 1
Range: 1 - 4294967295
DeviceName
Template string for defining device names. $(BlockIndex) will be replaced with the block index of the device block
in the current device generator expansion.
Type: string
Default: Device $(BlockIndex)
DuplicateNameResolution
Determines how duplicate device names are handled.

Type: enum
Default: SKIP_BLOCK_INDEX
Possible Values:
Value
Description
ALLOW
Allows duplicate names to be used. When this mode is used, the device generator does
not do any checks for duplicate names.
APPEND_INDEX
Appends an integer value to the end of the name to create a unique name.
SKIP_BLOCK_INDEX Increments the block index until a unique name is found.

GroupAssignmentMode
Group assignment mode.

Type: enum
Default: GROUPS_PER_PORT
Possible Values:
Value
Description
ALL_SAME_GROUPS All devices are assigned to the same group(s).
GROUPS_PER_PORT Multiple groups are created for each port.
PORTS_PER_GROUP Multiple ports are grouped together.
PortType
Type of port to generate devices on.

Type: enum
Default: ETHERNET
Possible Values:
Value
Description
ETHERNET Ethernet.
POS
POS (PPP/HDLC).
ATM
ATM.
FC
PreviewMaxCount
Maximum number of devices to return in the preview.

Type: u32
Default: 1000
Range: 1 - 100000
700
enabledCapabilities
Writable Attribute
Description
PreviewMaxCountPerIncrementLevel
Maximum number of devices to show in the preview for each increment level (for example, port, VLAN, device, and
so on). This is used to reduce the number of items in the preview. This option is only applicable in PARTIAL preview
mode.
Type: u32
Default: 3
Range: 1 - 100000
PreviewMode
Preview mode.
Type: enum
Default: FULL
Possible Values:
Value
Description
FULL
Show all devices in the preview.
PARTIAL Show a subset of the devices in the preview.

BLOCK
Show all device blocks in the preview.
Role
Role to assign to the devices that are created (for example, Host, Router).
Type: string
RouterId
Router ID value.
Type: ip
Default: 192.0.0.1
RouterIdSrc
Determines how the Router ID value is determined.

Type: enum
Default: MANUAL
Possible Values:
Value
Description
MANUAL
Use the configured Router ID value and step.
USE_IPV4ADDR Use the Router ID from the IPv4 interface address.

RouterIdStep
Router ID step value.

Type: ip
Default: 0.0.0.1
StepOrder
Specifies the order in which the interfaces will be stepped. For example, a StepOrder of "VlanIf1 VlanIf2" will step
the outer VLAN interface before the inner VLAN interface. If StepOrder is not specified, the interfaces are stepped
from the innermost (closest to top of stack) interface outward.
Type: string
EmulatedDeviceGenParams Read-Only Attributes

enabledCapabilities
Description:
Parents: SystemCapabilitiesTlv, SystemCapabilitiesTlv
Children: None
lldp:NivSupportTlv
701
EncapEthernet8022
enabledCapabilities Attributes
Attribute
Description
bridge
Type: BITSTRING
Default: 0
docsisCableDevice
Type: BITSTRING
Default: 0
Name
Type: string
other
Type: BITSTRING
Default: 0
repeater
Type: BITSTRING
Default: 0
reserved
Type: OCTETSTRING
Default: 00
router
Type: BITSTRING
Default: 1
stationOnly
Type: BITSTRING
Default: 0
telephone
Type: BITSTRING
Default: 0
wlanAccessPoint
Type: BITSTRING
Default: 0
EncapEthernet8022 (mimethernet:EncapEthernet8022)
Description:
Children: cvlans, llcheader, svlans
Next headers: ipv4:IPv4, custom:Custom
EncapEthernet8022 Attributes
Attribute
Description
length
Type: INTEGER
Name
more information.
Type: string
EncapEthernet8023Raw (mimethernet:EncapEthernet8023Raw)
702
EncapEthernetII
Description:
Children: cvlans, svlans
EncapEthernet8023Raw Attributes
Attribute
Description
length
Type: INTEGER
Name
more information.
Type: string
EncapEthernetII (mimethernet:EncapEthernetII)
Description:
Next headers: ipv4:IPv4, ipv6:IPv6, mpls:Mpls, pppoe:PPPoEDiscovery, pppoe:PPPoESession, arp:ARP, arp:RARP, lacp:LACP, lacp:Marker, serviceoam:CCM,
serviceoam:LBR, serviceoam:LBM, serviceoam:LTM, serviceoam:LTR, serviceoam:LMM, serviceoam:LMR, serviceoam:DMM, serviceoam:DMR, lldp:ChassisIdTlv,
custom:Custom
703
EncapEthernetSnap
EncapEthernetII Attributes
Attribute
Description
etherType
Type: EtherTypes
Default: 88B5
Possible Values:
Value Description
0200
XEROX PUP
0201
PUP Addr Trans
0400
Nixdorf
0600
XEROX NS IDP
0660
DLOG
0661
DLOG2
0800
Internet IP
0801
X.75 Internet
0802
NBS Internet
0803
ECMA Internet
0804
Chaosnet
0805
X.25 Level 3
0806
ARP
0807
XNS Compatibility
0808
Frame Relay ARP
8035
RARP
86DD IPv6
880B PPP
Name
8809
Slow Protocol
8847
MPLS Unicast
8848
MPLS Multicast
8863
PPPoE Discovery
8864
PPPoE Session
8906
FCoE
8914
FIP
Type: string
EncapEthernetSnap (mimethernet:EncapEthernetSnap)
Description:
Children: cvlans, llcheader, snapheader, svlans
Next headers: ipv4:IPv4, ipv6:IPv6, mpls:Mpls, pppoe:PPPoEDiscovery, pppoe:PPPoESession, arp:ARP, arp:RARP, ieeeMacControl:MACControl, lldp:ChassisIdTlv,
custom:Custom
EncapEthernetSnap Attributes
Attribute
Description
length
Type: INTEGER
704
EncapMAC-in-MAC
Attribute
Description
Name
more information.
Type: string
EncapMAC-in-MAC (MAC-in-MAC:EncapMAC-in-MAC)
Description:
Children: bVlanTag
Next headers: MAC-in-MAC:iTag, mpls:Mpls, lacp:LACP, lacp:Marker, serviceoam:CCM, serviceoam:LBM, serviceoam:LBR, serviceoam:LTM, serviceoam:LTR,
serviceoam:LMM, serviceoam:LMR, serviceoam:DMM, serviceoam:DMR
EncapMAC-in-MAC Attributes
Attribute
Description
etherType
Type: EtherTypes
Default: 88B5
Possible Values:
Value Description
0200
XEROX PUP
0201
PUP Addr Trans
0400
Nixdorf
0600
XEROX NS IDP
0660
DLOG
0661
DLOG2
0800
Internet IP
0801
X.75 Internet
0802
NBS Internet
0803
ECMA Internet
0804
Chaosnet
0805
X.25 Level 3
0806
ARP
0807
XNS Compatibility
0808
Frame Relay ARP
8035
RARP
86DD IPv6
880B PPP
Name
8809
Slow Protocol
8847
MPLS Unicast
8848
MPLS Multicast
8863
PPPoE Discovery
8864
PPPoE Session
8906
FCoE
8914
FIP
Type: string
705
endOfList
endOfList
Description:
Parents: PPPoETag
Children: None
endOfList Attributes
Attribute
Description
length
Type: OCTETSTRING
Default: 0000
Name
more information.
Type: string
type
Type: OCTETSTRING
Default: 0000
endOfOptions
Description:
The DHCP "end" option, which terminates the options field
Parents: DHCPOption
Children: None
endOfOptions Attributes
Attribute
Description
Name
information.
Type: string
type
Type: OCTETSTRING
Default: FF
endOfOptlist
Description:
Children: None
endOfOptlist Attributes
Attribute
Description
Name
Type: string
706
EndpointNode
Attribute
Description
type
Default: 0
Possible Values:
Value Description
0
End of Options List
NOP
130
Security
131
Loose Source Route
68
Time Stamp
133
Extended Security
Record Route
136
Stream Identifier
137
Strict Source Route
11
MTU Probe
12
MTU Reply
82
Traceroute
147
Address Extension
148
Router Alert
149
EndpointNode
Description:

Children: EndpointNode
EndpointNode Writable Attributes

Writable Attribute
Description
Active, Name
NodeName
Type: string
Default: NONE
NodeType
Type: enum
Default: PROTOCOL
Possible Values:
Value
Description
PROJECT
PORT
PROTOCOL
PROTOCOL_CONFIG
HOST
ROUTER
SRC_OR_DST_ENDPOINT
SRC_ONLY_ENDPOINT
DST_ONLY_ENDPOINT
DEVICE
707
EndTlv
EndpointNode Read-Only Attributes

Read-Only Attribute
Description
Node
Type: handle
Default: 0
EndTlv (lldp:EndTlv)
Description:
Children: None
EndTlv Attributes
Attribute
Description
length
Type: INTEGER
Default: 0
Name
more information.
Type: string
type
Type: INTEGER
Default: 0
EndTLV (EOAMTLV:EndTLV)
Description:
Children: None
EndTLV Attributes
Attribute
Description
Name
information.
Type: string
Type
Type: OCTETSTRING
Default: 00
EndTLV (overloaded)
EndTLV (EOAM)
708
EndTLV
EndTLV (serviceoam)
EndTLV Object (EOAM PDU library)

Description:
Parents: CCMTLVList (StreamBlock.CCM.theCCMTLVS.CCMTLVList)

LBMTLVList (StreamBlock.LBM.theLBMTLVs.LBMTLVList)
LTMTLVList (StreamBlock.LTM.theLTMTLVs.LTMTLVList)
LTRTLVList (StreamBlock.LTR.theLTRTLVs.LTRTLVList)
Children: None
EndTLV Attributes
Attribute
Description
Name
information.
Type: string
Type
Type: OCTETSTRING
Default: 00
EndTLV Object (serviceoam PDU library)

Description:

Children: None
EndTLV Attributes
Attribute
Description
Name
information.
Type: string
709
enhancedZoning
Attribute
Description
Type
Type: OCTETSTRING
Default: 00
enhancedZoning (overloaded)
enhancedZoning (fc)
enhancedZoning (fcsw)
enhancedZoning Object (fc PDU library)

Description:
Parents: MRPayloadChoice (StreamBlock.FCoE.fc.fcPayloads.FCPayload-Choice.mergeRequest.payload.MRPayloadChoice)

Children: None
enhancedZoning Attributes
Attribute
Description
activeZoneSetLength
Type: INTEGER
Default: 0
enhancedZoningFlags
Type: BITSTRING
Name
Type: string
reserved
Type: OCTETSTRING
Default: 0000
Type: INTEGER
Default: 0
enhancedZoning Object (fcsw PDU library)

Description:
Parents: MRPayloadChoice (StreamBlock.MReq.payload.MRPayloadChoice)

Children: None
710
EntropyLabel
enhancedZoning Attributes
Attribute
Description
activeZoneSetLength
Type: INTEGER
Default: 0
enhancedZoningFlags
Type: BITSTRING
Name
Type: string
reserved
Type: OCTETSTRING
Default: 0000
Type: INTEGER
Default: 0
EntropyLabel (mpls:EntropyLabel)
Description:
Children: None
Next headers: ethernet:EthernetII, ipv4:IPv4, ipv6:IPv6, mpls:ControlWord, custom:Custom
EntropyLabel Attributes
Attribute
Description
exp
Type: BITSTRING
Default: 000
hash
Type: INTEGER
Default: 00000
Name
more information.
Type: string
sBit
Type: BITSTRING
Default: 1
ttl
Type: INTEGER
Default: 0
EoamAisCommandConfig
Description:
EOAM AIS command configuration.

711
EoamAisResults
Parents: EoamMaintenancePointConfig
EoamAisCommandConfig Writable Attributes

Writable Attribute
Description
Active, Name
EnableMulticastTarget
Unicast or multicast message type.

Type: bool
Default: TRUE
Possible Values:
Value Description
TRUE
Send multicast AIS messages.
FALSE Send unicast AIS messages.

UnicastTargetList
List of unicast MAC addresses to target.

Type: mac
Default: 00-00-00-00-00-00
EoamAisCommandConfig Read-Only Attributes

EoamAisResults
Description:
EOAM AIS results.

Relations:
Side name
(Type)
Relative
Description
ResultParent
(ResultChild)
EoamMaintenancePointConfig
EoamAisResults Writable Attributes

EoamAisResults Read-Only Attributes

Read-Only Attribute
Description
AisRxCount
Number of AIS messages received. Received multicast AIS messages are reported per MEG, not per MP. All
multicast AIS messages received for a MEG are reported for all MPs in the MEG.
Type: u32
Default: 0
712
EoamChangeAisRxEnableCommand
Read-Only Attribute
Description
AisRxPeriod
AIS period for MEPs.

Type: enum
Default: 0
Possible Values:
Value
Description
NONE
No period.
AISPERIOD_1S
1 sec AIS period.
AISPERIOD_1MIN 1 min AIS period.

INVALID
AisRxState
Invalid AIS period.
AIS receive state.

Type: enum
Default: OFF
Possible Values:
Value
Description
OFF
AIS is off.
ON
AIS is on.
DISABLED AIS is disabled.

AisTxCount
Number of AIS messages transmitted.

Type: u32
Default: 0
AisTxState
AIS transmit state.

Type: enum
Default: OFF
Possible Values:
Value
Description
OFF
AIS is off.
ON
AIS is on.

MaintenancePointName
MP's name.
Type: string
EoamChangeAisRxEnableCommand
Description:
Set the Rx enable option for AIS.

Parents: Project, Sequencer, StcSystem
EoamChangeAisRxEnableCommand Writable Attributes

Writable Attribute
Description
713
EoamChangeInterfaceStatusCommand
Writable Attribute
Description
EnableAisRx
Rx state of the selected MEPs.

Type: bool
Default: TRUE
Possible Values:
Value Description
TRUE
Receive AIS messages.
FALSE Drop AIS messages.

MepList
List of MEPs.
Type: handle
Default: 0
EoamChangeAisRxEnableCommand Read-Only Attributes

Read-Only Attribute
Description

EoamChangeInterfaceStatusCommand
Description:
Set the status of the interface.

EoamChangeInterfaceStatusCommand Writable Attributes

Writable Attribute
Description
InterfaceStatus
Interface status of the selected MEPs.

Type: enum
Default: UP
Possible Values:
Value
Description
UP
Interface status up.
DOWN
Interface status down.
TESTING
Interface status testing.
UNKNOWN
Interface status unknown.
DORMANT
Interface status dormant.
NOT_PRESENT
Interface status not present.
LOWER_LAYER_DOWN Interface status lower layer down.

MepList
List of MEPs.
Type: handle
Default: 0
714
EoamChangeLckRxEnableCommand
EoamChangeInterfaceStatusCommand Read-Only Attributes

Read-Only Attribute
Description

ProgressDisplayCounter, ProgressMaxValue, ProgressStepsCount, StartTime, State
Status
Status to change the Interface Status TLV to.

Type: string
EoamChangeLckRxEnableCommand
Description:
Set the Rx enable option for LCK.

EoamChangeLckRxEnableCommand Writable Attributes

Writable Attribute
Description
EnableLckRx
Rx state of the selected MEPs.

Type: bool
Default: TRUE
Possible Values:
Value Description
TRUE
Receive LCK messages.
FALSE Drop LCK messages.

MepList
List of MEPs.
Type: handle
Default: 0
EoamChangeLckRxEnableCommand Read-Only Attributes

Read-Only Attribute
Description

EoamChangePortStatusCommand
Description:
Set the status of the port.

715
EoamClearTlvsCommand
EoamChangePortStatusCommand Writable Attributes

Writable Attribute
Description
MepList
List of MEPs.
Type: handle
Default: 0
PortStatus
Port status of the selected MEPs.

Type: enum
Default: UP
Possible Values:
Value
Description
BLOCKED Port status blocked.
UP
Port status up.
EoamChangePortStatusCommand Read-Only Attributes

Read-Only Attribute
Description

ProgressDisplayCounter, ProgressMaxValue, ProgressStepsCount, StartTime, State
Status
Status to change the Port Status TLV to.

Type: string
EoamClearTlvsCommand
Description:
EOAM Clear TLVs Command.

EoamClearTlvsCommand Writable Attributes

Writable Attribute
Description
MpList
List of MPs.
Type: handle
Default: 0
716
EoamContChkCommandConfig
Writable Attribute
Description
OptionalTlvType
Optional TLV type to clear.

Type: enum
Default: ALL
Possible Values:
Value Description
ALL
Clear all TLVs.
CCM Clear CCM TLVs.

LBM
Clear LBM TLVs.
LBR
Clear LBR TLVs.
LTM
Clear LTM TLVs.
LTR
Clear LTR TLVs.
EoamClearTlvsCommand Read-Only Attributes

Read-Only Attribute
Description

EoamContChkCommandConfig
Description:
EOAM CC command configuration.

EoamContChkCommandConfig Writable Attributes

Writable Attribute
Description
Active, Name

Type: bool
Default: TRUE
Possible Values:
Value Description
TRUE
Send multicast CC messages.
FALSE Send unicast CC messages.

UnicastTargetList

Type: mac
Default: 00-00-00-00-00-00
EoamContChkCommandConfig Read-Only Attributes

717
EoamContChkLocalResults
Description:
EOAM CC local results.

Relations:
Side name
(Type)
Relative
Description
ResultParent
(ResultChild)
EoamContChkLocalResults Writable Attributes

EoamContChkLocalResults Read-Only Attributes

Read-Only Attribute
Description
AisRxState
AIS receive state.

Type: enum
Default: OFF
Possible Values:
Value
Description
OFF
AIS is off.
ON
AIS is on.

ContChkRxCount
Number of CC messages received. Received CC messages are reported per MEG, not per MP. All CC
messages received for a MEG are reported for all MPs in the MEG.
Type: u32
Default: 0
ContChkTxCount
Number of CC messages transmitted.

Type: u32
Default: 0
DroppedPktCount
Number of unserviceable packets that were dropped (as indicated by gaps in sequence numbers).
Type: u32
Default: 0
InterfaceStatus
Locally transmitted interface status.

Type: enum
Default: NONE
Possible Values:
Value
Description
NONE
Interface Status TLV doesn't exist.
UP
DOWN
TESTING
UNKNOWN
DORMANT
NOT_PRESENT

LastSeqNumTx
Last CC sequence number transmitted.

Type: u32
Default: 0
718
Read-Only Attribute
Description
LckRxState
LCK receive state.

Type: enum
Default: OFF
Possible Values:
Value
Description
OFF
LCK is off.
ON
LCK is on.
DISABLED LCK is disabled.

Name of maintenance point.

Type: string
NumOfRemoteMegEndPoints
Number of remote MEPs that the MP expects to send CC messages.

Type: u32
Default: 0
NumOfRemoteMegEndPointsDown
Number of remote MEPs that have not sent CC messages.

Type: u32
Default: 0
NumOfRemoteMegEndPointsUp
Number of remote MEPs that have sent CC messages.

Type: u32
Default: 0
NumOfTimeouts
Number of timeouts (message failed to arrive before timer expired).

Type: u32
Default: 0
NumOfUnexpectedMegEndPoints
Number of CC messages received from a MA/MEP ID or source MAC address that not is found in the expected
MEPs list for that MA/MEG.
Type: u32
Default: 0
NumOfUnexpectedMegIds
Number of received CC messages with a MA/MEG ID that is not configured on the receiving port.
Type: u32
Default: 0
NumOfUnexpectedMegLevels
Number of CC messages with an unexpected MD/ME level value.

Type: u32
Default: 0
NumOfUnexpectedPeriodValues
Number of received CC Messages for which the CC period value in the CC message does not match that
configured on the MA/MEG.
Type: u32
Default: 0
PortStatus
Locally transmitted port status.

Type: enum
Default: NONE
Possible Values:
Value
Description
NONE
Port Status TLV doesn't exist.

UP
RdiRxState
Port status up.
RDI receive state.

Type: enum
Default: OFF
Possible Values:
Value
Description
OFF
RDI is off.
ON
RDI is on.
DISABLED RDI is disabled.
719
EoamContChkRemoteResults
Read-Only Attribute
Description
RdiTxState
RDI transmit state.

Type: enum
Default: OFF
Possible Values:
Value
Description
OFF
RDI is off.
ON
RDI is on.
DISABLED RDI is disabled.
Description:
EOAM CC remote results.

Relations:
Side name
(Type)
Relative
Description
ResultParent
(ResultChild)
EoamContChkRemoteResults Writable Attributes

EoamContChkRemoteResults Read-Only Attributes

Read-Only Attribute
Description
State
BadContChkRxCount
Number of bad CC messages received. Number of CC messages received with an unexpected MEP ID,
MAC address, or period.
Type: u32
Default: 0
ContChkRxCount
Number of CC messages received.

Type: u32
Default: 0
GoodContChkRxCount
Number of good CC messages received. Number of CC messages received with an expected MEP ID,
MAC address, and period value.
Type: u32
Default: 0
720
Read-Only Attribute
Description
InterfaceStatus
Remote transmitted interface status.

Type: enum
Default: NONE
Possible Values:
Value
Description
NONE
Interface Status TLV doesn't exist.
UP
DOWN
TESTING
UNKNOWN
DORMANT
NOT_PRESENT

LastSeqNumRx
Last CC sequence number received.

Type: u32
Default: 0
MegEndPointAddr
MEP address.
Type: mac
Default: 00-00-00-00-00-00
MegEndPointId
MEP ID.
Type: u16
Default: 0
NumOfTimeouts
Number of timeouts.
Type: u32
Default: 0
Number of unexpected MEPs.

Type: u32
Default: 0
Number of unexpected MEG IDs.

Type: u32
Default: 0
Number of unexpected ME levels.

Type: u32
Default: 0
Number of unexpected CC period values.

Type: u32
Default: 0
NumOutOfSeq
Number of out of sequence messages.

Type: u32
Default: 0
PortStatus
Remote transmitted port status.

Type: enum
Default: NONE
Possible Values:
Value
Description
NONE
Port Status TLV doesn't exist.

UP
Port status up.
721
EoamContChkRemoteResultsCommand
Read-Only Attribute
Description
RdiState
RDI state.
Type: enum
Default: OFF
Possible Values:
Value Description
OFF
RDI is off.
ON
RDI is on.
EoamContChkRemoteResultsCommand
Description:
EOAM CC remote results command.

EoamContChkRemoteResultsCommand Writable Attributes

Writable Attribute
Description
Mep
Handle of the MEP for which results are being subscribed.

Type: handle
Default: 0
Subscribe
Specifies a subscribe or unsubscribe command.

Type: bool
Default: TRUE
Possible Values:
Value Description
TRUE
Subscribe to results.
FALSE Unsubscribe from results.
EoamContChkRemoteResultsCommand Read-Only Attributes

Read-Only Attribute
Description

EoamDelayMeasurementCommandConfig
Description:
EOAM DM command configuration.

722
EoamDelayMeasurementDetailedResultsCommand
EoamDelayMeasurementCommandConfig Writable Attributes

Writable Attribute
Description
Active, Name
DelayMeasurementTxRate
DM message transmit rate.

Type: enum
Default: DMRATE_1_PER_SEC
Possible Values:
Value
Description
DMRATE_10_PER_SEC 10 DMs per second.
DMRATE_1_PER_SEC
1 DM per second.
DMRATE_1_PER_MIN
1 DM per minute.
DMRATE_1_PER_10MIN 1 DM per 10 minutes.

DelayMeasurementTxType
DM message transmit type.

Type: enum
Default: SINGLE_MSG
Possible Values:
Value
Description
SINGLE_MSG Send a single DM message.
CONTINUOUS Send continuous DM messages.

Type: bool
Default: TRUE
Possible Values:
Value Description
TRUE
Send multicast DM messages.
FALSE Send unicast DM messages.

UnicastTargetList

Type: mac
Default: 00-00-00-00-00-00
EoamDelayMeasurementCommandConfig Read-Only Attributes

EoamDelayMeasurementDetailedResultsCommand
Description:
EOAM DM detailed results command.

EoamDelayMeasurementDetailedResultsCommand Writable Attributes

Writable Attribute
Description
Mep

Type: handle
Default: 0
723
EoamDelayMeasurementMessageRxResults
Writable Attribute
Description
Subscribe

Type: bool
Default: TRUE
Possible Values:
Value Description
TRUE
EoamDelayMeasurementDetailedResultsCommand Read-Only Attributes

Read-Only Attribute
Description

EoamDelayMeasurementMessageRxResults
Description:
EOAM DM Message RX results.

Relations:
Side name
(Type)
Relative
Description
ResultParent
(ResultChild)
EoamDelayMeasurementMessageRxResults Writable Attributes

EoamDelayMeasurementMessageRxResults Read-Only Attributes

Read-Only Attribute
Description
AvgBackwardDelayDmm
Average of the DMM backward delay values.

Type: double
Default: 0
AvgBackwardDelayVariationDmm
Average of the DMM backward delay variation values.

Type: double
Default: 0
BackwardDelayDmm
Backward delay measurement of the DMM in milliseconds.

Type: double
Default: 0
BackwardDelayVariationDmm
Difference between backward delay DMM values.

Type: double
Default: 0
DelayMeasurementMsgRxCount
Number of DM messages received.

Type: u32
Default: 0
724
EoamDelayMeasurementResponseRxResults
Read-Only Attribute
Description
MaxBackwardDelayDmm
Highest of the DMM backward delay values.

Type: double
Default: 0
MaxBackwardDelayVariationDmm
Highest of the DMM backward delay variation values.

Type: double
Default: 0
MinBackwardDelayDmm
Lowest of the DMM backward delay values.

Type: double
Default: 0
MinBackwardDelayVariationDmm
Lowest of the DMM backward delay variation values.

Type: double
Default: 0
SrcAddr
Source address.
Type: mac
Default: 00-00-00-00-00-00
TxTimeStampfDelta
Difference between Tx timestamp forward values.

Type: double
Default: 0
TxTimeStampfMsec
Tx timestamp forward milliseconds.

Type: double
Default: 0
TxTimeStampfSec
Tx timestamp forward seconds.

Type: u32
Default: 0
Description:
EOAM DM Response Rx results.

Relations:
Side name
(Type)
Relative
Description
ResultParent
(ResultChild)
EoamDelayMeasurementResponseRxResults Writable Attributes

EoamDelayMeasurementResponseRxResults Read-Only Attributes

Read-Only Attribute
Description
AvgBackwardDelayDmr
Average of the DMR backward delay values.

Type: double
Default: 0
725
Read-Only Attribute
Description
AvgBackwardDelayVariationDmr
Average of the DMR backward delay variation values.

Type: double
Default: 0
AvgForwardDelay
Average of the forward delay values.

Type: double
Default: 0
AvgForwardDelayVariation
Average of the forward delay variation values.

Type: double
Default: 0
AvgProcessingTime
Average of the processing time values.

Type: double
Default: 0
AvgRoundTripTime
Average of the round trip time values.

Type: double
Default: 0
AvgRoundTripTimeVariation
Average of the round trip time variation values.

Type: double
Default: 0
AvgRoundTripTransmissionTime
Average of the round trip transmission time values.

Type: double
Default: 0
BackwardDelayDmr
Backward delay measurement of the DMR in milliseconds.

Type: double
Default: 0
BackwardDelayVariationDmr
Difference between backward delay DMR values.

Type: double
Default: 0
DelayMeasurementResponseRxCount
Number of DM responses received.

Type: u32
Default: 0
ForwardDelay
Forward delay measurement in milliseconds.

Type: double
Default: 0
ForwardDelayVariation
Difference between forward delay values.

Type: double
Default: 0
MaxBackwardDelayDmr
Highest of the DMR backward delay values.

Type: double
Default: 0
MaxBackwardDelayVariationDmr
Highest of the DMR backward delay variation values.

Type: double
Default: 0
MaxForwardDelay
Highest of the forward delay values.

Type: double
Default: 0
MaxForwardDelayVariation
Highest of the forward delay variation values.

Type: double
Default: 0
MaxProcessingTime
Highest of the processing time values.

Type: double
Default: 0
726
Read-Only Attribute
Description
MaxRoundTripTime
Highest of the round trip time values.

Type: double
Default: 0
MaxRoundTripTimeVariation
Highest of the round trip time variation values.

Type: double
Default: 0
MaxRoundTripTransmissionTime
Highest of the round trip transmission time values.

Type: double
Default: 0
MinBackwardDelayDmr
Lowest of the DMR backward delay values.

Type: double
Default: 0
MinBackwardDelayVariationDmr
Lowest of the DMR backward delay variation values.

Type: double
Default: 0
MinForwardDelay
Lowest of the forward delay values.

Type: double
Default: 0
MinForwardDelayVariation
Lowest of the forward delay variation values.

Type: double
Default: 0
MinProcessingTime
Lowest of the processing time values.

Type: double
Default: 0
MinRoundTripTime
Lowest of the round trip time values.

Type: double
Default: 0
MinRoundTripTimeVariation
Lowest of the round trip time variation values.

Type: double
Default: 0
MinRoundTripTransmissionTime
Lowest of the round trip transmission time values.

Type: double
Default: 0
ProcessingTime
Internal processing time in milliseconds.

Type: double
Default: 0
RoundTripTime
Round trip time in milliseconds.

Type: double
Default: 0
RoundTripTimeVariation
Difference between round trip times.

Type: double
Default: 0
RoundTripTransmissionTime
Round trip transmission time in milliseconds.

Type: double
Default: 0
RxTimeStampfDelta
Difference between Rx timestamp forward values.

Type: double
Default: 0
RxTimeStampfMsec
Rx timestamp forward milliseconds.

Type: double
Default: 0
727
EoamDelayMeasurementResults
Read-Only Attribute
Description
RxTimeStampfSec
Rx timestamp forward seconds.

Type: u32
Default: 0
SrcAddr
Source address.
Type: mac
Default: 00-00-00-00-00-00
TxTimeStampbDelta
Difference between Tx timestamp back values.

Type: double
Default: 0
TxTimeStampbMsec
Tx timestamp back milliseconds.

Type: double
Default: 0
TxTimeStampbSec
Tx timestamp back seconds.

Type: u32
Default: 0
EoamDelayMeasurementResults
Description:
EOAM DM results.

Relations:
Side name
(Type)
Relative
Description
ResultParent
(ResultChild)
EoamDelayMeasurementResults Writable Attributes

EoamDelayMeasurementResults Read-Only Attributes

Read-Only Attribute
Description
DelayMeasurementMsgRxCount
Number of DM messages received.

Type: u32
Default: 0
DelayMeasurementMsgTxCount
Number of DM messages transmitted.

Type: u32
Default: 0
DelayMeasurementResponseRxCount
Number of DM responses received.

Type: u32
Default: 0
DelayMeasurementResponseTxCount
Number of DM responses transmitted.

Type: u32
Default: 0
728
EoamGenConfig
Read-Only Attribute
Description
Name of the maintenance point.

Type: string
EoamGenConfig
Description:
EOAM wizard generation configuration.

Parents: Project
EoamGenConfig Writable Attributes

Writable Attribute
Description
Active, Name
AisPriority
AIS priority for MEPs in the MEG.

Type: u8
Default: 0
Range: 0 - 7
ContChkPeriod
CC period for MEPs in the MEG.

Type: enum
Default: CCPERIOD1S
Possible Values:
Value
Description
CCPERIOD3MS
3 ms CC period.
CCPERIOD10MS
10 ms CC period.
CCPERIOD100MS 100 ms CC period.

CCPERIOD1S
1 sec CC period.
CCPERIOD10S
10 sec CC period.
CCPERIOD1MIN
1 min CC period.
CCPERIOD10MIN 10 min CC period.

ContChkPriority
CC priority for MEPs in the MEG.

Type: u8
Default: 0
Range: 0 - 7
DelayMeasurementPriority
DM priority for MEPs in the MEG.

Type: u8
Default: 0
Range: 0 - 7
DomainIdExpr
A regular expression for the Domain ID depending on Domain ID type.

DNS Like Name: Specifies the DNS like domain ID (e.g. Spirent.com).
MAC address + 2 Octets: Specifies the MAC address plus 2 octet domain ID in the format
XX-XX-XX-XX-XX-XX:XXXX.
Character String: Specifies the character string domain ID (e.g. Domain_1).
Type: string
Default: Domain_$
729
EoamGenConfig
Writable Attribute
Description
DomainIdIter
How to iterate Domain IDs.

Type: enum
Default: LEVEL
Possible Values:
Value
Description
LEVEL
Domain IDs are stepped in parallel with ME levels.
MEGID
Domain IDs are stepped in parallel with MEG IDs.
LEVELS_X_MEGID Domain IDs are continuously stepped for all ME levels and MEG IDs.
DomainIdType
Domain ID type for an IEEE MEG.

Type: enum
Default: NO_NAME
Possible Values:
Value
Description
NO_NAME
No domain ID.
DNS_LIKE
DNS like.
MAC_2_OCTETS MAC address plus 2 octets.

STRING
Character string.
DomainIdWildcard1
Wildcard character of the Domain ID expression for DNS Like Name, first half of MAC address + 2 Octets, and
Character String.
Type: string
Default: $
DomainIdWildcard1RangeStart
Starting value that will replace the first wildcard on Domain ID generation.
Type: u32
Default: 1
DomainIdWildcard1RangeStep
Stepping value applied to the first wildcard value on Domain ID generation.

Type: u32
Default: 1
Range: 1 - 4294967295
DomainIdWildcard2
Second wildcard character of the Domain ID expression for second half of MAC address + 2 Octets.
Type: string
Default: %
DomainIdWildcard2RangeStart
Starting value that will replace the second wildcard on Domain ID generation (MAC address + 2 Octets only).
Type: u32
Default: 1
DomainIdWildcard2RangeStep
Stepping value applied to the second wildcard value on Domain ID generation (MAC address + 2 Octets only).
Type: u32
Default: 1
Range: 1 - 4294967295
DutMacAddrFixedAcrossMegs
Use the same MAC addresses across all MA/MEGs.

Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
Use the same MAC addresses across all MA/MEGs.
FALSE Step the MAC addresses across the MA/MEGs.

DutMacAddrStart
Starting MAC address of a DUT(s).

Type: mac
Default: 00-00-00-00-00-01
DutMacAddrStep
Stepping value for the DUT MAC addresses. Each generated MEG will have a unique DUT MAC address.
Type: mac
Default: 00-00-00-00-00-01
730
EoamGenConfig
Writable Attribute
Description
DutMepIdFixedAcrossMegs
Use the same MEP IDs across all MA/MEGs.

Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
Use the same MEP IDs across all MA/MEGs.
FALSE Step the MEP IDs across the MA/MEGs.

DutMepIdStart
Starting MEP ID of a DUT(s).

Type: u16
Default: 1
Range: 1 - 8191
DutMepIdStep
Stepping value for the DUT MEP ID. Each generated MEG will have a unique DUT MEP ID.
Type: u16
Default: 1
Range: 1 - 8191
DutRole
Topology position of the DUT.

Type: enum
Default: MIP
Possible Values:
Value Description
EnableVlan1
MEP
DUT will act as a MEP and therefore a DUT MEP ID and MAC address will be added to the expected
MEPs list of the MEG.
MIP
DUT will act as a MIP. No entry will be added for the DUT in the expected MEPs list of the MEG.
Whether to create (outer) VLAN #1 for the generated routers.

Type: bool
Default: TRUE
Possible Values:
Value Description
TRUE
Create VLAN #1 (required for VLAN #2).
FALSE Do not create VLAN #1 (VLAN #2 disabled).

EnableVlan2
Whether to create (inner) VLAN #2 for the generated routers (requires VLAN #1).
Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
Create VLAN #2.
FALSE Do not create VLAN #2.

LckPriority
LCK priority for MEPs in the MEG.

Type: u8
Default: 0
Range: 0 - 7
LinkTracePriority
LT priority for MEPs in the MEG.

Type: u8
Default: 0
Range: 0 - 7
LoopbackPriority
LB priority for MEPs in the MEG.

Type: u8
Default: 0
Range: 0 - 7
LossMeasurementPriority
LM priority for MEPs in the MEG.

Type: u8
Default: 0
Range: 0 - 7
731
EoamGenConfig
Writable Attribute
Description
MacAddrStart
Starting MAC address for the generated routers.

Type: mac
Default: 00-10-94-00-00-00
MacAddrStep
Stepping value for the MAC addresses of the generated routers.

Type: mac
Default: 00-00-00-00-00-01
MegIdExpr
A regular expression for the MEG ID depending on MEG ID type.

Primary VID: Specifies the primary VID MEG ID.
Character String: Specifies the character string MEG ID.
2 Octets: Specifies the 2 octet MEG ID in the format XXXX.
RFC 2685 VPN ID: Specifies the RFC 2685 VPN MEG ID in the format XX-XX-XX:XX-XX-XX-XX.
Type: string
Default: MEG_$
MegIdType
MEG ID type for an IEEE MEG.

Type: enum
Default: STRING
Possible Values:
Value
Description
PRIMARY_VID
Primary VID.
STRING
Character string.
INT_2_OCTETS
2 octets.
RFC_2685_VPN_ID RFC 2685 VPN ID.

MegIdWildcard1
Wildcard character of the MEG ID expression for Primary VID, Character String, 2 Octets, and first half of RFC
2685 VPN ID.
Type: string
Default: $
MegIdWildcard1RangeStart
Starting value that will replace the first wildcard on MEG ID generation.
Type: u32
Default: 1
MegIdWildcard1RangeStep
Stepping value applied to the first wildcard value on MEG ID generation.

Type: u32
Default: 1
Range: 1 - 4294967295
MegIdWildcard2
Second wildcard character of the MEG ID expression for second half of RFC 2685 VPN ID.
Type: string
Default: %
MegIdWildcard2RangeStart
Starting value that will replace the second wildcard on MEG ID generation (RFC 2685 VPN ID only).
Type: u32
Default: 1
MegIdWildcard2RangeStep
Stepping value applied to the first wildcard value on MEG ID generation (RFC 2685 VPN ID only).
Type: u32
Default: 1
Range: 1 - 4294967295
MeLevels
A comma-delimited list of ME levels for the generated MEGs.

Type: string
Default: 1
MepIdStart
Starting MEP ID for the generated MEPs.

Type: u16
Default: 2
Range: 1 - 8191
732
EoamGenConfig
Writable Attribute
Description
MepIdStep
Stepping value for the MEP ID of the generated MEPs.

Type: u16
Default: 1
Range: 1 - 8191
NumDutMpsPerMeg
Number of DUT MPs in each MEG.

Type: u32
Default: 1
Range: 1 - 10
NumMegIds
Number of MEG IDs to generate.

Type: u32
Default: 1
Range: 1 - 8191
NumMepsPerMeg
Number of MEPs per port to generate per MEG. For example, with ports = 2 and NumMepsPerMeg = 3, total
number of MEPs in MEG is 6.
Type: u32
Default: 1
Range: 1 - 8191
NumMipsPerMep
Number of MIPs preceding each MEP. For multipoint MEGs, the closest MIP to the DUT is multipoint; this ensures
that a MEG residing on a port will take a single VLAN value.
Type: u32
Default: 0
Range: 0 - 253
OperationMode
Operation mode of the MEG.

Type: enum
Default: ITU_T
Possible Values:
Value Description
ITU_T Operates in accordance with the ITU-T spec.
IEEE
Operates in accordance with the IEEE spec.
PortList
List of handles to ports where EOAM topology will be generated.

Type: handle
Default: 0
Vlan1Start
Starting VLAN value for VLAN #1.

Type: u16
Default: 100
Range: 0 - 4095
Vlan1Step
Stepping value for VLAN #1.

Type: u16
Default: 1
Range: 1 - 4095
Vlan2Start
Starting VLAN value for VLAN #2.

Type: u16
Default: 100
Range: 0 - 4095
Vlan2Step
Stepping value for VLAN #2.

Type: u16
Default: 1
Range: 1 - 4095
EoamGenConfig Read-Only Attributes

Read-Only Attribute
Description
TotalMegs
Total number of EoamMegConfigs that will be generated given the current parameters.
Type: u16
Default: 1
733
EoamGenConfigExpandCommand
EoamGenConfigExpandCommand
Description:
Expand and generate an EOAM topology.

EoamGenConfigExpandCommand Writable Attributes

Writable Attribute
Description
ClearPreviousConfig
Prompts the option to clear any previous configuration.

Type: enum
Default: PROMPT
Possible Values:
Value
Description
PROMPT Prompt options.
YES
Clear all previous configuration.
NO
Keep existing configuration.
GenParam
Handle to a wizard generation configuration.

Type: handle
Default: 0
Determines whether EmulatedDevice or Host/Router objects should be created in the expansion.

Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
Expand creates EmulatedDevice objects with Role assigned to Host/Router.
FALSE Expand creates Host/Router objects.
EoamGenConfigExpandCommand Read-Only Attributes

Read-Only Attribute
Description

EoamGlobalConfig
Description:
EOAM Global configuration.

EoamGlobalConfig Writable Attributes

Writable Attribute
Description
Active, Name
734
EoamGlobalConfig
Writable Attribute
Description
CcOptionalTlvs
CC optional TLV XML string.

Type: string
Default: <frame><config><pdus /></config></frame>
DmCommonTimeSource
Whether to enable a common time source for DM.

Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
Enable a common time source for DM.
FALSE Do not enable a common time source for DM.

LbmOptionalTlvs
LBM optional TLV XML string.

Type: string
LbrOptionalTlvs
LBR optional TLV XML string.

Type: string
LmmTxFCfOffset
LMM Tx frame count forward offset value.

Type: s16
Default: 0
LmrRxFCfOffset
LMR Rx frame count forward offset value.

Type: s16
Default: 0
LmrRxFCfStart
LMR Rx frame count forward starting value.

Type: u32
Default: 1
LmrRxFCfStep
LMR Rx frame count forward stepping value.

Type: u16
Default: 1
LmrTxFCbOffset
LMR Tx frame count back offset value.

Type: s16
Default: 0
LmrTxFCbStart
LMR Tx frame count back starting value.

Type: u32
Default: 1
LmrTxFCbStep
LMR Tx frame count back stepping value.

Type: u16
Default: 1
LtmOptionalTlvs
LTM optional TLV XML string.

Type: string
Default: <frame><config><pdus><pdu name=\"proto1\"
pdu=\"EOAMTLV:LTMEgrID\"><Length>0000</Length></pdu></pdus></config></frame>
LtrOptionalTlvs
LTR optional TLV XML string.

Type: string
Default: <frame><config><pdus><pdu name=\"proto1\"
pdu=\"EOAMTLV:LTREgrID\"><Length>0000</Length></pdu><pdu name=\"RplyEgr_1\"
pdu=\"EOAMTLV:RplyEgr\"><Length>0000</Length></pdu></pdus></config></frame>
EoamGlobalConfig Read-Only Attributes

735
EoamLckCommandConfig
EoamLckCommandConfig
Description:
EOAM AIS command configuration.

EoamLckCommandConfig Writable Attributes

Writable Attribute
Description
Active, Name

Type: bool
Default: TRUE
Possible Values:
Value Description
TRUE
Send multicast LCK messages.
FALSE
UnicastTargetList

Type: mac
Default: 00-00-00-00-00-00
EoamLckCommandConfig Read-Only Attributes

EoamLckResults
Description:
EOAM LCK results.

Relations:
Side name
(Type)
Relative
Description
ResultParent
(ResultChild)
EoamLckResults Writable Attributes

EoamLckResults Read-Only Attributes

Read-Only Attribute
Description
LckRxCount
Number of LCK messages received. Received multicast LCK messages are reported per MEG, not per MP. All
multicast LCK messages received for a MEG are reported for all MPs in the MEG.
Type: u32
Default: 0
736
EoamLink
Read-Only Attribute
Description
LckRxPeriod
LCK period for MEPs.

Type: enum
Default: 0
Possible Values:
Value
Description
NONE
No period.
LCKPERIOD_1S
1 sec LCK period.
LCKPERIOD_1MIN 1 min LCK period.

INVALID
LckRxState
LCK receive state.

Type: enum
Default: OFF
Possible Values:
Value
Description
OFF
LCK is off.
ON
LCK is on.

LckTxCount
Number of LCK messages transmitted.

Type: u32
Default: 0
LckTxState
AIS transmit state.

Type: enum
Default: OFF
Possible Values:
Value
Description
OFF
LCK is off.
ON
LCK is on.

MP's name.
Type: string
EoamLink
Description:
Connects EOAM devices.

Relations:
Side name
(Type)
Relative
Description
Container
(ContainedLink)

(LinkDst)
LinkDstDevice
(LinkDstDevice)
EmulatedDevice
737
EoamLinkTraceCommandConfig
Side name
(Type)
Relative
Description
NetworkLinkSource
(LinkSrc)
EoamLink Writable Attributes

Writable Attribute
Description
Active, Name
EoamLink Read-Only Attributes

Read-Only Attribute
Description
LinkType
Type: string
EoamLinkTraceCommandConfig
Description:
EOAM LT command configuration.

EoamLinkTraceCommandConfig Writable Attributes

Writable Attribute
Description
Active, Name

Type: bool
Default: TRUE
Possible Values:
Value Description
TRUE
Send multicast LT messages.
FALSE Send unicast LT messages.

InitialTransactionId
Initial transaction ID.

Type: u32
Default: 1
LinkTraceTxType
LT message transmit type.

Type: enum
Default: SINGLE_MSG
Possible Values:
Value
Description
SINGLE_MSG Send a single LT message.
CONTINUOUS Send continuous LT messages.
Ttl
Time to live.
Type: u32
Default: 255
Range: 1 - 255
738
EoamLinkTraceDetailedResultsCommand
Writable Attribute
Description
UnicastTargetList

Type: mac
Default: 00-00-00-00-00-00
EoamLinkTraceCommandConfig Read-Only Attributes

EoamLinkTraceDetailedResultsCommand
Description:
EOAM LT detailed results command.

EoamLinkTraceDetailedResultsCommand Writable Attributes

Writable Attribute
Description
Mep

Type: handle
Default: 0
Subscribe

Type: bool
Default: TRUE
Possible Values:
Value Description
TRUE
EoamLinkTraceDetailedResultsCommand Read-Only Attributes

Read-Only Attribute
Description

EoamLinkTraceMessageRxResults
Description:
EOAM LT message RX results.

Relations:
739
EoamLinkTraceMessageTxResults
Side name
(Type)
Relative
Description
ResultParent
(ResultChild)
EoamLinkTraceMessageRxResults Writable Attributes

EoamLinkTraceMessageRxResults Read-Only Attributes

Read-Only Attribute
Description
LinkTraceMsgRxCount
Number of LT messages received.

Type: u32
Default: 0
RequestMsgLastTransactionIdRx
Last transaction ID of the received message.

Type: u32
Default: 0
SrcAddr
Source address.
Type: mac
Default: 00-00-00-00-00-00
EoamLinkTraceMessageTxResults
Description:
EOAM LT message TX results.

Relations:
Side name
(Type)
Relative
Description
ResultParent
(ResultChild)
EoamLinkTraceMessageTxResults Writable Attributes

EoamLinkTraceMessageTxResults Read-Only Attributes

Read-Only Attribute
Description
DstAddr
Destination address.
Type: mac
Default: 00-00-00-00-00-00
LinkTraceMsgTxCount
Number of LT messages transmitted.

Type: u32
Default: 0
NumOfTimeouts
Number of timeouts.
Type: u32
Default: 0
740
EoamLinkTracePathResults
Read-Only Attribute
Description
RequestMsgLastTransactionIdTx
Last transaction ID of the transmitted message.

Type: u32
Default: 0
EoamLinkTracePathResults
Description:
EOAM LT path results.

Relations:
Side name
(Type)
Relative
Description
ResultParent
(ResultChild)
EoamLinkTracePathResults Writable Attributes

EoamLinkTracePathResults Read-Only Attributes

Read-Only Attribute
Description
EgressAction
How the LTM will be transmitted through the MP.

Type: enum
Default: NO_ACTION
Possible Values:
Value
Description
NO_ACTION
Reply Egress TLV does not exist.
ACTION_OK
Frame will be forwarded.
ACTION_DOWN
MP is down.
ACTION_BLOCKED Frame will not be passed through.

ACTION_VID
IngressAction
Frame be filtered by egress filtering.
How the LTM will be received on the MP.

Type: enum
Default: NO_ACTION
Possible Values:
Value
Description
NO_ACTION
Reply Ingress TLV does not exist.
ACTION_OK
Frame will be passed through.
ACTION_DOWN
MP is down.
ACTION_BLOCKED Frame will not be passed through.

ACTION_VID
MaintenancePointAddr
Frame be filtered by ingress filtering.
Address of the maintenace point.

Type: mac
Default: 00-00-00-00-00-00
741
EoamLinkTraceResponseRxResults
Read-Only Attribute
Description
RelayAction
Relay action through the MP.

Type: enum
Default: NO_ACTION
Possible Values:
Value
Description
NO_ACTION No action.
RLY_HIT
Relay Hit.
RLY_FDB
Relay filtering database.
RLY_MPDB
Relay MP database.
ResponseMsgLastTransactionIdRx
Last transaction ID of the received response.

Type: u32
Default: 0
Ttl
Time to live.
Type: u32
Default: 0
EoamLinkTraceResponseRxResults
Description:
EOAM LT response RX results.

Relations:
Side name
(Type)
Relative
Description
ResultParent
(ResultChild)
EoamLinkTraceResponseRxResults Writable Attributes

EoamLinkTraceResponseRxResults Read-Only Attributes

Read-Only Attribute
Description
LinkTraceResponseRxCount
Number of LT responses received.

Type: u32
Default: 0

Type: u32
Default: 0
SrcAddr
Source address.
Type: mac
Default: 00-00-00-00-00-00
742
EoamLinkTraceResponseTxResults
EoamLinkTraceResponseTxResults
Description:
EOAM LT response TX results.

Relations:
Side name
(Type)
Relative
Description
ResultParent
(ResultChild)
EoamLinkTraceResponseTxResults Writable Attributes

EoamLinkTraceResponseTxResults Read-Only Attributes

Read-Only Attribute
Description
DstAddr
Type: mac
Default: 00-00-00-00-00-00
LinkTraceResponseTxCount
Number of LT responses transmitted.

Type: u32
Default: 0
ResponseMsgLastTransactionIdTx
Last transaction ID of the transmitted response.

Type: u32
Default: 0
EoamLinkTraceResults
Description:
EOAM LT results.

Relations:
Side name
(Type)
Relative
Description
ResultParent
(ResultChild)
EoamLinkTraceResults Writable Attributes

743
EoamLoopbackCommandConfig
EoamLinkTraceResults Read-Only Attributes

Read-Only Attribute
Description
DroppedPktCount
Number of unserviceable packets that were dropped (as indicated by gaps in sequence
numbers).
Type: u32
Default: 0
LinkTraceMsgRxCount
Number of LT messages received.

Type: u32
Default: 0
LinkTraceMsgTxCount
Number of LT messages transmitted.

Type: u32
Default: 0
LinkTraceResponseRxCount
Number of LT responses received.

Type: u32
Default: 0
LinkTraceResponseTxCount
Number of LT responses transmitted.

Type: u32
Default: 0
Name of maintenance point..

Type: string
NumOfTimeouts
Number of timeouts.
Type: u32
Default: 0
Description:
EOAM loopback command configuration.

EoamLoopbackCommandConfig Writable Attributes

Writable Attribute
Description
Active, Name
744
Writable Attribute
Description
DataPattern
NOTE: This is deprecated. It will be removed in subsequent releases, so it is recommended that you do not use
it.
Instead of using this attribute, use the LbmOptionalTlvs attribute in the EoamGlobalConfig or EoamMaintenancePointConfig
objects.
Type of data pattern.
Type: enum
Default: CONST_AA
Possible Values:
Value
Description
CONST_AA AA
CONST_55 55
CONST_A5 A5
CONST_5A 5A
CONST_F0 F0
CONST_0F 0F
CONST_FF FF

Type: bool
Default: TRUE
Possible Values:
Value Description
TRUE
Send multicast LB messages.
FALSE Send unicast LB messages.

FillLength
it.
See the DataPattern attribute for an alternate attribute to use.
Fill length.
Type: u16
Default: 1
Range: 0 - 16320
FillType
it.
See the DataPattern attribute for an alternate attribute to use.
Fill type.
Type: enum
Default: DISABLED
Possible Values:
Value
Description
DISABLED No fill type.
DATA
Data pattern.
TEST
Test pattern.
InitialTransactionId
Initial transaction ID.

Type: u32
Default: 1
LoopbackTxType
LB message transmit type.

Type: enum
Default: SINGLE_MSG
Possible Values:
Value
Description
SINGLE_MSG Send a single LB message.
CONTINUOUS Send continuous LB messages.
745
EoamLoopbackDetailedResultsCommand
Writable Attribute
Description
OperationMode
Operation mode for the command. This should match the MEG's operation mode that is being targeted.
Type: enum
Default: ITU_T
Possible Values:
Value Description
ITU_T Send LB messages to an ITU-T MEG.
IEEE
TestPattern
Send LB messages to an IEEE MEG.
it.
Instead of using this attribute, use the LbmOptionalTlvs attribute in the EoamGlobalConfig or EoamMaintenancePointConfig
objects.
Type of test pattern.
Type: enum
Default: NULL_WO_CRC
Possible Values:
Value
Description
NULL_WO_CRC Null without CRC.
NULL_W_CRC
Null with CRC.
PRBS_WO_CRC PRBS without CRC.

PRBS_W_CRC
UnicastTargetList
PRBS with CRC.

Type: mac
Default: 00-00-00-00-00-00
EoamLoopbackCommandConfig Read-Only Attributes

EoamLoopbackDetailedResultsCommand
Description:
EOAM LB detailed results command.

EoamLoopbackDetailedResultsCommand Writable Attributes

Writable Attribute
Description
Mep

Type: handle
Default: 0
Subscribe

Type: bool
Default: TRUE
Possible Values:
Value Description
TRUE
746
EoamLoopbackMessageRxResults
EoamLoopbackDetailedResultsCommand Read-Only Attributes

Read-Only Attribute
Description

EoamLoopbackMessageRxResults
Description:
EOAM LB Message Rx results.

Relations:
Side name
(Type)
Relative
Description
ResultParent
(ResultChild)
EoamLoopbackMessageRxResults Writable Attributes

EoamLoopbackMessageRxResults Read-Only Attributes

Read-Only Attribute
Description
LoopbackMsgRxCount
Number of LB messages received.

Type: u32
Default: 0
RequestMsgLastTransactionIdRx
Last transaction ID of the received message.

Type: u32
Default: 0
SrcAddr
Source address.
Type: mac
Default: 00-00-00-00-00-00
EoamLoopbackMessageTxResults
Description:
EOAM LB message TX results.

Relations:
747
EoamLoopbackResponseRxResults
Side name
(Type)
Relative
Description
ResultParent
(ResultChild)
EoamLoopbackMessageTxResults Writable Attributes

EoamLoopbackMessageTxResults Read-Only Attributes

Read-Only Attribute
Description
DstAddr
Type: mac
Default: 00-00-00-00-00-00
LoopbackMsgTxCount
Number of LB messages transmitted.

Type: u32
Default: 0
NumOfTimeouts
Number of timeouts.
Type: u32
Default: 0
RequestMsgLastTransactionIdTx
Last transaction ID of the transmitted message.

Type: u32
Default: 0
EoamLoopbackResponseRxResults
Description:
EOAM LB response RX results.

Relations:
Side name
(Type)
Relative
Description
ResultParent
(ResultChild)
EoamLoopbackResponseRxResults Writable Attributes

EoamLoopbackResponseRxResults Read-Only Attributes

Read-Only Attribute
Description
LoopbackResponseRxCount
Number of LB response messages received.

Type: u32
Default: 0
NumOfTransactionIdMismatches
Number of transaction ID mismatches.

Type: u32
Default: 0
748
EoamLoopbackResponseTxResults
Read-Only Attribute
Description

Type: u32
Default: 0
SrcAddr
Source address.
Type: mac
Default: 00-00-00-00-00-00
EoamLoopbackResponseTxResults
Description:
EOAM loopback response TX results.

Relations:
Side name
(Type)
Relative
Description
ResultParent
(ResultChild)
EoamLoopbackResponseTxResults Writable Attributes

EoamLoopbackResponseTxResults Read-Only Attributes

Read-Only Attribute
Description
DstAddr
Type: mac
Default: 00-00-00-00-00-00
LoopbackResponseTxCount
Number of LB response messages transmitted.

Type: u32
Default: 0
ResponseMsgLastTransactionIdTx
Last transaction ID of the transmitted response.

Type: u32
Default: 0
EoamLoopbackResults
Description:
EOAM loopback results.

Relations:
749
EoamLossMeasurementCommandConfig
Side name
(Type)
Relative
Description
ResultParent
(ResultChild)
EoamLoopbackResults Writable Attributes

EoamLoopbackResults Read-Only Attributes

Read-Only Attribute
Description
DroppedPktCount
Number of unserviceable packets that were dropped (as indicated by gaps in sequence
numbers).
Type: u32
Default: 0
LoopbackMsgRxCount
Number of LB messages received.

Type: u32
Default: 0
LoopbackMsgTxCount
Number of LB messages transmitted.

Type: u32
Default: 0
LoopbackResponseRxCount
Number of LB responses received.

Type: u32
Default: 0
LoopbackResponseTxCount
Number of LB responses transmitted.

Type: u32
Default: 0
MP's name.
Type: string
NumOfTimeouts
Number of timeouts.
Type: u32
Default: 0
NumOfTransactionIdMismatches
Number of transaction ID mismatches.

Type: u32
Default: 0
EoamLossMeasurementCommandConfig
Description:
EOAM LM command configuration.

EoamLossMeasurementCommandConfig Writable Attributes

Writable Attribute
Description
Active, Name
750
EoamLossMeasurementDetailedResultsCommand
Writable Attribute
Description

Type: bool
Default: TRUE
Possible Values:
Value Description
TRUE
Send multicast LM messages.
FALSE Send unicast LM messages.

LossMeasurementTxRate
LM message transmit rate.

Type: enum
Default: LMRATE_1_PER_SEC
Possible Values:
Value
Description
LMRATE_10_PER_SEC 10 LMs per second.
LMRATE_1_PER_SEC
1 LM per second.
LMRATE_1_PER_MIN
1 LM per minute.
LMRATE_1_PER_10MIN 1 LM per 10 minutes.

LossMeasurementTxType
LM message transmit type.

Type: enum
Default: SINGLE_MSG
Possible Values:
Value
Description
SINGLE_MSG Send a single LM message.
CONTINUOUS Send continuous LM messages.
TxFCfMode
Transmit frame count forward mode.

Type: enum
Default: STEP
Possible Values:
Value
Description
STATIC Use the same TxFCf for each LM message.
STEP
Step the TxFCf for each LM message.
TxFCfStep
TxFCf step value.

Type: u16
Default: 1
TxFCfValue
TxFCf value.
Type: u32
Default: 1
UnicastTargetList

Type: mac
Default: 00-00-00-00-00-00
EoamLossMeasurementCommandConfig Read-Only Attributes

EoamLossMeasurementDetailedResultsCommand
Description:
EOAM LM detailed results command.
751
EoamLossMeasurementMessageRxResults

EoamLossMeasurementDetailedResultsCommand Writable Attributes

Writable Attribute
Description
Mep

Type: handle
Default: 0
Subscribe

Type: bool
Default: TRUE
Possible Values:
Value Description
TRUE
EoamLossMeasurementDetailedResultsCommand Read-Only Attributes

Read-Only Attribute
Description

EoamLossMeasurementMessageRxResults
Description:
EOAM LM Message Rx results.

Relations:
Side name
(Type)
Relative
Description
ResultParent
(ResultChild)
EoamLossMeasurementMessageRxResults Writable Attributes

EoamLossMeasurementMessageRxResults Read-Only Attributes

Read-Only Attribute
Description
LossMeasurementMsgRxCount
Number of LM messages received.

Type: u32
Default: 0
SrcAddr
Source address.
Type: mac
Default: 00-00-00-00-00-00
752
EoamLossMeasurementResponseRxResults
Read-Only Attribute
Description
TxFCf
Transmit frame count forward.

Type: u32
Default: 0
EoamLossMeasurementResponseRxResults
Description:
EOAM LM Response Rx results.

Relations:
Side name
(Type)
Relative
Description
ResultParent
(ResultChild)
EoamLossMeasurementResponseRxResults Writable Attributes

EoamLossMeasurementResponseRxResults Read-Only Attributes

Read-Only Attribute
Description
FrameLossFarEnd
Number of frames sent minus number of frames received.

Type: s32
Default: 0
LossMeasurementResponseRxCount
Number of LM responses received.

Type: u32
Default: 0
RxFCf
Configured received frame counter at the time of LMM reception.

Type: u32
Default: 0
SrcAddr
Source address.
Type: mac
Default: 00-00-00-00-00-00
TxFCb
Configured local transmit frame counter at the time of LMR transmission. .

Type: u32
Default: 0
TxFCf
Configured transmitted frame count at the LMM source.

Type: u32
Default: 0
EoamLossMeasurementResults
Description:
753
EOAM LM results.

Relations:
Side name
(Type)
Relative
Description
ResultParent
(ResultChild)
EoamLossMeasurementResults Writable Attributes

EoamLossMeasurementResults Read-Only Attributes

Read-Only Attribute
Description
LossMeasurementMsgRxCount
Number of LM messages received.

Type: u32
Default: 0
LossMeasurementMsgTxCount
Number of LM messages transmitted.

Type: u32
Default: 0
LossMeasurementResponseRxCount
Number of LM responses received.

Type: u32
Default: 0
LossMeasurementResponseTxCount
Number of LM responses transmitted.

Type: u32
Default: 0
Name of the maintenance point.

Type: string
TxFCf
Transmit frame count forward.

Type: u32
Default: 0
Description:
EOAM MP configuration.

Parents: EoamNodeConfig
Children: EoamAisCommandConfig, EoamContChkCommandConfig, EoamDelayMeasurementCommandConfig, EoamLckCommandConfig,
EoamLinkTraceCommandConfig, EoamLoopbackCommandConfig, EoamLossMeasurementCommandConfig
Result children (automatically created): EoamAisResults, EoamContChkLocalResults, EoamContChkRemoteResults,
EoamDelayMeasurementMessageRxResults, EoamDelayMeasurementResponseRxResults, EoamDelayMeasurementResults, EoamLckResults,
EoamLinkTraceMessageRxResults, EoamLinkTraceMessageTxResults, EoamLinkTracePathResults, EoamLinkTraceResponseRxResults,
EoamLinkTraceResponseTxResults, EoamLinkTraceResults, EoamLoopbackMessageRxResults, EoamLoopbackMessageTxResults,
EoamLoopbackResponseRxResults, EoamLoopbackResponseTxResults, EoamLoopbackResults, EoamLossMeasurementMessageRxResults,
EoamLossMeasurementResponseRxResults, EoamLossMeasurementResults
Relations:
754
Side name
(Type)
Relative
Description
Meg
(MegAssociation)
EoamMegConfig
Relationship between the EOAM MP

configuration and the EOAM MEG
configuration.
ResultChild
(ResultChild)
EoamAisResults, EoamContChkLocalResults, EoamContChkRemoteResults,

EoamDelayMeasurementMessageRxResults,
EoamDelayMeasurementResponseRxResults, EoamDelayMeasurementResults,
EoamLckResults, EoamLinkTraceMessageRxResults, EoamLinkTraceMessageTxResults,
EoamLinkTracePathResults, EoamLinkTraceResponseRxResults,
EoamLinkTraceResponseTxResults, EoamLinkTraceResults,
EoamLoopbackMessageRxResults, EoamLoopbackMessageTxResults,
EoamLoopbackResponseRxResults, EoamLoopbackResponseTxResults,
EoamLoopbackResults, EoamLossMeasurementMessageRxResults,
EoamLossMeasurementResponseRxResults, EoamLossMeasurementResults
Use this to connect a results object to

an object.
EoamMaintenancePointConfig Writable Attributes

Writable Attribute
Description
Active, Name
CcOptionalTlvs
CC optional TLV XML string.

Type: string
DmmDelay
Delay value of the DMM in 10ms increments.

Type: u8
Default: 0
Range: 0 - 100
DmrDelay
Delay value of the DMR in 10ms increments.

Type: u8
Default: 0
Range: 0 - 100
EnableAisRx
MP's ability to receive AIS messages.

Type: bool
Default: TRUE
Possible Values:
Value Description
TRUE
Receive AIS messages.
FALSE Drop AIS messages.

EnableDelayMeasurementResponse
MP's ability to respond to DM messages.

Type: bool
Default: TRUE
Possible Values:
Value Description
TRUE
Respond to DM messages.
FALSE Do not respond to DM messages.

EnableLckRx
MP's ability to receive LCK messages.

Type: bool
Default: TRUE
Possible Values:
Value Description
TRUE
Receive LCK messages.
FALSE Drop LCK messages.
755
Writable Attribute
Description
EnableLinkTraceResponse
MP's ability to respond to LT messages.

Type: bool
Default: TRUE
Possible Values:
Value Description
TRUE
Respond to LT messages.
FALSE Do not respond to LT messages.

EnableLoopbackResponse
MP's ability to respond to LB messages.

Type: bool
Default: TRUE
Possible Values:
Value Description
TRUE
Respond to LB messages.
FALSE Do not respond to LB messages.

EnableLossMeasurementResponse
MP's ability to respond to LM messages.

Type: bool
Default: TRUE
Possible Values:
Value Description
TRUE
Respond to LM messages.
FALSE Do not respond to LM messages.

InitialCcSeqNum
Initial CC sequence number in an IEEE MEG.

Type: u32
Default: 1
LbmOptionalTlvs
LBM optional TLV XML string.

Type: string
LbrOptionalTlvs
LBR optional TLV XML string.

Type: string
LmmTxFCfOffset
LMM Tx frame count forward offset value.

Type: s16
Default: 0
LmrRxFCfOffset

Type: s16
Default: 0
LmrRxFCfStart
LMR Rx frame count forward starting value.

Type: u32
Default: 0
LmrRxFCfStep
LMR Rx frame count forward stepping value.

Type: u16
Default: 0
LmrTxFCbOffset

Type: s16
Default: 0
LmrTxFCbStart
LMR Tx frame count back starting value.

Type: u32
Default: 0
LmrTxFCbStep
LMR Tx frame count back stepping value.

Type: u16
Default: 0
756
Writable Attribute
Description
LtmOptionalTlvs
LTM optional TLV XML string.

Type: string
LtrOptionalTlvs
LTR optional TLV XML string.

Type: string
MegEndPointId
MEP's ID. This value should be unique within the MEG.

Type: u16
Default: 1
Range: 1 - 8191
OverrideAisPeriod
An override AIS period for this MEP.

Type: enum
Default: NONE
Possible Values:
Value
Description
NONE
No override value specified. Use the AIS period from the associated MEG.
AISPERIOD_1S
1 sec AIS period.

OverrideContChkPeriod
An override CC period for this MEP.

Type: enum
Default: NONE
Possible Values:
Value
Description
NONE
No override value specified. Use the CC period from the associated MEG.
CCPERIOD_3MS
3 ms CC period.
CCPERIOD_10MS
10 ms CC period.
CCPERIOD_100MS 100 ms CC period.

CCPERIOD_1S
1 sec CC period.
CCPERIOD_10S
10 sec CC period.
CCPERIOD_1MIN
1 min CC period.
CCPERIOD_10MIN 10 min CC period.

OverrideLckPeriod
An override LCK period for this MEP.

Type: enum
Default: NONE
Possible Values:
Value
Description
NONE
No override value specified. Use the LCK period from the associated MEG.
LCKPERIOD_1S
1 sec LCK period.

OverrideMeLevel
An override ME level for this MEP.

Type: enum
Default: NONE
Possible Values:
Value
Description
NONE
No override value specified. Use the ME level from the associated MEG.
LEVEL_0 Level 0.
LEVEL_1 Level 1.
LEVEL_2 Level 2.
LEVEL_3 Level 3.
LEVEL_4 Level 4.
LEVEL_5 Level 5.
LEVEL_6 Level 6.
LEVEL_7 Level 7.
757
EoamMegConfig
Writable Attribute
Description
Rdi
How the RDI bit is handled.

Type: enum
Default: AUTO
Possible Values:
Value
Description
AUTO
Default handling.
ALWAYS_OFF Always off.

ALWAYS_ON
Always on.
EoamMaintenancePointConfig Read-Only Attributes

Read-Only Attribute
Description
MaintenancePointType
MP type.
Type: enum
Default: MEP
Possible Values:
Value Description
MEP
Maintenance End Point.
MIP
Maintenance Intermediate Point.
EoamMegConfig
Description:
EOAM MEG configuration.

Parents: Project
Children: EoamRemoteMegEndPointConfig
Result children (automatically created): EoamMegResults
Relations:
Side name
(Type)
Relative
Description
MaintenancePoint
(MegAssociation)
Relationship between the EOAM MP configuration and the EOAM

MEG configuration.
ResultChild
(ResultChild)
EoamMegResults
EoamMegConfig Writable Attributes

Writable Attribute
Description
Active, Name
AisPeriod
AIS period for MEPs in the MEG.

Type: enum
Default: AISPERIOD_1S
Possible Values:
Value
Description
AISPERIOD_1S
1 sec AIS period.
758
EoamMegConfig
Writable Attribute
Description
AisPriority
AIS priority for MEPs in the MEG.

Type: u8
Default: 0
Range: 0 - 7
ContChkPeriod
CC period for MEPs in the MEG.

Type: enum
Default: CCPERIOD_1S
Possible Values:
Value
Description
CCPERIOD_3MS
3 ms CC period.
CCPERIOD_10MS
10 ms CC period.
CCPERIOD_100MS 100 ms CC period.

CCPERIOD_1S
1 sec CC period.
CCPERIOD_10S
10 sec CC period.
CCPERIOD_1MIN
1 min CC period.
CCPERIOD_10MIN 10 min CC period.

ContChkPriority
CC priority for MEPs in the MEG.

Type: u8
Default: 0
Range: 0 - 7
DelayMeasurementPriority
DM priority for MEPs in the MEG.

Type: u8
Default: 0
Range: 0 - 7
DomainId_DnsLike
DNS like domain ID.

Type: string
Default: Spirent.com
DomainId_Mac_2Octets
MAC address plus 2 octet domain ID in the format XX-XX-XX-XX-XX-XX:XXXX.

Type: string
Default: 00-00-00-00-00-00:0000
DomainId_String
Character string domain ID.

Type: string
Default: Domain_
DomainIdType
Domain ID type for an IEEE MEG.

Type: enum
Default: NO_NAME
Possible Values:
Value
Description
NO_NAME
No domain ID.
DNS_LIKE
DNS like.
MAC_2_OCTETS MAC address plus 2 octets.

STRING
LckPeriod
Character string.
LCK period for MEPs in the MEG.

Type: enum
Default: LCKPERIOD_1S
Possible Values:
Value
Description
LCKPERIOD_1S
1 sec LCK period.
759
EoamMegConfig
Writable Attribute
Description
LckPriority
LCK priority for MEPs in the MEG.

Type: u8
Default: 0
Range: 0 - 7
LinkTracePriority
LT priority for MEPs in the MEG.

Type: u8
Default: 0
Range: 0 - 7
LoopbackPriority
LB priority for MEPs in the MEG.

Type: u8
Default: 0
Range: 0 - 7
LossMeasurementPriority
LM priority for MEPs in the MEG.

Type: u8
Default: 0
Range: 0 - 7
MegId_2Octets
2-octet MEG ID in the format XXXX.

Type: string
Default: 0000
MegId_IccString
ICC string MEG ID for an ITU-T MEG.

Type: string
Default: MEG_
MegId_PrimaryVid
Primary VID MEG ID.

Type: u16
Default: 100
Range: 0 - 4095
MegId_String
Character string MEG ID.

Type: string
Default: MA_
MegId_VpnId
RFC 2685 VPN MEG ID in the format XX-XX-XX:XX-XX-XX-XX.

Type: string
Default: 00-00-00:00-00-00-00
MegIdType
MEG ID type for an IEEE MEG.

Type: enum
Default: STRING
Possible Values:
Value
Description
PRIMARY_VID
Primary VID.
STRING
Character string.
INT_2_OCTETS
2 octets.
RFC_2685_VPN_ID RFC 2685 VPN ID.

MeLevel
ME level of the MEG.

Type: u8
Default: 1
Range: 0 - 7
OperationMode
Operation mode of the MEG.

Type: enum
Default: ITU_T
Possible Values:
Value Description
ITU_T Operates in accordance with the ITU-T spec.
IEEE
Operates in accordance with the IEEE spec.
760
EoamMegResults
EoamMegConfig Read-Only Attributes

EoamMegResults
Description:
EOAM MEG results.

Parents: EoamMegConfig
Relations:
Side name
(Type)
Relative
Description
ResultParent
(ResultChild)
EoamMegConfig
EoamMegResults Writable Attributes

EoamMegResults Read-Only Attributes

Read-Only Attribute
Description
BadContChkRxCount
Number of bad CC messages received from all MEPs in the MA/MEG. Number of CC messages received
with an unexpected MEP ID, MAC address, or period.
Type: u32
Default: 0
ContChkRxState
CC receive state.
Type: enum
Default: DOWN
Possible Values:
Value Description
DOWN CC messages are not being received.
UP
ContChkTxState
CC messages are being received.
CC transmit state.
Type: enum
Default: DOWN
Possible Values:
Value Description
DOWN CC messages are not being transmitted.
UP
CC messages are being transmitted.
DomainId
ID of the Domain.
Type: string
DroppedPktCount
Type: u32
Default: 0
MegId
ID of the MA/MEG.
Type: string
761
EoamNodeConfig
Read-Only Attribute
Description
MeLevel
MD/ME level of the MA/MEG.

Type: u8
Default: 1
NumOfMegEndPoints
Number of MEPs in the MEG.

Type: u32
Default: 0
NumOfTimeouts
Number of timeouts in the MEG (message failed to arrive before timer expired).
Type: u32
Default: 0
Number of CC messages received from a MEP ID or source MAC address that not is found in the expected
MEPs list for that MA/MEG.
Type: u32
Default: 0
Number of received EOAM messages with an unexpected MA/MEG ID value.

Type: u32
Default: 0
Number of EOAM messages with an unexpected MD/ME level value.

Type: u32
Default: 0
Number of received EOAM messages with an unexpected period value.

Type: u32
Default: 0
PortName
Name of the port.

Type: string
EoamNodeConfig
Description:
EOAM node configuration.

Children: EoamMaintenancePointConfig
Relations:
Side name
(Type)
Relative
Description
UsesIf
(UsesIf)

EoamNodeConfig Writable Attributes

Writable Attribute
Description
Active, Name
762

EoamPortConfig
Writable Attribute
Description

Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
EoamNodeConfig Read-Only Attributes

EoamPortConfig
Description:
EOAM port configuration.

Result children (automatically created): EoamPortResults
Relations:
Side name
(Type)
Relative
Description
ResultChild
(ResultChild)
EoamPortResults
EoamPortConfig Writable Attributes

Writable Attribute
Description
Active, Name
CVlanEtherType
do not use it.
Customer VLAN ether type.
Type: string
Default: 0000
DisableContChkRx
Whether to disable the receiving of CC messages.

Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
Do not process incoming CC messages.
FALSE Process incoming CC messages.

EchoTlvsInDelayMeasurementResponse
Whether to echo TLVs in DM response.

Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
Echo TLVs in DM response.
FALSE Do not echo TLVs in DM response.
763
EoamPortConfig
Writable Attribute
Description
EncodeMeLevel
Whether to encode the ME level in the multicast DA.

Type: bool
Default: TRUE
Possible Values:
Value Description
TRUE
Encode ME level in multicast DA.
FALSE Do not encode ME level in multicast DA.

EtherType
do not use it.
EOAM ether type.
Type: string
Default: 8902
ImmediateLinkTraceResponse
Whether to immediately send an LT response.

Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
Send the LT response immediately.
FALSE Send the LT response on a random delay.

ImmediateLoopbackResponse
Whether to immediately send an LB response.

Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
Send the LB response immediately.
FALSE Send the LB response on a random delay.

LinkTraceResponseRelayAction
Relay action for Link-Trace.

Type: enum
Default: DEFAULT
Possible Values:
Value
Description
DEFAULT
Default.
NO_ACTION No action.
RLY_FDB
Use relay filtering database.
RLY_MPDB
Use relay MP database.
MulticastMacType1
Multicast DA Class 1: CCM, LBM, and so on.

Type: mac
Default: 01-80-c2-00-00-30
MulticastMacType2
Multicast DA Class 2: LTM.

Type: mac
Default: 01-80-c2-00-00-38
SVlanEtherType
do not use it.
Service VLAN ether type.
Type: string
Default: 0000
EoamPortConfig Read-Only Attributes

764
EoamPortResults
EoamPortResults
Description:
EOAM port results.

Parents: EoamPortConfig
Relations:
Side name
(Type)
Relative
Description
ResultParent
(ResultChild)
EoamPortConfig
EoamPortResults Writable Attributes

EoamPortResults Read-Only Attributes

Read-Only Attribute
Description
AisRxCount
Number of AIS messages received on this port.

Type: u32
Default: 0
AisTxCount
Number of AIS messages transmitted from this port.

Type: u32
Default: 0
ContChkRxCount
Number of CC messages received on this port.

Type: u32
Default: 0
ContChkTxCount
Number of CC messages transmitted from this port.

Type: u32
Default: 0
DelayMeasurementRxCount
Number of DM messages received on this port.

Type: u32
Default: 0
DelayMeasurementTxCount
Number of DM messages transmitted from this port.

Type: u32
Default: 0
DroppedPktCount
Type: u32
Default: 0
LckRxCount
Number of LCK messages received on this port.

Type: u32
Default: 0
LckTxCount
Number of LCK messages transmitted from this port.

Type: u32
Default: 0
LinkTraceRxCount
Number of LT messages received on this port.

Type: u32
Default: 0
LinkTraceTxCount
Number of LT messages transmitted from this port.

Type: u32
Default: 0
765
EoamRemoteMegEndPointConfig
Read-Only Attribute
Description
LoopbackRxCount
Number of LB messages received on this port.

Type: u32
Default: 0
LoopbackTxCount
Number of LB messages transmitted from this port.

Type: u32
Default: 0
LossMeasurementRxCount
Number of LM messages received on this port.

Type: u32
Default: 0
LossMeasurementTxCount
Number of LM messages transmitted from this port.

Type: u32
Default: 0
NumOfMegEndPoints
Number of MEPs on this port.

Type: u32
Default: 0
NumOfMegs
Number of MEGs on this port.

Type: u32
Default: 0
PortName
Name of the port.

Type: string
EoamRemoteMegEndPointConfig
Description:
EOAM remote MEP configuration.

Parents: EoamMegConfig
EoamRemoteMegEndPointConfig Writable Attributes

Writable Attribute
Description
Active, Name
RemoteMacAddr
Remote MEP's MAC address.

Type: mac
Default: 00-00-01-00-00-02
RemoteMegEndPointId
Remote MEP's ID.

Type: u16
Default: 1
Range: 1 - 8191
EoamRemoteMegEndPointConfig Read-Only Attributes

766
EoamRequestLinkTracePathCommand
EoamRequestLinkTracePathCommand
Description:
EOAM request LT path command.

EoamRequestLinkTracePathCommand Writable Attributes

Writable Attribute
Description
Mep
Handle of the MEP to obtain an LT path from.

Type: handle
Default: 0
TargetMaintenancePointAddr
Targeted MP address to obtain an LT path from.

Type: mac
Default: 00-00-00-00-00-00
EoamRequestLinkTracePathCommand Read-Only Attributes

Read-Only Attribute
Description

EoamResetMpsToUseDefaultLmrFrameCountValuesCommand
Description:
EOAM reset MPs to use default LMR frame count values.

EoamResetMpsToUseDefaultLmrFrameCountValuesCommand Writable Attributes

Writable Attribute
Description
MpList
List of MPs.
Type: handle
Default: 0
EoamResetMpsToUseDefaultLmrFrameCountValuesCommand Read-Only Attributes

Read-Only Attribute
Description

767
EoamResetMpsToUseDefaultLossMeasurementOffsetsCommand
EoamResetMpsToUseDefaultLossMeasurementOffsetsCommand
Description:
EOAM Reset MPs To use default LM Offsets.

EoamResetMpsToUseDefaultLossMeasurementOffsetsCommand Writable Attributes

Writable Attribute
Description
MpList
List of MPs.
Type: handle
Default: 0
EoamResetMpsToUseDefaultLossMeasurementOffsetsCommand Read-Only Attributes

Read-Only Attribute
Description

EoamResetMpsToUseDefaultTlvsCommand
Description:
EOAM Reset MPs To Use Default TLVs.

EoamResetMpsToUseDefaultTlvsCommand Writable Attributes

Writable Attribute
Description
MpList
List of MEPs.
Type: handle
Default: 0
EoamResetMpsToUseDefaultTlvsCommand Read-Only Attributes

Read-Only Attribute
Description

768
EoamSaveLinkTracePathCommand
EoamSaveLinkTracePathCommand
Description:
EOAM save LT path command.

EoamSaveLinkTracePathCommand Writable Attributes

Writable Attribute
Description
Filename
Name of the file to save the LT path to.

Default: LtPath.csv
Mep
Handle of the MEP to save the LT path from.

Type: handle
Default: 0
EoamSaveLinkTracePathCommand Read-Only Attributes

Read-Only Attribute
Description

EoamStartAisCommand
Description:
EOAM start AIS command.

EoamStartAisCommand Writable Attributes

Writable Attribute
Description
AisConfigList
List of handles to AIS command configurations.

Type: handle
Default: 0
EoamStartAisCommand Read-Only Attributes

Read-Only Attribute
Description

769
EoamStartAutoMepDiscoveryCommand
EoamStartAutoMepDiscoveryCommand
Description:
Start discovery of the MEPs for all MA/MEGs.

EoamStartAutoMepDiscoveryCommand Writable Attributes

Writable Attribute
Description
EoamStartAutoMepDiscoveryCommand Read-Only Attributes

Read-Only Attribute
Description

EoamStartContChkCommand
Description:
Start sending CC messages from the list of routers. If CC messages are already being sent or the router has not been started, this command will be ignored.

EoamStartContChkCommand Writable Attributes

Writable Attribute
Description
ContChkConfigList
List of handles to CC command configurations.

Type: handle
Default: 0
EoamStartContChkCommand Read-Only Attributes

Read-Only Attribute
Description

EoamStartDelayMeasurementCommand
Description:
EOAM start DM command.
770
EoamStartLckCommand

EoamStartDelayMeasurementCommand Writable Attributes

Writable Attribute
Description
DelayMeasurementConfigList
List of handles to DM command configurations.

Type: handle
Default: 0
EoamStartDelayMeasurementCommand Read-Only Attributes

Read-Only Attribute
Description

EoamStartLckCommand
Description:
EOAM start LCK command.

EoamStartLckCommand Writable Attributes

Writable Attribute
Description
LckConfigList
List of handles to LCK command configurations.

Type: handle
Default: 0
EoamStartLckCommand Read-Only Attributes

Read-Only Attribute
Description

EoamStartLinkTraceCommand
Description:
Start sending LT messages from the list of routers. If LT messages are already being sent or the router has not been started, this command will be ignored.

771
EoamStartLoopbackCommand

EoamStartLinkTraceCommand Writable Attributes

Writable Attribute
Description
LinkTraceConfigList
List of handles to LT command configurations.

Type: handle
Default: 0
EoamStartLinkTraceCommand Read-Only Attributes

Read-Only Attribute
Description

EoamStartLoopbackCommand
Description:
Start sending LB messages from the list of routers. If LB messages are already being sent or the router has not been started, this command will be ignored.

EoamStartLoopbackCommand Writable Attributes

Writable Attribute
Description
LoopbackConfigList
List of handles to LB command configurations.

Type: handle
Default: 0
EoamStartLoopbackCommand Read-Only Attributes

Read-Only Attribute
Description

EoamStartLossMeasurementCommand
Description:
EOAM start LM command.

772
EoamStopAisCommand
EoamStartLossMeasurementCommand Writable Attributes

Writable Attribute
Description
LossMeasurementConfigList
List of handles to LM command configurations.

Type: handle
Default: 0
EoamStartLossMeasurementCommand Read-Only Attributes

Read-Only Attribute
Description

EoamStopAisCommand
Description:
EOAM stop AIS command.

EoamStopAisCommand Writable Attributes

Writable Attribute
Description
MepList
List of MEP handles.

Type: handle
Default: 0
EoamStopAisCommand Read-Only Attributes

Read-Only Attribute
Description

EoamStopAutoMepDiscoveryCommand
Description:
Stop the discovery process and retrieve the list of discovered MEPs.

773
EoamStopContChkCommand
EoamStopAutoMepDiscoveryCommand Writable Attributes

Writable Attribute
Description
ApplyAfterDiscovery
Whether to apply the discovered MEPs to the current configuration without stopping the test.
Type: bool
Default: TRUE
Possible Values:
Value Description
TRUE
Apply the discovered MEPs to the current configuration without stopping the test.
FALSE Do not apply the discovered MEPs to the current test.

ClearExistingRemoteMeps
Clear existing remote MEPs.

Type: bool
Default: TRUE
Possible Values:
Value Description
TRUE
Clear existing remote MEPs.
FALSE Do not clear existing remote MEPs.
EoamStopAutoMepDiscoveryCommand Read-Only Attributes

Read-Only Attribute
Description

EoamStopContChkCommand
Description:
Stop sending CC messages from the list of routers. If CC messages are already not being sent or the router has not been started, this command will be ignored.

EoamStopContChkCommand Writable Attributes

Writable Attribute
Description
MepList

Type: handle
Default: 0
EoamStopContChkCommand Read-Only Attributes

Read-Only Attribute
Description

774
EoamStopDelayMeasurementCommand
EoamStopDelayMeasurementCommand
Description:
EOAM stop DM command.

EoamStopDelayMeasurementCommand Writable Attributes

Writable Attribute
Description
MepList

Type: handle
Default: 0
EoamStopDelayMeasurementCommand Read-Only Attributes

Read-Only Attribute
Description

EoamStopLckCommand
Description:
EOAM stop LCK command.

EoamStopLckCommand Writable Attributes

Writable Attribute
Description
MepList

Type: handle
Default: 0
EoamStopLckCommand Read-Only Attributes

Read-Only Attribute
Description

775
EoamStopLinkTraceCommand
EoamStopLinkTraceCommand
Description:
Stop sending LT messages from the list of routers. If LT messages are already not being sent or the router has not been started, this command will be ignored.

EoamStopLinkTraceCommand Writable Attributes

Writable Attribute
Description
MepList

Type: handle
Default: 0
EoamStopLinkTraceCommand Read-Only Attributes

Read-Only Attribute
Description

EoamStopLoopbackCommand
Description:
Stop sending LB messages from the list of routers. If LB messages are already not being sent or the router has not been started, this command will be ignored.

EoamStopLoopbackCommand Writable Attributes

Writable Attribute
Description
MepList

Type: handle
Default: 0
EoamStopLoopbackCommand Read-Only Attributes

Read-Only Attribute
Description

776
EoamStopLossMeasurementCommand
EoamStopLossMeasurementCommand
Description:
EOAM stop LM command.

EoamStopLossMeasurementCommand Writable Attributes

Writable Attribute
Description
MepList

Type: handle
Default: 0
EoamStopLossMeasurementCommand Read-Only Attributes

Read-Only Attribute
Description

EoamUpdateMpTypesCommand
Description:
EOAM Update MP Types.

EoamUpdateMpTypesCommand Writable Attributes

Writable Attribute
Description
EoamUpdateMpTypesCommand Read-Only Attributes

Read-Only Attribute
Description

EOTResultsWriteDatasetCommand
Description:
Do not use this object.
777
EOTResultsWriteIterationCommand

EOTResultsWriteDatasetCommand Writable Attributes

Writable Attribute
Description
ConfigList
Type: handle
Default: 0
CreateNewDataSetId
Type: bool
Default: TRUE
Possible Values:
Value Description
TRUE
FALSE
Default: result.db
FilterClassList
Type: classId
Default: 0
IsRecursive
Type: bool
Default: TRUE
Possible Values:
Value Description
TRUE
FALSE
OverwriteIfExist
Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
FALSE
EOTResultsWriteDatasetCommand Read-Only Attributes

Read-Only Attribute
Description

OutputDataSetId
Type: u32
Default: 0
EOTResultsWriteIterationCommand
Description:
Gather results for the current iteration.

778
erroredTlv
EOTResultsWriteIterationCommand Writable Attributes

Writable Attribute
Description
EnableDetailedResultsCollection
Collect detailed results.

Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
Test collects Detailed Results.
FALSE Test does not collect Detailed Results.

SaveTrafficResults
Save traffic results.

Type: bool
Default: TRUE
Possible Values:
Value Description
TRUE
Save traffic results.
FALSE Save traffic results.

StreamBlockList
List of stream blocks used to gather results.

Type: handle
Default: 0
TestType
This is a user defined string that is the root label in the results database file. When used in any of the custom
tests, this field must contain the type of test currently being run. Can be one of the following: "Step" - Step
Test "Cont" - Continuous Test "Fixed" - Fixed Duration Test "Tput" - Throughput Test.
Type: string
Default: Standalone
EOTResultsWriteIterationCommand Read-Only Attributes

Read-Only Attribute
Description

CurrentDataSetId
Current result dataset ID.

Type: u32
Default: 1
TestStatus
Test status.
Type: string
erroredTlv
Description:
Children: None
erroredTlv Attributes
Attribute
Description
length
Type: INTEGER
Default: 4
779
errorestimate
Attribute
Description
Name
more information.
Type: string
type
Type: INTEGER
Default: 9
value
Type: OCTETSTRING
Default: 00000000
errorestimate
Description:
Parents: TwampSenderPackets, TwampReflectorPackets, TwampReflectorPackets
Children: None
errorestimate Attributes
Attribute
Description
multiplier
Type: INTEGER
Default: 255
Name
more information.
Type: string
sbit
Type: BITSTRING
Default: 0
scale
Type: INTEGER
Default: 3
zbit
Type: BITSTRING
Default: 0
EscAcc (fcsw:EscAcc)
Description:
Children: escProtocolDescriptors, vendorEscID
EscAcc Attributes
Attribute
Description
command
Type: OCTETSTRING
Default: 02
length
Type: INTEGER
Default: 12
780
escAccept
Attribute
Description
Name
Type: string
reserved
Type: OCTETSTRING
Default: 00
escAccept
Description:
escAccept Attributes
Attribute
Description
command
Type: OCTETSTRING
Default: 02
length
Type: INTEGER
Default: 12
Name
Type: string
reserved
Type: OCTETSTRING
Default: 00
escProtocolDescriptors (overloaded)
escProtocolDescriptors (fc)
escProtocolDescriptors (fcsw)
escProtocolDescriptors Object (fc PDU library)

Description:
Parents: escRequest (StreamBlock.FCoE.fc.fcPayloads.FCPayload-Choice.escRequest)

escAccept (StreamBlock.FCoE.fc.fcPayloads.FCPayload-Choice.escAccept)
Children: ProtocolDescriptor
781
EscReq
escProtocolDescriptors Attributes
Attribute
Description
Name
information.
Type: string
escProtocolDescriptors Object (fcsw PDU library)

Description:
Parents: escRequest (StreamBlock.EscReq)

escAccept (StreamBlock.EscAcc)
Children: ProtocolDescriptor
escProtocolDescriptors Attributes
Attribute
Description
Name
information.
Type: string
EscReq (fcsw:EscReq)
Description:
EscReq Attributes
Attribute
Description
command
Type: OCTETSTRING
Default: 30
flags
Type: BITSTRING
Default: 00000000
length
Type: INTEGER
Default: 12
Name
Type: string
782
escRequest
escRequest
Description:
escRequest Attributes
Attribute
Description
command
Type: OCTETSTRING
Default: 30
flags
Type: BITSTRING
Default: 00000000
length
Type: INTEGER
Default: 12
Name
Type: string
Ethernet100GigFiber
Description:

Parents: Port
Children: Mdio, Mii, PhyCompensationOptions
Relations:
Side name
(Type)
Relative
ActivePhyPort
(ActivePhy)
Port
(ApplicableOnPhy)
EthIIIf
Ethernet100GigFiber Writable Attributes

Writable Attribute
Description
Active, Name
AutoNegotiation
Type: bool
Default: TRUE
Possible Values:
Value Description
TRUE
FALSE
783
Description
Ethernet100GigFiber
Writable Attribute
Description
AutoNegotiationMasterSlave
Type: enum
Default: MASTER
Possible Values:
Value
Description
MASTER
SLAVE
CollisionExponent
Type: u8
Default: 10
Range: 1 - 10
DataPathMode
Type: enum
Default: NORMAL
Possible Values:
Value
Description
NORMAL
LOCAL_LOOPBACK
LINE_MONITOR
Duplex
Type: enum
Default: FULL
Possible Values:
Value Description
HALF
FULL
EnforceMtuOnRx
Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
FALSE
FlowControl
Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
FALSE
InternalPpmAdjust
Type: s32
Default: 0
Range: -100 - 100
LineSpeed
Type: enum
Default: SPEED_1G
Possible Values:
Value
Description
SPEED_10M
SPEED_100M
SPEED_1G
SPEED_10G
SPEED_40G
SPEED_100G
Mtu
Type: u32
Default: 1500
Range: 0 - 16383
784
Ethernet100GigFiber
Writable Attribute
Description
PortSetupMode
Type: enum
Possible Values:
Value
Description
PORTCONFIG_ONLY
REGISTERS_ONLY
RxEqualization
Type: u8
Default: 8
Range: 0 - 15
TransmitClockSource
Type: enum
Default: INTERNAL
Possible Values:
Value
INTERNAL
INTERNAL_PPM_ADJ
LOOP
TxPreEmphasisMainTap
Type: u8
Default: 21
Range: 0 - 31
TxPreEmphasisPostTap
Type: u8
Default: 8
Range: 0 - 15
Ethernet100GigFiber Read-Only Attributes

Read-Only Attribute
Description
DuplexStatus
Type: enum
Default: FULL
Possible Values:
Value Description
HALF
FULL
ForceAutoNegotiationFor1GSpeed
Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
FALSE
Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
FALSE
IsMgtRegistersOnly
Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
FALSE
785
Description
Ethernet100GigFiber
Read-Only Attribute
Description
LinkStatus
Type: enum
Default: NONE
Possible Values:
Value
Description
DOWN
UP
ERROR
ADMIN_DOWN
SONET
NONE
ModuleType
Type: enum
Default: NA
Possible Values:
Value
Description
NA
UNKNOWN
ABSENT
SFP_FIBER
SFP_Copper
XFP
XENPAK
X2
E1000
TEN_GBASE_T
SFP_PLUS
CFP
QSFP_PLUS
PersonalityCardType
Type: enum
Default: NA
Possible Values:
Value
Description
NA
UNKNOWN
ABSENT
SFP
XFP
XENPAK
X2
TEN_GBASE_T
CFP
SupportedManagementRegisters
Type: enum
Default: NONE
Possible Values:
Value Description
NONE
MII
GMII
MDIO
786
Ethernet100GigFiber
Read-Only Attribute
Description
SupportedSpeeds
Type: enum
Default: SPEED_1G
Possible Values:
Value
Description
SPEED_10M
SPEED_100M
SPEED_1G
SPEED_10G
SPEED_40G
SPEED_100G
787
Ethernet100GigFiber
Read-Only Attribute
Description
TransceiverType
Type: enum
Possible Values:
Value
Description
MODULE_NONE
MODULE_10GBASE_ER
MODULE_10GBASE_LR
MODULE_10GBASE_SR
MODULE_10GBASE_EW
MODULE_10GBASE_LW
MODULE_10GBASE_SW
MODULE_10GBASE_CX4
MODULE_10GBASE_LX4
SPIRENT_10GBASE_CX4
MODULE_OC48_LR
MODULE_OC48_IR
MODULE_OC48_SR
MODULE_OC12_LR
MODULE_OC12_IR
MODULE_OC12_SR
MODULE_OC3_LR
MODULE_OC3_IR
MODULE_OC3_SR
MODULE_OC192_LR
MODULE_OC192_IR
MODULE_OC192_SR
MODULE_OC192_VR
MODULE_10GBASE_T
MODULE_XFP_CX4
MODULE_XFP_E
MODULE_1000BASE_T
MODULE_1000BASE_CX
MODULE_1000BASE_LX
MODULE_1000BASE_SX
MODULE_40GBASE_LR
MODULE_40GBASE_SR
MODULE_40GBASE_CR4
MODULE_40GBASE_SR4
MODULE_100GBASE_LR
MODULE_100GBASE_SR
MODULE_FC_2G
MODULE_FC_4G
MODULE_FC_8G
MODULE_100BASE_FX
TransceiverTypeList
Type: string
788
Ethernet10GigCopper
Ethernet10GigCopper
Description:
Ethernet 10 Gig Copper PHY. Provides parameters specific to ports with an Ethernet 10 Gig interface.

Parents: Port
Relations:
Side name
(Type)
Relative
ActivePhyPort
(ActivePhy)
Port
(ApplicableOnPhy)
EthIIIf
Description
Ethernet10GigCopper Writable Attributes

Writable Attribute
Description
Active, Name
AutoMdix
Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
FALSE
AutoNegotiation
Auto negotiation.
Type: bool
Default: TRUE
Possible Values:
Value Description
TRUE
Enable
FALSE Disable
Sets the port to be Master or Slave for auto negotiation.

Type: enum
Default: MASTER
Possible Values:
Value
Description
MASTER Master.
SLAVE
ClockOutputFreq
Slave.
Clock output frequency.

Type: enum
Default: FREQ_156_25_MHZ
Possible Values:
Value
Description
FREQ_125_MHZ
125 MHz.
FREQ_156_25_MHZ 156.25 MHz.

CollisionExponent
Sets the exponent used in the collision back-off algorithm. Larger exponents indicate larger back-off times after
collisions occur.
Type: u8
Default: 10
Range: 1 - 10
789
Ethernet10GigCopper
Writable Attribute
Description
DataPathMode

Type: enum
Default: NORMAL
Possible Values:
Value
Description
NORMAL
LOCAL_LOOPBACK Port will transmit in a loopback mode, so transmitted data will be received by the transmitting
port without going out on the wire.
LINE_MONITOR
DeficitIdleCount
Deficit idle count.

Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
Enable
FALSE Disable
Duplex
Type of duplex to use.

Type: enum
Default: FULL
Possible Values:
Value Description
HALF Half duplex.
FULL Full duplex.
EnforceMtuOnRx
Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
FALSE
FlowControl
Flow control (PAUSE frames).

Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
Enable
FALSE Disable
InternalPpmAdjust
Specifies the PPM value to adjust the IEEE clock frequency tolerance. This value affects the transmit clock frequency
when Transmit Clock Source is set to InternalPpmAdj.
Type: s32
Default: 0
Range: -50 - 50
LineSpeed
Sets the line speed for the port.

Type: enum
Default: SPEED_1G
Possible Values:
Value
Description
SPEED_10M
10 MBPS.
SPEED_100M 100 MBPS.

SPEED_1G
1 GBPS.
SPEED_10G
10 GBPS.
SPEED_40G
SPEED_100G
790
Ethernet10GigCopper
Writable Attribute
Description
Mtu

Type: u32
Default: 1500
Range: 0 - 16383
PortSetupMode

Type: enum
Possible Values:
Value
Description
TransmitClockSource
REGISTERS_ONLY
Transmit clock source.

Type: enum
Default: INTERNAL
Possible Values:
Value
Description
INTERNAL
Internal
INTERNAL_PPM_ADJ Adjust the clock PPM within the IEEE clock frequency.
LOOP
Loop
EXTERNAL
External
Ethernet10GigCopper Read-Only Attributes

Read-Only Attribute
Description
DuplexStatus
Duplex status.
Type: enum
Default: FULL
Possible Values:
Value Description
HALF Half duplex.
FULL Full duplex.
Force auto negotiation.

Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
Enable
FALSE Disable
IsAutoMdixSupported
Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
FALSE
Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
FALSE
791
Ethernet10GigCopper
Read-Only Attribute
Description
IsMgtRegistersOnly
Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
Enable
FALSE Disable
LineSpeedStatus
Line speed status.

Type: enum
Default: SPEED_1G
Possible Values:
Value
Description
SPEED_10M
Line speed 10 MBPS.
SPEED_100M Line speed 100 MBPS.

SPEED_1G
Line speed 1 GBPS.
SPEED_10G
Line speed 10 GBPS.
SPEED_40G
SPEED_100G
LinkStatus
Status of link.
Type: enum
Default: NONE
Possible Values:
Value
Description
DOWN
Link is down.
UP
Link is up.
ERROR
Link has error.
ModuleType
SONET
Link is SONET.
NONE
No link present.

Type: enum
Default: NA
Possible Values:
Value
Description
NA
UNKNOWN
ABSENT
SFP_FIBER
SFP fiber media.
SFP_Copper
SFP copper media.
XFP
XFP
XENPAK
Xenpak
X2
X2
E1000
E1000
SFP_PLUS
SFP Plus
CFP
QSFP_PLUS
792
Ethernet10GigCopper
Read-Only Attribute
Description
PersonalityCardType
Type: enum
Default: NA
Possible Values:
Value
Description
NA
UNKNOWN
ABSENT
SFP
SFP
XFP
XFP
XENPAK
Xenpak
X2
X2
CFP
Specifies the Management Registers type supported on a port.

Type: enum
Default: NONE
Possible Values:
Value Description
NONE None.
MII
MII registers.
GMII
GMII registers.
MDIO MDIO registers.

SupportedSpeeds
Specifies the list of supported line speeds.

Type: enum
Default: SPEED_1G
Possible Values:
Value
Description
SPEED_10M
10 MBPS.

SPEED_1G
1 GBPS.
SPEED_10G
10 GBPS.
SPEED_40G
SPEED_100G
793
Ethernet10GigCopper
Read-Only Attribute
Description
TransceiverType
Displays the first transceiver type presented by the hardware.

Type: enum
Possible Values:
Value
Description
MODULE_NONE
None
MODULE_10GBASE_ER
10GBASE-ER
MODULE_10GBASE_LR
10GBASE-LR
MODULE_10GBASE_SR
10GBASE-SR
MODULE_10GBASE_EW
10GBASE-EW
MODULE_10GBASE_LW
10GBASE-EW
MODULE_10GBASE_SW
10GBASE-SW
MODULE_10GBASE_CX4
10GBASE-CX4
MODULE_10GBASE_LX4
10GBASE-LX4
SPIRENT_10GBASE_CX4
Spirent 10GBASE-CX4
MODULE_OC48_LR
OC48-LR
MODULE_OC48_IR
OC48-IR
MODULE_OC48_SR
OC48-SR
MODULE_OC12_LR
OC12-LR
MODULE_OC12_IR
OC12-IR
MODULE_OC12_SR
OC12-SR
MODULE_OC3_LR
OC3-LR
MODULE_OC3_IR
OC3-IR
MODULE_OC3_SR
OC3-SR
MODULE_OC192_LR
OC192-LR
MODULE_OC192_IR
OC192-IR
MODULE_OC192_SR
OC192-SR
MODULE_OC192_VR
OC192-VR
MODULE_10GBASE_T
10GBASE-T
MODULE_XFP_CX4
XFP-CX4
MODULE_XFP_E
XFP-E
MODULE_1000BASE_T
1000BASE-T
MODULE_1000BASE_CX
1000BASE-CX
MODULE_1000BASE_LX
1000BASE-LX
MODULE_1000BASE_SX
1000BASE-SX
MODULE_40GBASE_LR
MODULE_40GBASE_SR
MODULE_40GBASE_CR4
MODULE_40GBASE_SR4
MODULE_100GBASE_LR
MODULE_100GBASE_SR
MODULE_FC_2G
MODULE_FC_4G
MODULE_FC_8G
MODULE_100BASE_FX
TransceiverTypeList

Type: string
794
Ethernet10GigFiber
Ethernet10GigFiber
Description:
Ethernet 10 Gig Fiber PHY. Provides parameters specific to ports with an Ethernet 10 Gig interface.

Parents: Port
Automatically-created children: EthernetWan
Relations:
Side name
(Type)
Relative
ActivePhyPort
(ActivePhy)
Port
(ApplicableOnPhy)
EthIIIf
Description

Writable Attribute
Description
Active, Name
AutoNegotiation
Auto negotiation.
Type: bool
Default: TRUE
Possible Values:
Value Description
TRUE
Enable
FALSE Disable

Type: enum
Default: MASTER
Possible Values:
Value
Description
MASTER Master
SLAVE
Slave
CollisionExponent
collisions occur.
Type: u8
Default: 10
Range: 1 - 10
DataPathMode

Type: enum
Default: NORMAL
Possible Values:
Value
Description
NORMAL
LINE_MONITOR
Port will be placed in line monitor mode. All received packets will be transmitted as is but can
also be captured on the port.
795
Ethernet10GigFiber
Writable Attribute
Description
DeficitIdleCount
Deficit idle count.

Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
Enable
FALSE Disable
Duplex
Specifies the type of duplex to use.

Type: enum
Default: FULL
Possible Values:
Value Description
HALF Half duplex.
FULL Full duplex.
EnforceMtuOnRx
Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
FALSE
FlowControl

Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
Enable
FALSE Disable
InternalPpmAdjust
PPM value to adjust the IEEE clock frequency tolerance. This value affects the transmit clock frequency when Transmit
Clock Source is set to InternalPpmAdj.
Type: s32
Default: 0
Range: -100 - 100
IsPfcNegotiated
Specifies if priority flow control is negotiated by DCBX.

Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
Priority flow control is negotiated by DCBX.
FALSE Priority flow control is not negotiated by DCBX.

LineSpeed
Sets the line speed for the port. Only SPEED_10G is supported on Ethernet 10 Gig ports. In general, use the
SupportedSpeeds attribute to determine compatibility.
Type: enum
Default: SPEED_1G
Possible Values:
Value
Description
SPEED_10M
10 MBPS.

SPEED_1G
1 GBPS.
SPEED_10G
10 GBPS.
SPEED_40G
SPEED_100G
796
Ethernet10GigFiber
Writable Attribute
Description
Mtu
Maximum transmission unit in bytes.

Type: u32
Default: 1500
Range: 0 - 16383
PortMode
Port mode.
Type: enum
Default: LAN
Possible Values:
Value Description
LAN
LAN
WAN WAN
PortSetupMode

Type: enum
Possible Values:
Value
Description
REGISTERS_ONLY
Array of boolean priority bit values (8 bits).

Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
Enable the nth bit.
FALSE Disable the nth bit.

TransmitClockSource
Transmit clock source.

Type: enum
Default: INTERNAL
Possible Values:
Value
Description
INTERNAL
Internal
INTERNAL_PPM_ADJ Adjust the clock PPM within the IEEE clock frequency.
BITS
Bits
LOOP
Loop
EXTERNAL
External

Read-Only Attribute
Description
DuplexStatus
Status of the duplex.

Type: enum
Default: FULL
Possible Values:
Value Description
HALF Half duplex.
FULL Full duplex.

Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
Enable
FALSE Disable
797
Ethernet10GigFiber
Read-Only Attribute
Description
IsClockingSupported
Indicates whether the TransmitClockSource attribute is supported on a port.

Type: bool
Default: TRUE
Possible Values:
Value Description
TRUE
Enable
FALSE Disable
Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
FALSE
IsInternalPpmSupported
Indicates whether Internal PPM is supported.

Type: bool
Default: TRUE
Possible Values:
Value Description
TRUE
Internal PPM is supported.
FALSE Internal PPM is not supported.

IsMgtRegistersOnly
Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
Enable
FALSE Disable
IsPriorityFlowControlSupported
Specifies whether priority flow control is supported.

Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
Priority flow control is supported.
FALSE Priority flow control is not supported.

LinkStatus
Status of link.
Type: enum
Default: NONE
Possible Values:
Value
Description
DOWN
Link is DOWN.
UP
Link is UP.
ERROR
Link has error.

SONET
Link is SONET.
NONE
No Link Present.
798
Ethernet10GigFiber
Read-Only Attribute
Description
ModuleType

Type: enum
Default: NA
Possible Values:
Value
Description
NA
UNKNOWN
ABSENT
SFP_FIBER
SFP fiber media.
SFP_Copper
SFP copper media.
XFP
XFP
XENPAK
Xenpak
X2
X2
E1000
E1000
SFP_PLUS
SFP Plus
CFP
QSFP_PLUS
PersonalityCardType
Type: enum
Default: NA
Possible Values:
Value
Description
NA
UNKNOWN
ABSENT
SFP
SFP
XFP
XFP
XENPAK
Xenpak
X2
X2
CFP
PfcTxQueueCount
Number of priority flow control transmit queues supported on this card.

Type: u8
Default: 0
PpmStep
Internal PPM Adjust Step.

Type: s32
Default: 1
PriorityFlowControlStatusArray
Status array of boolean priority bit values (8 bits).

Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
Nth bit is enabled.
FALSE Nth bit is disabled.
799
Ethernet10GigFiber
Read-Only Attribute
Description

Type: enum
Default: NONE
Possible Values:
Value Description
NONE None.
MII
MII registers.
GMII
GMII registers.

SupportedSpeeds

Type: enum
Default: SPEED_1G
Possible Values:
Value
Description
SPEED_10M
10 MBPS.

SPEED_1G
1 GBPS.
SPEED_10G
10 GBPS.
SPEED_40G
SPEED_100G
800
Ethernet10GigFiber
Read-Only Attribute
Description
TransceiverType

Type: enum
Possible Values:
Value
Description
MODULE_NONE
None
MODULE_10GBASE_ER
10GBASE-ER
MODULE_10GBASE_LR
10GBASE-LR
MODULE_10GBASE_SR
10GBASE-SR
MODULE_10GBASE_EW
10GBASE-EW
MODULE_10GBASE_LW
10GBASE-LW
MODULE_10GBASE_SW
10GBASE-SW
MODULE_10GBASE_CX4
10GBASE-CX4
MODULE_10GBASE_LX4
10GBASE-LX4
SPIRENT_10GBASE_CX4
Spirent 10GBASE-CX4
MODULE_OC48_LR
OC48-LR
MODULE_OC48_IR
OC48-IR
MODULE_OC48_SR
OC48-SR
MODULE_OC12_LR
OC12-LR
MODULE_OC12_IR
OC12-IR
MODULE_OC12_SR
OC12-SR
MODULE_OC3_LR
OC3-LR
MODULE_OC3_IR
OC3-IR
MODULE_OC3_SR
OC3-SR
MODULE_OC192_LR
OC192-LR
MODULE_OC192_IR
OC192-IR
MODULE_OC192_SR
OC192-SR
MODULE_OC192_VR
OC192-SR
MODULE_10GBASE_T
10GBASE-T
MODULE_XFP_CX4
XFP-CX4
MODULE_XFP_E
XFP-E
MODULE_1000BASE_T
1000BASE-T
MODULE_1000BASE_CX
1000BASE-CX
MODULE_1000BASE_LX
1000BASE-LX
MODULE_1000BASE_SX
1000BASE-SX
MODULE_40GBASE_LR
MODULE_40GBASE_SR
MODULE_40GBASE_CR4
MODULE_40GBASE_SR4
MODULE_100GBASE_LR
MODULE_100GBASE_SR
MODULE_FC_2G
MODULE_FC_4G
MODULE_FC_8G
MODULE_100BASE_FX
100BASE-FX
MODULE_SFP_PLUS_COPPER SFP Plus Copper

TransceiverTypeList

Type: string
801
Ethernet40GigFiber
Ethernet40GigFiber
Description:

Parents: Port
Relations:
Side name
(Type)
Relative
ActivePhyPort
(ActivePhy)
Port
(ApplicableOnPhy)
EthIIIf

Writable Attribute
Description
Active, Name
AutoNegotiation
Type: bool
Default: TRUE
Possible Values:
Value Description
TRUE
FALSE
Type: enum
Default: MASTER
Possible Values:
Value
Description
MASTER
SLAVE
CollisionExponent
Type: u8
Default: 10
Range: 1 - 10
DataPathMode
Type: enum
Default: NORMAL
Possible Values:
Value
Description
NORMAL
LOCAL_LOOPBACK
LINE_MONITOR
Duplex
Type: enum
Default: FULL
Possible Values:
Value Description
HALF
FULL
EnforceMtuOnRx
Description
Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
FALSE
802
Ethernet40GigFiber
Writable Attribute
Description
FlowControl
Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
FALSE
InternalPpmAdjust
Type: s32
Default: 0
Range: -100 - 100
IsPfcNegotiated
Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
FALSE
LineSpeed
Type: enum
Default: SPEED_1G
Possible Values:
Value
Description
SPEED_10M
SPEED_100M
SPEED_1G
SPEED_10G
SPEED_40G
SPEED_100G
Mtu
Type: u32
Default: 1500
Range: 0 - 16383
PortSetupMode
Type: enum
Possible Values:
Value
Description
PORTCONFIG_ONLY
REGISTERS_ONLY
Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
FALSE
RxEqualization
Type: u8
Default: 8
Range: 0 - 15
TransmitClockSource
Type: enum
Default: INTERNAL
Possible Values:
Value
INTERNAL
INTERNAL_PPM_ADJ
LOOP
803
Description
Ethernet40GigFiber
Writable Attribute
Description
TxPreEmphasisMainTap
Type: u8
Default: 21
Range: 0 - 31
TxPreEmphasisPostTap
Type: u8
Default: 8
Range: 0 - 15

Read-Only Attribute
Description
DuplexStatus
Type: enum
Default: FULL
Possible Values:
Value Description
HALF
FULL
Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
FALSE
Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
FALSE
IsMgtRegistersOnly
Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
FALSE
LinkStatus
Type: enum
Default: NONE
Possible Values:
Value
Description
DOWN
UP
ERROR
ADMIN_DOWN
SONET
NONE
804
Ethernet40GigFiber
Read-Only Attribute
Description
ModuleType
Type: enum
Default: NA
Possible Values:
Value
Description
NA
UNKNOWN
ABSENT
SFP_FIBER
SFP_Copper
XFP
XENPAK
X2
E1000
TEN_GBASE_T
SFP_PLUS
CFP
QSFP_PLUS
PersonalityCardType
Type: enum
Default: NA
Possible Values:
Value
Description
NA
UNKNOWN
ABSENT
SFP
XFP
XENPAK
X2
TEN_GBASE_T
CFP
PriorityFlowControlStatusArray
Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
FALSE
Type: enum
Default: NONE
Possible Values:
Value Description
NONE
MII
GMII
MDIO
805
Ethernet40GigFiber
Read-Only Attribute
Description
SupportedSpeeds
Type: enum
Default: SPEED_1G
Possible Values:
Value
Description
SPEED_10M
SPEED_100M
SPEED_1G
SPEED_10G
SPEED_40G
SPEED_100G
806
Ethernet40GigFiber
Read-Only Attribute
Description
TransceiverType
Type: enum
Possible Values:
Value
Description
MODULE_NONE
MODULE_10GBASE_ER
MODULE_10GBASE_LR
MODULE_10GBASE_SR
MODULE_10GBASE_EW
MODULE_10GBASE_LW
MODULE_10GBASE_SW
MODULE_10GBASE_CX4
MODULE_10GBASE_LX4
SPIRENT_10GBASE_CX4
MODULE_OC48_LR
MODULE_OC48_IR
MODULE_OC48_SR
MODULE_OC12_LR
MODULE_OC12_IR
MODULE_OC12_SR
MODULE_OC3_LR
MODULE_OC3_IR
MODULE_OC3_SR
MODULE_OC192_LR
MODULE_OC192_IR
MODULE_OC192_SR
MODULE_OC192_VR
MODULE_10GBASE_T
MODULE_XFP_CX4
MODULE_XFP_E
MODULE_1000BASE_T
MODULE_1000BASE_CX
MODULE_1000BASE_LX
MODULE_1000BASE_SX
MODULE_40GBASE_LR
MODULE_40GBASE_SR
MODULE_40GBASE_CR4
MODULE_40GBASE_SR4
MODULE_100GBASE_LR
MODULE_100GBASE_SR
MODULE_FC_2G
MODULE_FC_4G
MODULE_FC_8G
MODULE_100BASE_FX
TransceiverTypeList
Type: string
807
Ethernet8022
Ethernet8022 (ethernet:Ethernet8022)
Description:
Children: llcheader, vlans, vntags
Ethernet8022 Attributes
Attribute
Description
dstMac
Type: MACADDR
Default: 00:00:01:00:00:01
length
Type: INTEGER
Name
Type: string
preamble
Type: OCTETSTRING
Default: 55555555555555d5
srcMac
Type: MACADDR
Default: 00:10:94:00:00:02
Ethernet8022 (mimethernet:Ethernet8022)
Description:
Children: cvlans, llcheader, svlans
Ethernet8022 Attributes
Attribute
Description
cDstMac
Type: MACADDR
Default: 00:00:01:00:00:01
cSrcMac
Type: MACADDR
Default: 00:10:94:00:00:02
length
Type: INTEGER
Name
Type: string
preamble
Type: OCTETSTRING
Default: 55555555555555d5
808
Ethernet8023Raw
Ethernet8023Raw (ethernet:Ethernet8023Raw)
Description:
Children: vlans, vntags
Ethernet8023Raw Attributes
Attribute
Description
dstMac
Type: MACADDR
Default: 00:00:01:00:00:01
length
Type: INTEGER
Name
Type: string
preamble
Type: OCTETSTRING
Default: 55555555555555d5
srcMac
Type: MACADDR
Default: 00:10:94:00:00:02
Ethernet8023Raw (mimethernet:Ethernet8023Raw)
Description:
Ethernet8023Raw Attributes
Attribute
Description
cDstMac
Type: MACADDR
Default: 00:00:01:00:00:01
cSrcMac
Type: MACADDR
Default: 00:10:94:00:00:02
length
Type: INTEGER
Name
Type: string
preamble
Type: OCTETSTRING
Default: 55555555555555d5
809
EthernetBridgeLink
EthernetBridgeLink
Description:

Relations:
Side name
(Type)
Relative
Description
Container
(ContainedLink)

(LinkDst)
LinkDstDevice
(LinkDstDevice)
EmulatedDevice
NetworkLinkSource
(LinkSrc)
EthernetBridgeLink Writable Attributes

Writable Attribute
Description
Active, Name
EthernetBridgeLink Read-Only Attributes

Read-Only Attribute
Description
LinkType
Type: string
EthernetCapTLV (VICTLV:EthernetCapTLV)
Description:
Children: None
VICTLV:CustomTLV
EthernetCapTLV Attributes
Attribute
Description
Length
Type: INTEGER
Default: 2
Name
Type: string
NumEthVifsSupported
Type: INTEGER
Default: 1
810
EthernetCopper
Attribute
Description
Type
Type: INTEGER
Default: 19
EthernetCopper
Description:
Ethernet copper Phy. Provides parameters specific to ports with an Ethernet copper interface.

Parents: Port
Relations:
Side name
(Type)
Relative
ActivePhyPort
(ActivePhy)
Port
(ApplicableOnPhy)
EthIIIf
Description
EthernetCopper Writable Attributes

Writable Attribute
Description
Active, Name
AutoMdix
Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
FALSE
AutoNegotiation
Auto negotiation.
Type: bool
Default: TRUE
Possible Values:
Value Description
TRUE
Enable
FALSE Disable

Type: enum
Default: MASTER
Possible Values:
Value
Description
MASTER Master
SLAVE
CollisionExponent
Slave
collisions occur.
Type: u8
Default: 10
Range: 1 - 10
811
EthernetCopper
Writable Attribute
Description
DataPathMode

Type: enum
Default: NORMAL
Possible Values:
Value
Description
NORMAL
LINE_MONITOR
Duplex
Port will be placed in line monitor mode. All received packets will be transmitted as is but can
also be captured on the port.
Duplex.
Type: enum
Default: FULL
Possible Values:
Value Description
HALF Half duplex.
FULL Full duplex.
EnforceMtuOnRx
Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
FALSE
FlowControl

Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
Enable
FALSE Disable
LineSpeed
Sets the line speed for the port. Not all speeds are supported on all Ethernet copper ports. Use the SupportedSpeeds
attribute to determine compatibility.
Type: enum
Default: SPEED_1G
Possible Values:
Value
Description
SPEED_10M
10 MBPS.

SPEED_1G
1 GBPS.
SPEED_10G
10 GBPS.
SPEED_40G
SPEED_100G
Mtu

Type: u32
Default: 1500
Range: 0 - 16383
PortSetupMode

Type: enum
Possible Values:
Value
Description
REGISTERS_ONLY
812
EthernetCopper
EthernetCopper Read-Only Attributes

Read-Only Attribute
Description
DuplexStatus
Duplex status.
Type: enum
Default: FULL
Possible Values:
Value Description
HALF Half duplex.
FULL Full duplex.

Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
Enable
FALSE Disable
IsAutoMdixSupported
Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
FALSE
Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
FALSE
IsMgtRegistersOnly
Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
Enable
FALSE Disable
LineSpeedStatus
Line speed status.

Type: enum
Default: SPEED_1G
Possible Values:
Value
Description
SPEED_10M
Line speed 10 Mbps.
SPEED_100M Line speed 100 Mbps.

SPEED_1G
Line speed 1 Gbps.
SPEED_10G
Line speed 10 Gbps.
SPEED_40G
SPEED_100G
813
EthernetCopper
Read-Only Attribute
Description
LinkStatus
Status of link.
Type: enum
Default: NONE
Possible Values:
Value
Description
DOWN
Link is DOWN.
UP
Link is UP.
ERROR
Link has error.
ModuleType
SONET
Link is SONET.
NONE
No link present.

Type: enum
Default: NA
Possible Values:
Value
Description
NA
UNKNOWN
ABSENT
SFP_FIBER
SFP fiber media.
SFP_Copper
SFP copper media.
XFP
XFP
XENPAK
Xenpak
X2
X2
E1000
E1000
SFP_PLUS
SFP Plus
CFP
QSFP_PLUS
PersonalityCardType
Type: enum
Default: NA
Possible Values:
Value
Description
NA
UNKNOWN
ABSENT
SFP
SFP
XFP
XFP
XENPAK
Xenpak
X2
X2
CFP

Type: enum
Default: NONE
Possible Values:
Value Description
NONE None.
MII
MII registers.
GMII
GMII registers.
814
EthernetCopper
Read-Only Attribute
Description
SupportedSpeeds

Type: enum
Default: SPEED_1G
Possible Values:
Value
Description
SPEED_10M
10 MBPS.

SPEED_1G
1 GBPS.
SPEED_10G
10 GBPS.
SPEED_40G
SPEED_100G
815
EthernetCopper
Read-Only Attribute
Description
TransceiverType

Type: enum
Possible Values:
Value
Description
MODULE_NONE
None
MODULE_10GBASE_ER
10GBASE-ER
MODULE_10GBASE_LR
10GBASE-LR
MODULE_10GBASE_SR
10GBASE-SR
MODULE_10GBASE_EW
10GBASE-EW
MODULE_10GBASE_LW
10GBASE-LW
MODULE_10GBASE_SW
10GBASE-SW
MODULE_10GBASE_CX4
10GBASE-CX4
MODULE_10GBASE_LX4
10GBASE-LX4
SPIRENT_10GBASE_CX4
Spirent 10GBASE-CX4
MODULE_OC48_LR
OC48-LR
MODULE_OC48_IR
OC48-IR
MODULE_OC48_SR
OC48-SR
MODULE_OC12_LR
OC12-LR
MODULE_OC12_IR
OC12-IR
MODULE_OC12_SR
OC12-SR
MODULE_OC3_LR
OC3-LR
MODULE_OC3_IR
OC3-IR
MODULE_OC3_SR
OC3-SR
MODULE_OC192_LR
OC192-LR
MODULE_OC192_IR
OC192-IR
MODULE_OC192_SR
OC192-SR
MODULE_OC192_VR
OC192-VR
MODULE_10GBASE_T
10GBASE-T
MODULE_XFP_CX4
XFP-CX4
MODULE_XFP_E
XFP-E
MODULE_1000BASE_T
1000BASE-T
MODULE_1000BASE_CX
1000BASE-CX
MODULE_1000BASE_LX
1000BASE-LX
MODULE_1000BASE_SX
1000BASE-SX
MODULE_40GBASE_LR
MODULE_40GBASE_SR
MODULE_40GBASE_CR4
MODULE_40GBASE_SR4
MODULE_100GBASE_LR
MODULE_100GBASE_SR
MODULE_FC_2G
MODULE_FC_4G
MODULE_FC_8G
MODULE_100BASE_FX
TransceiverTypeList

Type: string
816
EthernetFiber
EthernetFiber
Description:
Ethernet Fiber PHY. Provides parameters specific to ports with an Ethernet fiber interface.

Parents: Port
Relations:
Side name
(Type)
Relative
ActivePhyPort
(ActivePhy)
Port
(ApplicableOnPhy)
EthIIIf
Description
EthernetFiber Writable Attributes

Writable Attribute
Description
Active, Name
AutoNegotiation
Auto negotiation.
Type: bool
Default: TRUE
Possible Values:
Value Description
TRUE
Enable
FALSE Disable

Type: enum
Default: MASTER
Possible Values:
Value
Description
MASTER Master
SLAVE
Slave
CollisionExponent
Type: u8
Default: 10
Range: 1 - 10
DataPathMode

Type: enum
Default: NORMAL
Possible Values:
Value
Description
NORMAL
LINE_MONITOR
Duplex
Type: enum
Default: FULL
Possible Values:
Value Description
HALF
FULL
817
EthernetFiber
Writable Attribute
Description
EnforceMtuOnRx
Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
FALSE
FlowControl

Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
Enable
FALSE Disable
LineSpeed
Sets the line speed for the port. Only SPEED_1G is supported on Ethernet Fiber ports. In general, use the
SupportedSpeeds attribute to determine compatibility.
Type: enum
Default: SPEED_1G
Possible Values:
Value
Description
SPEED_10M
10 MBPS.

SPEED_1G
1 GBPS.
SPEED_10G
10 GBPS.
SPEED_40G
SPEED_100G
Mtu

Type: u32
Default: 1500
Range: 0 - 16383
PortSetupMode

Type: enum
Possible Values:
Value
Description
REGISTERS_ONLY
EthernetFiber Read-Only Attributes

Read-Only Attribute
Description
DuplexStatus
Type: enum
Default: FULL
Possible Values:
Value Description
HALF
FULL

Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
Enable
FALSE Disable
818
EthernetFiber
Read-Only Attribute
Description
Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
FALSE
IsMgtRegistersOnly
Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
Enable
FALSE Disable
LinkStatus
Status of link.
Type: enum
Default: NONE
Possible Values:
Value
Description
DOWN
Link is DOWN.
UP
Link is UP.
ERROR
Link has error.
ModuleType
SONET
Link is SONET.
NONE
No link present.

Type: enum
Default: NA
Possible Values:
Value
Description
NA
UNKNOWN
ABSENT
SFP_FIBER
SFP fiber media.
SFP_Copper
SFP copper media.
XFP
XFP
XENPAK
Xenpak
X2
X2
E1000
E1000
SFP_PLUS
SFP Plus
CFP
QSFP_PLUS
819
EthernetFiber
Read-Only Attribute
Description
PersonalityCardType
Type: enum
Default: NA
Possible Values:
Value
Description
NA
UNKNOWN
ABSENT
SFP
SFP
XFP
XFP
XENPAK
Xenpak
X2
X2
CFP

Type: enum
Default: NONE
Possible Values:
Value Description
NONE None.
MII
MII registers.
GMII
GMII registers.

SupportedSpeeds

Type: enum
Default: SPEED_1G
Possible Values:
Value
Description
SPEED_10M
10 MBPS.

SPEED_1G
1 GBPS.
SPEED_10G
10 GBPS.
SPEED_40G
SPEED_100G
820
EthernetFiber
Read-Only Attribute
Description
TransceiverType

Type: enum
Possible Values:
Value
Description
MODULE_NONE
None
MODULE_10GBASE_ER
10GBASE-ER
MODULE_10GBASE_LR
10GBASE-LR
MODULE_10GBASE_SR
10GBASE-SR
MODULE_10GBASE_EW
10GBASE-EW
MODULE_10GBASE_LW
10GBASE-LW
MODULE_10GBASE_SW
10GBASE-SW
MODULE_10GBASE_CX4
10GBASE-CX4
MODULE_10GBASE_LX4
10GBASE-LX4
SPIRENT_10GBASE_CX4
Spirent 10GBASE-CX4
MODULE_OC48_LR
OC48-LR
MODULE_OC48_IR
OC48-IR
MODULE_OC48_SR
OC48-SR
MODULE_OC12_LR
OC12-LR
MODULE_OC12_IR
OC12-IR
MODULE_OC12_SR
OC12-SR
MODULE_OC3_LR
OC3-LR
MODULE_OC3_IR
OC3-IR
MODULE_OC3_SR
OC3-SR
MODULE_OC192_LR
OC192-LR
MODULE_OC192_IR
OC192-IR
MODULE_OC192_SR
OC192-SR
MODULE_OC192_VR
OC192-VR
MODULE_10GBASE_T
10GBASE-T
MODULE_XFP_CX4
XFP-CX4
MODULE_XFP_E
XFP-E
MODULE_1000BASE_T
1000BASE-T
MODULE_1000BASE_CX
1000BASE-CX
MODULE_1000BASE_LX
1000BASE-LX
MODULE_1000BASE_SX
1000BASE-SX
MODULE_40GBASE_LR
MODULE_40GBASE_SR
MODULE_40GBASE_CR4
MODULE_40GBASE_SR4
MODULE_100GBASE_LR
MODULE_100GBASE_SR
MODULE_FC_2G
MODULE_FC_4G
MODULE_FC_8G
MODULE_100BASE_FX
TransceiverTypeList

Type: string
821
EthernetII
EthernetII (ethernet:EthernetII)
Description:
Children: vlans, vntags
Next headers: ipv4:IPv4, ipv6:IPv6, mpls:Mpls, pppoe:PPPoEDiscovery, pppoe:PPPoESession, arp:ARP, arp:RARP, ethernetpause:PFC, lacp:LACP, lacp:Marker,
serviceoam:CCM, serviceoam:LBM, serviceoam:LBR, serviceoam:LTM, serviceoam:LTR, serviceoam:DMM, serviceoam:DMR, serviceoam:LMM,
serviceoam:LMR, fc:FCoE, fc:FIP, fc:FCoEHeader, lldp:ChassisIdTlv, ethernetssm:EthernetSSM, custom:Custom
EthernetII Attributes
Attribute
Description
dstMac
Type: MACADDR
Default: 00:00:01:00:00:01
etherType
Type: EtherTypes
Default: 88B5
Possible Values:
Value Description
0200
XEROX PUP
0201
PUP Addr Trans
0400
Nixdorf
0600
XEROX NS IDP
0660
DLOG
0661
DLOG2
0800
Internet IP
0801
X.75 Internet
0802
NBS Internet
0803
ECMA Internet
0804
Chaosnet
0805
X.25 Level 3
0806
ARP
0807
XNS Compatibility
0808
Frame Relay ARP
8035
RARP
86DD IPv6
880B PPP
8809
Slow Protocol
8847
MPLS Unicast
8848
MPLS Multicast
8863
PPPoE Discovery
8864
PPPoE Session
8906
FCoE
8914
FIP
Name
information.
Type: string
preamble
Type: OCTETSTRING
Default: 55555555555555d5
srcMac
Type: MACADDR
Default: 00:10:94:00:00:02
822
EthernetII
EthernetII (mimethernet:EthernetII)
Description:
Next headers: ipv4:IPv4, ipv6:IPv6, mpls:Mpls, pppoe:PPPoEDiscovery, pppoe:PPPoESession, arp:ARP, arp:RARP, lacp:LACP, lacp:Marker, serviceoam:CCM,
serviceoam:LBR, serviceoam:LBM, serviceoam:LTM, serviceoam:LTR, serviceoam:LMM, serviceoam:LMR, serviceoam:DMM, serviceoam:DMR, lldp:ChassisIdTlv,
custom:Custom
EthernetII Attributes
Attribute
Description
cDstMac
Type: MACADDR
Default: 00:00:01:00:00:01
cSrcMac
Type: MACADDR
Default: 00:10:94:00:00:02
etherType
Type: EtherTypes
Default: 88B5
Possible Values:
Value Description
0200
XEROX PUP
0201
PUP Addr Trans
0400
Nixdorf
0600
XEROX NS IDP
0660
DLOG
0661
DLOG2
0800
Internet IP
0801
X.75 Internet
0802
NBS Internet
0803
ECMA Internet
0804
Chaosnet
0805
X.25 Level 3
0806
ARP
0807
XNS Compatibility
0808
Frame Relay ARP
8035
RARP
86DD IPv6
880B PPP
8809
Slow Protocol
8847
MPLS Unicast
8848
MPLS Multicast
8863
PPPoE Discovery
8864
PPPoE Session
8906
FCoE
8914
FIP
Name
information.
Type: string
preamble
Type: OCTETSTRING
Default: 55555555555555d5
823
EthernetPause
EthernetPause (ethernetpause:EthernetPause)
Description:
Children: None
EthernetPause Attributes
Attribute
Description
dstMac
Type: MACADDR
Default: 01:80:C2:00:00:01
lengthType
Type: OCTETSTRING
Default: 8808
Name
Type: string
Opcode
Type: OCTETSTRING
Default: 0001
Parameters
Type: OCTETSTRING
Default: 0000
preamble
Type: OCTETSTRING
Default: 55555555555555d5
Reserved
Type: OCTETSTRING
srcMac
Type: MACADDR
Default: 00:00:01:00:00:03
EthernetSnap (ethernet:EthernetSnap)
Description:
Children: llcheader, snapheader, vlans, vntags
custom:Custom
EthernetSnap Attributes
Attribute
Description
dstMac
Type: MACADDR
Default: 00:00:01:00:00:01
length
Type: INTEGER
Name
Type: string
preamble
Type: OCTETSTRING
Default: 55555555555555d5
824
EthernetSnap
Attribute
Description
srcMac
Type: MACADDR
Default: 00:10:94:00:00:02
EthernetSnap (mimethernet:EthernetSnap)
Description:
Children: cvlans, llcheader, snapheader, svlans
custom:Custom
EthernetSnap Attributes
Attribute
Description
cDstMac
Type: MACADDR
Default: 00:00:01:00:00:01
cSrcMac
Type: MACADDR
Default: 00:10:94:00:00:02
length
Type: INTEGER
Name
Type: string
preamble
Type: OCTETSTRING
Default: 55555555555555d5
EthernetSSM (ethernetssm:EthernetSSM)
Description:
Children: None
Next headers: ethernetssm:QlTlv
EthernetSSM Attributes
Attribute
Description
event
Type: EventType
Default: 0
Possible Values:
Value Description
ituOui
Event
Information
Type: OCTETSTRING
Default: 0019A7
825
EthernetWan
Attribute
Description
ituSubType
Type: OCTETSTRING
Default: 0001
Name
Type: string
reservedBits
Type: BITSTRING
Default: 000
reservedBytes
Type: OCTETSTRING
Default: 000000
subType
Type: OCTETSTRING
Default: 0A
version
Type: INTEGER
Default: 1
EthernetWan
Description:
Ethernet WAN, used only if WAN is selected for PortMode in Ethernet 10 Gig Fiber.

Automatically created from: Ethernet10GigFiber
EthernetWan Writable Attributes

Writable Attribute
Description
Active, Name
Crc32
CRC 32.
Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
Enable
FALSE Disable
FramingMode
Framing mode.
Type: enum
Default: SONET_FRAMING
Possible Values:
Value
Description
SONET_FRAMING SONET framing.
SDH_FRAMING
SDH framing.
826
EthIIIf
Writable Attribute
Description
PathSignalLabel
Path signal label.

Type: enum
Default: HDLC_PATH_SIGNAL_LABEL
Possible Values:
Value
Description
HDLC_PATH_SIGNAL_LABEL
HDLC Path Signal Label.
PPP_PATH_SIGNAL_LABEL
PPP Path Signal Label.
ATM_PATH_SIGNAL_LABEL
ATM Path Signal Label.
ETHERNET_10G_WAN_PATH_SIGNAL_LABEL Ethernet 10G Wan Path Signal Label.

SectionScramble
Section scramble.
Type: bool
Default: TRUE
Possible Values:
Value Description
TRUE
Enable
FALSE Disable
EthernetWan Read-Only Attributes

EthIIIf
Description:
Ethernet II interface object.

Relations:
Side name
(Type)
Relative
Description
ApplicableOnPhy
(ApplicableOnPhy)
Ethernet100GigFiber, Ethernet10GigCopper, Ethernet10GigFiber,

Ethernet40GigFiber, EthernetCopper, EthernetFiber
DstBoundTo
(DstBinding)

StreamBlock.
EncapsulationSource
(Encapsulation)
PathDescriptor
NetworkLink
(LinkSrc)

MplsIpv4VpnCeToPeLink, MplsIpv6VpnCeToPeLink, MplsIpv6VpnCeToPeLink,
MplsL2VpnPeToPLink, MplsL2VpnPeToPLink, MplsL3VpnPeToPLink,
MplsL3VpnPeToPLink, MVpnGreCeToPeLink, MVpnGreCeToPeLink,
MVpnGrePeToPLink, MVpnGrePeToPLink, VifToVicLink, VifToVicLink,
VlanSwitchLink, VlanSwitchLink, VplsBgpCeToPeLink, VplsBgpCeToPeLink,
VplsLdpCeToPeLink, VplsLdpCeToPeLink
MemberOfVpn
(MemberOfVpn)

VpnSiteInfoVplsLdp
827
EthIIIf
Side name
(Type)
Relative
Description
Port

relation.

WimaxIf

PrimaryIfSource
(PrimaryIf)

SUT

the DUT.
RelayBlockConfig
(RelayIf)
(ResolvesInterface)

RsvpRouterConfig

SrcBoundTo
(SrcBinding)

StreamBlock.
StackedOn
(StackedOnEndpoint)

WimaxIf
TopLevelIfSource
(TopLevelIf)

SUT

interface stack.
Port

to be received as unicast traffic by any
relation.
UsesIfSource
(UsesIf)


EthIIIf Writable Attributes

Writable Attribute
Description
Active, Name
828
EthIIIf
Writable Attribute
Description
Authenticator
Authenticator identifier string.

Type: string
Default: default
IfCountPerLowerIf

Type: u32
Default: 1
IfRecycleCount
How many to times to increment the source MAC address before returning to the starting value. See SourceMac for more
information.
Type: u32
Default: 0
IsLoopbackIf

Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE

IsRange
Whether to use a combination of attributes to generate a range of source MAC addresses, or to use the SrcMacList
attribute to specify the source MAC addresses.
Type: bool
Default: TRUE
Possible Values:
Value Description
TRUE
Use a combination of attributes to generate a range of source MAC addresses. The attributes are SourceMac,
SrcMacStep, SrcMacStepMask, SrcMacRepeatCount, and IfRecycleCount. See SourceMac for more information.
FALSE Use the SrcMacList attribute to specify the source MAC addresses.
SourceMac
Source MAC address. You can generate more than one source MAC address by using combinations of SrcMacRepeatCount,
SrcMacStep, SrcMacStepMask, and IfRecycleCount. If you do that, then this attribute is the starting source MAC address.
To use this attribute, the IsRange attribute must be TRUE.
Example: SourceMac = 00:10:94:00:00:02, SrcMacStep = 00:00:00:00:00:01, SrcMacStepMask = 00:00:FF:FF:FF:FF,
IfRecycleCount = 2, SrcMacRepeatCount = 0. Generated values will be 00:10:94:00:00:02, 00:10:94:00:00:03,
00:10:94:00:00:02, 00:10:94:00:00:03, and so on.
Example: SourceMac = 00:10:94:00:00:02, SrcMacStep = 00:00:00:00:00:01, SrcMacStepMask = 00:00:FF:FF:FF:FF,
IfRecycleCount = 2, SrcMacRepeatCount = 1. Generated values will be 00:10:94:00:00:02, 00:10:94:00:00:02,
00:10:94:00:00:03, 00:10:94:00:00:03, 00:10:94:00:00:02, 00:10:94:00:00:02, 00:10:94:00:00:03, 00:10:94:00:00:03, and
so on.
Type: mac
Default: 00:10:94:00:00:02
SrcMacList
A Tcl list of source MAC addresses. To use this attribute, the IsRange attribute must be FALSE.
Type: mac
Default: 0
SrcMacRepeatCount
How many times to repeat the same source MAC address before incrementing it. See SourceMac for more information.
Type: u32
Default: 0
SrcMacStep
Source MAC address step value. See SourceMac for more information.
Type: mac
Default: 00:00:00:00:00:01
SrcMacStepMask
Source MAC address step mask. Indicates which parts of the MAC address will change when incremented. See SourceMac
Type: mac
Default: 00:00:FF:FF:FF:FF
829
ETSConfigurationTlv
Writable Attribute
Description
UseDefaultPhyMac
Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
FALSE
EthIIIf Read-Only Attributes

Read-Only Attribute
Description
AuthenticationState
Authentication state of this interface.

Type: enum
Default: RESOLVE_DONE
Possible Values:
Value
Description
RESOLVE_DONE
Resolve is done.
RESOLVE_NEEDED
Resolve is needed.
RESOLVE_FAILED
Resolve failed.
RESOLVE_IN_PROGRESS
Resolve is in progress.
RESOLVE_PARTIALLY_DONE Resolve is partially done.

EffectiveBlockCount
Block count for this interface.

Type: u32
Default: 1
IfState
State of this interface.

Type: enum
Default: DISABLED
Possible Values:
Value
Description
READY
Ready.
DISABLED
Disabled.
DELETING
Deleting.
ETSConfigurationTlv (lldp:ETSConfigurationTlv)
Description:
Children: priorityAssign, tcgBandwidth
lldp:ApplicationPriorityTlv, lldp:ETSRecommendationTlv, lldp:CongestionNotificationTlv, lldp:NivSupportTlv
ETSConfigurationTlv Attributes
Attribute
Description
length
Type: INTEGER
Default: 17
830
ETSRecommendationTlv
Attribute
Description
maxTCG
Type: INTEGER
Default: 0
Name
Type: string
oui
Type: OCTETSTRING
Default: 0080C2
reserved
Type: BITSTRING
Default: 0000
subtype
Type: OCTETSTRING
Default: 9
type
Type: INTEGER
Default: 127
willing
Type: BITSTRING
Default: 1
ETSRecommendationTlv (lldp:ETSRecommendationTlv)
Description:
Children: priorityAssign, tcgBandwidth
lldp:ApplicationPriorityTlv, lldp:ETSConfigurationTlv, lldp:CongestionNotificationTlv, lldp:NivSupportTlv
ETSRecommendationTlv Attributes
Attribute
Description
length
Type: INTEGER
Default: 17
Name
Type: string
oui
Type: OCTETSTRING
Default: 0080C2
recommendationValid
Type: BITSTRING
Default: 1
reserved
Type: BITSTRING
Default: 0000000
subtype
Type: OCTETSTRING
Default: 10
type
Type: INTEGER
Default: 127
831
EventMessageChartSeries
EventMessageChartSeries
Description:
A series of event messages for display in a chart.

Parents: ResultChartQuerySet
EventMessageChartSeries Writable Attributes

EventMessageChartSeries Read-Only Attributes

EventNoteOAMPDU (LinkOAM:EventNoteOAMPDU)
Description:
Children: DataPad, OAMBH
EventNoteOAMPDU Attributes
Attribute
Description
Code
Type: OCTETSTRING
Default: 01
Name
information.
Type: string
EventOAMPDUTLVList
Description:
Parents: EventTLV
Children: LE
EventOAMPDUTLVList Attributes
Attribute
Description
Name
information.
Type: string
832
EventTLV
EventTLV
Description:
Parents: DataPad
Children: EventOAMPDUTLVList
EventTLV Attributes
Attribute
Description
Name
information.
Type: string
ExpandBenchmarkConfigCommand
Description:
Creates a sequence of commands and sets their parameters in the sequencer in order to run a benchmarking test.

ExpandBenchmarkConfigCommand Writable Attributes

Writable Attribute
Description
Config
Benchmarking test config associated with the command.

Type: handle
Default: 0
ExpandBenchmarkConfigCommand Read-Only Attributes

Read-Only Attribute
Description

ExpandCustomConfigCommand
Description:
Populates and configures the sequencer with commands relating to the type of test defined by CustomConfigHandle.

833
ExpandResultViewDataCommand
ExpandCustomConfigCommand Writable Attributes

Writable Attribute
Description
ClearSequencer
Specifies whether or not to clear the sequencer before inserting the new sequence into the sequencer.
Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
Will clear the sequencer and stop routine sequence before inserting the new sequence.
FALSE Will append the new sequence to any existing sequencer sequence.
Config
Custom Test configuration to use when expanding.

Type: handle
Default: 0
ExpandCustomConfigCommand Read-Only Attributes

Read-Only Attribute
Description

ExpandResultViewDataCommand
Description:

ExpandResultViewDataCommand Writable Attributes

Writable Attribute
Description
ResultViewData
Type: handle
Default: 0
ExpandResultViewDataCommand Read-Only Attributes

Read-Only Attribute
Description

Type: handle
Default: 0
834
ExportDbResultsCommand
ExportDbResultsCommand
Description:
Export End of test database results.

ExportDbResultsCommand Writable Attributes

Writable Attribute
Description
Field
Config property to be saved and exported.

Type: enum
Default: VLANPRIORITY
Possible Values:
Value
Description
VLANID
Aggregate results per VLAN ID.
VLANPRIORITY Aggregate results per VLAN priority.

SRCMAC
Aggregate results per source MAC address.
DESTMAC
Aggregate results per destination MAC address.
SRCIPV4
Aggregate results per source IPv4 address.
DESTIPV4
Aggregate results per destination IPv4 address.
IPV4_TOS
Aggregate results per TOS value.
IPV4_DIFFSERV Aggregate results per DiffServ value.
Format
SRCIPV6
Aggregate results per source IPv6 address.
DESTIPV6
Aggregate results per destination IPv6 address.
FC_SID
Aggregate results per source FC source ID.
FC_DID
Aggregate results per destination FC source ID.
Type of format to use for export.

Type: enum
Default: CSV
Possible Values:
Value
Description
CSV
Csv export format.
BINARY Return values in array as command output.

GetResultCount
Return available result count if true.

Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
Return only row count.
FALSE Do not return only row count.

ResultDbFile
Provide result db file to use for exporting results. Save results if not provided.
Type: string
ResultFileName
File name prefix to use for export file.

Type: string
StartIndex
Export results from provided index.

Type: u32
Default: 0
Range: 0 - 1000000
835
ExportFecDetailsCommand
Writable Attribute
Description
TemplateUri
Template file to use for exporting results.

Type: string
TotalCount
Number of results to export.

Type: u32
Default: 0
Range: 0 - 1000000
ExportDbResultsCommand Read-Only Attributes

Read-Only Attribute
Description

TableColumnCount
Number of Columns for each exported table.

Type: u32
Default: 0
TableColumnNames
Name of Columns for each exported table.

Type: string
Default: 0
TableColumnValues
Exported results values.

Type: string
Default: 0
TableNames
Names of exported table.

Type: string
Default: 0
TableResultCount
Number of results available for each table.

Type: u64
Default: 0
Description:
Export MPLS FEC binding details.

ExportFecDetailsCommand Writable Attributes

Writable Attribute
Description
ExportAll
Speicify whether to export all matching FEC bindings.

Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
Exports all matching FEC bindings and ignores MaxEntries property.
FALSE Exports matching FEC bindings restricted by MaxEntries property.
836
Writable Attribute
Description
ExportFilePrefix
Prefix for the exported files (*.csv).

Type: string
Default: FecBindings
ExportPath
Output Folder/Archive Path to save exported FEC Bindings as files.

FecTypes
List of FEC Types to be exported.

Type: enum
Default: IPV4_PREFIX
Possible Values:
Value
Description
IPV4_PREFIX
IPv4 Prefix
IPV6_PREFIX
IPv6 Prefix
LDP_VC_FEC_128 LDP VC FEC 128

LDP_VC_FEC_129 LDP VC FEC 129
LabelSource
BGP_VPLS
BGP VPLS
VPN_IPV4
VPN IPv4
VPN_IPV6
VPN IPv6
RSVP
RSVP
Whether Learned/Advertised labels are to be exported.

Type: enum
Default: LEARNED
Possible Values:
Value
Description
LEARNED
Learned
ADVERTISED Advertised
MaxEntries
Maximum FEC bindings to export.

Type: u32
Default: 5000
ProtocolList
List of protocol handles.

Type: handle
Default: 0
SaveAsArchive
Specify whether to save exported FEC bindings as an Archive.

Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
Save FEC bindings as an Archive.
FALSE Save FEC bindings into a Folder.

TrafficBinding
Whether Resolved/Unresolved labels are to be exported.

Type: enum
Default: SHOW_ALL
Possible Values:
Value
Description
RESOLVED
Resolved labels.
UNRESOLVED Unresolved labels.

TRAFFIC_ALL All labels used with traffic.
SHOW_ALL
All labels.
837
ExportResultsCommand
ExportFecDetailsCommand Read-Only Attributes

Read-Only Attribute
Description

ExportedFileNames
Exported file names.

FecBindingCount
Exported FEC Binding Count.

Type: u32
Default: 0
ExportResultsCommand
Description:
Exports results of an existing Result View to a file.
Tcl example: stc::perform ExportResults -filenameprefix myresults -resultview [ stc::get project1 -children-resultdataset ]

ExportResultsCommand Writable Attributes

Writable Attribute
Description
ColumnHeaderStyle
Style for the column heading names.

Type: enum
Default: DISPLAY
Possible Values:
Value
Description
DISPLAY
Use the GUI display name for column headings.
PROPERTY Use the property name for column headings.

FileNamePrefix
Prefix of results file.

Type: string
OutputFormat
Format of results file. Currently only csv format is supported.

Type: string
Default: csv
ResultView
Handle to the Result View to export. Can either be a ResultDataSet or DynamicResultView. Charts are not
supported.
Type: handle
Default: 0
WriteMode
Write mode for file save.

Type: enum
Default: OVERWRITE
Possible Values:
Value
Description
APPEND
Append results to the end of an existing file.
OVERWRITE Overwrite an existing file.
838
ExposedConfig
ExportResultsCommand Read-Only Attributes

Read-Only Attribute
Description

ExposedConfig
Description:

Parents: Project
Children: ExposedProperty
ExposedConfig Writable Attributes

Writable Attribute
Description
Active, Name
ExposedConfig Read-Only Attributes

ExposedProperty
Description:

Parents: ExposedConfig
ExposedProperty Writable Attributes

Writable Attribute
Description
Active, Name
EPClassId
Type: classId
Default: 0
EPDefaultValue
Type: string
EPDisplayName
Type: string
EPName
Type: string
EPPropertyId
Type: propertyId
Default: 0
839
extendedControl
ExposedProperty Read-Only Attributes

extendedControl
Description:
Parents: rch
Children: None
extendedControl Attributes
Attribute
Description
ef
Type: efValues
Default: 0
Possible Values:
Value Description
fi
Not an Extended Frame
Extended Frame
Type: fiValues
Default: 00
Possible Values:
Value Description
0
No Flood
Unidirectional Flood
Bidirectional Flood
Reserved Type of Flood
Name
Type: string
ps
Type: psValues
Default: 0
Possible Values:
Value Description
0
First Transmitted by Station
Wrapped Frame passes Source Station
res
Type: BITSTRING
Default: 000
so
Type: soValues
Default: 0
Possible Values:
Value Description
0
Not Required to Provide Strict Ordering
Strict Ordering is Required
extendedHeader
840
ExtendHeaderSize
Description:
Parents: DataFrame, ControlFrame
Children: EXTHDR
extendedHeader Attributes
Attribute
Description
Name
information.
Type: string
ExtendHeaderSize
Description:
Parents: EXTHDR
Children: None
ExtendHeaderSize Attributes
Attribute
Description
daExtended
Type: MACADDR
Default: 00:00:01:00:00:01
Name
Type: string
saExtended
Type: MACADDR
Default: 00:00:01:00:00:01
externalAdditionalMetrics
Description:
Parents: ospfv2AsExternalLsa
Children: Ospfv2ExternalLsaTosMetric
externalAdditionalMetrics Attributes
Attribute
Description
Name
information.
Type: string
841
ExternalDevice
ExternalDevice
Description:
External device class.

Parents: Project
Children: Aal5If, Dhcpv4ServerDefaultPoolConfig, Dhcpv4ServerPoolConfig, Dhcpv6ServerAddrPoolConfig, Dhcpv6ServerDefaultAddrPoolConfig,
Dhcpv6ServerDefaultPrefixPoolConfig, Dhcpv6ServerPrefixPoolConfig, EthIIIf, ExternalDevicePort, ExternalDeviceSession, FcIf, GreIf, HdlcIf, Ipv4If,
Ipv4NetworkBlock, Ipv6If, Ipv6NetworkBlock, ItagIf, L2tpv2If, MacBlock, MplsIf, Pimv4JoinSrc, Pimv4PruneSrc, Pimv6JoinSrc, Pimv6PruneSrc, PppIf, PppoeIf,
PppoeServerIpv4PeerPool, PppoxServerIpv4PeerPool, PppoxServerIpv6PeerPool, VlanBlock, VlanIf, WimaxIf
Relations:
Side name
(Type)
Relative
Description
PrimaryIf
(PrimaryIf)

Specifies if a top-level interface is facing the DUT.
TopLevelIf
(TopLevelIf)

Specifies the top-level interface in the interface

stack.
ExternalDevice Writable Attributes

Writable Attribute
Description
Active, Name
AppendDeviceTypeToHostName
Flag to append/no-append device type to host name.

Type: bool
Default: TRUE
Possible Values:
Value Description
TRUE
Enable privileged password for external device.
FALSE Disable privileged password for external device.

DeviceType
Define external device type, such as Cisco7200, Cisco7600, JuniperMx4.

Type: string
Default: null
EnablePrivilege
Flag to enable/disable privileged password for external device.

Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
Enable privileged password for external device.
FALSE Disable privileged password for external device.

HostName
Define external device IP address.

Type: ip
Default: 0.0.0.0
PrivilegedPassword
Privileged password.
Type: string
ExternalDevice Read-Only Attributes

842
ExternalDeviceAddNewTypeCommand
ExternalDeviceAddNewTypeCommand
Description:
Add new DUT type to template library.

ExternalDeviceAddNewTypeCommand Writable Attributes

Writable Attribute
Description
ExternalDeviceType
External device (DUT) type name.

Type: string
InheritFrom
Which ExternalDeviceType the new type will inherit from.

Type: string
SessionProfileRef
SessionProfile reference.
Type: string
ExternalDeviceAddNewTypeCommand Read-Only Attributes

Read-Only Attribute
Description

ExternalDeviceCustom10Command
Description:
Tenth customized command for External Device. TIP: Up to ten results columns can be set up to display Device Commander custom command results. For
more information see Creating Device Configuration Test Cases in the online Help file.

Parents: Sequencer
ExternalDeviceCustom10Command Writable Attributes

Writable Attribute
Description
HandleList
Indicates which session list this command will be executed on.

Type: handle
Default: 0
WaitTime
Maximum expected command execution time. Command exits after WaitTime expires, even if the command
execution is still in progress.
Type: u32
Default: 120
843
ExternalDeviceCustom10CommandResults
ExternalDeviceCustom10Command Read-Only Attributes

Read-Only Attribute
Description
PassFailState
Alias
Alias for the tenth custom command name.

Type: string
Description:
Custom10 command results class for Device Commander.

Parents: ExternalDeviceSession
Relations:
Side name
(Type)
Relative
Description
ResultParent
(ResultChild)
ExternalDeviceSession
ExternalDeviceCustom10CommandResults Writable Attributes

ExternalDeviceCustom10CommandResults Read-Only Attributes

Read-Only Attribute
Description
Column1
First column name.

Type: double
Default: 0
Column10
Tenth column name.

Type: string
Column2
Second column name.

Type: double
Default: 0
Column3
Third column name.

Type: double
Default: 0
Column4
Fourth column name.

Type: double
Default: 0
Column5
Fifth column name.

Type: double
Default: 0
Column6
Sixth column name.

Type: string
844
Read-Only Attribute
Description
Column7
Seventh column name.

Type: string
Column8
Eighth column name.

Type: string
Column9
Ninth column name.

Type: string
Timestamp
Time stamp for the last updated data.

Type: string
Default: 0
Description:
First customized command for External Device. TIP: Up to ten results columns can be set up to display Device Commander custom command results. For

Parents: Sequencer

Writable Attribute
Description
HandleList
Indicates on which session list this command will be executed.

Type: handle
Default: 0
WaitTime
Type: u32
Default: 120

Read-Only Attribute
Description
PassFailState
Alias
Alias for the first custom command name.

Type: string
Description:
Custom 1 command results class for Device Commander.
845

Relations:
Side name
(Type)
Relative
Description
ResultParent
(ResultChild)


Read-Only Attribute
Description
Column1
First column name.

Type: double
Default: 0
Column10
Tenth column name.

Type: string
Column2
Second column name.

Type: double
Default: 0
Column3
Third column name.

Type: double
Default: 0
Column4
Fourth column name.

Type: double
Default: 0
Column5
Fifth column name.

Type: double
Default: 0
Column6
Sixth column name.

Type: string
Column7

Type: string
Column8
Eighth column name.

Type: string
Column9
Ninth column name.

Type: string
Timestamp

Type: string
Default: 0
846
Description:
Second customized command for External Device. TIP: Up to ten results columns can be set up to display Device Commander custom command results. For

Parents: Sequencer

Writable Attribute
Description
HandleList

Type: handle
Default: 0
WaitTime
Type: u32
Default: 120

Read-Only Attribute
Description
PassFailState
Alias
Alias for the second custom command name.

Type: string
Description:

Relations:
Side name
(Type)
Relative
Description
ResultParent
(ResultChild)


Read-Only Attribute
Description
Column1
First column name.

Type: double
Default: 0
847
Read-Only Attribute
Description
Column10
Tenth column name.

Type: string
Column2
Second column name.

Type: double
Default: 0
Column3
Third column name.

Type: double
Default: 0
Column4
Fourth column name.

Type: double
Default: 0
Column5
Fifth column name.

Type: double
Default: 0
Column6
Sixth column name.

Type: string
Column7

Type: string
Column8
Eighth column name.

Type: string
Column9
Ninth column name.

Type: string
Timestamp

Type: string
Default: 0
Description:
Third customized command for External Device. TIP: Up to ten results columns can be set up to display Device Commander custom command results. For

Parents: Sequencer

Writable Attribute
Description
HandleList

Type: handle
Default: 0
848
Writable Attribute
Description
WaitTime
Type: u32
Default: 120

Read-Only Attribute
Description
PassFailState
Alias
Alias for the third custom command name.

Type: string
Description:

Relations:
Side name
(Type)
Relative
Description
ResultParent
(ResultChild)


Read-Only Attribute
Description
Column1
First column name.

Type: double
Default: 0
Column10
Tenth column name.

Type: string
Column2
Second column name.

Type: double
Default: 0
Column3
Third column name.

Type: double
Default: 0
Column4
Fourth column name.

Type: double
Default: 0
849
Read-Only Attribute
Description
Column5
Fifth column name.

Type: double
Default: 0
Column6
Sixth column name.

Type: string
Column7

Type: string
Column8
Eighth column name.

Type: string
Column9
Ninth column name.

Type: string
Timestamp

Type: string
Default: 0
Description:
Fourth customized command for External Device. TIP: Up to ten results columns can be set up to display Device Commander custom command results. For

Parents: Sequencer

Writable Attribute
Description
HandleList

Type: handle
Default: 0
WaitTime
Type: u32
Default: 120

Read-Only Attribute
Description
PassFailState
Alias
Alias for the fourth custom command name.

Type: string
850
Description:

Relations:
Side name
(Type)
Relative
Description
ResultParent
(ResultChild)


Read-Only Attribute
Description
Column1
First column name.

Type: double
Default: 0
Column10
Tenth column name.

Type: string
Column2
Second column name.

Type: double
Default: 0
Column3
Third column name.

Type: double
Default: 0
Column4
Fourth column name.

Type: double
Default: 0
Column5
Fifth column name.

Type: double
Default: 0
Column6
Sixth column name.

Type: string
Column7

Type: string
Column8
Eighth column name.

Type: string
Column9
Ninth column name.

Type: string
Timestamp

Type: string
Default: 0
851
Description:
Fifth customized command for External Device. TIP: Up to ten results columns can be set up to display Device Commander custom command results. For

Parents: Sequencer

Writable Attribute
Description
HandleList

Type: handle
Default: 0
WaitTime
Type: u32
Default: 120

Read-Only Attribute
Description
PassFailState
Alias
Alias for the fifth custom command name.

Type: string
Description:

Relations:
Side name
(Type)
Relative
Description
ResultParent
(ResultChild)


Read-Only Attribute
Description
Column1
First column name.

Type: double
Default: 0
852
Read-Only Attribute
Description
Column10
Tenth column name.

Type: string
Column2
Second column name.

Type: double
Default: 0
Column3
Third column name.

Type: double
Default: 0
Column4
Fourth column name.

Type: double
Default: 0
Column5
Fifth column name.

Type: double
Default: 0
Column6
Sixth column name.

Type: string
Column7

Type: string
Column8
Eighth column name.

Type: string
Column9
Ninth column name.

Type: string
Timestamp

Type: string
Default: 0
Description:
Sixth customized command for External Device. TIP: Up to ten results columns can be set up to display Device Commander custom command results. For

Parents: Sequencer

Writable Attribute
Description
HandleList

Type: handle
Default: 0
853
Writable Attribute
Description
WaitTime
Type: u32
Default: 120

Read-Only Attribute
Description
PassFailState
Alias
Alias for the sixth custom command name.

Type: string
Description:

Relations:
Side name
(Type)
Relative
Description
ResultParent
(ResultChild)


Read-Only Attribute
Description
Column1
First column name.

Type: double
Default: 0
Column10
Tenth column name.

Type: string
Column2
Second column name.

Type: double
Default: 0
Column3
Third column name.

Type: double
Default: 0
Column4
Fourth column name.

Type: double
Default: 0
854
Read-Only Attribute
Description
Column5
Fifth column name.

Type: double
Default: 0
Column6
Sixth column name.

Type: string
Column7

Type: string
Column8
Eighth column name.

Type: string
Column9
Ninth column name.

Type: string
Timestamp

Type: string
Default: 0
Description:
Seventh customized command for External Device. TIP: Up to ten results columns can be set up to display Device Commander custom command results. For

Parents: Sequencer

Writable Attribute
Description
HandleList

Type: handle
Default: 0
WaitTime
Type: u32
Default: 120

Read-Only Attribute
Description
PassFailState
Alias
Alias for the seventh custom command name.

Type: string
855
Description:

Relations:
Side name
(Type)
Relative
Description
ResultParent
(ResultChild)


Read-Only Attribute
Description
Column1
First column name.

Type: double
Default: 0
Column10
Tenth column name.

Type: string
Column2
Second column name.

Type: double
Default: 0
Column3
Third column name.

Type: double
Default: 0
Column4
Fourth column name.

Type: double
Default: 0
Column5
Fifth column name.

Type: double
Default: 0
Column6
Sixth column name.

Type: string
Column7

Type: string
Column8
Eighth column name.

Type: string
Column9
Ninth column name.

Type: string
Timestamp

Type: string
Default: 0
856
Description:
Eighth customized command for External Device. TIP:Up to ten results columns can be set up to display Device Commander custom command results. For

Parents: Sequencer

Writable Attribute
Description
HandleList

Type: handle
Default: 0
WaitTime
Type: u32
Default: 120

Read-Only Attribute
Description
PassFailState
Alias
Alias for the eighth custom command name.

Type: string
Description:

Relations:
Side name
(Type)
Relative
Description
ResultParent
(ResultChild)


Read-Only Attribute
Description
Column1
First column name.

Type: double
Default: 0
857
Read-Only Attribute
Description
Column10
Tenth column name.

Type: string
Column2
Second column name.

Type: double
Default: 0
Column3
Third column name.

Type: double
Default: 0
Column4
Fourth column name.

Type: double
Default: 0
Column5
Fifth column name.

Type: double
Default: 0
Column6
Sixth column name.

Type: string
Column7

Type: string
Column8
Eighth column name.

Type: string
Column9
Ninth column name.

Type: string
Timestamp

Type: string
Default: 0
Description:
Ninth customized command for External Device. TIP: Up to ten results columns can be set up to display Device Commander custom command results. For

Parents: Sequencer

Writable Attribute
Description
HandleList

Type: handle
Default: 0
858
Writable Attribute
Description
WaitTime
Type: u32
Default: 120

Read-Only Attribute
Description
PassFailState
Alias
Alias for the ninth custom command name.

Type: string
Description:

Relations:
Side name
(Type)
Relative
Description
ResultParent
(ResultChild)


Read-Only Attribute
Description
Column1
First column name.

Type: double
Default: 0
Column10
Tenth column name.

Type: string
Column2
Second column name.

Type: double
Default: 0
Column3
Third column name.

Type: double
Default: 0
Column4
Fourth column name.

Type: double
Default: 0
859
ExternalDeviceCustomPollingCommandResults
Read-Only Attribute
Description
Column5
Fifth column name.

Type: double
Default: 0
Column6
Sixth column name.

Type: string
Column7

Type: string
Column8
Eighth column name.

Type: string
Column9
Ninth column name.

Type: string
Timestamp

Type: string
Default: 0
Description:
Result of ExternalDeviceCustomPollingCommand. TIP: Up to ten results columns can be set up to display Device Commander custom command results. For

Relations:
Side name
(Type)
Relative
Description
ResultParent
(ResultChild)
ExternalDeviceCustomPollingCommandResults Writable Attributes

ExternalDeviceCustomPollingCommandResults Read-Only Attributes

Read-Only Attribute
Description
Column1
First column name.

Type: double
Default: 0
Column10
Tenth column name.

Type: string
Column2
Second column name.

Type: double
Default: 0
860
ExternalDeviceCustomPollingStartCommand
Read-Only Attribute
Description
Column3
Third column name.

Type: double
Default: 0
Column4
Fourth column name.

Type: double
Default: 0
Column5
Fifth column name.

Type: double
Default: 0
Column6
Sixth column name.

Type: string
Column7

Type: string
Column8
Eighth column name.

Type: string
Column9
Ninth column name.

Type: string
Timestamp

Type: string
Default: 0
ExternalDeviceCustomPollingStartCommand
Description:
Notify DutAdaptor to execute a custom test case periodically. TIP: Up to ten results columns can be set up to display Device Commander custom command
results. For more information see Creating Device Configuration Test Cases in the online Help file.

ExternalDeviceCustomPollingStartCommand Writable Attributes

Writable Attribute
Description
HandleList

Type: handle
Default: 0
Interval
Interval in seconds between executing the test case.

Type: u32
Default: 10
861
ExternalDeviceCustomPollingStopCommand
ExternalDeviceCustomPollingStartCommand Read-Only Attributes

Read-Only Attribute
Description

Alias
Description of the command, which is defined by the user.

Type: string
ExternalDeviceCustomPollingStopCommand
Description:
Deactivate custom polling notification from DutAdaptor. TIP: Up to ten results columns can be set up to display Device Commander custom command results.
For more information see Creating Device Configuration Test Cases in the online Help file.

ExternalDeviceCustomPollingStopCommand Writable Attributes

Writable Attribute
Description
HandleList

Type: handle
Default: 0
ExternalDeviceCustomPollingStopCommand Read-Only Attributes

Read-Only Attribute
Description

ExternalDeviceDeleteTypeCommand
Description:
Delete a DUT type from template library.

ExternalDeviceDeleteTypeCommand Writable Attributes

Writable Attribute
Description
862
ExternalDeviceDummySession
Writable Attribute
Description
ExternalDeviceType
External device (DUT) type name.

Type: string
ExternalDeviceDeleteTypeCommand Read-Only Attributes

Read-Only Attribute
Description

ExternalDeviceDummySession
Description:

Automatically created from: ExternalDummyDevice
ExternalDeviceDummySession Writable Attributes

Writable Attribute
Description
Active, Name
Password
Type: string
Port
Type: u16
Default: 23
SessionType
Type: enum
Default: TELNET
Possible Values:
Value
Description
TELNET
SSH
VMWARE
DUMMY
SshAuthentication
Type: enum
Default: PASSWORD
Possible Values:
Value
Description
PASSWORD
SshVersion
Type: enum
Default: AUTO
Possible Values:
Value Description
AUTO
UserName
Type: string
863
ExternalDeviceGetAllPortsCommand
ExternalDeviceDummySession Read-Only Attributes

Read-Only Attribute
Description
SessionStatus
Type: enum
Default: CLOSED
Possible Values:
Value
Description
CLOSED
OPENED
ExternalDeviceGetAllPortsCommand
Description:
Retrieves ports information from DUT through specified session.

Parents: Sequencer
ExternalDeviceGetAllPortsCommand Writable Attributes

Writable Attribute
Description
Session

Type: handle
Default: 0
WaitTime
Maximum expected command execution time. Command will exit after WaitTime expires even if the command
Type: u32
Default: 120
ExternalDeviceGetAllPortsCommand Read-Only Attributes

Read-Only Attribute
Description
PassFailState
PortNameList
External device port name list.

Type: string
PortStatusList
Status of the port.

Type: string
ExternalDeviceLoadConfigCommand
Description:
Upload DUT configuration file from your computer to the DUT. NOTE: enable DUT tfpt/ftp client before using this command.
864
ExternalDeviceOption

Parents: Sequencer
ExternalDeviceLoadConfigCommand Writable Attributes

Writable Attribute
Description
ActiveImmediately
Specifies when to activate the configuration file.

Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
Activate the configuration file right away.
FALSE Activate the configuration file later.

Session

Type: handle
Default: 0
SourceFileName
Source config file name.

Type: string
WaitTime
Type: u32
Default: 180
ExternalDeviceLoadConfigCommand Read-Only Attributes

Read-Only Attribute
Description
PassFailState
ExternalDeviceOption
Description:
Contains configuration information specific to Device Commander.

ExternalDeviceOption Writable Attributes

Writable Attribute
Description
Active, Name
ApplicationFileName
Path to the Device commander application.

Type: string
CurrentDeviceCommanderType
Device Commander application type to be used.

Type: enum
Default: EXDEVICE_ITEST
Possible Values:
Value
Description
EXDEVICE_ITEST iTest application.
865
ExternalDevicePort
Writable Attribute
Description
TclLibPath
Specify the Tcl interpreter to be used by Device Commander.

Type: string
Workspace
Workspace path to be used by Device Commander GUI and CLI upon loading.
Type: string
ExternalDeviceOption Read-Only Attributes

ExternalDevicePort
Description:
External device port class.

Parents: ExternalDevice, Project
Dhcpv6ServerDefaultPrefixPoolConfig, Dhcpv6ServerPrefixPoolConfig, EthIIIf, FcIf, GreIf, HdlcIf, Ipv4If, Ipv4NetworkBlock, Ipv6If, Ipv6NetworkBlock, ItagIf,
L2tpv2If, MacBlock, MplsIf, Pimv4JoinSrc, Pimv4PruneSrc, Pimv6JoinSrc, Pimv6PruneSrc, PppIf, PppoeIf, PppoeServerIpv4PeerPool, PppoxServerIpv4PeerPool,
PppoxServerIpv6PeerPool, VlanBlock, VlanIf, WimaxIf
Automatically-created children: Host
Result children (automatically created): ExternalDevicePortResults, ExternalDeviceVmwareCpuResults, ExternalDeviceVmwareNicResults,
ExternalDeviceVmwareResults
Relations:
Side name
(Type)
Relative
Description
PhysicalPort
(PhysicalLogical)
PhysicalPort
PrimaryIf
(PrimaryIf)
Aal5If, EthIIIf, FcIf, GreIf, HdlcIf, Ipv4If, Ipv6If, ItagIf, L2tpv2If, MplsIf,
PppIf, PppoeIf, VlanIf, WimaxIf
Specifies if a top-level interface is facing the

DUT.
ResultChild
(ResultChild)
ExternalDevicePortResults, ExternalDeviceVmwareCpuResults,
ExternalDeviceVmwareNicResults, ExternalDeviceVmwareResults

object.
TopLevelIf
(TopLevelIf)

stack.
ExternalDevicePort Writable Attributes

Writable Attribute
Description
Active, Name
AppendLocationToPortName
Type: bool
Default: TRUE
Possible Values:
Value Description
TRUE
FALSE
866
ExternalDevicePortResults
Writable Attribute
Description
Layer3Type
Type: enum
Default: IPV4
Possible Values:
Value Description
IPV4
IPV6
IPV4V6
Location
Type: csp
Default: //(Offline)/1/1
UseDefaultHost
Type: bool
Default: TRUE
Possible Values:
Value Description
TRUE
FALSE
ExternalDevicePort Read-Only Attributes

Read-Only Attribute
Description
Online
Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
FALSE
PortGroupSize
Type: u16
Default: 0
PortStatus
External device port status.

Type: string
SupportedPhys
Type: enum
Default: ETHERNET_COPPER
Possible Values:
Value
Description
ETHERNET_COPPER
ETHERNET_FIBER
ETHERNET_10_GIG_FIBER
POS
ETHERNET_10_GIG_COPPER
ATM
FC
ExternalDevicePortResults
Description:
ExternalDevicePortResults used to keep statistic result on a specified ExternalDevicePort.
867
ExternalDevicePortStatsStartCommand

Parents: ExternalDevicePort
Relations:
Side name
(Type)
Relative
Description
ResultParent
(ResultChild)
ExternalDevicePort
ExternalDevicePortResults Writable Attributes

ExternalDevicePortResults Read-Only Attributes

Read-Only Attribute
Description
Timestamp
Timestamp when the last result record is retrieved from DUT.

Type: string
Default: 0
TotalRxCount
Total received packets count. If port status is down, set this value to 0.
Type: s64
Default: 0
TotalRxRate
Total received rate in bytes. If port status is down, set this value to 0.
Type: s64
Default: 0
TotalTxCount
Total transmitted packets count. If port status is down, set this value to 0.
Type: s64
Default: 0
TotalTxRate
Total transmitted Rate in bytes. If port status is down, set this value to 0.
Type: s64
Default: 0
ExternalDevicePortStatsStartCommand
Description:
Activate port statistic notification from DutAdaptor.

ExternalDevicePortStatsStartCommand Writable Attributes

Writable Attribute
Description
HandleList

Type: handle
Default: 0
868
ExternalDevicePortStatsStopCommand
ExternalDevicePortStatsStartCommand Read-Only Attributes

Read-Only Attribute
Description

ExternalDevicePortStatsStopCommand
Description:
Deactivate port statistic notification from DutAdaptor.

ExternalDevicePortStatsStopCommand Writable Attributes

Writable Attribute
Description
HandleList

Type: handle
Default: 0
ExternalDevicePortStatsStopCommand Read-Only Attributes

Read-Only Attribute
Description

ExternalDeviceRefreshPortsStatusCommand
Description:

ExternalDeviceRefreshPortsStatusCommand Writable Attributes

Writable Attribute
Description
HandleList
Type: handle
Default: 0
WaitTime
Type: u32
Default: 180
869
ExternalDeviceResetCommand
ExternalDeviceRefreshPortsStatusCommand Read-Only Attributes

Read-Only Attribute
Description

ExternalDeviceResetCommand
Description:
Reset DUTs through specified sessions

Parents: Sequencer
ExternalDeviceResetCommand Writable Attributes

Writable Attribute
Description
HandleList

Type: handle
Default: 0
WaitTime
Maximum waiting time (in seconds) before stopping this command's execution. To allow time for the DUT to
reset successfully, set WaitTime at 60 seconds or more.
Type: u32
Default: 360
ExternalDeviceResetCommand Read-Only Attributes

Read-Only Attribute
Description
PassFailState
ExternalDeviceRunConfigCommand
Description:
Replay a file recorded by Spirent Device Commander.

Parents: Sequencer
Relations:
Side name
(Type)
Relative
ConfigHandle
(CommandConfigMap)
ExternalDummyDevice
870
Description
ExternalDeviceRunConfigCommandResults
ExternalDeviceRunConfigCommand Writable Attributes

Writable Attribute
Description
Application
Type: enum
Default: EXDEVICE_ITEST
Possible Values:
Value
Description
EXDEVICE_ITEST
ApplicationFilePath
Type: inputFilePath
Arguments
Arguments passed to the application.

Type: string
ExecutionMode
Execution mode.
Type: enum
Default: BLOCKING
Possible Values:
Value
Description
BLOCKING
InputFileName
Test case file name.

Type: inputFilePath
WaitTime
Type: u32
Default: 0
Workspace
Type: inputFilePath
ExternalDeviceRunConfigCommand Read-Only Attributes

Read-Only Attribute
Description
PassFailState
Description:
Result of ExternalRunConfigCommand. TIP: Up to ten results columns can be set up to display Device Commander custom command results. For more
information see Creating Device Configuration Test Cases in the online Help file.

Parents: ExternalDummyDevice
Relations:
Side name
(Type)
Relative
Description
ResultParent
(ResultChild)
ExternalDummyDevice
871
ExternalDeviceSaveCommandMappingCommand
ExternalDeviceRunConfigCommandResults Writable Attributes

ExternalDeviceRunConfigCommandResults Read-Only Attributes

Read-Only Attribute
Description
Column1
First column name.

Type: double
Default: 0
Column10
Tenth column name.

Type: string
Column2
Second column name.

Type: double
Default: 0
Column3
Third column name.

Type: double
Default: 0
Column4
Fourth column name.

Type: double
Default: 0
Column5
Fifth column name.

Type: double
Default: 0
Column6
Sixth column name.

Type: string
Column7

Type: string
Column8
Eighth column name.

Type: string
Column9
Ninth column name.

Type: string
InputFileName
Type: string
Timestamp
Type: string
Default: 0
ExternalDeviceSaveCommandMappingCommand
Description:
Internal command to save Spirent TestCenter command to Device Commander recorded file mapping relations into CommandMap.xml.

872
ExternalDeviceSaveCommandMappingCommand Writable Attributes

Writable Attribute
Description
ExternalDeviceSaveCommandMappingCommand Read-Only Attributes

Read-Only Attribute
Description

Description:
Contains session (telnet/ssh) related configuration to a DUT.

Parents: ExternalDevice, ExternalDeviceCustom10CommandResults, ExternalDeviceCustom1CommandResults, ExternalDeviceCustom2CommandResults,
ExternalDeviceCustom3CommandResults, ExternalDeviceCustom4CommandResults, ExternalDeviceCustom5CommandResults,
ExternalDeviceCustom9CommandResults, ExternalDeviceCustomPollingCommandResults
Result children (automatically created): ExternalDeviceCustom10CommandResults, ExternalDeviceCustom1CommandResults,
ExternalDeviceCustom8CommandResults, ExternalDeviceCustom9CommandResults, ExternalDeviceCustomPollingCommandResults
Relations:
Side name
(Type)
Relative
Description
ResultChild
(ResultChild)
ExternalDeviceCustom10CommandResults, ExternalDeviceCustom1CommandResults,
Use this to connect a results

object to an object.
ExternalDeviceSession Writable Attributes

Writable Attribute
Description
Active, Name
Password
Password used for login to external device.

Type: string
Port
Port used for session connection.

Type: u16
Default: 23
873
ExternalDeviceSessionConnectCommand
Writable Attribute
Description
SessionType
Session type.
Type: enum
Default: TELNET
Possible Values:
Value
Description
TELNET
Telnet session mode.
SSH
SSH session mode.
VMWARE Vmware session mode.

DUMMY
SshAuthentication
SSH authentication type, should be one of EnumSshAuthentication.

Type: enum
Default: PASSWORD
Possible Values:
Value
Description
PASSWORD Password mode.
SshVersion
SSH version, should be one of EnumSshVersion.

Type: enum
Default: AUTO
Possible Values:
Value Description
AUTO Auto mode.
UserName
User name used for login to external device.

Type: string
ExternalDeviceSession Read-Only Attributes

Read-Only Attribute
Description
SessionStatus
Session Status presented by EnumSessionStatus type.

Type: enum
Default: CLOSED
Possible Values:
Value
Description
CLOSED Session is not opened by a connection, or has been closed.
OPENED Session is opened for interaction.
ExternalDeviceSessionConnectCommand
Description:
Start connection on a list of external device sessions.

Parents: Sequencer
874
ExternalDeviceSessionDisconnectCommand
ExternalDeviceSessionConnectCommand Writable Attributes

Writable Attribute
Description
HandleList

Type: handle
Default: 0
WaitTime
Maximum waiting time(seconds) before stopping this command's execution.

Type: u32
Default: 180
ExternalDeviceSessionConnectCommand Read-Only Attributes

Read-Only Attribute
Description
PassFailState
ExternalDeviceSessionDisconnectCommand
Description:
Disconnect specified sessions to DUTs.

Parents: Sequencer
ExternalDeviceSessionDisconnectCommand Writable Attributes

Writable Attribute
Description
HandleList
List of sessions to be terminated to DUTs.

Type: handle
Default: 0
WaitTime
Time in seconds to exit the command execution in case disconnect fails.

Type: u32
Default: 30
ExternalDeviceSessionDisconnectCommand Read-Only Attributes

Read-Only Attribute
Description
PassFailState
ExternalDeviceSyncMapCommand
Description:
Resynchronize user test case and session profile to template library.

875
ExternalDeviceVmwareCpuResults
ExternalDeviceSyncMapCommand Writable Attributes

Writable Attribute
Description
ExternalDeviceSyncMapCommand Read-Only Attributes

Read-Only Attribute
Description

ExternalDeviceVmwareCpuResults
Description:
Results for VMware sessions for virtual machines by virtual CPU.

Relations:
Side name
(Type)
Relative
Description
ResultParent
(ResultChild)
ExternalDevicePort
ExternalDeviceVmwareCpuResults Writable Attributes

ExternalDeviceVmwareCpuResults Read-Only Attributes

Read-Only Attribute
Description
AvgCpuMhzUsage
CPU clock cycles during the collection interval that the virtual CPU was running.
Type: u64
Default: 0
CpuId
Virtual CPU index.

Type: u64
Default: 0
TotalCpuTimeReadyState
Milliseconds spent by the virtual CPU in the ready to run state during the collection interval.
Type: u64
Default: 0
TotalCpuTimeSystemProcesses
Milliseconds spent by the virtual CPU running system processes during the collection interval.
Type: u64
Default: 0
TotalCpuTimeWaitingForSwapIn
Milliseconds spent by the virtual CPU waiting for SwapIn during the collection interval.
Type: u64
Default: 0
876
ExternalDeviceVmwareNicResults
Read-Only Attribute
Description
TotalCpuTimeWaitState
Milliseconds spent by the virtual CPU in the waiting to run state during the collection interval.
Type: u64
Default: 0
TotalUsedCpuTime
Milliseconds spent by the virtual CPU running during the collection interval.
Type: u64
Default: 0
ExternalDeviceVmwareNicResults
Description:
Results for VMware sessions per virtual machine by virtual Network Interface.

Relations:
Side name
(Type)
Relative
Description
ResultParent
(ResultChild)
ExternalDevicePort
ExternalDeviceVmwareNicResults Writable Attributes

ExternalDeviceVmwareNicResults Read-Only Attributes

Read-Only Attribute
Description
AvgRxRate
Rx bytes per second for the virtual network interface during the collection interval.
Type: u64
Default: 0
AvgTxRate
Tx bytes per second for the virtual network interface during the collection interval.
Type: u64
Default: 0
NicId
Virtual Network Interface index.

Type: u64
Default: 0
TotalRxPackets
Rx byte count for the virtual network interface during the collection interval.
Type: u64
Default: 0
TotalTxPackets
Tx byte count for the virtual network interface during the collection interval.
Type: u64
Default: 0
Description:
877
Summary results for VMware sessions by virtual machine.

Relations:
Side name
(Type)
Relative
Description
ResultParent
(ResultChild)
ExternalDevicePort
ExternalDeviceVmwareResults Writable Attributes

ExternalDeviceVmwareResults Read-Only Attributes

Read-Only Attribute
Description
AggregateNetworkPerformance
Sum of the Rx and Tx bytes for all virtual network interfaces over the collection interval.
Type: u64
Default: 0
AvgCpuMhzUsage
CPU clock cycles during the collection interval that the virtual CPUs were running.
Type: u64
Default: 0
AvgCpuPercentageUsage
Percentage of the collection interval that the virtual CPUs were running.
Type: double
Default: 0
AvgRxRate
Rx bytes per second for all virtual network interfaces over the collection interval.
Type: u64
Default: 0
AvgTxRate
Tx bytes per second for all virtual network interfaces over the collection interval.
Type: u64
Default: 0
CpuCount
Count of virtual CPUs.

Type: u16
Default: 0
MemoryActivelyUsed
Memory used during the collection interval.

Type: u64
Default: 0
MemoryPercentUsage
Percentage of the memory used during the collection interval.

Type: double
Default: 0
NicCount
Count of virtual network interfaces.

Type: u16
Default: 0
Timestamp
Result collection time.

Type: string
Default: 0
TotalCpuTimeReadyState
Milliseconds all virtual CPUs spent in the ready to run state over the collection interval.
Type: u64
Default: 0
TotalCpuTimeWaitingForSwapIn
Milliseconds all virtual CPUs spent in the waiting for Swap-In state over the collection interval.
Type: u64
Default: 0
878
ExternalDeviceWriteConfigCommand
ExternalDeviceWriteConfigCommand
Description:
Save DUT configuration file from DUT to your computer. NOTE: enable DUT tfpt/ftp client before using this command.

Parents: Sequencer
ExternalDeviceWriteConfigCommand Writable Attributes

Writable Attribute
Description
FileNameToSave
Destination config file name.

Type: string
Session
Specifies for which session this command should be executed.

Type: handle
Default: 0
WaitTime
Type: u32
Default: 180
ExternalDeviceWriteConfigCommand Read-Only Attributes

Read-Only Attribute
Description
PassFailState
ExternalDummyDevice
Description:

Parents: Project
Children: ExternalDeviceRunConfigCommandResults
Automatically-created children: ExternalDeviceDummySession
Result children (automatically created): ExternalDeviceRunConfigCommandResults
Relations:
Side name
(Type)
Relative
Description
CommandHandle
(CommandConfigMap)
ExternalDeviceRunConfigCommand
ResultChild
(ResultChild)
ExternalDummyDevice Writable Attributes

ExternalDummyDevice Read-Only Attributes

879

object.
ExternalEquationResultProperty
ExternalEquationResultProperty
Description:

Parents: DynamicChartResultView, DynamicResultView, ResultProviderRegistry, ResultQuery
ExternalEquationResultProperty Writable Attributes

Writable Attribute
Description
Active, Name
DependedCounters
Type: string
Equation
Type: string
ExpressionType
Type: enum
Default: MATH
Possible Values:
Value Description
MATH
BOOL
PropertyDisplayName
Type: string
PropertyName
Type: string
PropertyType
Type: enum
Default: UINT
Possible Values:
Value
Description
STRING
UBYTE
BYTE
USHORT
SHORT
UINT
INT
U64
S64
DOUBLE
BOOL
HANDLE
IP
IPV6
MAC
880
ExternalLsaBlock
Writable Attribute
Description
PropertyUnitType
Type: enum
Default: NONE
Possible Values:
Value
Description
NONE
BITS
KBITS
MBITS
GBITS
BITSPERSEC
KBITSPERSEC
MBITSPERSEC
GBITSPERSEC
LATENCYMICROSECONDS
LATENCYMILLISECONDS
LATENCYSECONDS
BYTES
KBYTES
MBYTES
GBYTES
FRAMES
FRAMESPERSEC
BYTESPERSEC
KBYTESPERSEC
MBYTESPERSEC
GBYTESPERSEC
MICROSECONDS
MILLISECONDS
CELLS
CELLSPERSEC
SECONDS
StandardGroupingDefinition
Type: string
ExternalEquationResultProperty Read-Only Attributes

ExternalLsaBlock
Description:
Use this in OSPFv2 to create an emulated router in an external area.

881
ExternalLsaBlock
ExternalLsaBlock Writable Attributes

Writable Attribute
Description
AdvertisingRouterId
Specifies the router ID of the emulated router that this object is associated with. This will be the advertising router field in the
advertised LSAs.
Type: ip
Default: null
Age

Type: u16
Default: 0
Range: 0 - 3600
CheckSum
This specifies whether the LSA will be advertised with a good or bad checksum.
Type: enum
Default: GOOD
Possible Values:
Value Description
BAD
LSA will be advertised with bad checksum.
GOOD LSA will be advertised with bad checksum.

ForwardingAddr
IPv4 forwarding address to use in the forwarding address field of the LSA.
Type: ip
Default: 0.0.0.0
Metric
This is the route-cost metric used when advertising the LSAs.

Type: u32
Default: 1
Range: 1 - 16777215
MetricType
Metric Type (1 or 2). Used only for external routes. This is the type of metric to be advertised. Type 1: When calculating the
cost of the path to an external route, the costs of internal links are included. Type 2: Costs of internal links are not included in
total cost calculation. Type 2 routes have a lower priority and are considered in path selection after Type 1 costs have been
evaluated.
Type: enum
Default: TYPE1
Possible Values:
Value Description
TYPE1 Type 1.
TYPE2 Type 2.
Options
External LSA Options.

Type: enum
Default: EBIT
Possible Values:
Value
Description
TBIT
EBIT
MCBIT
NPBIT
EABIT
DCBIT
OBIT
882
externalLsaOptions
Writable Attribute
Description
RouteCategory

Type: enum
Default: UNDEFINED
Possible Values:
Value
Description
UNDEFINED
PRIMARY
Primary route.

UNIQUE
Unique route.
ANY
Any route.
RouteTag
Value to use in the external route tag field in the LSA.

Type: u32
Default: 0
Range: 0 - 2147483647
SeqNum

Type: u32
Default: 0x80000001
Type
Type of LSA to be generated.

Type: enum
Default: EXT
Possible Values:
Value Description
EXT
Type 5 AS external LSA.
NSSA Type 7 AS external LSA (for NSSAs), described in RFC 3101.
ExternalLsaBlock Read-Only Attributes

externalLsaOptions
Description:
Parents: ospfv2AsExternalLsa
Children: None
externalLsaOptions Attributes
Attribute
Description
eBit
Type: BITSTRING
Default: 0
Name
more information.
Type: string
reserved
Type: INTEGER
Default: 0
883
EXTHDR
EXTHDR
Description:
Parents: extendedHeader
Children: ExtendHeaderSize
EXTHDR Attributes
Attribute
Description
Name
information.
Type: string
extSecurity
Description:
Children: None
extSecurity Attributes
Attribute
Description
addSecInfo
Type: OCTETSTRING
formatCode
Type: INTEGER
Default: 0
length
Type: INTEGER
Default: 0
Name
information.
Type: string
884
fabricLogoAccept
Attribute
Description
type
Default: 133
Possible Values:
Value Description
0
End of Options List
NOP
130
Security
131
Loose Source Route
68
Time Stamp
133
Extended Security
Record Route
136
Stream Identifier
137
Strict Source Route
11
MTU Probe
12
MTU Reply
82
Traceroute
147
Address Extension
148
Router Alert
149
fabricLogoAccept
Description:
Parents: DL-Choice
Children: logoAcc
fabricLogoAccept Attributes
Attribute
Description
length
Type: INTEGER
Default: 8
Name
more information.
Type: string
reserved
Type: OCTETSTRING
Default: 0000
type
Type: INTEGER
Default: 9
fabricLogoReject
Description:
Parents: DL-Choice
Children: logoRjt
885
fabricLogoRequest
fabricLogoReject Attributes
Attribute
Description
length
Type: INTEGER
Default: 9
Name
more information.
Type: string
reserved
Type: OCTETSTRING
Default: 0000
type
Type: INTEGER
Default: 9
fabricLogoRequest
Description:
Parents: DL-Choice
Children: logo
fabricLogoRequest Attributes
Attribute
Description
length
Type: INTEGER
Default: 11
Name
more information.
Type: string
reserved
Type: OCTETSTRING
Default: 0000
type
Type: INTEGER
Default: 9
fabricName
Description:
Parents: DL-Choice
Children: None
fabricName Attributes
Attribute
Description
fabricName
Type: WWN
Default: 20:00:10:94:00:00:00:01
886
FairnessFrame
Attribute
Description
fcMap
Type: OCTETSTRING
Default: 0EFC00
length
Type: INTEGER
Default: 4
Name
Type: string
reserved
Type: OCTETSTRING
Default: 00
type
Type: INTEGER
Default: 5
VF_ID
Type: INTEGER
Default: 0
FairnessFrame (RPR:FairnessFrame)
Description:
Children: baseControl, FairnessHeader
FairnessFrame Attributes
Attribute
Description
fairRate
Type: OCTETSTRING
Default: 0000
Name
more information.
Type: string
srcMac
Type: MACADDR
Default: 00:00:01:00:00:02
ttl
Type: OCTETSTRING
Default: 1
FairnessHeader
Description:
Parents: FairnessFrame
Children: None
887
fc
FairnessHeader Attributes
Attribute
Description
ffType
Type: ffTypeValues
Default: 000
Possible Values:
Value Description
0
SINGLE_CHOKE
MULTI_CHOKE
Reserved
Name
information.
Type: string
res
Type: BITSTRING
Default: 0000000000000
fc (overloaded)
fc (fc) - Object definition for the following paths:
StreamBlock.FCoE.fc.fc
StreamBlock.FIP.DL.DL-Choice.flogiRequest.flogi.fc
StreamBlock.FIP.DL.DL-Choice.flogiAccept.flogiAcc.fc
StreamBlock.FIP.DL.DL-Choice.flogiReject.flogiRjt.fc
StreamBlock.FIP.DL.DL-Choice.npivFdiscRequest.fdisc.fc
StreamBlock.FIP.DL.DL-Choice.npivFdiscAccept.fdiscAcc.fc
StreamBlock.FIP.DL.DL-Choice.npivFdiscReject.fdiscRjt.fc
StreamBlock.FIP.DL.DL-Choice.fabricLogoRequest.logo.fc
StreamBlock.FIP.DL.DL-Choice.fabricLogoAccept.logoAcc.fc
StreamBlock.FIP.DL.DL-Choice.fabricLogoReject.logoRjt.fc
StreamBlock.FIP.DL.DL-Choice.elpReject.elprjt.fc
StreamBlock.FIP.DL.DL-Choice.elpRequest.elp.fc
StreamBlock.FIP.DL.DL-Choice.elpAccept.elp.fc
StreamBlock.FCoE.fc
fc Object (fc PDU library)

Description:
Parents: fc (StreamBlock.FCoE.fc)
flogiRjt (StreamBlock.FIP.DL.DL-Choice.flogiReject.flogiRjt)
flogiRjt (StreamBlock.FIP.DL.DL-Choice.npivFdiscReject.fdiscRjt)
logo (StreamBlock.FIP.DL.DL-Choice.fabricLogoRequest.logo)
logoAcc (StreamBlock.FIP.DL.DL-Choice.fabricLogoAccept.logoAcc)
flogiRjt (StreamBlock.FIP.DL.DL-Choice.fabricLogoReject.logoRjt)
flogiRjt (StreamBlock.FIP.DL.DL-Choice.elpReject.elprjt)
Children: None
888
fc
fc Attributes
Attribute
Description
csCtl
Type: OCTETSTRING
Default: 00
dfCtl
Type: OCTETSTRING
Default: 00
dId
Type: OCTETSTRING
Default: 000000
frameControl
Type: OCTETSTRING
Default: 380000
Name
Type: string
origExchangeID
Type: OCTETSTRING
Default: 0000
parameter
Type: OCTETSTRING
Default: 00000000
rCtl
Type: OCTETSTRING
Default: 22
responseExchangeId
Type: OCTETSTRING
Default: FFFF
seqCnt
Type: OCTETSTRING
Default: 0000
seqId
Type: OCTETSTRING
Default: 00
sId
Type: OCTETSTRING
Default: 000000
type
Type: OCTETSTRING
Default: 01

Description:
Parents: elp (StreamBlock.FIP.DL.DL-Choice.elpRequest.elp)

elp (StreamBlock.FIP.DL.DL-Choice.elpAccept.elp)
Children: None
fc Attributes
Attribute
Description
csCtl
Type: OCTETSTRING
Default: 00
889
fc
Attribute
Description
dfCtl
Type: OCTETSTRING
Default: 00
dId
Type: OCTETSTRING
Default: fffffd
frameControl
Type: OCTETSTRING
Default: 290000
Name
Type: string
origExchangeID
Type: OCTETSTRING
Default: 0000
parameter
Type: OCTETSTRING
Default: 00000000
rCtl
Type: OCTETSTRING
Default: 02
responseExchangeId
Type: OCTETSTRING
Default: FFFF
seqCnt
Type: OCTETSTRING
Default: 0000
seqId
Type: OCTETSTRING
Default: 00
sId
Type: OCTETSTRING
Default: fffffd
type
Type: OCTETSTRING
Default: 22

Description:
Parents: FCoE (StreamBlock.FCoE)

Children: fcHeader, fcPayloads
fc Attributes
Attribute
Description
Name
information.
Type: string
890
FC
FC (fc:FC)
Description:
Children: None
Next headers: fc:ELSFLOGI, fc:ELSPLOGI, fc:ELSFLOGILSACC, fc:ELSLOGO, fc:ELSLOGOLSACC, fc:ELSLSRJT, fcp:FcpCmnd, fcsw:EscReq, fcsw:EscAcc,
fcsw:Rdi, fcsw:HloReq, fcsw:LsuReq, fcsw:LsaReq, fcsw:EfpReq, fcsw:EfpAcc, fcsw:MReq, fcsw:MReqAcc, fcsw:DiaReq, fcsw:DiaAcc,
fcgs:GsRequestWithPortIdentifier, fcgs:GaNxtAccept, fcgs:GpnIdAccept, fcgs:GnnIdAccept, fcgs:GcsIdAccept, fcgs:GftIdAccept, fcgs:GspnIdAccept,
fcgs:GptIdAccept, fcgs:GfpnIdAccept, fcgs:GffIdAccept, fcgs:GsRequestWithPortName, fcgs:GidPnAccept, fcgs:GsRequestWithNodeName, fcgs:GidNnAccept,
fcgs:GsnnNnAccept, fcgs:GsRequestWithFc4Type, fcgs:GidFtAccept, fcgs:GpnFtAccept, fcgs:GnnFtAccept, fcgs:GsRequestWithPortType, fcgs:GidPtAccept,
fcgs:RpnId, fcgs:RnnId, fcgs:RcsId, fcgs:RftId, fcgs:RptId, fcgs:RspnId, fcgs:RffId, fcgs:RsnnNn, fcgs:DaId, fcgs:Gtin, fcgs:GtinAccept, fcgs:Giel, fcgs:GielAccept,
fcgs:GsRequestWithInterconnectElementName, fcgs:GietAccept, fcgs:GdidAccept, fcgs:GmidAccept, fcgs:GfnAccept, fcgs:GielnAccept, fcgs:GmalAccept,
fcgs:GieilAccept, fcgs:GplAccept, fcgs:GptAccept, fcgs:GppnAccept, fcgs:GapnlAccept, fcgs:GpsAccept, fcgs:GpscAccept, fcgs:Gatin, fcgs:GatinAccept,
fcgs:GsesAccept, fcgs:GsRequestWithPlatformName, fcgs:GplnlAccept, fcgs:GpltAccept, fcgs:GplmlAccept, fcgs:GpabAccept, fcgs:Gnpl, fcgs:GnplAccept,
fcgs:Gpnl, fcgs:GpnlAccept, fcgs:GpfcpAccept, fcgs:GpliAccept, fcgs:Gnid, fcgs:GnidAccept, fcgs:Rieln, fcgs:Rpl, fcgs:Rpln, fcgs:Rplt, fcgs:Rplm, fcgs:Rpab,
fcgs:Rpfcp, fcgs:Rpli, fcgs:Dpl, fcgs:Dpln, fcgs:Dplm, fcgs:GsDeregisterWithPlatformName, fcgs:Dpall, fcgs:Ftr, fcgs:FtrAccept, fcgs:Fpng, fcgs:FpngAccept,
fcgs:GsAccept, fcgs:GsReject, oncrpcv2:RpcMsg, custom:Custom
FC Attributes
Attribute
Description
csCtl
Type: OCTETSTRING
Default: 00
dfCtl
Type: OCTETSTRING
Default: 00
dId
Type: OCTETSTRING
Default: 000000
frameControl
Type: OCTETSTRING
Default: 380000
Name
Type: string
origExchangeID
Type: OCTETSTRING
Default: 0000
parameter
Type: OCTETSTRING
Default: 00000000
rCtl
Type: OCTETSTRING
Default: 22
responseExchangeId
Type: OCTETSTRING
Default: FFFF
seqCnt
Type: OCTETSTRING
Default: 0000
seqId
Type: OCTETSTRING
Default: 00
sId
Type: OCTETSTRING
Default: 000000
type
Type: OCTETSTRING
Default: 01
891
FC
FC (fcIf:FC)
Description:
Children: None
FC Attributes
Attribute
Description
Name
information.
Type: string
wwpn
Type: WWN
Default: 20:00:10:94:00:00:00:01
FcBaseTestGenUpdateAvailablePortsCommand
Description:

FcBaseTestGenUpdateAvailablePortsCommand Writable Attributes

Writable Attribute
Description
GenParams
Type: handle
Default: 0
RemoveUnusedPorts
Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
FALSE
FcBaseTestGenUpdateAvailablePortsCommand Read-Only Attributes

Read-Only Attribute
Description

FcDeviceGenProtocolParams
Description:
892
FcEPortConfig

FcDeviceGenProtocolParams Writable Attributes

Writable Attribute
Description
Active, Name
HostType
Specify whether hosts will register with the name server as a target, initiator, or both.
Type: enum
Default: INITIATOR
Possible Values:
Value
Description
INITIATOR Hosts will register with the name server as an initiator.
UseFcIfWorldWidePortName
TARGET
Hosts will register with name server as target.
BOTH
Hosts will register with name server as both initiator and as target.
Use the WWPN as WWNN.

Type: bool
Default: TRUE
Possible Values:
Value Description
TRUE
Use the WWPN as WWNN.
FALSE Do not use the WWPN as WWNN.

WorldWideNodeName
Starting WWNN value.

Type: wwn
Default: 10:00:10:94:00:00:00:01
WorldWideNodeNameRepeatCount
Specify the world wide node name repeat count, currently only count "1" is supported.
Type: u32
Default: 0
WorldWideNodeNameStep
Step to calculate the subsequent WWNN values.

Type: wwn
Default: 00:00:00:00:00:00:00:01
FcDeviceGenProtocolParams Read-Only Attributes

FcEPortConfig
Description:

Relations:
Side name
(Type)
Relative
Description
UsesIf
(UsesIf)

893

FcFcoeTestGenConfigExpandCommand
FcEPortConfig Writable Attributes

Writable Attribute
Description
Active, Name
Type: bool
Default: TRUE
Possible Values:
Value Description
TRUE
FALSE
Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
FALSE
WorldWideNodeName
Type: wwn
Default: 10:00:10:94:00:00:00:01
NOTE: This is deprecated. It will be removed in subsequent releases, so it is

recommended that you do not use it.
Type: u32
Default: 0
Type: wwn
Default: 00:00:00:00:00:00:00:01
FcEPortConfig Read-Only Attributes

FcFcoeTestGenConfigExpandCommand
Description:

FcFcoeTestGenConfigExpandCommand Writable Attributes

Writable Attribute
Description
ClearPortConfig
Whether the current configuration will be deleted on expanding the wizard.

Type: enum
Default: PROMPT
Possible Values:
Value
Description
PROMPT The wizard will prompt at the end before clearing the configuration.
YES
The wizard will delete the current configuration before expanding the wizard.
NO
Current configuration will not be deleted.
894
FcFcoeTrafficParams
Writable Attribute
Description
EnableDetails
Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
FALSE
EnablePreview
Show preview before creating the configuration.

Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
Show preview before creating the configuration.
FALSE Do not show preview before creating the configuration.

GenFcoeParams
Handle of the FcoeTestGenParams to be used in creating the configuration.

Type: handle
Default: 0
GenFcParams
Handle of the FcTestGenParams to be used in creating the configuration.

Type: handle
Default: 0
GenTrafficParams
Handle of the FcFcoeTrafficParams to be used in creating the configuration.

Type: handle
Default: 0
Expand using EmulatedDevice objects or Host Objects.

Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
Expand using EmulatedDevice objects.
FALSE Expand using Host Objects.
FcFcoeTestGenConfigExpandCommand Read-Only Attributes

Read-Only Attribute
Description

Details
Type: string
Summary
Type: string
FcFcoeTrafficParams
Description:
Class used by FCoE wizard to create traffic.

Parents: Project
895
FcFPortConfig
FcFcoeTrafficParams Writable Attributes

Writable Attribute
Description
Active, Name
CreateTraffic
Select to create traffic.

Type: bool
Default: TRUE
Possible Values:
Value Description
TRUE
Traffic will be created.
FALSE Traffic will not be created.

StreamBlockGroupMethod
To decide how the streams are grouped into stream blocks.

Type: enum
Default: AGGREGATE
Possible Values:
Value
Description
AGGREGATE Aggregates all streams into one stream block for each side of the configuration.
HOST
TrafficFlow
Creates one stream block for each host in each direction.
Select the direction of traffic flow.

Type: enum
Possible Values:
Value
Description
LEFT_TO_RIGHT Traffic flow is from left side ports to right side ports.
RIGHT_TO_LEFT Traffic flow is from right side ports to left side ports.
BIDIRECTIONAL Bi-directional traffic.
BACKBONE
Backbone traffic.
TrafficFrameSize
Size of frames generated.

Type: u16
Default: 2112
Range: 12 - 16383
TrafficLoadPercentPorts
Percent of traffic load generated on each port.

Type: double
Default: 10.0
Range: 0 - 100
FcFcoeTrafficParams Read-Only Attributes

FcFPortConfig
Description:

Result children (automatically created): FcFPortNeighborResults, FcFPortResults
Relations:
896
FcFPortConfig
Side name
(Type)
Relative
Description
ResultChild
(ResultChild)
FcFPortNeighborResults, FcFPortResults
UsesIf
(UsesIf)


FcFPortConfig Writable Attributes

Writable Attribute
Description
Active, Name
DomainId
Type: u8
Default: 16
EDTOV
Type: u32
Default: 2000
RATOV
Type: u32
Default: 10000
Type: bool
Default: TRUE
Possible Values:
Value Description
TRUE
FALSE
Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
FALSE
WorldWideNodeName
Type: wwn
Default: 10:00:10:94:00:00:00:01

Type: u32
Default: 0
Type: wwn
Default: 00:00:00:00:00:00:00:01
897
FcFPortNeighborResults
FcFPortConfig Read-Only Attributes

Read-Only Attribute
Description
AggregateSubState
Type: enum
Default: NONE
Possible Values:
Value
Description
NONE
LOGGED_OUT
FCF_FLOGI_RECEIVED
FCF_FLOGI_TIMED_OUT
FCF_FLOGI_REJECTED
FCF_FLOGI_ACCEPTED
FCF_FDISC_RECEIVED
FCF_FDISC_TIMED_OUT
FCF_FDISC_REJECTED
FCF_FDISC_ACCEPTED
FCF_PLOGI_RECEIVED
FCF_PLOGI_TIMED_OUT
FCF_PLOGI_REJECTED
FCF_PLOGI_ACCEPTED
MAX
BbCredit
Type: u16
Default: 3
MaxRxSize
Type: u16
Default: 2112
Range: 64 - 2166
Description:
FC F_Port results.

Parents: FcFPortConfig
Relations:
Side name
(Type)
Relative
Description
ResultParent
(ResultChild)
FcFPortConfig
FcFPortNeighborResults Writable Attributes

898
FcFPortNeighborResults Read-Only Attributes

Read-Only Attribute
Description
FcId
Assigned FC ID of the neighbor N_Port.

Type: u32
Default: 0
RxFDISCCount
Number of FDSIC messages received.

Type: u32
Default: 0
RxFLOGICount
Number of FLOGI messages received.

Type: u32
Default: 0
RxLOGOCount
Number of LOGO messages received.

Type: u32
Default: 0
RxPLOGICount
Number of PLOGI messages received.

Type: u32
Default: 0
SubState
State of the neighbor N_Port.

Type: enum
Default: 0
Possible Values:
Value
Description
NONE
The state is indeterminate.
LOGGED_OUT
Port is logged out.
FCF_FLOGI_RECEIVED
An FLOGI message was received.
FCF_FLOGI_TIMED_OUT Login attempt timed out before a response was received.

FCF_FLOGI_REJECTED
Login attempt was rejected.
FCF_FLOGI_ACCEPTED Login attempt was accepted.

FCF_FDISC_RECEIVED
An FDISC message was received.
FCF_FDISC_TIMED_OUT Discovery attempt timed out before a response was received.

FCF_FDISC_REJECTED
Discovery attempt was rejected.
FCF_FDISC_ACCEPTED Discovery attempt was accepted.

FCF_PLOGI_RECEIVED
A PLOGI message was received.
FCF_PLOGI_TIMED_OUT Login attempt timed out before a response was received.

FCF_PLOGI_REJECTED
FCF_PLOGI_ACCEPTED Login attempt was accepted.

MAX
F_Port has the maximum number of neighbors.
TxFDISCAcceptCount
Number of FDISC messages accepted.

Type: u32
Default: 0
TxFLOGIAcceptCount
Number of FLOGI messages accepted.

Type: u32
Default: 0
TxLOGOCount
Number of LOGO messages transmitted.

Type: u32
Default: 0
TxPLOGIAcceptCount
Number of PLOGI messages accepted.

Type: u32
Default: 0
WorldWideNodeName
World Wide Node Name of the neighbor N_Port.

Type: wwn
Default: 10:00:10:94:00:00:00:01
899
FcFPortResults
Read-Only Attribute
Description
WorldWidePortName
World Wide Port Name of the neighbor N_Port.

Type: wwn
Default: 10:00:10:94:00:00:00:01
FcFPortResults
Description:
FC F_Port results.

Parents: FcFPortConfig
Relations:
Side name
(Type)
Relative
Description
ResultParent
(ResultChild)
FcFPortConfig
FcFPortResults Writable Attributes

FcFPortResults Read-Only Attributes

Read-Only Attribute
Description
NeighborCount
Number of neighbors detected.

Type: u32
Default: 0
RxFDISCCount

Type: u32
Default: 0
RxFLOGICount

Type: u32
Default: 0
RxLOGOCount

Type: u32
Default: 0
RxPLOGICount

Type: u32
Default: 0
State
State of the F_Port.

Type: enum
Default: 0
Possible Values:
Value Description
UP
The port is up.
DOWN The port is down.

TxFDISCAcceptCount

Type: u32
Default: 0
900
FcGlobalConfig
Read-Only Attribute
Description
TxFLOGIAcceptCount

Type: u32
Default: 0
TxLOGOCount

Type: u32
Default: 0
TxPLOGIAcceptCount

Type: u32
Default: 0
FcGlobalConfig
Description:
Specify global values for FC host configuration.

FcGlobalConfig Writable Attributes

Writable Attribute
Description
Active, Name
FcoeDraftVersion
use it.
Specify the FCoE draft version.
Type: enum
Default: FIP
Possible Values:
Value
Description
FCOE
FCoE draft version FCoE.
FIP
FCoE draft version FIP.
FIP_INTEROP
LoginDelay
use it.
FCoE device start/login/discovery processes will be staggered with the interval of LoginDelay between 2 consecutive
start.
Type: u32
Default: 10
LogoutDelay
use it.
FCoE device stop/logout processes will be staggered with the interval of LoginDelay between 2 consecutive starts.
Type: u32
Default: 10
FcGlobalConfig Read-Only Attributes

901
FcGlobalParams
FcGlobalParams
Description:

Parents: Project
FcGlobalParams Writable Attributes

Writable Attribute
Description
Active, Name
LoginDelay
FC device start/login processes will be staggered with the interval of LoginDelay between 2
consecutive start.
Type: u32
Default: 10
LogoutDelay
FC device stop/logout processes will be staggered with the interval of LoginDelay between 2
consecutive starts.
Type: u32
Default: 10
ResetPhysicalLinkOnLogout
Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
FALSE
RetryCount
Type: u32
Default: 0
RetryTimer
Type: u32
Default: 10
FcGlobalParams Read-Only Attributes

FcHostConfig
Description:

Result children (automatically created): FcNPortResults, FcSummaryResults
Relations:
Side name
(Type)
Relative
Description
ResultChild
(ResultChild)
FcNPortResults, FcSummaryResults
UsesIf
(UsesIf)


902
FcHostConfig
FcHostConfig Writable Attributes

Writable Attribute
Description
Active, Name
HostType
Specifies if the host will register with the name server as an initiator, a target or both.
Type: enum
Default: INITIATOR
Possible Values:
Value
Description
INITIATOR Host will register with the name server as an initiator.
TARGET
Host will register with the name server as a target.
BOTH
Host will register with the name server as initiator and as target.
Select to use the WWPN of the interface for this host block as the WWNN.
Type: bool
Default: TRUE
Possible Values:
Value Description
TRUE
Use the WWPN as the WWNN.
FALSE Input the WWNN which may be different from the WWPN.
Whether to use the partial block state.

Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
Use the partial block state.
FALSE Do not use the partial block state.

WorldWideNodeName
Value of the first WWNN. Available when Use FC Interface World Wide Port Name is cleared.
Type: wwn
Default: 10:00:10:94:00:00:00:01
not use it.
Deprecated property, do not use.
Type: u32
Default: 0
Increment value for additional WWNNs. Available when Use FC Interface World Wide Port Name is cleared.
Type: wwn
Default: 00:00:00:00:00:00:00:01
903
FcIf
FcHostConfig Read-Only Attributes

Read-Only Attribute
Description
AggregateSubState
Aggregate Sub-State of the N_Port.

Type: enum
Default: NONE
Possible Values:
Value
Description
NONE
Not Started.
LOGGED_OUT
Logged out.
FLOGI_SENT
FLOGI Sent.
FLOGI_TIMED_OUT FLOGI Timed out.

FLOGI_REJECTED
FLOGI Rejected.
FLOGI_ACCEPTED FLOGI Accepted.

FDISC_SENT
FDISC Sent.
FDISC_TIMED_OUT FDISC Timed out.

FDISC_REJECTED
FDISC Rejected.
FDISC_ACCEPTED FDISC Accepted.

PLOGI_SENT
PLOGI Sent.
PLOGI_TIMED_OUT PLOGI Timed Out.

PLOGI_REJECTED
PLOGI Rejected.
PLOGI_ACCEPTED PLOGI Accepted.

SCR_SENT
SCR Sent.
SCR_TIMED_OUT
SCR Timed Out.
SCR_REJECTED
SCR Rejected.
SCR_ACCEPTED
SCR Accepted.
MAX
Max value for internal use.
BbCredit
Buffer-to-buffer credit. Number of frames the port can receive.

Type: u16
Default: 3
ENodeCount
Number of ENodes in the Device Block.

Type: u32
Default: null
MaxRxSize
Maximum Receive Size.

Type: u16
Default: 2112
Range: 64 - 2130
FcIf
Description:

Relations:
Side name
(Type)
Relative
Description
DstBoundTo
(DstBinding)

StreamBlock.
904
FcIf
Side name
(Type)
Relative
Description
EncapsulationSource
(Encapsulation)
PathDescriptor
NetworkLink
(LinkSrc)

MemberOfVpn
(MemberOfVpn)

VpnSiteInfoVplsLdp
Port

relation.

WimaxIf

PrimaryIfSource
(PrimaryIf)

SUT

the DUT.
RelayBlockConfig
(RelayIf)
(ResolvesInterface)

RsvpRouterConfig

SrcBoundTo
(SrcBinding)

StreamBlock.
StackedOn
(StackedOnEndpoint)

WimaxIf
TopLevelIfSource
(TopLevelIf)

SUT

interface stack.
Port

relation.
905
FcIf
Side name
(Type)
Relative
Description
UsesIfSource
(UsesIf)


FcIf Writable Attributes

Writable Attribute
Description
Active, Name
IfCountPerLowerIf
Type: u32
Default: 1
IfRecycleCount
Type: u32
Default: 0
IsLoopbackIf
Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
FALSE
IsRange
Type: bool
Default: TRUE
Possible Values:
Value Description
TRUE
FALSE
WorldWideName
Type: wwn
Default: 20:00:10:94:00:00:00:01
WorldWideNameList
Type: wwn
Default: 00:00:00:00:00:00:00:01
WorldWideNameRepeatCount
Type: u32
Default: 0
WorldWideNameStep
Type: wwn
Default: 00:00:00:00:00:00:00:01
WorldWideNameStepMask
Type: wwn
Default: 00:00:00:00:FF:FF:FF:FF
906
FcLeftSidePortParams
FcIf Read-Only Attributes

Read-Only Attribute
Description
EffectiveBlockCount
Type: u32
Default: 1
IfState
Type: enum
Default: DISABLED
Possible Values:
Value
Description
READY
DISABLED
DELETING
PARTIALLY_READY
WwnResolveState
Type: enum
Default: RESOLVE_NEEDED
Possible Values:
Value
Description
RESOLVE_DONE
RESOLVE_NEEDED
RESOLVE_FAILED
RESOLVE_IN_PROGRESS
RESOLVE_PARTIALLY_DONE
FcLeftSidePortParams
Description:

Parents: FcTestGenParams
Relations:
Side name
(Type)
Relative
Description
AffiliatedPort
(AffiliationPort)
Port
Relation to port on which FC will be configured.
FcLeftSidePortParams Writable Attributes

Writable Attribute
Description
Active, Name
MaxRxSize
Maximum frame size.

Type: u16
Default: 2112
Range: 64 - 2112
RxCredit
Number of frames the port can receive.

Type: u16
Default: 3
FcLeftSidePortParams Read-Only Attributes

907
FcLeftSideTestParams
FcLeftSideTestParams
Description:
FC left side test parameters.

Automatically created from: FcTestGenParams
FcLeftSideTestParams Writable Attributes

Writable Attribute
Description
Active, Name
HostType
Type: enum
Default: INITIATOR
Possible Values:
Value
Description
TARGET
BOTH
Host will register as both initiator and as a target.
StartWorldWideNodeName
Value of the first WWNN.

Type: wwn
Default: 10:00:10:94:00:00:00:01
StartWorldWidePortName
Starting value of the WWPN.

Type: wwn
Default: 20:00:10:94:00:00:00:01
UseWorldWidePortName
Type: bool
Default: TRUE
Possible Values:
Value Description
TRUE
Use WWPN as WWNN.
FALSE Use the WWNN as given in the WWNN field.

Increment value for additional WWNNs.

Type: wwn
Default: 00:00:00:00:00:00:00:01
WorldWidePortNameStep
Step used to increment WWPN.

Type: wwn
Default: 00:00:00:00:00:00:00:01
FcLeftSideTestParams Read-Only Attributes

FcLoginCommand
Description:
Start FC Login process from the list of hosts.

908
FcLogoutCommand
FcLoginCommand Writable Attributes

Writable Attribute
Description
HostList
Type: handle
Default: 0
FcLoginCommand Read-Only Attributes

Read-Only Attribute
Description

FcLogoutCommand
Description:
Start FC Logout process from the list of hosts.

FcLogoutCommand Writable Attributes

Writable Attribute
Description
HostList
Type: handle
Default: 0
FcLogoutCommand Read-Only Attributes

Read-Only Attribute
Description

fcMap
Description:
Parents: DL-Choice
Children: None
909
FcNPortResults
fcMap Attributes
Attribute
Description
fcMap
Type: OCTETSTRING
Default: 0EFC00
length
Type: INTEGER
Default: 2
Name
Type: string
reserved
Type: OCTETSTRING
Default: 000000
type
Type: INTEGER
Default: 3
FcNPortResults
Description:
FC N_Port results.

Parents: FcHostConfig
Relations:
Side name
(Type)
Relative
Description
ResultParent
(ResultChild)
FcHostConfig
FcNPortResults Writable Attributes

FcNPortResults Read-Only Attributes

Read-Only Attribute
Description
State
FcId
Assigned FC ID of the N_Port.

Type: u32
Default: 0
MaxRxSize
Maximum frame size.

Type: u64
Default: 0
RxAcceptCount
Count of Accept messages received.

Type: u64
Default: 0
RxRejectCount
Count of Reject messages received.

Type: u64
Default: 0
910
FCoE
Read-Only Attribute
Description
SubState
State of the device.

Type: enum
Default: NONE
Possible Values:
Value
Description
NONE
Not Started.
LOGGED_OUT
Logged Out.
FLOGI_SENT
FLOGI Sent.
FLOGI_TIMED_OUT FLOGI Timed Out.

FLOGI_REJECTED
FLOGI Rejected.
FLOGI_ACCEPTED FLOGI Accepted.

FDISC_SENT
FDISC Sent.
FDISC_TIMED_OUT FDISC Timed Out.

FDISC_REJECTED
FDISC Rejected.
FDISC_ACCEPTED FDISC Accepted.

PLOGI_SENT
PLOGI Sent.
PLOGI_TIMED_OUT PLOGI Timed Out.

PLOGI_REJECTED
PLOGI Rejected.
PLOGI_ACCEPTED PLOGI Accepted.

SCR_SENT
SCR Sent.
SCR_TIMED_OUT
SCR Timed Out.
SCR_REJECTED
SCR Rejected.
SCR_ACCEPTED
SCR Accepted.
MAX
Max for internal use.
TxFdiscCount
Count of FLOGI messages sent.

Type: u64
Default: 0
TxFlogiCount
Count of FLOGI messages sent.

Type: u64
Default: 0
TxLogoCount
Count of LOGO messages sent.

Type: u64
Default: 0
TxPlogiCount
Count of PLOGI messages sent.

Type: u64
Default: 0
TxStateChangeRegisterCount
Count of State Change Registration messages sent.

Type: u64
Default: 0
WorldWideNodeName
World Wide Node Name.

Type: wwn
Default: 00:00:00:00:00:00:00:00
WorldWidePortName
World Wide Port Name.

Type: wwn
Default: 00:00:00:00:00:00:00:00
FCoE (fc:FCoE)
Description:
911
FCoE
Children: fc
FCoE Attributes
Attribute
Description
crc
Type: INTEGER
Default: 0
eof
Type: FCOEEOF
Default: 42
Possible Values:
Value Description
41
EOFn
42
EOFt
49
EOFni
50
EOFa
46
EOFdt
4E
EOFdti
44
EOFrt
4F
EOFrti
Name
Type: string
reserved1
Type: BITSTRING
Default: 0
reserved2
Type: OCTETSTRING
Default: 00000000
reserved3
Type: OCTETSTRING
Default: 00000000
reserved4
Type: OCTETSTRING
Default: 000000
reserved5
Type: OCTETSTRING
Default: 000000
sof
Type: FCOESOF
Default: 2E
Possible Values:
Value Description
version
28
SOFf
2D
SOFi2
35
SOFn2
2E
SOFi3
36
SOFn3
29
SOFi4
31
SOFn4
39
SOFc4
Type: BITSTRING
Default: 0
912
FcoeCapTLV
FcoeCapTLV (VICTLV:FcoeCapTLV)
Description:
Children: None
VICTLV:CustomTLV
FcoeCapTLV Attributes
Attribute
Description
Length
Type: INTEGER
Default: 2
Name
Type: string
NumFcoeVifsSupported
Type: INTEGER
Default: 1
Type
Type: INTEGER
Default: 20
FcoeClearVirtualLinksCommand
Description:

FcoeClearVirtualLinksCommand Writable Attributes

Writable Attribute
Description
HostList
Type: handle
Default: 0
FcoeClearVirtualLinksCommand Read-Only Attributes

Read-Only Attribute
Description

FcoeDeviceGenProtocolParams
Description:
Protocol parameters that FCoE wizard will use to create FcoeHostConfigs.
913
FcoeDeviceGenProtocolParams

FcoeDeviceGenProtocolParams Writable Attributes

Writable Attribute
Description
Active, Name
AddressingMode
Specify the addressing mode of the host block.

Type: enum
Default: FPMA
Possible Values:
Value Description
FPMA Fabric Provided MAC address.
SPMA Server Provided MAC address.
BOTH Both addressing modes enabled.
BbCredit
Buffer to buffer Credit of the host block.

Type: u16
Default: 3
ENodeCount
Number of E-Nodes in an emulated device block.

Type: u32
Default: 1
FcMap
Specify the FC map.

Type: u32
Default: 0x0EFC00
FcoeDraftVersion

Type: enum
Default: FIP
Possible Values:
Value
Description
FCOE
FCoE draft version.
FIP
FIP draft version.
FIP_INTEROP
FipPriority
Specify the Fip Priority.

Type: u8
Default: 100
HostType
Specify the host type is Initiator or Target.

Type: enum
Default: INITIATOR
Possible Values:
Value
Description
INITIATOR SCSI Initiator.
MaxRxSize
TARGET
SCSI Target.
BOTH
SCSI Initiator and Target.
Specify the Max Receive Size.

Type: u16
Default: 2112
Range: 64 - 2166
914
FcoeDiscoveryCommand
Writable Attribute
Description
Use world wide port name under the FC interface.

Type: bool
Default: TRUE
Possible Values:
Value Description
TRUE
FALSE Not use world wide port name under the FC interface.
WorldWideNodeName
Specify the starting World Wide Node Name.

Type: wwn
Default: 10:00:10:94:00:00:00:01
Specify the World wide node name repeat count.

Type: u32
Default: 0
Specify the World Wide Node Name Step.

Type: wwn
Default: 00:00:00:00:00:00:00:01
FcoeDeviceGenProtocolParams Read-Only Attributes

FcoeDiscoveryCommand
Description:
Start FCoE Discovery process from the list of hosts.

FcoeDiscoveryCommand Writable Attributes

Writable Attribute
Description
HostList
Host handle list.

Type: handle
Default: 0
FcoeDiscoveryCommand Read-Only Attributes

Read-Only Attribute
Description

FcoeGlobalParams
915
FCoEHeader
Description:

Parents: Project
FcoeGlobalParams Writable Attributes

Writable Attribute
Description
Active, Name
DraftVersion

Type: enum
Default: FIP
Possible Values:
Value
Description
FCOE
Protocol operation will be according to FCoE draft version.
FIP
Protocol operation will be according to the FIP draft version.
FIP_INTEROP FIP Interop Mode.

LoginDelay
FCoE device start/login/discovery processes will be staggered with the interval of LoginDelay between 2
consecutive start.
Type: u32
Default: 10
LogoutDelay
FCoE device stop/logout processes will be staggered with the interval of LoginDelay between 2 consecutive
starts.
Type: u32
Default: 10
RetryCount
Type: u32
Default: 0
RetryTimer
Type: u32
Default: 10
FcoeGlobalParams Read-Only Attributes

FCoEHeader (fc:FCoEHeader)
Description:
Children: None
Next headers: fc:FC, fc:VFT, custom:Custom
FCoEHeader Attributes
Attribute
Description
crc
Type: INTEGER
Default: 0
916
FcoeHostConfig
Attribute
Description
eof
Type: FCOEEOF
Default: 42
Possible Values:
Value Description
41
EOFn
42
EOFt
49
EOFni
50
EOFa
46
EOFdt
4E
EOFdti
44
EOFrt
4F
EOFrti
Name
Type: string
reserved1
Type: BITSTRING
Default: 0
reserved2
Type: OCTETSTRING
Default: 00000000
reserved3
Type: OCTETSTRING
Default: 00000000
reserved4
Type: OCTETSTRING
Default: 000000
reserved5
Type: OCTETSTRING
Default: 000000
sof
Type: FCOESOF
Default: 2E
Possible Values:
Value Description
version
28
SOFf
2D
SOFi2
35
SOFn2
2E
SOFi3
36
SOFn3
29
SOFi4
31
SOFn4
39
SOFc4
Type: BITSTRING
Default: 0
FcoeHostConfig
Description:
Defines the characteristics of an emulated host that acts as a FCoE host.

917
FcoeHostConfig
Result children (automatically created): FcoeSummaryResults, FcoeVnPortResults

Relations:
Side name
(Type)
Relative
Description
ResultChild
(ResultChild)
FcoeSummaryResults, FcoeVnPortResults
UsesIf
(UsesIf)


FcoeHostConfig Writable Attributes

Writable Attribute
Description
Active, Name
AddressingMode

Type: enum
Default: FPMA
Possible Values:
Value Description
FPMA FPMA
SPMA SPMA
BOTH FPMA and SPMA
BbCredit
Buffer to buffer credit of the host block.

Type: u16
Default: 3
ENodeCount
An EmulatedDevice block can have multiple devices. If the device count is greater than 1, the ENodeCount
denotes the number of E-Nodes in an EmulatedDevice block.
Type: u32
Default: null
FcfMacAddr
Specify the MAC address of the Fibre Channel forwarder.

Type: mac
Default: null
FcMap
Specify the FC map of the FCoE.

Type: u32
Default: 0x0EFC00
FipPriority
Specify the FIP priority of the FCoE.

Type: u8
Default: 100
HostType
Specify the host type of the host block is Initiator or Target.

Type: enum
Default: INITIATOR
Possible Values:
Value
Description
MaxRxSize
TARGET
SCSI Target.
BOTH
Maximum frame size.

Type: u16
Default: 2112
Range: 64 - 2166
918
FcoeHostConfig
Writable Attribute
Description

Type: bool
Default: TRUE
Possible Values:
Value Description
TRUE
FALSE Not use world wide port name under the FC interface.

Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
FALSE Not use partial block state.

VlanDiscovery
Enable/disable VLAN discovery.

Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
Enable the VLAN discovery process.
FALSE Disable the VLAN discovery process.

VnPortName
VN_port name of the FCoE.

Type: string
Default: VNport_@p-@b-@s
WorldWideNodeName
Starting world wide node name of the host block.

Type: wwn
Default: 10:00:10:94:00:00:00:01
do not use it.
Specify the world wide node name repeat count, currently only count "1" is supported.
Type: u32
Default: 0
Specify the world wide node name step of the host block.
Type: wwn
Default: 00:00:00:00:00:00:00:01
WWPNClearVirtualLinksList
Type: wwn
Default: 10:00:10:94:00:00:00:01
919
FcoeLeftSidePortParams
FcoeHostConfig Read-Only Attributes

Read-Only Attribute
Description
AggregateSubState
Aggregate sub-state of the host block.

Type: enum
Default: NONE
Possible Values:
Value
Description
NONE
No state.
LOGGED_OUT
Logged out.
SOLICITATION_SENT
Solicitation sent.
SOLICITATION_TIMED_OUT
Solicitation timed out.
DISCOVERY_FAILED
Discovery failed.
ADVERTISEMENT_RECEIVED
Advertisement received.
FLOGI_SENT
FLOGI sent.
FLOGI_TIMED_OUT
FLOGI timed out.
FLOGI_REJECTED
FLOGI rejected.
FLOGI_ACCEPTED
FLOGI accepted.
FDISC_SENT
FDISC sent.
FDISC_TIMED_OUT
FDISC timed out.
FDISC_REJECTED
FDISC rejected.
FDISC_ACCEPTED
FDISC accepted.
PLOGI_SENT
PLOGI sent.
PLOGI_TIMED_OUT
PLOGI timed out.
PLOGI_REJECTED
PLOGI rejected.
PLOGI_ACCEPTED
PLOGI accepted.
SCR_SENT
SCR sent.
SCR_TIMED_OUT
SCR timed out.
SCR_REJECTED
SCR rejected.
SCR_ACCEPTED
SCR accepted.
KEEP_ALIVE_TIMEDOUT
Keep alive timeout.
LOGGED_OUT_ON_CLR_LINKS Logged out on receiving clear link message.

VLAN_DISC_SENT
VLAN discovery sent.
VLAN_DISC_FAILED
VLAN discovery failed.
VLAN_DISC_COMPLETE
VLAN discovery complete.
MAX
Reached maximum possible value.
Description:
Specify FCoE topology generator left side port parameters.

Parents: FcoeTestGenParams
Relations:
Side name
(Type)
Relative
Description
AffiliatedPort
(AffiliationPort)
Port
Affiliation port for the FCoE topology generator.
920
FcoeLeftSidePortParams Writable Attributes

Writable Attribute
Description
Active, Name
AutoByDcbx

Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE

Enable priority flow control.

Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
FALSE Not enable priority flow control.

EnableVlan
Enable VLAN.
Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
Enable VLAN.
FALSE Not enable VLAN.

MacAddrStep
Step of the MAC address.

Type: mac
Default: 00:00:00:00:00:01
PriorityRxBits
Priority receive bits.

Type: enum
Default: 0
Possible Values:
Value Description
BIT_0 Bit 0.
BIT_1 Bit 1.
BIT_2 Bit 2.
BIT_3 Bit 3.
BIT_4 Bit 4.
BIT_5 Bit 5.
BIT_6 Bit 6.
BIT_7 Bit 7.
SourceMacAddr
Source MAC address for the FCoE topology generator.

Type: mac
Default: 00:10:94:00:00:02
VlanId
VLAN ID.
Type: u16
Default: 0
Range: 0 - 4095
VlanIdStep
Step of the VLAN ID.

Type: u16
Default: 0
Range: 0 - 4095
921
FcoeLeftSideTestParams
Writable Attribute
Description
VlanPriority
VLAN priority.
Type: u8
Default: 3
Range: 0 - 7
FcoeLeftSidePortParams Read-Only Attributes

FcoeLeftSideTestParams
Description:
FCoE generator left side test parameters.

Automatically created from: FcoeTestGenParams
Automatically-created children: FcoeSideDcbxTlvConfig
FcoeLeftSideTestParams Writable Attributes

Writable Attribute
Description
Active, Name
ENodeCountPerDevice
Number of E-Nodes per Emulated Device.

Type: u32
Default: 1
FcMap
FC map.
Type: u32
Default: 0x0EFC00
FipPriority
FIP priority.
Type: u8
Default: 100
HostType

Type: enum
Default: INITIATOR
Possible Values:
Value
Description
TARGET
SCSI Target.
BOTH
MsgTxHoldMultiplier
A multiplier used to compute the TTL value.

Type: u8
Default: 4
Range: 2 - 10
MsgTxInterval
Interval in seconds between successive transmit cycles.

Type: u16
Default: 30
Range: 5 - 32768
ReinitializeDelay
Delay in seconds after adminStatus becomes disabled before re-initialization is attempted.

Type: u8
Default: 2
Range: 1 - 10
922
FcoeLoginCommand
Writable Attribute
Description
Starting world wide node name.

Type: wwn
Default: 10:00:10:94:00:00:00:01
Starting world wide port name.

Type: wwn
Default: 20:00:10:94:00:00:00:01
TxDelay
Minimum delay (in seconds) between successive LLDP message transmissions.

Type: u16
Default: 2
Range: 1 - 8192
Use the world wide port name.

Type: bool
Default: TRUE
Possible Values:
Value Description
TRUE
FALSE Do not use the world wide port name.

Step of world wide node name.

Type: wwn
Default: 00:00:00:00:00:00:00:01
Step of world wide port name.

Type: wwn
Default: 00:00:00:00:00:00:00:01
FcoeLeftSideTestParams Read-Only Attributes

FcoeLoginCommand
Description:
Start FCoE Login process from the list of hosts.

FcoeLoginCommand Writable Attributes

Writable Attribute
Description
HostList
Host handle list.

Type: handle
Default: 0
FcoeLoginCommand Read-Only Attributes

Read-Only Attribute
Description

923
FcoeLogoutCommand
FcoeLogoutCommand
Description:
Start FCoE Logout process from the list of hosts.

FcoeLogoutCommand Writable Attributes

Writable Attribute
Description
HostList
Host handle list.

Type: handle
Default: 0
FcoeLogoutCommand Read-Only Attributes

Read-Only Attribute
Description

FcoeRightSidePortParams
Description:
Specify FCoE topology generator right side port parameters.

Parents: FcoeTestGenParams
Relations:
Side name
(Type)
Relative
Description
AffiliatedPort
(AffiliationPort)
Port
Affiliation port for the FCoE topology generator.
FcoeRightSidePortParams Writable Attributes

Writable Attribute
Description
Active, Name
AutoByDcbx

Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
924
FcoeRightSidePortParams
Writable Attribute
Description

Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
FALSE Not enable priority flow control.

EnableVlan
Enable VLAN.
Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
Enable VLAN.
FALSE Do not enable VLAN.

MacAddrStep
Step of the MAC address.

Type: mac
Default: 00:00:00:00:00:01
PriorityRxBits
Priority receive bits.

Type: enum
Default: 0
Possible Values:
Value Description
BIT_0 Bit 0.
BIT_1 Bit 1.
BIT_2 Bit 2.
BIT_3 Bit 3.
BIT_4 Bit 4.
BIT_5 Bit 5.
BIT_6 Bit 6.
BIT_7 Bit 7.
SourceMacAddr
Source MAC address for the FCoE topology generator.

Type: mac
Default: 00:10:94:00:00:02
VlanId
VLAN ID.
Type: u16
Default: 0
Range: 0 - 4095
VlanIdStep
Step of the VLAN ID.

Type: u16
Default: 0
Range: 0 - 4095
VlanPriority
VLAN priority.
Type: u8
Default: 3
Range: 0 - 7
FcoeRightSidePortParams Read-Only Attributes

925
FcoeRightSideTestParams
FcoeRightSideTestParams
Description:
FCoE generator right side test parameters.

Automatically created from: FcoeTestGenParams
Automatically-created children: FcoeSideDcbxTlvConfig
FcoeRightSideTestParams Writable Attributes

Writable Attribute
Description
Active, Name
ENodeCountPerDevice
Number of E-Nodes per Emulated Device.

Type: u32
Default: 1
FcMap
FC map.
Type: u32
Default: 0x0EFC00
FipPriority
FIP priority.
Type: u8
Default: 100
HostType

Type: enum
Default: INITIATOR
Possible Values:
Value
Description
TARGET
SCSI Target.
BOTH
MsgTxHoldMultiplier
Used to calculate how long to retain information. This value is multiplied by Message Tx Interval to establish
the Tine To Live value.
Type: u8
Default: 4
Range: 2 - 10
MsgTxInterval
Interval (in seconds) between successive transmit cycles. Used in configuring LLDP/DCBX.
Type: u16
Default: 30
Range: 5 - 32768
ReinitializeDelay
Delay (in seconds) after LLDP adminStatus becomes disabled before re-initialization is attempted.
Type: u8
Default: 2
Range: 1 - 10
Starting world wide node name.

Type: wwn
Default: 10:00:10:94:00:00:00:01
Starting world wide port name.

Type: wwn
Default: 20:00:10:94:00:00:00:01
TxDelay

Type: u16
Default: 2
Range: 1 - 8192
926
FcoeSideDcbxTlvConfig
Writable Attribute
Description

Type: bool
Default: TRUE
Possible Values:
Value Description
TRUE
FALSE Do not use the world wide port name.

Step of world wide node name.

Type: wwn
Default: 00:00:00:00:00:00:00:01
Step of world wide port name.

Type: wwn
Default: 00:00:00:00:00:00:00:01
FcoeRightSideTestParams Read-Only Attributes

FcoeSideDcbxTlvConfig
Description:
Specifies the values for DCBX for the wizard.

Automatically created from: FcoeLeftSideTestParams, FcoeRightSideTestParams
FcoeSideDcbxTlvConfig Writable Attributes

Writable Attribute
Description
Active, Name
AllowInvalidHeaders
Used to allow FrameConfig to contain an invalid TLV.

Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
FrameConfig can contain invalid TLVs.
FALSE FrameConfig can contain invalid TLVs.

FrameConfig
The TLVs that will be configured for DCBX.

Type: string
FcoeSideDcbxTlvConfig Read-Only Attributes

Read-Only Attribute
Description
PduInfo
Type: string
927
FcoeStartCommand
FcoeStartCommand
Description:
Start FCoE from the list of hosts.

FcoeStartCommand Writable Attributes

Writable Attribute
Description
HostList
Host handle list.

Type: handle
Default: 0
FcoeStartCommand Read-Only Attributes

Read-Only Attribute
Description

FcoeStopCommand
Description:
Stop FCoE from the list of hosts.

FcoeStopCommand Writable Attributes

Writable Attribute
Description
HostList
Host handle list.

Type: handle
Default: 0
FcoeStopCommand Read-Only Attributes

Read-Only Attribute
Description

928
FcoeSummaryResults
FcoeSummaryResults
Description:
FCoE aggregated VN_Port results.

Parents: FcoeHostConfig
Relations:
Side name
(Type)
Relative
Description
ResultParent
(ResultChild)
FcoeHostConfig
FcoeSummaryResults Writable Attributes

FcoeSummaryResults Read-Only Attributes

Read-Only Attribute
Description
KeepAlivePeriod
KeepAlive Period received from DUT.

Type: u64
Default: 0
MaxRxSize
Maximum frame size.

Type: u64
Default: 0
RxAcceptCount
Number of accepted message received.

Type: u64
Default: 0
RxClearVirtualLinksCount
Number of ClearVirtualLinks messages received.

Type: u64
Default: 0
RxMulticastAdvertisementCount
Number of multicast advertisement message received.

Type: u64
Default: 0
RxRejectCount
Number of rejected message received.

Type: u64
Default: 0
RxUnicastAdvertisementCount
Number of unicast advertisement message received.

Type: u64
Default: 0
TxFdiscCount
Number of FDISC message transmitted.

Type: u64
Default: 0
TxFlogiCount
Number of FLOGI message transmitted.

Type: u64
Default: 0
TxKeepAliveCount
Number of KeepAlive messages transmitted.

Type: u64
Default: 0
TxLogoCount
Number of LOGO message transmitted.

Type: u64
Default: 0
929
FcoeTestGenConfigExpandCommand
Read-Only Attribute
Description
TxPlogiCount
Number of PLOGI message transmitted.

Type: u64
Default: 0
Number of state change register transmitted.

Type: u64
Default: 0
TxUnicastSolicatationCount
Number of unicast solicitation messages transmitted.

Type: u64
Default: 0
VnPortDownCount
Number of VN_Port in DOWN state.

Type: u32
Default: 0
VnPortUpCount
Number of VN_Port in UP state.

Type: u32
Default: 0
FcoeTestGenConfigExpandCommand
Description:
Expand FCoE test generator topology.

FcoeTestGenConfigExpandCommand Writable Attributes

Writable Attribute
Description
ClearPortConfig
Clear port configuration on expand.

Type: enum
Default: PROMPT
Possible Values:
Value
Description
PROMPT Prompt for clear port configuration on expand.
EnableDetails
YES
Clear port configuration on expand.
NO
Do not clear port configuration on expand.
Enable details.
Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
Enable details.
FALSE Do not enable details.
930
FcoeTestGenParams
Writable Attribute
Description
EnablePreview
Enable preview.
Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
Enable preview.
FALSE Do not enable preview.

GenFcoeParams
Handle of the FcoeTestGenParams to be used in creating the configuration.

Type: handle
Default: 0
GenFcParams
Handle of the FcTestGenParams to be used in creating the configuration.

Type: handle
Default: 0
GenParams
not use it.
Handle of FCoE test Generator parameters.
Type: handle
Default: 0
GenTrafficParams
Handle of the FcFcoeTrafficParams to be used in creating the configuration.

Type: handle
Default: 0

Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
FALSE Do not expand using EmulatedDevice objects.
FcoeTestGenConfigExpandCommand Read-Only Attributes

Read-Only Attribute
Description

Details
Details
Type: string
Summary
Summary
Type: string
FcoeTestGenParams
Description:
FCoE generator parameters.

Parents: Project
Children: FcoeLeftSidePortParams, FcoeRightSidePortParams
Automatically-created children: FcoeLeftSideTestParams, FcoeRightSideTestParams
931
FcoeTestGenParams
FcoeTestGenParams Writable Attributes

Writable Attribute
Description
Active, Name
AddressingMode

Type: enum
Default: FPMA
Possible Values:
Value Description
FPMA FPMA
SPMA SPMA
BOTH FPMA and SPMA
BbCredit
Buffer-to-buffer credit of the host block.

Type: u16
Default: 3
CreateTraffic
not use it.
Create traffic.
Type: bool
Default: TRUE
Possible Values:
Value Description
TRUE
Create traffic.
FALSE Do not create traffic.

FcoeDraftVersion

Type: enum
Default: FIP
Possible Values:
Value
Description
FCOE
FCOE
FIP
FIP
FIP_INTEROP FIP interop

HostsPerPortCount
Number of hosts per port.

Type: u16
Default: 1
Range: 1 - 1000
MaxRxSize
Maximum frame size.

Type: u16
Default: 2112
Range: 64 - 2166
not use it.
Stream block group method.
Type: enum
Default: AGGREGATE
Possible Values:
Value
Description
AGGREGATE Aggregate
HOST
Host
932
FcoeTestGenUpdateAvailablePortsCommand
Writable Attribute
Description
TrafficFlow
not use it.
Traffic flow direction.
Type: enum
Possible Values:
Value
Description
LEFT_TO_RIGHT Traffic flow from left side to right side.
RIGHT_TO_LEFT Traffic flow from right side to left side.
BIDIRECTIONAL Traffic flow in bi-direction.
BACKBONE
Traffic flow in backbone pattern.
TrafficFrameSize
not use it.
Frame size of the traffic.
Type: u16
Default: 2112
Range: 12 - 16383
TrafficLoadPercentPorts
not use it.
Traffic load percent among ports.
Type: double
Default: 10.0
Range: 0 - 100
VnportsPerHostCount
Number of VnPorts per emulated device block.

Type: u16
Default: 1
Range: 1 - 2000
FcoeTestGenParams Read-Only Attributes

FcoeTestGenUpdateAvailablePortsCommand
Description:
Populates the FCoE test generator with all available ports and removes unreferenced ports.

FcoeTestGenUpdateAvailablePortsCommand Writable Attributes

Writable Attribute
Description
GenParams
Handle of FCoE test Generator parameters.

Type: handle
Default: 0
933
FcoeVePortConfig
Writable Attribute
Description
RemoveUnusedPorts
Remove unused ports.

Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
Remove unused ports.
FALSE Do not remove unused ports.
FcoeTestGenUpdateAvailablePortsCommand Read-Only Attributes

Read-Only Attribute
Description

FcoeVePortConfig
Description:

Relations:
Side name
(Type)
Relative
Description
UsesIf
(UsesIf)

FcoeVePortConfig Writable Attributes

Writable Attribute
Description
Active, Name
Type: bool
Default: TRUE
Possible Values:
Value Description
TRUE
FALSE
Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
FALSE
WorldWideNodeName
Type: wwn
Default: 10:00:10:94:00:00:00:01
934

FcoeVfPortConfig
Writable Attribute
Description

Type: u32
Default: 0
Type: wwn
Default: 00:00:00:00:00:00:00:01
FcoeVePortConfig Read-Only Attributes

FcoeVfPortConfig
Description:

Result children (automatically created): FcoeVfPortNeighborResults, FcoeVfPortResults
Relations:
Side name
(Type)
Relative
Description
ResultChild
(ResultChild)
FcoeVfPortNeighborResults, FcoeVfPortResults
UsesIf
(UsesIf)


FcoeVfPortConfig Writable Attributes

Writable Attribute
Description
Active, Name
AddressingMode
Type: enum
Default: FPMA
Possible Values:
Value Description
FPMA
SPMA
BOTH
AdvertisementTimeInterval
Type: u32
Default: 8000
BbCredit
Type: u16
Default: 3
DATOV
Type: u32
Default: 5000
DomainId
Type: u8
Default: 16
935
FcoeVfPortConfig
Writable Attribute
Description
EDTOV
Type: u32
Default: 2000
EnableVlanDiscovery
Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
FALSE
FcMap
Type: u32
Default: 0x0EFC00
FipPriority
Type: u8
Default: 100
MaxRxSize
Type: u16
Default: 2112
Range: 64 - 2166
NegotiatedVlan
Type: u16
Default: 0
RATOV
Type: u32
Default: 10000
Type: bool
Default: TRUE
Possible Values:
Value Description
TRUE
FALSE
Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
FALSE
WorldWideNodeName
Type: wwn
Default: 10:00:10:94:00:00:00:01

Type: u32
Default: 0
Type: wwn
Default: 00:00:00:00:00:00:00:01
936
FcoeVfPortNeighborResults
FcoeVfPortConfig Read-Only Attributes

Read-Only
Attribute
Description
AggregateSubState
Aggregate state of the neighbor ports.

Type: enum
Default: NONE
Possible Values:
Value
Description
NONE
LOGGED_OUT
Ports are logged out.
FCF_VLAN_DISC_RECEIVED
A discovery message was received.
FCF_VLAN_DISC_FAILED
Discovery failed.
FCF_VLAN_DISC_COMPLETE
Discovery is complete.
FCF_SOLICITATION_RECEIVED
A solicitation message was received.
FCF_SOLICITATION_TIMED_OUT
Solicitation timed out before a response was received.
FCF_ADVERTISEMENT_SENT
An advertisement message was sent.
FCF_ADVERTISEMENT_TIMEDOUT Advertisement timed out before a response was received.
State
FCF_FLOGI_RECEIVED
FCF_FLOGI_TIMED_OUT
Login timed out before a response was received.
FCF_FLOGI_REJECTED
FCF_FLOGI_ACCEPTED
Login attempt was accepted.
FCF_FDISC_RECEIVED
FCF_FDISC_TIMED_OUT
Discovery timed out before a response was received.
FCF_FDISC_REJECTED
FCF_FDISC_ACCEPTED
Discovery attempt was accepted.
FCF_PLOGI_RECEIVED
FCF_PLOGI_TIMED_OUT
FCF_PLOGI_REJECTED
FCF_PLOGI_ACCEPTED
MAX
Port has connected to the maximum number of neighbors.
State of the VF_Port.

Type: enum
Default: 0
Possible Values:
Value Description
DOWN Port is down.
UP
Port is up.
Description:
FCoE VF port neighbor results.

Parents: FcoeVfPortConfig
Relations:
Side name
(Type)
Relative
Description
ResultParent
(ResultChild)
FcoeVfPortConfig
937
FcoeVfPortNeighborResults Writable Attributes

FcoeVfPortNeighborResults Read-Only Attributes

Read-Only Attribute
Description
FcId
Assigned FC ID of the neighbor VN_Port.

Type: u32
Default: 0
MacAddress
MAC address of the neighbor VN_Port.

Type: mac
Default: 00:00:00:00:00:00
RxFDISCCount

Type: u32
Default: 0
RxFLOGICount

Type: u32
Default: 0
RxKeepAliveCount
Number of KeepAlive messages received.

Type: u32
Default: 0
RxLOGOCount

Type: u32
Default: 0
RxPLOGICount

Type: u32
Default: 0
RxSolicitationCount
Number of solicitation messages received.

Type: u32
Default: 0
RxVlanRequestCount
Number of VLAN Requests received.

Type: u32
Default: 0
938
Read-Only Attribute
Description
SubState
State of the neighbor VN_Port.

Type: enum
Default: 0
Possible Values:
Value
Description
NONE
LOGGED_OUT
Port is logged out.
FCF_VLAN_DISC_RECEIVED
A VLAN DISC message was received.
FCF_VLAN_DISC_FAILED
Discovery failed.
FCF_VLAN_DISC_COMPLETE
Discovery is complete.
FCF_SOLICITATION_RECEIVED
A solicitation message was received.
FCF_SOLICITATION_TIMED_OUT
Solicitation timed out before a response was received.
FCF_ADVERTISEMENT_SENT
An advertisement message was sent.
FCF_ADVERTISEMENT_TIMEDOUT Advertisement timed out before a response was received.

FCF_FLOGI_RECEIVED
FCF_FLOGI_TIMED_OUT
FCF_FLOGI_REJECTED
FCF_FLOGI_ACCEPTED
FCF_FDISC_RECEIVED
FCF_FDISC_TIMED_OUT
Discovery timed out before a response was received.
FCF_FDISC_REJECTED
FCF_FDISC_ACCEPTED
Discovery attempt was accepted.
FCF_PLOGI_RECEIVED
FCF_PLOGI_TIMED_OUT
FCF_PLOGI_REJECTED
FCF_PLOGI_ACCEPTED
MAX
VF_Port has the maximum number of neighbors.
TxAdvertisementCount
Number of advertisement messages transmitted.

Type: u32
Default: 0
TxClearVirtualLinksCount
Number of ClearVirtualLinks messages transmitted.

Type: u32
Default: 0
TxFDISCAcceptCount

Type: u32
Default: 0
TxFLOGIAcceptCount

Type: u32
Default: 0
TxLOGOCount

Type: u32
Default: 0
TxMulticastAdvertisementCount
Number of multicast advertisement messages transmitted.

Type: u32
Default: 0
TxPLOGIAcceptCount

Type: u32
Default: 0
TxVlanNotificationCount
Type: u32
Default: 0
939
FcoeVfPortResults
Read-Only Attribute
Description
WorldWideNodeName
World Wide Node Name of the neighbor VN_Port.

Type: wwn
Default: 10:00:10:94:00:00:00:01
WorldWidePortName
World Wide Port Name of the neighbor VN_Port.

Type: wwn
Default: 10:00:10:94:00:00:00:01
FcoeVfPortResults
Description:
FCoE VF port results.

Parents: FcoeVfPortConfig
Relations:
Side name
(Type)
Relative
Description
ResultParent
(ResultChild)
FcoeVfPortConfig
FcoeVfPortResults Writable Attributes

FcoeVfPortResults Read-Only Attributes

Read-Only Attribute
Description
NeighborCount
Number of neighbors detected.

Type: u32
Default: 0
RxFDISCCount

Type: u32
Default: 0
RxFLOGICount

Type: u32
Default: 0
RxKeepAliveCount
Number of KeepAlive messages received.

Type: u32
Default: 0
RxLOGOCount

Type: u32
Default: 0
RxPLOGICount

Type: u32
Default: 0
RxSolicitationCount
Number of solicitation messages received.

Type: u32
Default: 0
940
FcoeVnPortResults
Read-Only Attribute
Description
RxVlanRequestCount
Number of VLAN Requests received.

Type: u32
Default: 0
TxAdvertisementCount
Number of advertisement messages transmitted.

Type: u32
Default: 0
TxClearVirtualLinksCount
Number of ClearVirtualLinks messages transmitted.

Type: u32
Default: 0
TxFDISCAcceptCount

Type: u32
Default: 0
TxFLOGIAcceptCount

Type: u32
Default: 0
TxLOGOCount

Type: u32
Default: 0
TxMulticastAdvertisementCount
Type: u32
Default: 0
TxPLOGIAcceptCount

Type: u32
Default: 0
TxVlanNotificationCount
Type: u32
Default: 0
FcoeVnPortResults
Description:
FCoE Vn_Port results.

Parents: FcoeHostConfig
Relations:
Side name
(Type)
Relative
Description
ResultParent
(ResultChild)
FcoeHostConfig
FcoeVnPortResults Writable Attributes

FcoeVnPortResults Read-Only Attributes

Read-Only Attribute
Description
State
941
FcoeVnPortResults
Read-Only Attribute
Description
DstMacAddr
Destination MAC address of the VN_Port.

Type: mac
Default: 00:00:00:00:00:00
FcId
FC ID assigned by the DUT to the VN_Port.

Type: u32
Default: 0
GrantedMacAddr
Granted MAC address of the VN_Port.

Type: mac
Default: 00:00:00:00:00:00
GrantedVlanId
VLAN ID granted by the DUT.

Type: u16
Default: 0
KeepAlivePeriod
KeepAlive Period received from DUT.

Type: u64
Default: 0
MaxRxSize
Maximum frame size.

Type: u64
Default: 0
RxAcceptCount
Number of accepted message received.

Type: u64
Default: 0
RxClearVirtualLinksCount
Number of ClearVirtualLinks messages received.

Type: u64
Default: 0
RxMulticastAdvertisementCount
Number of multicast advertisement message received.

Type: u64
Default: 0
RxRejectCount
Number of rejected message received.

Type: u64
Default: 0
RxUnicastAdvertisementCount
Number of unicast solicitation messages received.

Type: u64
Default: 0
RxVlanNotificationCount
Number of VLAN Notifications received.

Type: u64
Default: 0
942
FcoeVnPortResults
Read-Only Attribute
Description
SubState
Sub-state of the VN_Port.

Type: enum
Default: NONE
Possible Values:
Value
Description
NONE
No state.
LOGGED_OUT
Logged out.
SOLICITATION_SENT
Solicitation sent.
SOLICITATION_TIMED_OUT
Solicitation timed out.
DISCOVERY_FAILED
Discovery failed.
ADVERTISEMENT_RECEIVED
Advertisement received.
FLOGI_SENT
FLOGI sent.
FLOGI_TIMED_OUT
FLOGI timed out.
FLOGI_REJECTED
FLOGI rejected.
FLOGI_ACCEPTED
FLOGI accepted.
FDISC_SENT
FDISC sent.
FDISC_TIMED_OUT
FDISC timed out.
FDISC_REJECTED
FDISC rejected.
FDISC_ACCEPTED
FDISC accepted.
PLOGI_SENT
PLOGI sent.
PLOGI_TIMED_OUT
PLOGI timed out.
PLOGI_REJECTED
PLOGI rejected.
PLOGI_ACCEPTED
PLOGI accepted.
SCR_SENT
SCR sent.
SCR_TIMED_OUT
SCR timed out.
SCR_REJECTED
SCR rejected.
SCR_ACCEPTED
SCR accepted.
KEEP_ALIVE_TIMEDOUT
Keep Alive Timeout.
LOGGED_OUT_ON_CLR_LINKS Logged out on Clear Virtual Links message.

VLAN_DISC_SENT
VLAN Discovery Sent.
VLAN_DISC_FAILED
VLAN Discovery Failed.
VLAN_DISC_COMPLETE
VLAN Discovery Complete.
MAX
Reached Maximum possible value.
TxFdiscCount
Number of FDISC message transmitted.

Type: u64
Default: 0
TxFlogiCount
Number of FLOGI message transmitted.

Type: u64
Default: 0
TxKeepAliveCount
Number of KeepAlive messages transmitted.

Type: u64
Default: 0
TxLogoCount
Number of FLOGO message transmitted.

Type: u64
Default: 0
TxPlogiCount
Number of PLOGI message transmitted.

Type: u64
Default: 0
Number of state change register transmitted.

Type: u64
Default: 0
943
FCPayload-Choice
Read-Only Attribute
Description
TxUnicastSolicatationCount
Number of unicast solicitation messages transmitted.

Type: u64
Default: 0
TxVlanRequestCount
Number of VLAN Requests transmitted.

Type: u64
Default: 0
WorldWideNodeName
Configured World Wide node name.

Type: wwn
Default: 10:00:10:94:00:00:00:01
WorldWidePortName
Configured World Wide port name.

Type: wwn
Default: 10:00:10:94:00:00:00:01
FCPayload-Choice
Description:
Parents: fcPayloads
Children: customPayload, daId, diaAccept, diaRequest, dpall, dpl, dplm, dpln, efpAccept, efpRequest, elpReject, elpRequestAccept, escAccept, escRequest,
fcpCmnd, fdiscAccept, fdiscReject, fdiscRequest, flogiAccept, flogiReject, flogiRequest, fpng, fpngAccept, ftr, ftrAccept, gaNxtAccept, gapnlAccept, gatin,
gatinAccept, gcsIdAccept, gdidAccept, gffIdAccept, gfnAccept, gfpnIdAccept, gftIdAccept, gidFtAccept, gidNnAccept, gidPnAccept, gidPtAccept, gieilAccept,
giel, gielAccept, gielnAccept, gietAccept, gmalAccept, gmidAccept, gnid, gnidAccept, gnnFtAccept, gnnIdAccept, gnpl, gnplAccept, gpabAccept, gpfcpAccept,
gplAccept, gpliAccept, gplmlAccept, gplnlAccept, gpltAccept, gpnFtAccept, gpnIdAccept, gpnl, gpnlAccept, gppnAccept, gpsAccept, gpscAccept, gptAccept,
gptIdAccept, gsAccept, gsDeregisterWithPlatformName, gsesAccept, gsnnNnAccept, gspnIdAccept, gsReject, gsRequestWithFc4Type,
gsRequestWithInterconnectElementName, gsRequestWithNodeName, gsRequestWithPlatformName, gsRequestWithPortIdentifier, gsRequestWithPortName,
gsRequestWithPortType, gtin, gtinAccept, hloRequest, logoAccept, logoReject, logoRequest, lsaRequest, lsuRequest, mergeRequest, mergeRequestAcc,
plogiAccept, plogiReject, plogiRequest, rcsId, rdiAccept, rdiRequest, rffId, rftId, rieln, rnnId, rpab, rpfcp, rpl, rpli, rplm, rpln, rplt, rpnId, rptId, rsnnNn, rspnId
FCPayload-Choice Attributes
Attribute
Description
Name
information.
Type: string
fcPayloads
Description:
Parents: fc
Children: FCPayload-Choice
fcPayloads Attributes
Attribute
Description
Name
information.
Type: string
944
fcpCdb
fcpCdb
Description:
Parents: fcpCmnd
Children: cdb10, cdb6, modeSense10, modeSense6, read10, read6, readBuffer, readCapacity10, readLong10, reportLUNs, startStopUnit, verify10, write10,
write6, writeAndVerify10, writeBuffer, writeLong10, xdRead10, xdWrite10, xpWrite10
fcpCdb Attributes
Attribute
Description
Name
information.
Type: string
fcpCmnd
Description:
Children: fcpCdb
fcpCmnd Attributes
Attribute
Description
additionalFcpCdbLen
Type: INTEGER
Default: 0
cmndRefNum
Type: INTEGER
Default: 0
fcpBiDirReadDl
Type: INTEGER
fcpDl
Type: INTEGER
fcpLun
Type: OCTETSTRING
Default: 0000000000000000
Name
Type: string
pad
Type: OCTETSTRING
priority
Type: INTEGER
Default: 0
rdData
Type: BITSTRING
Default: 0
reserved
Type: BITSTRING
Default: 0
taskAttrib
Type: BITSTRING
Default: 000
945
FcpCmnd
Attribute
Description
taskMgmtFlags
Type: OCTETSTRING
Default: 00
wrData
Type: BITSTRING
Default: 0
FcpCmnd (fcp:FcpCmnd)
Description:
Children: None
Next headers: scsi:Read6, scsi:Write6, scsi:ModeSense6, scsi:StartStopUnit, scsi:ReadCapacity10, scsi:Read10, scsi:Write10, scsi:WriteAndVerify10,
scsi:Verify10, scsi:WriteBuffer, scsi:ReadBuffer, scsi:ReadLong10, scsi:WriteLong10, scsi:XDWrite10, scsi:XPWrite10, scsi:XDRead10, scsi:ModeSense10,
scsi:ReportLUNs, custom:Custom, scsi:CDB6, scsi:CDB10
FcpCmnd Attributes
Attribute
Description
additionalFcpCdbLen
Type: INTEGER
Default: 0
cmndRefNum
Type: INTEGER
Default: 0
fcpLun
Type: OCTETSTRING
Default: 0000000000000000
Name
Type: string
priority
Type: INTEGER
Default: 0
rdData
Type: BITSTRING
Default: 0
reserved
Type: BITSTRING
Default: 0
taskAttrib
Type: BITSTRING
Default: 000
taskMgmtFlags
Type: OCTETSTRING
Default: 00
wrData
Type: BITSTRING
Default: 0
FcpCmndDl (fcp:FcpCmndDl)
Description:
946
FcPhy
Children: None
FcpCmndDl Attributes
Attribute
Description
fcpBiDirReadDl
Type: INTEGER
fcpDl
Type: INTEGER
Name
more information.
Type: string
pad
Type: OCTETSTRING
FcPhy
Description:

Parents: Port
Relations:
Side name
(Type)
Relative
ActivePhyPort
(ActivePhy)
Port
Description
FcPhy Writable Attributes

Writable Attribute
Description
Active, Name
DataPathMode
Type: enum
Default: NORMAL
Possible Values:
Value
Description
NORMAL
LOCAL_LOOPBACK Port will transmit in a loopback mode, so transmitted data will be received by the
transmitting port without going out on the wire.
LINE_MONITOR
EnforceMtuOnRx
Port will be placed in line monitor mode. All received packets will be transmitted as
is but can also be captured on the port.
Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
FALSE
947
FcPhy
Writable Attribute
Description
InternalPpmAdjust
Type: s32
Default: 0
Range: -100 - 100
LineSpeed
Type: enum
Default: SPEED_2G
Possible Values:
Value
Description
SPEED_2G
SPEED_4G
SPEED_8G
SPEED_10G
MaxRecvSize
Type: u16
Default: 2112
Range: 64 - 2120
Mtu
Type: u32
Default: 1500
Range: 0 - 16383
PortSetupMode
Type: enum
Possible Values:
Value
Description
PORTCONFIG_ONLY
REGISTERS_ONLY
ReceiverTimeOut
Type: u32
Default: 12
Range: 1 - 65535
RxCredits
Type: u16
Default: 16
Range: 1 - 65535
Topology
Type: enum
Default: PTP_PUBLIC
Possible Values:
Value
Description
PTP_PRIVATE
PTP_PUBLIC
TrafficClass
Type: enum
Default: TRAFFIC_CLASS_3
Possible Values:
Value
Description
TRAFFIC_CLASS_2
TRAFFIC_CLASS_3
TransmitClockSource
Type: enum
Default: INTERNAL
Possible Values:
Value
Description
INTERNAL
INTERNAL_PPM_ADJ
TxCredits
Type: u16
Default: 16
Range: 1 - 65535
948
FcPhy
FcPhy Read-Only Attributes

Read-Only Attribute
Description
Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
FALSE
IsMgtRegistersOnly
Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
FALSE
LineSpeedStatus
Type: enum
Default: SPEED_2G
Possible Values:
Value
Description
SPEED_2G
SPEED_4G
SPEED_8G
SPEED_10G
LinkStatus
Type: enum
Default: NONE
Possible Values:
Value
Description
DOWN
UP
ERROR
ADMIN_DOWN
SONET
NONE
ModuleType
Type: enum
Default: NA
Possible Values:
Value
Description
NA
UNKNOWN
ABSENT
SFP_FIBER
SFP_Copper
XFP
XENPAK
X2
E1000
TEN_GBASE_T
SFP_PLUS
CFP
QSFP_PLUS
949
FcPhy
Read-Only Attribute
Description
PersonalityCardType
Type: enum
Default: NA
Possible Values:
Value
Description
NA
UNKNOWN
ABSENT
SFP
XFP
XENPAK
X2
TEN_GBASE_T
CFP
SupportedSpeeds
Type: enum
Default: SPEED_2G
Possible Values:
Value
Description
SPEED_2G
SPEED_4G
SPEED_8G
SPEED_10G
950
FcPhy
Read-Only Attribute
Description
TransceiverType
Type: enum
Possible Values:
Value
Description
MODULE_NONE
MODULE_10GBASE_ER
MODULE_10GBASE_LR
MODULE_10GBASE_SR
MODULE_10GBASE_EW
MODULE_10GBASE_LW
MODULE_10GBASE_SW
MODULE_10GBASE_CX4
MODULE_10GBASE_LX4
SPIRENT_10GBASE_CX4
MODULE_OC48_LR
MODULE_OC48_IR
MODULE_OC48_SR
MODULE_OC12_LR
MODULE_OC12_IR
MODULE_OC12_SR
MODULE_OC3_LR
MODULE_OC3_IR
MODULE_OC3_SR
MODULE_OC192_LR
MODULE_OC192_IR
MODULE_OC192_SR
MODULE_OC192_VR
MODULE_10GBASE_T
MODULE_XFP_CX4
MODULE_XFP_E
MODULE_1000BASE_T
MODULE_1000BASE_CX
MODULE_1000BASE_LX
MODULE_1000BASE_SX
MODULE_40GBASE_LR
MODULE_40GBASE_SR
MODULE_40GBASE_CR4
MODULE_40GBASE_SR4
MODULE_100GBASE_LR
MODULE_100GBASE_SR
MODULE_FC_2G
MODULE_FC_4G
MODULE_FC_8G
MODULE_100BASE_FX
TransceiverTypeList
Type: string
951
FcPhyClearStatsCommand
FcPhyClearStatsCommand
Description:

FcPhyClearStatsCommand Writable Attributes

Writable Attribute
Description
Port
Type: handle
Default: 0
FcPhyClearStatsCommand Read-Only Attributes

Read-Only Attribute
Description

FcResults
Description:
FC port results.

Parents: Port
Relations:
Side name
(Type)
Relative
Description
ResultParent
(ResultChild)
Port
FcResults Writable Attributes

FcResults Read-Only Attributes

Read-Only Attribute
Description
B2BRxCreditCount
Number of B2B receive credits.

Type: u64
Default: 0
B2BRxCreditUnavailableCount
Number of B2B receive credits unavailable.

Type: u64
Default: 0
B2BTxCreditCount
Number of B2B transmit credits.

Type: u64
Default: 0
952
FcResults
Read-Only Attribute
Description
B2BTxCreditUnavailableCount
Number of B2B transmit credits unavailable.

Type: u64
Default: 0
Class2RxFrameCount
Number of Class 2 frames received.

Type: u64
Default: 0
Class2RxFrameRate
Frame rate of received Class 2 frames.

Type: u64
Default: 0
Class2TxFrameCount
Number of Class 2 frames sent.

Type: u64
Default: 0
Class2TxFrameRate
Frame rate of sent Class 2 frames.

Type: u64
Default: 0
Class3RxFrameCount
Number of Class 3 frames received.

Type: u64
Default: 0
Class3RxFrameRate
Frame rate of received Class 3 frames.

Type: u64
Default: 0
Class3TxFrameCount
Number of Class 3 frames sent.

Type: u64
Default: 0
Class3TxFrameRate
Frame rate of sent Class 3 frames.

Type: u64
Default: 0
OtherClassRxFrameCount
Number of other Class frames received.

Type: u64
Default: 0
OtherClassRxFrameRate
Frame rate of received other Class frames.

Type: u64
Default: 0
OtherClassTxFrameCount
Number of other Class frames sent.

Type: u64
Default: 0
OtherClassTxFrameRate
Frame rate of sent other Class frames.

Type: u64
Default: 0
TotalClass2RxByteCount
Total bytes of all Class 2 frames received.

Type: u64
Default: 0
TotalClass2RxByteRate
Byte rate of received Class 2 frames.

Type: u64
Default: 0
TotalClass2TxByteCount
Total bytes of all Class 2 frames sent.

Type: u64
Default: 0
TotalClass2TxByteRate
Byte rate of sent Class 2 frames.

Type: u64
Default: 0
953
FcRightSidePortParams
Read-Only Attribute
Description
TotalClass3RxByteCount
Total bytes of all Class 3 frames received.

Type: u64
Default: 0
TotalClass3RxByteRate
Byte rate of received Class 3 frames.

Type: u64
Default: 0
TotalClass3TxByteCount
Total bytes of all Class 3 frames sent.

Type: u64
Default: 0
TotalClass3TxByteRate
Byte rate of sent Class 3 frames.

Type: u64
Default: 0
TotalOtherClassRxByteCount
Total bytes of all other Class frames received.

Type: u64
Default: 0
TotalOtherClassRxByteRate
Byte rate of received other Class frames.

Type: u64
Default: 0
TotalOtherClassTxByteCount
Total bytes of all other Class frames sent.

Type: u64
Default: 0
TotalOtherClassTxByteRate
Byte rate of sent other Class frames.

Type: u64
Default: 0
FcRightSidePortParams
Description:

Parents: FcTestGenParams
Relations:
Side name
(Type)
Relative
Description
AffiliatedPort
(AffiliationPort)
Port
Relation to port on which FC will be configured.
FcRightSidePortParams Writable Attributes

Writable Attribute
Description
Active, Name
MaxRxSize
Maximum frame size.

Type: u16
Default: 2112
Range: 64 - 2112
RxCredit
Number of frames the port can receive.

Type: u16
Default: 3
954
FcRightSideTestParams
FcRightSidePortParams Read-Only Attributes

FcRightSideTestParams
Description:
FC right side test parameters.

Automatically created from: FcTestGenParams
FcRightSideTestParams Writable Attributes

Writable Attribute
Description
Active, Name
HostType
Type: enum
Default: INITIATOR
Possible Values:
Value
Description
TARGET
BOTH
Host will register with name server as both initiator and as target.
Value of First WWNN.

Type: wwn
Default: 10:00:10:94:00:00:00:01
Initial WWPN value.

Type: wwn
Default: 20:00:10:94:00:00:00:01
Type: bool
Default: TRUE
Possible Values:
Value Description
TRUE
WWPN will be used as WWNN.
FALSE WWNN specified in the World Wide Node Name parameter will be used.
Step for deciding subsequent WWNNs.

Type: wwn
Default: 00:00:00:00:00:00:00:01
Incremental value for additional WWPNs.

Type: wwn
Default: 00:00:00:00:00:00:00:01
FcRightSideTestParams Read-Only Attributes

955
FcSofEof
FcSofEof (fc:FcSofEof)
Description:
Children: None
Next headers: fc:FC, fc:VFT, custom:Custom
FcSofEof Attributes
Attribute
Description
eof
Type: FcEof
Default: BC957575
Possible Values:
Value
Description
BC957575
EOFt
BC95F5F5 EOFa
BC95D5D5 EOFn
BC8AD5D5 EOFni
Name
Type: string
sof
Type: FcSof
Default: BCB55656
Possible Values:
Value
Description
BCB55555 SOFi2
BCB53535 SOFn2
BCB55656 SOFi3
BCB53636 SOFn3
BCB55858 SOFf
FcSummaryResults
Description:
FC summary results.

Parents: FcHostConfig
Relations:
Side name
(Type)
Relative
Description
ResultParent
(ResultChild)
FcHostConfig
FcSummaryResults Writable Attributes

956
FcTestGenParams
FcSummaryResults Read-Only Attributes

Read-Only Attribute
Description
MaxRxSize
Maximum frame size.

Type: u64
Default: 0
NPortDownCount
Number of NPorts that are in UP state.

Type: u32
Default: 0
NPortUpCount
Number of NPorts that are in UP state.

Type: u32
Default: 0
RxAcceptCount
Number of Accept messages received.

Type: u64
Default: 0
RxRejectCount
Number of Reject messages received.

Type: u64
Default: 0
TxFdiscCount
Number of FDISC messages transmitted.

Type: u64
Default: 0
TxFlogiCount
Number of FLOGI messages transmitted.

Type: u64
Default: 0
TxLogoCount

Type: u64
Default: 0
TxPlogiCount
Number of PLOGI messages transmitted.

Type: u64
Default: 0
Number of State Change Registrations transmitted.

Type: u64
Default: 0
FcTestGenParams
Description:

Parents: Project
Children: FcLeftSidePortParams, FcRightSidePortParams
Automatically-created children: FcLeftSideTestParams, FcRightSideTestParams
FcTestGenParams Writable Attributes

Writable Attribute
Description
Active, Name
957
FcTestGenUpdateAvailablePortsCommand
Writable Attribute
Description
HostsPerPortCount
Number of hosts to create on each port.

Type: u16
Default: 1
Range: 1 - 1000
NportsPerHostCount
Nports Per Host.

Type: u16
Default: 1
Range: 1 - 2000
FcTestGenParams Read-Only Attributes

FcTestGenUpdateAvailablePortsCommand
Description:

FcTestGenUpdateAvailablePortsCommand Writable Attributes

Writable Attribute
Description
GenParams
Type: handle
Default: 0
RemoveUnusedPorts
Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
FALSE
FcTestGenUpdateAvailablePortsCommand Read-Only Attributes

Read-Only Attribute
Description

FcWaitForAggregateSubStateCommand
Description:
Wait for FCoE aggregate substate to the specified state from the list of hosts.

958
fdisc
Parents: Sequencer
FcWaitForAggregateSubStateCommand Writable Attributes

Writable Attribute
Description
ErrorOnFailure
ObjectList
Type: handle
Default: 0
WaitAggregateSubState
State to wait for.

Type: enum
Default: LOGGED_OUT
Possible Values:
Value
Description
NONE
State machine not started.
LOGGED_OUT
FC logged out.
FLOGI_SENT
FC FLOGI sent.
FLOGI_TIMED_OUT FC FLOGI timed out.

FLOGI_REJECTED
FC FLOGI rejected.
FLOGI_ACCEPTED FC FLOGI accepted.

FDISC_SENT
FC FDISC sent.
FDISC_TIMED_OUT FC FDISC timed out.

FDISC_REJECTED
FC FDISC rejected.
FDISC_ACCEPTED FC FDISC accepted.

PLOGI_SENT
FC PLOGI sent.
PLOGI_TIMED_OUT FC PLOGI timed out.

PLOGI_REJECTED
FC PLOGI rejected.
PLOGI_ACCEPTED FC PLOGI accepted.
WaitTime
SCR_SENT
FC SCR sent.
SCR_TIMED_OUT
FC SCR timed out.
SCR_REJECTED
FC SCR rejected.
SCR_ACCEPTED
FC SCR accepted.
MAX
MAX state.
Waiting time in seconds for the substate.

Type: double
Default: 30.0
Range: 0.005 - 2147483647.0
FcWaitForAggregateSubStateCommand Read-Only Attributes

Read-Only Attribute
Description
fdisc
Description:
Parents: npivFdiscRequest
Children: class1SvcParams, class2SvcParams, class3SvcParams, class4SvcParams, commonSvcParams, fc
959
fdiscAcc
fdisc Attributes
Attribute
Description
command
Type: OCTETSTRING
Default: 51
Name
Type: string
nodeName
Type: WWN
Default: 10:00:10:94:00:00:00:01
nPortName
Type: WWN
Default: 20:00:10:94:00:00:00:01
reserved1
Type: OCTETSTRING
Default: 000000
vendorVersionLevel
Type: OCTETSTRING
fdiscAcc
Description:
Parents: npivFdiscAccept
fdiscAcc Attributes
Attribute
Description
command
Type: OCTETSTRING
Default: 02
Name
Type: string
nodeName
Type: WWN
Default: 10:00:10:94:00:00:00:01
nPortName
Type: WWN
Default: 20:00:10:94:00:00:00:01
reserved1
Type: OCTETSTRING
Default: 000000
vendorVersionLevel
Type: OCTETSTRING
fdiscAccept
Description:
960
fdiscReject
Children: class1SvcParams, class2SvcParams, class3SvcParams, class4SvcParams, commonSvcParams
fdiscAccept Attributes
Attribute
Description
command
Type: OCTETSTRING
Default: 02
Name
Type: string
nodeName
Type: WWN
Default: 10:00:10:94:00:00:00:01
nPortName
Type: WWN
Default: 20:00:10:94:00:00:00:01
reserved1
Type: OCTETSTRING
Default: 000000
vendorVersionLevel
Type: OCTETSTRING
fdiscReject
Description:
Children: None
fdiscReject Attributes
Attribute
Description
command
Type: OCTETSTRING
Default: 01
Name
Type: string
reasonCode
Type: OCTETSTRING
Default: 3
reasonExplanation
Type: OCTETSTRING
Default: 0F
reserved1
Type: OCTETSTRING
Default: 00000000
vendorUnique
Type: OCTETSTRING
Default: 0
961
fdiscRequest
fdiscRequest
Description:
fdiscRequest Attributes
Attribute
Description
command
Type: OCTETSTRING
Default: 51
Name
Type: string
nodeName
Type: WWN
Default: 10:00:10:94:00:00:00:01
nPortName
Type: WWN
Default: 20:00:10:94:00:00:00:01
reserved1
Type: OCTETSTRING
Default: 000000
vendorVersionLevel
Type: OCTETSTRING
fdiscRjt
Description:
Children: fc
fdiscRjt Attributes
Attribute
Description
commandCode
Type: OCTETSTRING
Default: 01
explanationCode
Type: OCTETSTRING
Default: 0F
Name
Type: string
reasonCode
Type: OCTETSTRING
Default: 03
reserved1
Type: OCTETSTRING
Default: 000000
reserved2
Type: OCTETSTRING
Default: 00
962
FeatureLicense
Attribute
Description
vendorUnique
Type: OCTETSTRING
Default: 00
FeatureLicense
Description:
Object representing a licensed feature for a chassis.

Parents: PhysicalChassis, PhysicalChassisManager
FeatureLicense Writable Attributes

Writable Attribute
Description
Active, Name
FeatureLicense Read-Only Attributes

Read-Only Attribute
Description
CheckedOutTestModuleList
List of test modules in the chassis that a slot(test module) license is checked out for.
Type: u16
Default: 0
Description
Description for the licensed feature(for example, "PACKET GENERATOR AND ANALYZER BASE PKG A").
Type: string
ExpirationDate
Expiration date for the licensed feature(for example, "01-jan-2008").

Type: string
Feature
Name of the licensed feature(for example, "0001_PACKET_GEN_ANALYZER_BPK_A").

Type: string
LicensesAvailable
Number of slot(test module) licenses available to users.

Type: u32
Default: 0
LicenseServerList
IP address or hostname of the license server managing the slot(test module) licenses(currently not used).
Type: string
LicensesUsed
Number of slot(test module) licenses checked out by users.

Type: u32
Default: 0
ModuleType
Module type supported by the licensed feature(for example, "CPU" or "2000").

Type: string
PartNum
Part number of the licensed feature(for example, "BPK-1075A").

Type: string
963
fec128PseudowireSubTlv
Read-Only Attribute
Description
PerformanceLevel
Performance level supported by the licensed feature(for example, A, B or C).

Type: string
StartDate
Start date for the licensed feature(for example, "01-jan-2008").

Type: string
SupportedTestModuleList
>List of test modules in the chassis that the licensed feature supports.
Type: u16
Default: 0
UserList
Users with slot(test module) licenses checked out.

Type: string
Version
Application version supported by the licensed feature(for example, "2009.01").

Type: string
Description:
Children: None
fec128PseudowireSubTlv Attributes
Attribute
Description
length
Type: INTEGER
Default: 14
Name
Type: string
pwId
Type: INTEGER
Default: 1
pwType
Type: INTEGER
Default: 4
remotePeAddr
Type: IPV4ADDR
Default: 192.168.1.2
reserved
Type: ALIGNMENTPAD
Default: 0
senderPeAddr
Type: IPV4ADDR
Default: 192.168.1.1
type
Type: INTEGER
Default: 10
964
Description:
Children: None
fec129PseudowireSubTlv Attributes
Attribute
Description
agiLength
Type: INTEGER
Default: 8
agiType
Type: INTEGER
Default: 1
agiValue
Type: OCTETSTRING
Default: 0000000000000001
length
Type: INTEGER
Default: 32
Name
Type: string
pwType
Type: INTEGER
Default: 4
remotePeAddr
Type: IPV4ADDR
Default: 192.168.1.2
reserved
Type: ALIGNMENTPAD
Default: 0
saiiLength
Type: INTEGER
Default: 4
saiiType
Type: INTEGER
Default: 1
saiiValue
Type: OCTETSTRING
Default: 00000001
senderPeAddr
Type: IPV4ADDR
Default: 192.168.1.1
taiiLength
Type: INTEGER
Default: 8
taiiType
Type: INTEGER
Default: 1
taiiValue
Type: OCTETSTRING
Default: 00000002
type
Type: INTEGER
Default: 11
FilePathReplacementCommand
Description:
965
FilteredStreamResults

FilePathReplacementCommand Writable Attributes

Writable Attribute
Description
PathReplacements
Type: string
Default: 0
RootObject
Type: handle
Default: 0
FilePathReplacementCommand Read-Only Attributes

Read-Only Attribute
Description

Description:
Filtered stream results data. Provides filtered sub-stream results for all streams.

Parents: Analyzer
Relations:
Side name
(Type)
Relative
Description
ResultParent
(ResultChild)
Analyzer
SummaryResultParent
(SummaryResultChild)
Specifies a child of the summary result. Used to find out which objects
are used in the summary.
FilteredStreamResults Writable Attributes

FilteredStreamResults Read-Only Attributes

Read-Only Attribute
Description
AvgInterarrivalTime
Average inter-arrival time measured in 1 microsecond units.

Type: double
Default: 0
AvgJitter
Average jitter measured in 1 microsecond units. Although jitter value could be negative, only absolute value
will be measured.
Type: double
Default: 0
966
Read-Only Attribute
Description
AvgLatency
Average transfer delay measured in 1 microsecond units.

Type: double
Default: 0
BitCount
Number of bits received.

Type: u64
Default: 0
BitRate
Rate at which bits are received.

Type: u64
Default: 0
CellCount
Number of cells received.

Type: u64
Default: 0
CellRate
Rate at which cells are received.

Type: u64
Default: 0
Comp16_1
Value pulled from the packet by the first 16-bit filter, that is, part of the "Receive Stream ID".
Type: u16
Default: 0
Comp16_2
Value pulled from the packet by the second 16-bit filter, that is, part of the "Receive Stream ID".
Type: u16
Default: 0
Comp16_3
Value pulled from the packet by the third 16-bit filter, that is, part of the "Receive Stream ID".
Type: u16
Default: 0
Comp16_4
Value pulled from the packet by the fourth 16-bit filter, that is, part of the "Receive Stream ID".
Type: u16
Default: 0
Comp32
Value pulled from the packet by the 32-bit filter, that is, part of the "Receive Stream ID".
Type: u32
Default: 0
CounterTimestamp

Type: u64
Default: 0
DroppedFrameCount
Number of frames dropped in transit.

Type: u64
Default: 0
DroppedFramePercent
Percentage of dropped frames.

Type: double
Default: 0
DroppedFramePercentRate
Percent rate of dropped frames.

Type: double
Default: 0
DroppedFrameRate
Number of frames dropped over the last 1-second interval.

Type: u64
Default: 0
DuplicateFrameCount

Type: u64
Default: 0
DuplicateFrameRate
Number of duplicate frames received over the last 1-second interval.

Type: u64
Default: 0
967
Read-Only Attribute
Description
ExpectedSeqNum
Next expected sequence number in order.

Type: u64
Default: 0
FcsErrorFrameCount

Type: u64
Default: 0
FcsErrorFrameRate
Type: u64
Default: 0
FilteredName_1
Filtered name 1.
Type: string
FilteredName_10
Filtered name 10.

Type: string
FilteredName_2
Filtered name 2.
Type: string
FilteredName_3
Filtered name 3.
Type: string
FilteredName_4
Filtered name 4.
Type: string
FilteredName_5
Filtered name 5.
Type: string
FilteredName_6
Filtered name 6.
Type: string
FilteredName_7
Filtered name 7.
Type: string
FilteredName_8
Filtered name 8.
Type: string
FilteredName_9
Filtered name 9.
Type: string
FilteredValue_1
Filtered value 1.
Type: string
FilteredValue_10
Filtered value 10.

Type: string
FilteredValue_2
Filtered value 2.
Type: string
FilteredValue_3
Filtered value 3.
Type: string
968
Read-Only Attribute
Description
FilteredValue_4
Filtered value 4.
Type: string
FilteredValue_5
Filtered value 5.
Type: string
FilteredValue_6
Filtered value 6.
Type: string
FilteredValue_7
Filtered value 7.
Type: string
FilteredValue_8
Filtered value 8.
Type: string
FilteredValue_9
Filtered value 9.
Type: string
FirstArrivalTime
Backplane first arrival timestamp in 1 microsecond units. 48-bit: groups 6-8, 14-16; 32-bit: other groups.
Type: double
Default: 0
FrameCount

Type: u64
Default: 0
FrameRate
Rate at which frames are received.

Type: u64
Default: 0
HistBin10Count
Number of frames received in the histogram bucket 10.

Type: u64
Default: 0
HistBin10Name
Name of histogram bucket 10.

Type: string
HistBin10Rate
Number of frames received in histogram bucket 10 over the last 1-second interval.
Type: u64
Default: 0
HistBin11Count

Type: u64
Default: 0
HistBin11Name

Type: string
HistBin11Rate
Type: u64
Default: 0
HistBin12Count

Type: u64
Default: 0
HistBin12Name

Type: string
969
Read-Only Attribute
Description
HistBin12Rate
Type: u64
Default: 0
HistBin13Count

Type: u64
Default: 0
HistBin13Name

Type: string
HistBin13Rate
Type: u64
Default: 0
HistBin14Count

Type: u64
Default: 0
HistBin14Name

Type: string
HistBin14Rate
Type: u64
Default: 0
HistBin15Count

Type: u64
Default: 0
HistBin15Name

Type: string
HistBin15Rate
Type: u64
Default: 0
HistBin16Count

Type: u64
Default: 0
HistBin16Name

Type: string
HistBin16Rate
Type: u64
Default: 0
HistBin1Count

Type: u64
Default: 0
HistBin1Name

Type: string
HistBin1Rate
Type: u64
Default: 0
HistBin2Count

Type: u64
Default: 0
970
Read-Only Attribute
Description
HistBin2Name

Type: string
HistBin2Rate
Type: u64
Default: 0
HistBin3Count

Type: u64
Default: 0
HistBin3Name

Type: string
HistBin3Rate
Type: u64
Default: 0
HistBin4Count

Type: u64
Default: 0
HistBin4Name

Type: string
HistBin4Rate
Type: u64
Default: 0
HistBin5Count

Type: u64
Default: 0
HistBin5Name

Type: string
HistBin5Rate
Type: u64
Default: 0
HistBin6Count

Type: u64
Default: 0
HistBin6Name

Type: string
HistBin6Rate
Type: u64
Default: 0
HistBin7Count

Type: u64
Default: 0
HistBin7Name

Type: string
HistBin7Rate
Type: u64
Default: 0
971
Read-Only Attribute
Description
HistBin8Count

Type: u64
Default: 0
HistBin8Name

Type: string
HistBin8Rate
Type: u64
Default: 0
HistBin9Count

Type: u64
Default: 0
HistBin9Name

Type: string
HistBin9Rate
Type: u64
Default: 0
InOrderFrameCount
Number of frames received in sequence order.

Type: u64
Default: 0
InOrderFrameRate
Number of frames received in order over the last 1-second interval.

Type: u64
Default: 0
InSeqFrameCount

Type: u64
Default: 0
InSeqFrameRate
Number of frames received in sequence order over the last 1-second interval.
Type: u64
Default: 0

Type: u64
Default: 0
Type: u64
Default: 0
L1BitCount
Number of layer1 bits received.

Type: u64
Default: 0
L1BitRate
Rate at which layer1 bits are received.

Type: u64
Default: 0
LastArrivalTime
Backplane last arrival timestamp in 1 microsecond units. 48-bit: groups 6-8, 14-16; 32-bit: other groups.
Type: double
Default: 0
LastSeqNum
Last sequence number received.

Type: u64
Default: 0
LateFrameCount
Number of late frames received.

Type: u64
Default: 0
972
Read-Only Attribute
Description
LateFrameRate
Number of late frames received over the last 1-second interval.

Type: u64
Default: 0
MaxFrameLength

Type: u64
Default: 0
MaxInterarrivalTime
Maximum inter-arrival time measured in 1 microsecond units.

Type: double
Default: 0
MaxJitter
Maximum jitter measured in 1 microsecond units. Although jitter value could be negative, only absolute
value will be measured.
Type: double
Default: 0
MaxLatency
Maximum transfer delay measured in 1 microsecond units.

Type: double
Default: 0
MinFrameLength

Type: u64
Default: 0
MinInterarrivalTime
Minimum inter-arrival time measured in 1 microsecond units.

Type: double
Default: 0
MinJitter
Minimum jitter measured in 1 microsecond units. Although jitter value could be negative, only absolute value
will be measured.
Type: double
Default: 0
MinLatency
Minimum transfer delay measured in 1 microsecond units.

Type: double
Default: 0
OctetCount
Number of bytes received.

Type: u64
Default: 0
OctetRate
Rate at which bytes are received.

Type: u64
Default: 0
OutSeqFrameCount
Number of frames received out of sequence order.

Type: u64
Default: 0
OutSeqFrameRate
Number of frames received out of sequence order over the last 1-second interval.
Type: u64
Default: 0
PortStrayFrames
Whether frames received on the port are stray frames (not expected).
Type: enum
Default: NA
Possible Values:
Value Description
PrbsBitErrorCount
NA
If collect stray frames is not enabled or no traffic occurs, the frame is defined as NA.
YES
Stream was received on an unexpected port.
NO
Stream was received on the expected port.

Type: u64
Default: 0
973
Read-Only Attribute
Description
PrbsBitErrorRate
Type: u64
Default: 0
PrbsBitErrorRatio

Type: double
Default: 0
PrbsErrorFrameCount

Type: u64
Default: 0
PrbsErrorFrameRate

Type: u64
Default: 0
PrbsFillOctetCount

Type: u64
Default: 0
PrbsFillOctetRate
Type: u64
Default: 0
ReorderedFrameCount
Number of frames reordered.

Type: u64
Default: 0
ReorderedFrameRate
Number of frames reordered over the last 1-second interval.

Type: u64
Default: 0
Rfc4689AbsoluteAvgJitter
Avg Jitter value calculated using RFC 4689 specification.

Type: double
Default: 0
SeqRunLength
Sequence run length is the length of the current sequence run, updated each time a frame is received. A
sequence run can contain reordered frames (in which the received sequence number is less than the
expected sequence number) but no discontinuities (in which the received sequence number is greater than
the expected sequence number). Sequence runs have no missing sequence numbers between start and
end values.
Type: u64
Default: 0
ShortTermAvgInterarrivalTime
Short term average inter-arrival time measured in 1 microsecond units.

Type: double
Default: 0
ShortTermAvgJitter
Short term average jitter.

Type: double
Default: 0
ShortTermAvgLatency
Short term average latency of the transmission.

Type: double
Default: 0
SigFrameCount

Type: u64
Default: 0
SigFrameRate

Type: u64
Default: 0
StreamIndex
Monotonically incrementing index (zero-based) in the order that the streams were learned.
Type: u32
Default: 0
974
FIP
Read-Only Attribute
Description
TcpUdpChecksumErrorCount
Number of TCP/UDP checksum errors received.

Type: u64
Default: 0
TcpUdpChecksumErrorRate
Number of TCP/UDP checksum errors received over the last 1-second interval.
Type: u64
Default: 0
TotalInterarrivalTime
Total inter-arrival time measured in 1 microsecond units.

Type: u64
Default: 0
TotalJitter
Total jitter measured in 1 microsecond units. Although jitter value could be negative, only absolute value
will be measured.
Type: u64
Default: 0
TotalJitterRate
Total jitter over the last 1-second interval.

Type: u64
Default: 0
FIP (fc:FIP)
Description:
Children: DL
FIP Attributes
Attribute
Description
Type: BITSTRING
Default: 0
Type: BITSTRING
Default: 0
fipDescriptorListLength
Type: INTEGER
Default: 0
fipOperationCode
Type: OCTETSTRING
Default: 0001
fipSubCode
Type: OCTETSTRING
Default: 00
fp
Type: BITSTRING
Default: 1
Name
Type: string
padding
Type: OCTETSTRING
reserved1
Type: BITSTRING
Default: 00
975
Fixed
Attribute
Description
reserved2
Type: OCTETSTRING
Default: 00
reserved3
Type: BITSTRING
Default: 0
Type: BITSTRING
Default: 0
sp
Type: BITSTRING
Default: 0
version
Type: BITSTRING
Default: 0
Fixed
Description:
Parents: ProvList
Children: SubTlvs
Fixed Attributes
Attribute
Description
InfoType
Type: OCTETSTRING
Default: 03
Instance
Type: INTEGER
Default: 1
Name
Type: string
NumOfTlvs
Type: INTEGER
Default: 0
VifType
Type: VifTypeValues
Default: 01
Possible Values:
Value Description
01
Ethernet
02
FC
FixedDurationTestConfig
Description:
Configuration for custom fixed duration test.

Parents: Project
976
FixedDurationTestConfig Writable Attributes

Writable Attribute
Description
Active, Name
Type: u16
Default: 15
Range: 0 - 3600
DurationBursts
Transmission length in number of frames.

Type: u32
Default: 1000
Range: 1 - 16777215
DurationMode
Duration mode for each transmitted stream. Whether to measure test duration in seconds or number of frames.
Type: enum
Default: SECONDS
Possible Values:
Value
Description
BURSTS
DurationSeconds
Transmission time in seconds.

Type: double
Default: 10
Range: 0.000064 - 4398046.0
EnableArp
Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
ARP is enabled.

EnableDhcp
Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
DHCP is enabled.

EnableL2Learning
Whether to enable Layer 2 learning mode.

Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
Enable Layer 2 learning mode.
FALSE Disable Layer 2 learning mode.

EnableL2tp
Flag to add L2TP commands.

Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
Adds L2TP commands.
977
Writable Attribute
Description
Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE

EnablePpp
Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
PPP is enabled.

EnableRouter
Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
Router is enabled.

events and states.
Type: bool
Default: TRUE
Possible Values:
Value Description
TRUE

Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE

FixedFrameSize

Type: u16
Default: 128
Range: 40 - 16383
Type: u8
Default: 0
Range: 0 - 100
FixedLoad
Sets the fixed load rate when LoadType is FIXED.

Type: double
Default: 10
978
Writable Attribute
Description
FrameSizeType
Specifies the method of setting the frame size.

Type: enum
Possible Values:
Value
Description
USE_PORTS_STREAMS Use frame size that is currently set in streamblocks.
FIXED
Frame size is constant and equal to FixedFrameSize.
RANDOM
Frame size is randomly chosen within the range set by RandomMinFrameSize and
RandomMaxFrameSize.
IMIX
Frame size is defined by existing iMIX distribution.
ImixDistribution
Type: handle
Default: 0
InterburstGapMode
Specifies the inter-burst gap mode, the idle time between packets, as either fixed or random.
Type: enum
Default: FIXED
Possible Values:
Value
Description
FIXED
Type: u16
Default: 2
LoadType

Type: enum
Possible Values:
Value
Description
USE_PORTS_STREAMS Use load that is currently set in streamblocks.
LoadUnits
FIXED
Load rate is constant and equal to FixedLoad.
RANDOM
Load rate is randomly chosen within the range set by RandomMinLoad and
RandomMaxLoad.
Type: enum
Possible Values:
Value
Description
PERCENT_LINE_RATE
FRAMES_PER_SECOND
Frames per second.
INTER_BURST_GAP
PerformL2Learning
KILOBITS_PER_SECOND
BITS_PER_SECOND
Bits per second.
Specifies when to perform Layer 2 learning.

Type: enum
Default: BEFORE_TEST
Possible Values:
Value
Description
BEFORE_TEST
Perform Layer 2 learning before the test.
EACH_ITERATION Perform Layer 2 learning for each iteration.
979
FixedSubTlvList
Writable Attribute
Description
RandomMaxFrameSize
Maximum frame size when FrameSizeType is RANDOM. This attribute is ignored if FrameSizeType is set to STEP,
FIXED or CUSTOM.
Type: u16
Default: 256
Range: 40 - 16383
Type: u8
Default: 12
Range: 0 - 100
RandomMaxLoad
Type: double
Default: 50
RandomMinFrameSize
Minimum frame size when FrameSizeType is RANDOM.

Type: u16
Default: 128
Range: 40 - 16383
Type: u8
Default: 12
Range: 0 - 100
RandomMinLoad
Type: double
Default: 10
StartTrafficDelay
This is the number of seconds to wait before sending traffic. This setting gives you the flexibility to start traffic a specific
number of seconds after test start, or after advertisement is complete.
Type: u16
Default: 0
Range: 0 - 3600
TrafficStartMode
Traffic start mode to use.

Type: enum
Possible Values:
Value
Description
SYNCHRONOUS
FixedDurationTestConfig Read-Only Attributes

Read-Only Attribute
Description
TestType
Test type is Custom.

Type: string
Default: Custom
FixedSubTlvList
Description:
Parents: SubTlvs
Children: ProfileNameTlv, vNicUuidTlv
980
fkaAdvPeriod
FixedSubTlvList Attributes
Attribute
Description
Name
information.
Type: string
fkaAdvPeriod
Description:
Parents: DL-Choice
Children: None
fkaAdvPeriod Attributes
Attribute
Description
FkaAdvPeriod
Type: OCTETSTRING
Default: 00000000
length
Type: INTEGER
Default: 2
Name
Type: string
reserved
Type: OCTETSTRING
Default: 0000
type
Type: INTEGER
Default: 12
flags (overloaded)
flags (ipv4)
flags (lldp)
flags Object (ipv4 PDU library)

Description:
Parents: ipHdr (StreamBlock.IcmpDestUnreach.ipData.ipHdr)

ipHdr (StreamBlock.IcmpTimeExceeded.ipData.ipHdr)
ipHdr (StreamBlock.IcmpParameterProblem.ipData.ipHdr)
ipHdr (StreamBlock.IcmpSourceQuench.ipData.ipHdr)
981
FLAGS
ipHdr (StreamBlock.IcmpRedirect.ipData.ipHdr)
ipHdr (StreamBlock.IPv4)
Children: None
flags Attributes
Attribute
Description
dfBit
Type: BITSTRING
Default: 0
mfBit
Type: BITSTRING
Default: 0
Name
more information.
Type: string
reserved
Type: BITSTRING
Default: 0
flags Object (lldp PDU library)

Description:
Parents: PortAndProtocolVlanIdTlv (StreamBlock.PortAndProtocolVlanIdTlv)

Children: None
flags Attributes
Attribute
Description
Name
information.
Type: string
portAndProtocolVlanEnabled
Type: BITSTRING
Default: 1
portAndProtocolVlanSupport
Type: BITSTRING
Default: 1
reserved
Type: BITSTRING
Default: 00000
reserved
Type: BITSTRING
Default: 0
FLAGS
Description:
982
FLAGS
Parents: OAMBH
Children: None
FLAGS Attributes
Attribute
Description
CriticalEvent
Type: FlagsCriticalEvent
Default: 0
Possible Values:
Value Description
DyingGasp
LinkFault
LocalStableEval
A critical event has occurred
A critical event has not occurred
Type: FlagsDyingGasp
Default: 0
Possible Values:
Value Description
1
Unrecoverable local failure condition has occurred
Unrecoverable local failure condition has not occurred
Type: FlagsLinkFault
Default: 0
Possible Values:
Value Description
1
Local device's receive path has detected a fault
Local device's receive path has not detected a fault
Type: FlagsLocalStableEval
Default: 00
Possible Values:
Value Description
0
Local DTE Unsatisfied, Discovery can not complete
Local DTE Discovery process has not completed
Local DTE Discovery process has completed
Reserved
Name
more information.
Type: string
RemoteEval
Type: FlagsRemoteEval
Default: 1
Possible Values:
Value Description
RemoteStable
Reserved
False
True
Type: FlagsRemoteStable
Default: 1
Possible Values:
Value Description
0
False
True
Type: BITSTRING
Default: 000000000
983
FlapSetupCommand
FlapSetupCommand
Description:
Sets up a series of commands to flap in the sequencer.

FlapSetupCommand Writable Attributes

Writable Attribute
Description
CreateSequence
Create the sequence.

Type: bool
Default: TRUE
Possible Values:
Value Description
TRUE
Create the sequence.
FALSE Do not create the sequence.

DevicesToFlap
Devices to flap up/flap down.

Type: handle
Default: 0
EnableWaitTimeout
Determines whether or not a Wait Event is added to the sequencer.

Type: bool
Default: TRUE
Possible Values:
Value Description
TRUE
Enable wait timeout.
FALSE Disable wait timeout.

FlapDownClassIdList
List of the flap down command class IDs.

Type: s32
Default: 0
FlapDownFirst
Enable flap devices down first.

Type: bool
Default: TRUE
Possible Values:
Value Description
TRUE
Enable flap devices down first.
FALSE Flap devices up first.

IterationCount
Number of iterations to flap up/down.

Type: u32
Default: 1
WaitFlapTimeout
Maximum time to wait for wait for flap up/down events to complete.
Type: s32
Default: 30
WaitForFlap
Enable wait for flap up/down to complete.

Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
Enable wait for flap up/down to complete.
FALSE Disable wait for flap up/down to complete.
984
FlatPatternDescriptor
Writable Attribute
Description
WaitTimeout
Maximum time to wait for flap up/down events to complete.

Type: s32
Default: 30
FlapSetupCommand Read-Only Attributes

Read-Only Attribute
Description

LoopCommandHandle
Root loop command handle.

Type: handle
Default: 0
FlatPatternDescriptor
Description:
Describes a flat load type.

FlatPatternDescriptor Writable Attributes

Writable Attribute
Description
Active, Name
Height
Amount of load to apply (Y-axis). The LoadType attribute in the ClientLoadProfile object controls the type
of load that is generated.
Type: s32
Default: 30
RampTime
Time to wait before applying the load.

Type: u32
Default: 20
SteadyTime
Length of time to apply the load. The time unit is controlled by the LoadPhaseDurationUnits attribute on the
ClientLoadPhase object.
Type: u32
Default: 40
FlatPatternDescriptor Read-Only Attributes

flogi
Description:
Parents: flogiRequest
985
flogiAcc
flogi Attributes
Attribute
Description
command
Type: OCTETSTRING
Default: 04
Name
Type: string
nodeName
Type: WWN
Default: 10:00:10:94:00:00:00:01
nPortName
Type: WWN
Default: 20:00:10:94:00:00:00:01
reserved1
Type: OCTETSTRING
Default: 000000
vendorVersionLevel
Type: OCTETSTRING
flogiAcc
Description:
Parents: flogiAccept
flogiAcc Attributes
Attribute
Description
command
Type: OCTETSTRING
Default: 02
Name
Type: string
nodeName
Type: WWN
Default: 10:00:10:94:00:00:00:01
nPortName
Type: WWN
Default: 20:00:10:94:00:00:00:01
reserved1
Type: OCTETSTRING
Default: 000000
vendorVersionLevel
Type: OCTETSTRING
flogiAccept (overloaded)
flogiAccept (fc) - Object definition for the following paths:
986
flogiAccept
StreamBlock.FCoE.fc.fcPayloads.FCPayload-Choice.flogiAccept
flogiAccept (fc) - Object definition for the following paths:
StreamBlock.FIP.DL.DL-Choice.flogiAccept
flogiAccept Object (fc PDU library)

Description:

flogiAccept Attributes
Attribute
Description
command
Type: OCTETSTRING
Default: 02
Name
Type: string
nodeName
Type: WWN
Default: 10:00:10:94:00:00:00:01
nPortName
Type: WWN
Default: 20:00:10:94:00:00:00:01
reserved1
Type: OCTETSTRING
Default: 000000
vendorVersionLevel
Type: OCTETSTRING
flogiAccept Object (fc PDU library)

Description:

Children: flogiAcc
flogiAccept Attributes
Attribute
Description
length
Type: INTEGER
Default: 36
987
flogiReject
Attribute
Description
Name
more information.
Type: string
reserved
Type: OCTETSTRING
Default: 0000
type
Type: INTEGER
Default: 7
flogiReject (overloaded)
flogiReject (fc) - Object definition for the following paths:
StreamBlock.FCoE.fc.fcPayloads.FCPayload-Choice.flogiReject
flogiReject (fc) - Object definition for the following paths:
StreamBlock.FIP.DL.DL-Choice.flogiReject
flogiReject Object (fc PDU library)

Description:

Children: None
flogiReject Attributes
Attribute
Description
command
Type: OCTETSTRING
Default: 01
Name
Type: string
reasonCode
Type: OCTETSTRING
Default: 3
reasonExplanation
Type: OCTETSTRING
Default: 0F
reserved1
Type: OCTETSTRING
Default: 00000000
vendorUnique
Type: OCTETSTRING
Default: 0
988
flogiRequest
flogiReject Object (fc PDU library)

Description:

Children: flogiRjt
flogiReject Attributes
Attribute
Description
length
Type: INTEGER
Default: 9
Name
more information.
Type: string
reserved
Type: OCTETSTRING
Default: 0000
type
Type: INTEGER
Default: 7
flogiRequest (overloaded)
flogiRequest (fc) - Object definition for the following paths:
StreamBlock.FCoE.fc.fcPayloads.FCPayload-Choice.flogiRequest
flogiRequest (fc) - Object definition for the following paths:
StreamBlock.FIP.DL.DL-Choice.flogiRequest
flogiRequest Object (fc PDU library)

Description:

flogiRequest Attributes
Attribute
Description
command
Type: OCTETSTRING
Default: 04
Name
Type: string
989
flogiRjt
Attribute
Description
nodeName
Type: WWN
Default: 10:00:10:94:00:00:00:01
nPortName
Type: WWN
Default: 20:00:10:94:00:00:00:01
reserved1
Type: OCTETSTRING
Default: 000000
vendorVersionLevel
Type: OCTETSTRING
flogiRequest Object (fc PDU library)

Description:

Children: flogi
flogiRequest Attributes
Attribute
Description
length
Type: INTEGER
Default: 36
Name
more information.
Type: string
reserved
Type: OCTETSTRING
Default: 0000
type
Type: INTEGER
Default: 7
flogiRjt
Description:
Children: fc
flogiRjt Attributes
Attribute
Description
commandCode
Type: OCTETSTRING
Default: 01
990
ForeignMasterClockResults
Attribute
Description
explanationCode
Type: OCTETSTRING
Default: 0F
Name
Type: string
reasonCode
Type: OCTETSTRING
Default: 03
reserved1
Type: OCTETSTRING
Default: 000000
reserved2
Type: OCTETSTRING
Default: 00
vendorUnique
Type: OCTETSTRING
Default: 00
ForeignMasterClockResults
Description:
IEEE 1588v2 foreign master clock results.

Relations:
Side name
(Type)
Relative
Description
ResultParent
(ResultChild)
ForeignMasterClockResults Writable Attributes

ForeignMasterClockResults Read-Only Attributes

Read-Only Attribute
Description
AnnounceCount
Number of Announce messages received from the foreign master clock.

Type: u64
Default: 0
ClockIdentity
Clock idenitity.
Type: u64
Default: 0
PortNum
Port number.
Type: u16
Default: 0
Threshold
Foreign master threshold.

Type: u64
Default: 0
991
fpng
Read-Only Attribute
Description
TimeWindow
Foreign master time window.

Type: u64
Default: 0
fpng
Description:
fpng Attributes
Attribute
Description
destinationPortLength
Type: INTEGER
Default: 0
destinationPortTag
Type: SourceDestinationPortTags
Default: 01
Possible Values:
Value Description
01
N_PORT_ID
02
Nx_Port Port_Name
destinationPortValue
Type: OCTETSTRING
Default: 00000000
Name
Type: string
pad1
pad2
revision
Type: OCTETSTRING
Default: 00000000
sourcePortLength
Type: INTEGER
Default: 0
sourcePortTag
Default: 01
Possible Values:
Value Description
01
N_PORT_ID
02
Nx_Port Port_Name
sourcePortValue
Type: OCTETSTRING
Default: 00000000
Token
Type: OCTETSTRING
Default: 00000000
992
Fpng
Fpng (fcgs:Fpng)
Description:
Fpng Attributes
Attribute
Description
Type: INTEGER
Default: 0
destinationPortTag
Default: 01
Possible Values:
Value Description
01
N_PORT_ID
02
Nx_Port Port_Name
Type: OCTETSTRING
Default: 00000000
Name
Type: string
pad1
pad2
revision
Type: OCTETSTRING
Default: 00000000
sourcePortLength
Type: INTEGER
Default: 0
sourcePortTag
Default: 01
Possible Values:
Value Description
01
N_PORT_ID
02
Nx_Port Port_Name
sourcePortValue
Type: OCTETSTRING
Default: 00000000
Token
Type: OCTETSTRING
Default: 00000000
fpngAccept
Description:
993
FpngAccept
fpngAccept Attributes
Attribute
Description
Name
more information.
Type: string
Token
Type: OCTETSTRING
Default: 00000000
FpngAccept (fcgs:FpngAccept)
Description:
FpngAccept Attributes
Attribute
Description
Name
more information.
Type: string
Token
Type: OCTETSTRING
Default: 00000000
Description:
Defines an iMIX frame size distribution. iMIX traffic (iMIX for Internet mix) uses multiple frame sizes and you can use it to simulate traffic that is more realistic.
You can define a frame size distribution that has up to 16 different frame sizes by using up to 16 FrameLengthDistributionSlot children. Each
FrameLengthDistributionSlot object defines a frame size or a frame size range.
After you create a frame size distribution with this object, you can save it to a file by using FrameLengthDistributionSaveAsTemplateCommand. You can load
a frame size distribution file by using FrameLengthDistributionLoadFromTemplateCommand.

Parents: Project
Automatically-created children: FrameLengthDistributionSlot
Relations:
Side name
(Type)
Relative
GenParams
(AccessTestImixAffiliation)
AffiliationFrameLengthDistributionStreamBlock
(AffiliationFrameLengthDistribution)
StreamBlock
CollectionOwner
(DefaultSelection)
Project
994
Description
FrameLengthDistributionLoadFromTemplateCommand
FrameLengthDistribution Writable Attributes

Writable Attribute
Description
Active, Name
Seed
Used to change the sequence of transmitted frame sizes. If you change the value of the seed, frame
sizes will be transmitted in a different sequence.
Type: u32
Default: 10900842
FrameLengthDistribution Read-Only Attributes

FrameLengthDistributionLoadFromTemplateCommand
Description:
Load a frame size distribution file (iMIX file).
You can create a frame size distribution using a FrameLengthDistribution object, then you can save the frame size distribution to a file using
FrameLengthDistributionSaveAsTemplateCommand.
You can load one of the frame size distribution files that come with the Spirent TestCenter GUI application. These are usually under the installation directory
in Templates\Traffic\L2L3\FrameLengthDistribution.
You can also create frame size distribution files in the Spirent TestCenter GUI application by using the iMIX Editor.
This command uses a FrameLengthDistribution object and creates FrameLengthDistributionSlot objects under it as needed.

FrameLengthDistributionLoadFromTemplateCommand Writable Attributes

Writable Attribute
Description
FileName
Name of the frame length distribution file to load.

Type: inputFilePath
Default: FrameLengthDistributionTemplate.xml
TargetFrameLengthDistribution
Handle of the FrameLengthDistribution object under which to load the frame size distribution. A
FrameLengthDistributionSlot object will be created for each frame size. If you use the default, a new
FrameLengthDistribution object will be created.
Type: handle
Default: 0
FrameLengthDistributionLoadFromTemplateCommand Read-Only Attributes

Read-Only Attribute
Description

Handle of the FrameLengthDistribution object under which the frame size distribution is loaded.
Type: handle
Default: 0
995
FrameLengthDistributionSaveAsTemplateCommand
FrameLengthDistributionSaveAsTemplateCommand
Description:
Save a frame size distribution to a file. See FrameLengthDistribution for more information on frame size distributions.

FrameLengthDistributionSaveAsTemplateCommand Writable Attributes

Writable Attribute
Description
FileName
Name for the file to be saved.

Default: FrameLengthDistributionTemplate.xml
Handle of the FrameLengthDistribution object that defines the frame size distribution you want to
save.
Type: handle
Default: 0
FrameLengthDistributionSaveAsTemplateCommand Read-Only Attributes

Read-Only Attribute
Description

FrameLengthDistributionSlot
Description:
Defines a single frame size or frame size range in an iMIX frame size distribution. There can be up to 16 of these objects under a FrameLengthDistribution
object.

Automatically created from: FrameLengthDistribution
FrameLengthDistributionSlot Writable Attributes

Writable Attribute
Description
Active, Name
FixedFrameLength
Frame size used when FrameLengthMode is set to FIXED.

Type: u16
Default: 128
FrameLengthMode
Whether to use fixed or random frame sizes.

Type: enum
Default: FIXED
Possible Values:
Value
Description
FIXED
Use the fixed frame size defined by FixedFrameLength.
RANDOM Use random frame sizes between the settings of MaxFrameLength and MinFrameLength.
996
FrameLengthHistogram
Writable Attribute
Description
MaxFrameLength
Maximum frame size used when FrameLengthMode is set to RANDOM.

Type: u16
Default: 1518
MinFrameLength
Minimum frame size used when FrameLengthMode is set to RANDOM.

Type: u16
Default: 128
Weight
Importance to give this frame size definition (this FrameLengthDistributionSlot object) in the frame size distribution.
A higher Weight value for this frame size definition in relation to the Weight values of other frame size definitions
means more traffic of this size will be transmitted.
Type: u16
Default: 1
Range: 1 - 65535
FrameLengthDistributionSlot Read-Only Attributes

FrameLengthHistogram
Description:
Frame length histogram configuration. Minimum and maximum frame length, and 16 histogram bin counters can be retrieved from the results.

Automatically created from: AnalyzerConfig
Relations:
Side name
(Type)
Relative
Description
ActiveParent
(ActiveHistogram)
AnalyzerConfig
Associates an active histogram configuration to an AnalyzerConfig

object.
FrameLengthHistogram Writable Attributes

Writable Attribute
Description
Active, Name
BucketSizeList
List of bucket sizes when DistributionMode is CUSTOM_MODE and ConfigMode is CONFIG_SIZE_MODE. For example,
a bucket size list as follows: "2 4 8 16 32 64 128 256 512 1024 2048 4096 8192 16384 32768 65536" has a first bucket
of size 2, second bucket of size 4, and so on.
Type: u32
Default: 0
ConfigMode
Choose the configuration mode for the histogram buckets.

Type: enum
Default: CONFIG_SIZE_MODE
Possible Values:
Value
Description
CONFIG_SIZE_MODE Configure the histogram buckets using the bucket sizes.
CONFIG_LIMIT_MODE Configure the histogram buckets using the upper limit values for each bucket.
Description
Description of the histogram configuration.

Type: string
Default: (in bytes)
997
fs
Writable Attribute
Description
DistributionMode
Select the distribution size mode when ConfigMode is CONFIG_SIZE_MODE. CUSTOM_MODE is the default distribution
mode.
Type: enum
Default: CUSTOM_MODE
Possible Values:
Value
Description
CENTERED_MODE Bucket in the middle will be of DistributionModeSize and other buckets around it will be of
UniformDistributionSize.
LEFT_MODE
Leftmost bucket will be of DistributionModeSize and other buckets will be of UniformDistributionSize.
RIGHT_MODE
Rightmost bucket will be of DistributionModeSize and other buckets will be of

CUSTOM_MODE
Custom distribution of the histogram buckets using the BucketSizeList.
DistributionModeSize
Size of the bucket in the left, right, or center, according to the DistributionMode.
Type: u32
Default: 1024
LimitList
List of limits when config mode is CONFIG_LIMIT_MODE. For example, a limit list as follows: "2 4 8 16 32 64 128 256
512 1024 2048 4096 8192 16384 32768" has the first bucket from 0 to 2, second bucket from 3 to 4, and so on.
Type: u32
Default: 0
UniformDistributionSize
Size of the uniformly sized buckets. For example, if the DistributionMode is LEFT_MODE, then all the buckets, except
the leftmost one, will be of UniformDistributionSize.
Type: u32
Default: 8
FrameLengthHistogram Read-Only Attributes

fs
Description:
Parents: DataFrame
Children: dataMin, jumboMax, regMax
fs Attributes
Attribute
Description
Name
information.
Type: string
fspfHeader (overloaded)
fspfHeader (fc)
fspfHeader (fcsw)
998
fspfHeader
fspfHeader Object (fc PDU library)

Description:
Parents: hloRequest (StreamBlock.FCoE.fc.fcPayloads.FCPayload-Choice.hloRequest)

lsuRequest (StreamBlock.FCoE.fc.fcPayloads.FCPayload-Choice.lsuRequest)
lsaRequest (StreamBlock.FCoE.fc.fcPayloads.FCPayload-Choice.lsaRequest)
Children: None
fspfHeader Attributes
Attribute
Description
authentication
Type: OCTETSTRING
Default: 0000000000000000
authenticationType
Type: OCTETSTRING
Default: 00
command
Type: OCTETSTRING
Default: 14000000
fspfVersion
Type: OCTETSTRING
Default: 02
Name
Type: string
obsoletedFCSW4
Type: OCTETSTRING
Default: 00
originatingDomainID
Type: OCTETSTRING
Default: 00000001
reserved
Type: OCTETSTRING
Default: 00
fspfHeader Object (fcsw PDU library)

Description:
Parents: hloRequest (StreamBlock.HloReq)

lsuRequest (StreamBlock.LsuReq)
lsaRequest (StreamBlock.LsaReq)
Children: None
fspfHeader Attributes
Attribute
Description
authentication
Type: OCTETSTRING
Default: 0000000000000000
authenticationType
Type: OCTETSTRING
Default: 00
999
FtpClientProtocolConfig
Attribute
Description
command
Type: OCTETSTRING
Default: 14000000
fspfVersion
Type: OCTETSTRING
Default: 02
Name
Type: string
obsoletedFCSW4
Type: OCTETSTRING
Default: 00
originatingDomainID
Type: OCTETSTRING
Default: 00000001
reserved
Type: OCTETSTRING
Default: 00
Description:
Creates an FTP protocol client.

Result children (automatically created): FtpClientResults
Relations:
Side name
(Type)
Relative
Description
ClientLoadProfile
ClientLoadProfile
Specifies the client load profile used by a client.
ClientProfile
ClientProfile
Specifies the client profile used by a client.
L4L7ProtocolConfigServerBase
(ConnectionDestination)
FtpServerProtocolConfig, HttpServerProtocolConfig,
RawTcpServerProtocolConfig,
VideoServerProtocolConfig
Specifies client-server association.
ResultChild
(ResultChild)
FtpClientResults
UsesIf
(UsesIf)


FtpClientProtocolConfig Writable Attributes

Writable Attribute
Description
Active, Name
1000
Writable Attribute
Description
ClientName
User-defined name for the client. The name is relevant only to the user.
Type: string
DoGetOp
Whether the client does a GET or a PUT.

Type: bool
Default: TRUE
Possible Values:
Value Description
TRUE
Client does a GET.
FALSE Client does a PUT.

DynamicLoad
Load value in units of the load profile, only used when Use Dynamic Load is true.
Type: s32
Default: 30
Range: 1 - 500000
EnablePassiveDataXfer
Enable or disable passive mode data transfer.

Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
Enable
FALSE Disable
EndpointConnectionPattern
Pattern for connection of client endpoints to server/peer endpoints.

Type: enum
Default: PAIR
Possible Values:
Value
Description
PAIR
Pair connections.
BACKBONE_SRC_FIRST
Backbone connections, varying the source address first.
BACKBONE_DST_FIRST
Backbone connections, varying the destination address first.
BACKBONE_INTERLEAVED Backbone connections, interleaving source and destination addresses.

MaxTransactionsPerServer
Maximum number of transactions between a single client and server.

Type: u32
Default: 10
Range: 1 - 4294967295
Unused.
Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
Unused.
FALSE Unused.
FtpClientProtocolConfig Read-Only Attributes

Read-Only Attribute
Description
LoadProfileRunState
Whether the client protocol configuration is running.

Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
Is running.
FALSE Is not running.
1001
FtpClientResults
FtpClientResults
Description:
FTP client results.

Parents: FtpClientProtocolConfig
Relations:
Side name
(Type)
Relative
Description
ResultParent
(ResultChild)
FtpClientResults Writable Attributes

FtpClientResults Read-Only Attributes

Read-Only Attribute
Description
AbortedConnections
Total number of aborted connections from the client block.

Type: u64
Default: 0
AbortedConnectionsPerSecond
Total number of aborted connections per second from the client block.
Type: u64
Default: 0
AbortedTransactions
Total number of aborted transactions from the client block.

Type: u64
Default: 0
AbortedTransactionsPerSecond
Total number of aborted transactions per second from the client block.
Type: u64
Default: 0
ActiveConnections
Number of connections open or attempting for this client at this instant. Active Connections only applies
to the FTP control connections. The FTP data connections are not included in this result. Active
Connections on the server will typically be fewer in number than Active Connections on the associated
client due to differences in the events that inform the server and client processes that a connection
has been started and terminated.
Type: u32
Default: 0
AttemptedConnections
Total number of attempted connections from the client block.

Type: u64
Default: 0
AttemptedConnectionsPerSecond
Total number of attempted connections per second from the client block.
Type: u64
Default: 0
AttemptedTransactions
Total number of attempted transactions from the client block.

Type: u64
Default: 0
AttemptedTransactionsPerSecond
Total number of attempted transactions per second from the client block.
Type: u64
Default: 0
AvgFileTransferBps
Average of file transfer rate for successful transactions.

Type: u64
Default: 0
1002
FtpClientResults
Read-Only Attribute
Description
BlockIndex
Internally-allocated index for this FTP client block.

Type: u32
Default: 0
ElapsedSeconds
Time duration in seconds that this client block has been running.
Type: u64
Default: 0
GoodputAvgRxRateBps
Average goodput receive rate in bits per second.

Type: u64
Default: 0
GoodputAvgTxRateBps
Average transmitted goodput rate in bits per second.

Type: u64
Default: 0
GoodputMaxRxRateBps
Maximum received goodput rate in bits per second.

Type: u64
Default: 0
GoodputMaxTxRateBps
Maximum goodput rate in bits per second.

Type: u64
Default: 0
GoodputMinRxRateBps
Minimum received goodput rate in bits per second.

Type: u64
Default: 0
GoodputMinTxRateBps
Minimum goodput rate in bits per second.

Type: u64
Default: 0
GoodputRxBps
Current received goodput in bits per second.

Type: u64
Default: 0
GoodputRxBytes
Total received goodput bytes.

Type: u64
Default: 0
GoodputTxBps
Current transmitted goodput in bits per second.

Type: u64
Default: 0
GoodputTxBytes
Total transmitted goodput bytes.

Type: u64
Default: 0
IntendedLoad
Intended load. The unit for the value is determined by the setting of the LoadType attribute in the
ClientLoadProfile object.
Type: u32
Default: 0
ParentName
Name of parent Protocol for which the results apply.

Type: string
RxResponseCode150
Received response codes with a value of 150.

Type: u64
Default: 0
RxResponseCode200

Type: u64
Default: 0
1003
FtpClientResults
Read-Only Attribute
Description
RxResponseCode226

Type: u64
Default: 0
RxResponseCode227

Type: u64
Default: 0
RxResponseCode230

Type: u64
Default: 0
RxResponseCode331

Type: u64
Default: 0
RxResponseCode425

Type: u64
Default: 0
RxResponseCode426

Type: u64
Default: 0
RxResponseCode452

Type: u64
Default: 0
RxResponseCode500

Type: u64
Default: 0
RxResponseCode502

Type: u64
Default: 0
RxResponseCode530

Type: u64
Default: 0
SuccessfulConnections
Total number of successful connections from the client block.

Type: u64
Default: 0
SuccessfulConnectionsPerSecond
Total number of successful connections per second from the client block.
Type: u64
Default: 0
SuccessfulTransactions
Total number of successful transactions from the client block.

Type: u64
Default: 0
SuccessfulTransactionsPerSecond
Total number of successful transactions per second from the client block.
Type: u64
Default: 0
UnsuccessfulConnections
Total number of unsuccessful connections from the client block.

Type: u64
Default: 0
UnsuccessfulConnectionsPerSecond
Total number of unsuccessful connections per second from the client block.
Type: u64
Default: 0
UnsuccessfulTransactions
Total number of unsuccessful transactions from the client block.

Type: u64
Default: 0
1004
FtpProtocolParams
Read-Only Attribute
Description
UnsuccessfulTransactionsPerSecond
Total number of unsuccessful transactions per second from the client block.
Type: u64
Default: 0
FtpProtocolParams
Description:
Configure FTP specific parameters in the ALP Traffic Wizard.

Automatically created from: L4L7GenerateTrafficConfigParams
Relations:
Side name
(Type)
Relative
ClientLoadProfile
ClientLoadProfile
ClientProfile
ClientProfile
ServerProfile
(AffiliatedServerProfile)
ServerProfile
FtpProtocolParams Writable Attributes

Writable Attribute
Description
Active, Name
DoFtpGetOperation
Do FTP GET operation.

Type: bool
Default: TRUE
Possible Values:
Value Description
TRUE
Do FTP Get operation.
FALSE Do not do FTP Get operation.

EnablePassiveDataXfer
Whether to enable passive data transfer.

Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
Enable passive data transfer.
FALSE Disable passive data transfer.

MaxRequestsPerClient
Maximum requests per client.

Type: u32
Default: 10
Range: 1 - 4294967295
MaxSimultaneousClients
Maximum simultaneous clients.

Type: u32
Default: 4294967295
Range: 1 - 4294967295
1005
Description
FtpServerProtocolConfig
Writable Attribute
Description
Maximum transactions per server.

Type: u32
Default: 10
Range: 1 - 4294967295
FtpProtocolParams Read-Only Attributes

Description:
FTP protocol client.

Result children (automatically created): FtpServerResults
Relations:
Side name
(Type)
Relative
Description
ServerProfile
ServerProfile
Specifies the server profile used by a server.
FtpClientProtocolConfig, HttpClientProtocolConfig,
RawTcpClientProtocolConfig,
VideoClientProtocolConfig
ResultChild
(ResultChild)
FtpServerResults
UsesIf
(UsesIf)


FtpServerProtocolConfig Writable Attributes

Writable Attribute
Description
Active, Name
Maximum number of requests from a single client.

Type: u32
Default: 10
Range: 1 - 4294967295
Maximum number of simultaneous clients supported by the server.

Type: u32
Default: 4294967295
Range: 1 - 4294967295
ServerName
User-defined name for the server. Relevant only for the user.
Type: string
1006
FtpServerProtocolProfile
Writable Attribute
Description
Unused.
Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
Unused.
FALSE Unused.
FtpServerProtocolConfig Read-Only Attributes

FtpServerProtocolProfile
Description:
FTP protocol traffic-specific attributes for a potential FTP server.

Parents: ServerProfile
Automatically-created children: FtpServerResponseConfig
FtpServerProtocolProfile Writable Attributes

Writable Attribute
Description
Active, Name
ServerPortNum
Port number to use on the server.

Type: u16
Default: 21
Range: 1 - 65535
FtpServerProtocolProfile Read-Only Attributes

FtpServerResponseConfig
Description:
Common response configuration options for an FTP server.

Automatically created from: FtpServerProtocolProfile
FtpServerResponseConfig Writable Attributes

Writable Attribute
Description
Active, Name
1007
FtpServerResults
Writable Attribute
Description
BodyContentType
Body content type for server responses.

Type: enum
Default: ASCII
Possible Values:
Value
Description
ASCII
ASCII content type.
BINARY Binary content type.

BodySizeType
Body size for server responses.

Type: enum
Default: FIXED
Possible Values:
Value
Description
FIXED
Fixed body size.
RANDOM Random body size.

FixedBodySize
Size of a response body when the BodySizeType attribute is set to FIXED.

Type: u32
Default: 64
FixedResponseLatency
Latency (in milliseconds) of response timing when the BodySizeType attribute is set to FIXED.
Type: u32
Default: 0
RandomBodySizeMean
Mean size of response body when the BodySizeType attribute is set to RANDOM.
Type: u32
Default: 0
RandomBodySizeStdDeviation
Standard deviation of response body size when the BodySizeType attribute is set to RANDOM.
Type: u32
Default: 0
RandomResponseLatencyMean
Mean of response latency when the ResponseTimingType attribute is set to RANDOM.

Type: u32
Default: 0
RandomResponseLatencyStdDeviation
Standard deviation of response latency when the ResponseTimingType attribute is set to RANDOM.
Type: u32
Default: 0
ResponseTimingType
Type of timing to use on server responses.

Type: enum
Default: FIXED
Possible Values:
Value
Description
FIXED
Fixed response time.
RANDOM Random response time.
FtpServerResponseConfig Read-Only Attributes

FtpServerResults
Description:
FTP server results.
1008
FtpServerResults
Parents: FtpServerProtocolConfig
Relations:
Side name
(Type)
Relative
Description
ResultParent
(ResultChild)
FtpServerResults Writable Attributes

FtpServerResults Read-Only Attributes

Read-Only Attribute
Description
AbortedControlConnections
Total number of control connection Aborts detected by this server block.

Type: u64
Default: 0
AbortedControlConnectionsPerSecond
Total number of aborted control connections per second opened to or from this server block.
Type: u64
Default: 0
AbortedTransactions

Type: u64
Default: 0
Type: u64
Default: 0
ActiveControlConnections
Number of control connections open or attempting for this server at this instant. Active Connections
only applies to the FTP control connections. The FTP data connections are not included in this result.
Active Connections on the server will typically be fewer in number than Active Connections on the
associated client due to differences in the events that inform the server and client processes that a
connection has been started and terminated.
Type: u32
Default: 0

Type: u64
Default: 0
Type: u64
Default: 0
BlockIndex
Internally-allocated index for this FTP server block.

Type: u32
Default: 0
ElapsedSeconds
Time duration in seconds that this client block has been running.
Type: u64
Default: 0
GoodputAvgRxRateBps
Average received goodput rate in bits per second.

Type: u64
Default: 0
GoodputAvgTxRateBps

Type: u64
Default: 0
GoodputMaxRxRateBps

Type: u64
Default: 0
1009
FtpServerResults
Read-Only Attribute
Description
GoodputMaxTxRateBps

Type: u64
Default: 0
GoodputMinRxRateBps

Type: u64
Default: 0
GoodputMinTxRateBps

Type: u64
Default: 0
GoodputRxBps

Type: u64
Default: 0
GoodputRxBytes

Type: u64
Default: 0
GoodputTxBps

Type: u64
Default: 0
GoodputTxBytes

Type: u64
Default: 0
ParentName

Type: string
RxPassCmd
Total number of PASS commands received.

Type: u64
Default: 0
RxPortCmd
Total number of PORT commands received.

Type: u64
Default: 0
RxQuitCmd
Total number of QUIT commands received.

Type: u64
Default: 0
RxRetrCmd
Total number of RETR commands received.

Type: u64
Default: 0
RxTypeCmd
Total number of TYPE commands received.

Type: u64
Default: 0
RxUserCmd
Total number of USER commands received.

Type: u64
Default: 0

Type: u64
Default: 0
Type: u64
Default: 0
TotalControlConnections
Total number of control connections opened to this server block.

Type: u64
Default: 0
1010
FtpServerResults
Read-Only Attribute
Description
TotalControlConnectionsPerSecond
Total number of control connections per second opened to or from this server block.
Type: u64
Default: 0
TotalDataConnections
Total number of data connections opened to or from this server block.

Type: u64
Default: 0
TotalDataConnectionsPerSecond
Total number of data connections per second opened to or from this server block.
Type: u64
Default: 0
TxResponseCode150
Count of transmitted response codes with value 150.

Type: u64
Default: 0
TxResponseCode200

Type: u64
Default: 0
TxResponseCode226

Type: u64
Default: 0
TxResponseCode227

Type: u64
Default: 0
TxResponseCode230

Type: u64
Default: 0
TxResponseCode331

Type: u64
Default: 0
TxResponseCode425

Type: u64
Default: 0
TxResponseCode426

Type: u64
Default: 0
TxResponseCode452

Type: u64
Default: 0
TxResponseCode500

Type: u64
Default: 0
TxResponseCode502

Type: u64
Default: 0
TxResponseCode530

Type: u64
Default: 0

Type: u64
Default: 0
Type: u64
Default: 0
1011
ftr
ftr
Description:
ftr Attributes
Attribute
Description
Type: INTEGER
Default: 0
destinationPortTag
Default: 01
Possible Values:
Value Description
01
N_PORT_ID
02
Nx_Port Port_Name
Type: OCTETSTRING
Default: 00000000
maximumHopCount
Type: INTEGER
Default: 20
Name
Type: string
pad1
pad2
revision
Type: OCTETSTRING
Default: 00000000
sourcePortLength
Type: INTEGER
Default: 0
sourcePortTag
Default: 01
Possible Values:
Value Description
01
N_PORT_ID
02
Nx_Port Port_Name
sourcePortValue
Type: OCTETSTRING
Default: 00000000
t10VendorIdentifier
Type: OCTETSTRING
Default: 0000000000000000
Token
Type: OCTETSTRING
Default: 00000000
vendorSpecificInformation
Type: OCTETSTRING
Default: 0000000000000000
1012
Ftr
Ftr (fcgs:Ftr)
Description:
Ftr Attributes
Attribute
Description
Type: INTEGER
Default: 0
destinationPortTag
Default: 01
Possible Values:
Value Description
01
N_PORT_ID
02
Nx_Port Port_Name
Type: OCTETSTRING
Default: 00000000
maximumHopCount
Type: INTEGER
Default: 20
Name
Type: string
pad1
pad2
revision
Type: OCTETSTRING
Default: 00000000
sourcePortLength
Type: INTEGER
Default: 0
sourcePortTag
Default: 01
Possible Values:
Value Description
01
N_PORT_ID
02
Nx_Port Port_Name
sourcePortValue
Type: OCTETSTRING
Default: 00000000
t10VendorIdentifier
Type: OCTETSTRING
Default: 0000000000000000
Token
Type: OCTETSTRING
Default: 00000000
Type: OCTETSTRING
Default: 0000000000000000
1013
ftrAccept
ftrAccept
Description:
Children: ctIuPreamble, destinationPortsFabricEgressPathInformation, destinationPortsFabricIngressPathInformation, intermediateSwitchsPathInformation,
sourcePortsFabricEgressPathInformation, sourcePortsFabricIngressPathInformation
ftrAccept Attributes
Attribute
Description
Name
Type: string
numberOfPathInformationEntries
Type: INTEGER
Default: 0
revision
Type: OCTETSTRING
Default: 00000001
strRejectReasonCode
Type: OCTETSTRING
Default: 00000000
t10VendorIdentifier
Type: OCTETSTRING
Default: 0000000000000000
Token
Type: OCTETSTRING
Default: 00000000
Type: OCTETSTRING
Default: 0000000000000000
FtrAccept (fcgs:FtrAccept)
Description:
Children: ctIuPreamble, destinationPortsFabricEgressPathInformation, destinationPortsFabricIngressPathInformation, intermediateSwitchsPathInformation,
sourcePortsFabricEgressPathInformation, sourcePortsFabricIngressPathInformation
FtrAccept Attributes
Attribute
Description
Name
Type: string
numberOfPathInformationEntries
Type: INTEGER
Default: 0
revision
Type: OCTETSTRING
Default: 00000001
strRejectReasonCode
Type: OCTETSTRING
Default: 00000000
t10VendorIdentifier
Type: OCTETSTRING
Default: 0000000000000000
1014
FullMeshTopologyGenParams
Attribute
Description
Token
Type: OCTETSTRING
Default: 00000000
Type: OCTETSTRING
Default: 0000000000000000
FullMeshTopologyGenParams
Description:
Full mesh topology generation parameters. The specified full mesh topology is created on each emulated router.

Parents: BgpRouteGenParams, IsisLspGenParams, Ospfv2LsaGenParams, Ospfv3LsaGenParams, RipRouteGenParams
FullMeshTopologyGenParams Writable Attributes

Writable Attribute
Description
Active, Name
EmulatedRouterPos
Location of the emulated router in the full mesh.

Type: enum
Default: ATTACHED_TO_MESH
Possible Values:
Value
Description
ATTACHED_TO_MESH Emulated router is attached to one of the simulated routers in the full mesh.
MEMBER_OF_MESH
NumRouters
Emulated router is a member of the full mesh.
Total number of routers in the full mesh topology.

Type: u16
Default: 10
Range: 1 - 100
FullMeshTopologyGenParams Read-Only Attributes

FxPortClkSyncQos (fc:FxPortClkSyncQos)
Description:
Children: None
Next headers: fip:FipPadding, custom:Custom
FxPortClkSyncQos Attributes
Attribute
Description
implementedLsb
Type: OCTETSTRING
Default: 00
1015
gaNxtAccept
Attribute
Description
implementedMsb
Type: OCTETSTRING
Default: 00
Name
Type: string
reserved1
Type: OCTETSTRING
Default: 00
reserved2
Type: OCTETSTRING
Default: 00000000
transferAccuracy
Type: OCTETSTRING
Default: 00
gaNxtAccept
Description:
gaNxtAccept Attributes
Attribute
Description
classOfService
Type: OCTETSTRING
Default: 00000000
fabricPortName
Type: WWN
Default: 20:00:10:94:00:00:00:00
fc4Types
Type: OCTETSTRING
hardAddress
Type: OCTETSTRING
Default: 000000
initialProcessAssociator
Type: WWN
Default: 10:00:10:94:00:00:00:00
ipAddressNode
Type: OCTETSTRING
ipAddressPort
Type: OCTETSTRING
lengthOfSymbolicNodeName
Type: INTEGER
Default: 0
lengthOfSymbolicPortName
Type: INTEGER
Default: 0
Name
Type: string
nodeName
Type: WWN
Default: 10:00:10:94:00:00:00:00
1016
GaNxtAccept
Attribute
Description
portIdentifier
Type: OCTETSTRING
Default: 000000
portName
Type: WWN
Default: 20:00:10:94:00:00:00:00
portType
Type: PortType
Default: 00
Possible Values:
Value Description
00
Unidentified
01
N_Port
02
NL_Port
03
F/NL_Port
7F
Nx_Port
81
F_Port
82
FL_Port
84
E_Port
85
B_Port
reserved1
reserved2
reserved3
Type: OCTETSTRING
Default: 00
symbolicNodeName
Type: ASCII
symbolicPortName
Type: ASCII
GaNxtAccept (fcgs:GaNxtAccept)
Description:
GaNxtAccept Attributes
Attribute
Description
classOfService
Type: OCTETSTRING
Default: 00000000
fabricPortName
Type: WWN
Default: 20:00:10:94:00:00:00:00
fc4Types
Type: OCTETSTRING
hardAddress
Type: OCTETSTRING
Default: 000000
1017
GaNxtAccept
Attribute
Description
initialProcessAssociator
Type: WWN
Default: 10:00:10:94:00:00:00:00
ipAddressNode
Type: OCTETSTRING
ipAddressPort
Type: OCTETSTRING
lengthOfSymbolicNodeName
Type: INTEGER
Default: 0
lengthOfSymbolicPortName
Type: INTEGER
Default: 0
Name
Type: string
nodeName
Type: WWN
Default: 10:00:10:94:00:00:00:00
portIdentifier
Type: OCTETSTRING
Default: 000000
portName
Type: WWN
Default: 20:00:10:94:00:00:00:00
portType
Type: PortType
Default: 00
Possible Values:
Value Description
00
Unidentified
01
N_Port
02
NL_Port
03
F/NL_Port
7F
Nx_Port
81
F_Port
82
FL_Port
84
E_Port
85
B_Port
reserved1
reserved2
reserved3
Type: OCTETSTRING
Default: 00
symbolicNodeName
Type: ASCII
symbolicPortName
Type: ASCII
1018
gapnlAccept
gapnlAccept
Description:
Children: attachedPortEntries, ctIuPreamble
gapnlAccept Attributes
Attribute
Description
Name
Type: string
numberOfAttachedPortEntires
Type: INTEGER
Default: 0
GapnlAccept (fcgs:GapnlAccept)
Description:
Children: attachedPortEntries, ctIuPreamble
GapnlAccept Attributes
Attribute
Description
Name
Type: string
numberOfAttachedPortEntires
Type: INTEGER
Default: 0
gatin
Description:
gatin Attributes
Attribute
Description
interconnectElementPortName
Type: WWN
Default: 20:00:10:94:00:00:00:00
Name
Type: string
1019
Gatin
Gatin (fcgs:Gatin)
Description:
Gatin Attributes
Attribute
Description
interconnectElementPortName
Type: WWN
Default: 20:00:10:94:00:00:00:00
Name
Type: string
gatinAccept
Description:
Children: ctIuPreamble, topologyInformationDescriptor
gatinAccept Attributes
Attribute
Description
Name
information.
Type: string
GatinAccept (fcgs:GatinAccept)
Description:
Children: ctIuPreamble, topologyInformationDescriptor
GatinAccept Attributes
Attribute
Description
Name
information.
Type: string
1020
gcsIdAccept
gcsIdAccept
Description:
gcsIdAccept Attributes
Attribute
Description
classOfService
Type: OCTETSTRING
Default: 00000000
Name
Type: string
GcsIdAccept (fcgs:GcsIdAccept)
Description:
GcsIdAccept Attributes
Attribute
Description
classOfService
Type: OCTETSTRING
Default: 00000000
Name
Type: string
gdidAccept
Description:
gdidAccept Attributes
Attribute
Description
interconnectElementDomainIdentifier
Type: OCTETSTRING
Default: 00
Name
Type: string
1021
GdidAccept
Attribute
Description
reserved1
Type: OCTETSTRING
Default: 00
reserved2
Type: OCTETSTRING
Default: 0000
GdidAccept (fcgs:GdidAccept)
Description:
GdidAccept Attributes
Attribute
Description
interconnectElementDomainIdentifier
Type: OCTETSTRING
Default: 00
Name
Type: string
reserved1
Type: OCTETSTRING
Default: 00
reserved2
Type: OCTETSTRING
Default: 0000
GeneralizedPseudoWireFecInfo
Description:

Relations:
Side name
(Type)
Relative
Description
EchoRequestConfig
(InnerMostFecInfo)
DstFecInfo
(NextFecInfo)

GeneralizedPseudoWireFecInfo Writable Attributes

Writable Attribute
Description
Active, Name
1022
GeneralizedPseudoWireFecInfo
Writable Attribute
Description
AttachmentGroupId
Type: string
Default: 100:1
AttachmentGroupIdStep
Type: string
Default: 0:1
CustomEncap
Type: u16
Default: 4
Range: 0 - 32767
Encap
Type: enum
Default: LDP_L2VPN_ENCAP_ETHERNET_VLAN
Possible Values:
Value
LDP_L2VPN_ENCAP_FRAME_RELAY_DLCI
LDP_L2VPN_ENCAP_ATM_AAL5_VCC
LDP_L2VPN_ENCAP_ATM_TRANSPARENT_CELL
LDP_L2VPN_ENCAP_ETHERNET_VLAN
LDP_L2VPN_ENCAP_ETHERNET
LDP_L2VPN_ENCAP_HDLC
LDP_L2VPN_ENCAP_PPP
LDP_L2VPN_ENCAP_CEM
LDP_L2VPN_ENCAP_ATM_VCC
LDP_L2VPN_ENCAP_ATM_VPC
LDP_L2VPN_ENCAP_ETHERNET_VPLS
LDP_L2VPN_ENCAP_ATM_VCC_ONE_TO_ONE
LDP_L2VPN_ENCAP_ATM_VPC_ONE_TO_ONE
LDP_L2VPN_ENCAP_ATM_AAL5_PDU_VCC
LDP_L2VPN_ENCAP_FRAME_RELAY_PORT
LDP_L2VPN_ENCAP_SONET_SDH_OVER_PKT
LDP_L2VPN_ENCAP_STRUCT_AGNOSTIC_E1_OVER_PKT
LDP_L2VPN_ENCAP_STRUCT_AGNOSTIC_T1_OVER_PKT
LDP_L2VPN_ENCAP_STRUCT_AGNOSTIC_E3_OVER_PKT
LDP_L2VPN_ENCAP_STRUCT_AGNOSTIC_T3_OVER_PKT
LDP_L2VPN_ENCAP_CES_OVER_PSN_BASIC
LDP_L2VPN_ENCAP_TDM_OVER_IP_AAL1
LDP_L2VPN_ENCAP_CES_OVER_PSN_TDM_CAS
LDP_L2VPN_ENCAP_TDM_OVER_IP_AAL2
LDP_L2VPN_ENCAP_FRAME_RELAY_DLCI_NEW_BIT_ORDERING
LDP_L2VPN_ENCAP_ROHC_HEADER_COMPRESSED_PKT
LDP_L2VPN_ENCAP_ECRTP_HEADER_COMPRESSED_PKT
LDP_L2VPN_ENCAP_IPHC_HEADER_COMPRESSED_PKT
LDP_L2VPN_ENCAP_CRTP_HEADER_COMPRESSED_PKT
LDP_L2VPN_ENCAP_ATM_VP_VIRTUAL_TRUNK
LDP_L2VPN_ENCAP_RESERVED
LDP_L2VPN_ENCAP_WILDCARD
PseudoWireCount
Type: u32
Default: 1
Range: 1 - 65535
SrcAttachmentIndividualId
Type: string
Default: 192.168.1.1
SrcAttachmentIndividualIdStep
Type: string
Default: 0.0.0.1
1023
Description
GeneralizedPwidLsp
Writable Attribute
Description
TargetAttachmentIndividualId
Type: string
Default: 192.168.1.2
TargetAttachmentIndividualIdStep
Type: string
Default: 0.0.0.1
UseCustomEncap
Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
FALSE
GeneralizedPseudoWireFecInfo Read-Only Attributes

GeneralizedPwidLsp
Description:
Defines a Generalized PWid (FEC129) LSP object.

Parents: LdpRouterConfig
Children: PseudoWireSwitchingPointTlv
Relations:
Side name
(Type)
Relative
BackupLsp
(PseudowireBackupLsp)
GeneralizedPwidLsp, VcLsp
Description
GeneralizedPwidLsp Writable Attributes

Writable Attribute
Description
AttachmentGroupId
Start value for the Attachment Group Identifier field of Generalized PWid FEC (FEC 129).
Type: string
Default: 100:1
AttachmentGroupIdIncrement
Increment value for the Attachment Group Identifier field of Generalized PWid FEC (FEC 129).
Type: string
Default: 0:1
ControlWordPreference
Enable or disable C-bit in the FEC TLV.

Type: enum
Default: NOT_PREFERRED
Possible Values:
Value
Description
NOT_PREFERRED Disable C-bit in the FEC TLV.
PREFERRED
Enable C-bit in the FEC TLV.
1024
GeneralizedPwidLsp
Writable Attribute
Description
CustomEncap
Custom encapsulation value.

Type: u16
Default: 4
Range: 0 - 32767
CustomStatusCode
Type: u32
Default: 0
Encap
Encapsulation type.
Type: enum
Default: LDP_LSP_ENCAP_ETHERNET_VLAN
Possible Values:
Value
Description
LDP_LSP_ENCAP_FRAME_RELAY_DLCI
Frame relay DLCI.
LDP_LSP_ENCAP_ATM_AAL5_VCC
ATM AAL5 SDU VCC transport.
LDP_LSP_ENCAP_ATM_TRANSPARENT_CELL
ATM transparent cell transport.
LDP_LSP_ENCAP_ETHERNET_VLAN
Ethernet VLAN.
LDP_LSP_ENCAP_ETHERNET
Ethernet.
LDP_LSP_ENCAP_HDLC
HDLC.
LDP_LSP_ENCAP_PPP
PPP.
LDP_LSP_ENCAP_CEM
SONET/SDH Circuit Emulation Service

Over MPLS Encapsulation.
LDP_LSP_ENCAP_ATM_VCC
ATM n-to-one VCC cell transport.
LDP_LSP_ENCAP_ATM_VPC
ATM n-to-one VPC cell transport.
LDP_LSP_ENCAP_ETHERNET_VPLS
ETHERNET VPLS.
LDP_LSP_ENCAP_ATM_VCC_ONE_TO_ONE
ATM one-to-one VCC Cell Mode.
LDP_LSP_ENCAP_ATM_VPC_ONE_TO_ONE
ATM one-to-one VPC Cell Mode.
LDP_LSP_ENCAP_ATM_AAL5_PDU_VCC
ATM AAL5 PDU VCC transport.
LDP_LSP_ENCAP_FRAME_RELAY_PORT
Frame-Relay Port mode.
LDP_LSP_ENCAP_SONET_SDH_OVER_PKT
SONET/SDH Circuit Emulation over

Packet.
LDP_LSP_ENCAP_STRUCT_AGNOSTIC_E1_OVER_PKT
Structure-agnostic E1 over Packet.
LDP_LSP_ENCAP_STRUCT_AGNOSTIC_T1_OVER_PKT
Structure-agnostic T1 (DS1) over Packet.
LDP_LSP_ENCAP_CES_OVER_PSN_BASIC
CESoPSN basic mode.
LDP_LSP_ENCAP_TDM_OVER_IP_AAL1
TDMoIP AAL1 Mode .
LDP_LSP_ENCAP_CES_OVER_PSN_TDM_CAS
CESoPSN TDM with CAS.
TDMoIP AAL2 Mode.
LDP_LSP_ENCAP_FRAME_RELAY_DLCI_NEW_BIT_ORDERING Frame Relay DLCI.
GroupId
LDP_LSP_ENCAP_ROHC_HEADER_COMPRESSED_PKT
ROHC Transport Header-compressed

Packets.
LDP_LSP_ENCAP_ECRTP_HEADER_COMPRESSED_PKT
ECRTP Transport Header-compressed

Packet.
LDP_LSP_ENCAP_IPHC_HEADER_COMPRESSED_PKT
IPHC Transport Header-compressed

Packets.
LDP_LSP_ENCAP_CRTP_HEADER_COMPRESSED_PKT
cRTP Transport Header-compressed

Packets.
LDP_LSP_ENCAP_ATM_VP_VIRTUAL_TRUNK
ATM VP Virtual Trunk.
LDP_LSP_ENCAP_RESERVED
Reserved.
LDP_LSP_ENCAP_WILDCARD
Wildcard.
Value for the Pseudowire Group ID field of Generalized PWid FEC (FEC 129). If not null, then PW Grouping
TLV with the specified value is inserted.
Type: u32
Default: 0
1025
GeneralizedPwidLsp
Writable Attribute
Description
IfDescription
If not null, then insert Interface Description Sub-TLV to the Interface Parameters TLV, with Sub-TLV value of
this field.
Type: string
IfMtu
Interface Maximum Transmission Unit (MTU). If not null, then Interface MTU Sub-TLV in Interface Parameters
TLV will be sent as part of label mapping message for the PW.
Type: u32
Default: 1500
Range: 1 - 65535
IncludeFlowLabelSubTlv
Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
FALSE
IncludeStatusTlv
Include or exclude Pseudowire Status TLV in label mapping message.

Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
Include Pseudowire Status TLV.
FALSE Exclude Pseudowire Status TLV.

PwCount
Number of Generalized PWid (FEC 129) Pseudowires (PW) to advertise.

Type: u32
Default: 1
Range: 0 - 5000000
RedundantSetRole
Type: enum
Default: REDUNDANT_SET_ROLE_NONE
Possible Values:
Value
Description
REDUNDANT_SET_ROLE_NONE
REDUNDANT_SET_ROLE_PRIMARY_PSEUDOWIRE
REDUNDANT_SET_ROLE_SECONDARY_PSEUDOWIRE
RequestedVlanId
If not null, then insert Requested VLAN ID Sub-TLV to the Interface Parameters TLV, with Sub-TLV start value
of this field.
Type: u16
Default: null
Range: 0 - 4095
RequestedVlanIdIncrement
Increment for the Requested VLAN ID Sub-TLV value.

Type: u16
Default: 1
Range: 0 - 4095
SetFlowLabelSubTlvFBit
Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
FALSE
1026
GeneralizedPwidLsp
Writable Attribute
Description
SignalRequestSwitchoverStatusBit
Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
FALSE
Start value for the Source Attachment Individual Identifier (SAII) field of Generalized PWid FEC (FEC 129).
Type: string
Default: 192.0.0.1
SrcAttachmentIndividualIdIncrement
Increment value for the Source Attachment Individual Identifier (SAII) field of Generalized PWid FEC (FEC 129).
Type: string
Default: 0.0.0.0
StatusCode
Status Code value for PW Status TLV.

Type: enum
Default: 0
Possible Values:
Value
Description
NOT_FORWARDING
Pseudowire Not Forwarding.
ATTACHMENT_CIRCUIT_RX_FAULT
Attachment Circuit Receive fault.
ATTACHMENT_CIRCUIT_TX_FAULT
Attachment Circuit Transmit fault.
PSEUDOWIRE_RX_FAULT
Pseudowire Receive Transmit fault.
PSEUDOWIRE_TX_FAULT
Pseudowire Transmit Transmit fault.
PSEUDOWIRE_FORWARDING_STANDBY
PSEUDOWIRE_REQUEST_SWITCHOVER
Start value for the Target Attachment Individual Identifier (TAII) field of Generalized PWid FEC (FEC 129).
Type: string
Default: 192.0.0.1
TargetAttachmentIndividualIdIncrement
Increment value for the Target Attachment Individual Identifier (TAII) field of Generalized PWid FEC (FEC 129).
Type: string
Default: 0.0.0.0
UseCustomEncap
Enable or disable custom encapsulation.

Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
Enable custom encapsulation.
FALSE Disable custom encapsulation.

UseCustomStatusCode
Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
FALSE
GeneralizedPwidLsp Read-Only Attributes

1027
GenerateRawPacketTagsCommand
GenerateRawPacketTagsCommand
Description:
Gets a CaptureRawPacketTagsInfo object.

GenerateRawPacketTagsCommand Writable Attributes

Writable Attribute
Description
CaptureProxyId
Internal ID of the capture object.

Type: handle
Default: 0
PacketCount
Number of the captured packets.

Type: u32
Default: 0
StartIndex
Start index of the captured packet.

Type: u32
Default: 0
GenerateRawPacketTagsCommand Read-Only Attributes

Read-Only Attribute
Description

GenerateStreamBlockFromPcapCommand
Description:
Generate a stream block from a Pcap file.

GenerateStreamBlockFromPcapCommand Writable Attributes

Writable Attribute
Description
PcapFileName
Pcap capture file name with full path.

Type: inputFilePath
Port
Port handle for which stream block will be generated.

Type: handle
Default: 0
1028
generationID
GenerateStreamBlockFromPcapCommand Read-Only Attributes

Read-Only Attribute
Description

generationID
Description:
The Generation ID option in the PIM Hello message. See RFC 3973.
Children: None
generationID Attributes
Attribute
Description
length
Type: INTEGER
Default: 4
Name
more information.
Type: string
type
Type: INTEGER
Default: 20
value
Type: INTEGER
Default: 1
Generator
Description:
Traffic generator.

Automatically-created children: GeneratorConfig
Result children (automatically created): GeneratorPortResults, TxCpuPortResults
Relations:
Side name
(Type)
Relative
Description
ResultChild
(ResultChild)
GeneratorPortResults, TxCpuPortResults
Generator Writable Attributes

Writable Attribute
Description
Active, Name
1029
GeneratorConfig
Generator Read-Only Attributes

Read-Only Attribute
Description
State
State of traffic generator.

Type: enum
Default: STOPPED
Possible Values:
Value
Description
STOPPED
Traffic generator is idle.
RUNNING
Traffic generator is transmitting traffic.
PENDING_START A start message has been sent to firmware, and traffic generator has not been confirmed to be running.
PENDING_STOP
A stop message has been sent to firmware, and traffic generator has not been confirmed to be stopped.
GeneratorConfig
Description:
Specifies port configuration related to traffic generation. Exposes the Spirent TestCenter generator hardware capabilities, including time stamp reference
location, counter configuration, etc.

Children: ManualSchedule
Automatically created from: Generator
GeneratorConfig Writable Attributes

Writable Attribute
Description
Active, Name
BurstSize
Specifies the number of frames in each burst transmitted.

Type: u32
Default: 1
Duration
Specifies the length of packet transmission. You specify the transmission unit by the duration mode.
Type: double
Default: 30
DurationMode
Specifies the length of transmission in terms of continuous, bursts, or seconds.

Type: enum
Default: CONTINUOUS
Possible Values:
Value
Description
CONTINUOUS
Generate traffic continuously until stopped manually.
BURSTS
Generate traffic for the specified number of bursts.
SECONDS
Generate traffic for the specified number of seconds.
TABLE_REPETITIONS Repeat the manual schedule table for specified number of times.
STEP
Generator will transmit one packet each time you start the traffic. The sequence of the packets
depends on the order of the entries configured in the manual schedule table. All the packets generated
from the first entry will be transmitted before proceeding to the second entry.
FixedLoad
Specifies fixed load value.

Type: double
Default: 10
InterFrameGap
Gap (bytes) between frames in the same burst, when the burst size is greater than 1.
Type: double
Default: 12
1030
GeneratorConfig
Writable Attribute
Description
InterFrameGapUnit
Specifies the unit for inter-frame gap.

Type: enum
Default: BYTES
Possible Values:
Value
Description
PERCENT_LINE_RATE
inter-frame gap as a percentage of the maximum bandwidth available on the test module.
FRAMES_PER_SECOND
inter-frame gap as the number of frames per second.
BYTES
inter-frame gap as the number of bytes.
MILLISECONDS
inter-frame gap in milliseconds.
NANOSECONDS
inter-frame gap in nanoseconds.
BITS_PER_SECOND
inter-frame gap as the number of bits per second.
KILOBITS_PER_SECOND
inter-frame gap as the number of kilobits per second.
MEGABITS_PER_SECOND inter-frame gap as the number of megabits per second.

JumboFrameThreshold
Transmitted frame sizes above this threshold will be counted as jumbo frames. The value you specify must be less than the
over-sized frame threshold to avoid frames being counted as over-sized but not counted as jumbo frames.
Note: 10/100/1000 Mbps Ethernet range is 12-16383; 10 Gigabit Ethernet range is 56-16383; POS range is 46-16383.
Type: s16
Default: 1518
LoadMode
Specifies the load mode as fixed or random rate.

Type: enum
Default: FIXED
Possible Values:
Value
Description
FIXED
Use fixed load value.
RANDOM Use random load value.

LoadUnit
Specifies the load unit for the overall port load when in port-based scheduling mode.
Type: enum
Possible Values:
Value
Description
PERCENT_LINE_RATE
Load as a percentage of the maximum bandwidth available on the test module. Minimum =
0.001.
FRAMES_PER_SECOND
Load as the number of frames per second. Minimum = 1; maximum depends on the frame size
(bit rate/((frame size + 8) * 8 + 12 * 8)).
INTER_BURST_GAP
Load as the gap in bytes between adjacent bursts.
BITS_PER_SECOND
Load as the number of bits per second. Minimum depends on frame length and minimum
allowable interframe gap of the test module. Maximum depends on port speed: 10/100/1000
Ethernet = 10000000/100000000/1000000000; 10 Gigabit Ethernet = 10000000000; OC-3 =
149760000; OC-12 = 599040000; OC-48 = 2396160000; OC-192 = 9584640000.
KILOBITS_PER_SECOND
Load as the number of kilobits per second. Minimum = 1. Maximum depends on port speed:
10/100/1000 Ethernet = 10000/100000/1000000; 10 Gigabit Ethernet = 10000000; OC-3 =
149760; OC-12 = 599040; OC-48 = 2396160; OC-192 = 9584640.
MEGABITS_PER_SECOND Load as the number of megabits per second. Minimum = 1. Maximum depends on port speed:
10/100/1000 Ethernet = 10/100/1000; 10 Gigabit Ethernet = 10000; OC-3 = 149.76; OC-12 =
599.04; OC-48 = 2396.16; OC-192 = 9584.64.
OversizeFrameThreshold
Transmitted frame sizes above this threshold will be counted as over-sized frames.
Note: 10/100/1000 Mbps Ethernet range is 12-16383; 10 Gigabit Ethernet range is 56-16383; POS range is 46-16383.
Type: s16
Default: 9018
RandomLengthSeed
Specifies a seed value for generating a random frame length.

Type: s32
Default: 10900842
Range: 1 - 16777215
RandomMaxLoad
Specifies maximum random port load when in port-based scheduling mode.

Type: double
Default: 100
1031
GeneratorConfig
Writable Attribute
Description
RandomMinLoad
Specifies minimum random port load when in port-based scheduling mode.

Type: double
Default: 10
SchedulingMode
Specifies the scheduling mode as port, rate, priority, or manual based. The scheduling mode affects the sequence in which
frames from each stream block are transmitted.
Type: enum
Default: PORT_BASED
Possible Values:
Value
Description
PORT_BASED
Load is controlled at port level; guarantees a fixed interframe gap for Layer 2 testing. The order of frames
sent is determined by the order of the configured stream blocks.
Example: Port load = 60%, burst size = 2, 3 stream blocks (Stream Block A = 1 stream, Stream Block
B = 1 stream, Stream Block C = 2 streams). Packet sequence = A B, C1 C2, A B, C1 C2, A B.
RATE_BASED
Load is controlled at stream block level.

Example: 3 stream blocks (Stream Block A = 1 stream, Stream Block B = 1 stream, Stream Block C =
2 streams); 10% load on Stream Block A, 10% load on Stream Block B, and 20% load on Stream Block
C; burst size = 2. The Scheduler algorithm first determines the ratio (1:1:2) between stream block loads,
then uses burst size to build the Stream Sequence Table. Packet sequence = A A, B B, C1 C1, C2 C2,
A A. Each stream block is repeated as many times as specified by the burst size; ratio between stream
blocks remains 1:1:2.
PRIORITY_BASED High priority stream blocks are scheduled first; lower priority stream blocks are fit into gaps left available
by higher priority stream blocks.
Per-stream block burst configuration can be specified, as well as per-stream block load, including
interframe gap. Each stream block is considered an independent traffic source generating periodic bursts
of traffic based on burst size, interframe gap, and load. The Scheduler interleaves multiple stream block
traffic in round-robin mode.
MANUAL_BASED
Provide rate control to users such that they will be able to program the rates of the streams and bursts,
as well as the gaps between streams, bursts and frames.
Users can control the order in which stream blocks are transmitted. One stream block can be scheduled
in multiple table entries with different rates. Users will also be able to repeat sequence by using loops.
Users can also specify the size of the bursts and the number of bursts for each stream block. Schedule
can be modified in real-time without stopping the generator.
StepSize
Specify the number of packets to transmit per step. Applicable to step mode.
Type: u16
Default: 1
TimestampLatchMode
Position the timestamp on a specific frame location.

Type: enum
Possible Values:
Value
Description
START_OF_FRAME Position the timestamp on the start of the frame.
END_OF_FRAME
UndersizeFrameThreshold
Position the timestamp on the end of the frame.
Transmitted frame sizes below this threshold will be counted as under-sized frames.
Type: s16
Default: 64
GeneratorConfig Read-Only Attributes

Read-Only Attribute
Description
AvgBpsLoad
Average load value as the number of bits per second.

Type: double
Default: 100000000
AvgFpsLoad
Average load value as the number of frames per second.

Type: double
Default: 84459
1032
GeneratorConfig
Read-Only Attribute
Description
AvgIbgLoad
Average load value as the gap (in bytes) between adjacent bursts.
Type: double
Default: 1344
AvgKbpsLoad
Average load value as the number of kilobits per second.

Type: double
Default: 100000
AvgL2Rate
Average layer 2 bit rate.

Type: double
Default: 100000000
AvgMbpsLoad
Average load value as the number of megabits per second.

Type: double
Default: 100
AvgPercentageLoad
Average load value as percentage of line rate.

Type: double
Default: 10
BpsIfg

Type: double
Default: 100000000
BpsLoad
Load value as the number of bits per second.

Type: double
Default: 100000000
BytesIfg

Type: double
Default: 12
FpsIfg

Type: double
Default: 84459
FpsLoad
Load value as the number of frames per second.

Type: double
Default: 84459
IbgLoad
Load value as the gap (in bytes) between adjacent bursts.

Type: double
Default: 1344
KbpsIfg

Type: double
Default: 100000
KbpsLoad
Load value as the number of kilobits per second.

Type: double
Default: 100000
L2Rate
Layer 2 bit rate.

Type: double
Default: 86486016
MaxBpsLoad
Maximum load value as the number of bits per second.

Type: double
Default: 100000000
MaxFpsLoad
Maximum load value as the number of frames per second.

Type: double
Default: 84459
MaxIbgLoad
Maximum load value as the gap (in bytes) between adjacent bursts.
Type: double
Default: 1344
1033
GeneratorConfig
Read-Only Attribute
Description
MaxKbpsLoad
Maximum load value as the number of kilobits per second.

Type: double
Default: 100000
MaxL2Rate
Maximum layer 2 bit rate.

Type: double
Default: 100000000
MaxMbpsLoad
Maximum load value as the number of megabits per second.

Type: double
Default: 100
MaxPercentageLoad
Maximum load value as percentage of line rate.

Type: double
Default: 10
MbpsIfg
inter-frame gap as the number of megabits per second.

Type: double
Default: 100
MbpsLoad
Load value as the number of megabits per second.

Type: double
Default: 100
MillisecondsIfg

Type: double
Default: 1344
MinBpsLoad
Minimum load value as the number of bits per second.

Type: double
Default: 100000000
MinFpsLoad
Minimum load value as the number of frames per second.

Type: double
Default: 84459
MinIbgLoad
Minimum load value as the gap (in bytes) between adjacent bursts.
Type: double
Default: 1344
MinKbpsLoad
Minimum load value as the number of kilobits per second.

Type: double
Default: 100000
MinL2Rate
Minimum layer 2 bit rate.

Type: double
Default: 100000000
MinMbpsLoad
Minimum load value as the number of megabits per second.

Type: double
Default: 100
MinPercentageLoad
Minimum load value as percentage of line rate.

Type: double
Default: 10
NanosecondsIfg

Type: double
Default: 1344
PercentageIfg
Type: double
Default: 10
PercentageLoad
Load value as percentage of line rate.

Type: double
Default: 10
1034
GeneratorPortResults
Description:
Result object to store port results on the generator.

Parents: Generator
Relations:
Side name
(Type)
Relative
Description
ResultParent
(ResultChild)
Generator
GeneratorPortResults Writable Attributes

GeneratorPortResults Read-Only Attributes

Read-Only Attribute
Description
CounterTimestamp

Type: u64
Default: 0
GeneratorAbortFrameCount
Number of abort frames generated.

Type: u64
Default: 0
GeneratorAbortFrameRate
Number of abort frames generated over the last 1-second interval.

Type: u64
Default: 0
GeneratorBitRate
Total number of bits generated over the last 1-second interval.

Type: u64
Default: 0
GeneratorCrcErrorFrameCount
Number of CRC error frames generated.

Type: u64
Default: 0
GeneratorCrcErrorFrameRate
Number of CRC error frames generated over the last 1-second interval.
Type: u64
Default: 0
GeneratorFrameCount
Number of frames generated.

Type: u64
Default: 0
GeneratorFrameRate
Total number of frames generated over the last 1-second interval.

Type: u64
Default: 0
GeneratorIpv4FrameCount
Number of IPv4 frames generated.

Type: u64
Default: 0
GeneratorIpv4FrameRate
Total number of IPv4 frames generated over the last 1-second interval.
Type: u64
Default: 0
GeneratorIpv6FrameCount
Number of IPv6 frames generated.

Type: u64
Default: 0
1035
Read-Only Attribute
Description
GeneratorIpv6FrameRate
Total number of IPv6 frames generated over the last 1-second interval.
Type: u64
Default: 0
GeneratorJumboFrameCount
Number of jumbo frames generated.

Type: u64
Default: 0
GeneratorJumboFrameRate
Number of jumbo frames generated over the last 1-second interval.

Type: u64
Default: 0
GeneratorL3ChecksumErrorCount
Number of L3 checksum errors generated.

Type: u64
Default: 0
GeneratorL3ChecksumErrorRate
Number of L3 header checksum errors generated over the last 1-second interval.
Type: u64
Default: 0
GeneratorL4ChecksumErrorCount
Number of L4 checksum errors generated.

Type: u64
Default: 0
GeneratorL4ChecksumErrorRate
Number of L4 header checksum errors generated over the last 1-second interval.
Type: u64
Default: 0
GeneratorMplsFrameCount
Number of MPLS frames generated.

Type: u64
Default: 0
GeneratorMplsFrameRate
Total number of MPLS frames generated over the last 1-second interval.
Type: u64
Default: 0
GeneratorOctetCount
Number of bytes generated.

Type: u64
Default: 0
GeneratorOctetRate
Total number of bytes generated over the last 1-second interval.

Type: u64
Default: 0
GeneratorOversizeFrameCount
Number of oversized frames generated.

Type: u64
Default: 0
GeneratorOversizeFrameRate
Number of oversized frames generated over the last 1-second interval.

Type: u64
Default: 0
GeneratorSigFrameCount
Number of Spirent signature frames generated.

Type: u64
Default: 0
GeneratorSigFrameRate
Total number of Spirent signature frames generated over the last 1-second interval.
Type: u64
Default: 0
GeneratorUndersizeFrameCount
Number of undersized frames generated.

Type: u64
Default: 0
GeneratorUndersizeFrameRate
Number of undersized frames generated over the last 1-second interval.

Type: u64
Default: 0
1036
Read-Only Attribute
Description
GeneratorVlanFrameCount
Number of VLAN frames generated.

Type: u64
Default: 0
GeneratorVlanFrameRate
Total number of VLAN frames generated over the last 1-second interval.
Type: u64
Default: 0
HwFrameCount
Number of hardware frames transmitted.

Type: u64
Default: 0
L1BitCount
Count of total layer1 bits generated.

Type: u64
Default: 0
L1BitRate
Total number of layer1 bits transmitted over last 1-second interval.

Type: u64
Default: 0
PfcFrameCount
Number of pause frames generated.

Type: u64
Default: null
PfcPri0FrameCount
Number of priority0 pause frames generated.

Type: u64
Default: null
PfcPri1FrameCount

Type: u64
Default: null
PfcPri2FrameCount

Type: u64
Default: null
PfcPri3FrameCount

Type: u64
Default: null
PfcPri4FrameCount

Type: u64
Default: null
PfcPri5FrameCount

Type: u64
Default: null
PfcPri6FrameCount

Type: u64
Default: null
PfcPri7FrameCount

Type: u64
Default: null
TotalBitCount
Count of total bits generated.

Type: u64
Default: 0
TotalBitRate
Total number of bits transmitted over the last 1-second interval.

Type: u64
Default: 0
TotalCellCount
Count of total cells generated.

Type: u64
Default: 0
1037
GeneratorStartCommand
Read-Only Attribute
Description
TotalCellRate
Total number of bytes generated over last 1-second interval.

Type: u64
Default: 0
TotalFrameCount

Type: u64
Default: 0
TotalFrameRate
Total number of frames transmitted over the last 1-second interval.

Type: u64
Default: 0
TotalIpv4FrameCount
Total number of IPv4 frames transmitted.

Type: u64
Default: 0
TotalIpv4FrameRate
Total number of IPv4 frames transmitted over the last 1-second interval.
Type: u64
Default: 0
TotalIpv6FrameCount
Total number of IPv6 frames transmitted.

Type: u64
Default: 0
TotalIpv6FrameRate
Total number of IPv6 frames transmitted over the last 1-second interval.
Type: u64
Default: 0
TotalMplsFrameCount
Total number of MPLS frames transmitted.

Type: u64
Default: 0
TotalMplsFrameRate
Total number of MPLS frames transmitted over the last 1-second interval.
Type: u64
Default: 0
TotalOctetCount
Total number of bytes transmitted.

Type: u64
Default: 0
TotalOctetRate
Total number of bytes transmitted over the last 1-second interval.

Type: u64
Default: 0
TxDuration
Generator on time in seconds.

Type: double
Default: 0
GeneratorStartCommand
Description:
Start traffic generator. All the active stream blocks in the generator will be started.
NOTE: If the link is down, it may take up to one minute for the generator to start.

1038
GeneratorStopCommand
GeneratorStartCommand Writable Attributes

Writable Attribute
Description
GeneratorList
A list of one or more generator handles.

Type: handle
Default: 0
GeneratorStartCommand Read-Only Attributes

Read-Only Attribute
Description

GeneratorStopCommand
Description:
Stop generator from transmitting stream block traffic. All streams in the generator will be stopped.

GeneratorStopCommand Writable Attributes

Writable Attribute
Description
GeneratorList
A list of generators.
Type: handle
Default: 0
GeneratorStopCommand Read-Only Attributes

Read-Only Attribute
Description

GeneratorUpdateCommand
Description:
Update the generator configuration. Read-only attributes, such as PercentageLoad, FpsLoad, and so on, will be updated. (Does not apply the configuration
to Spirent TestCenter test modules.)

1039
GeneratorWaitForStopCommand
GeneratorUpdateCommand Writable Attributes

Writable Attribute
Description
Generator
Generator to update.
Type: handle
Default: 0
GeneratorList
Generators to update.
Type: handle
Default: 0
GeneratorUpdateCommand Read-Only Attributes

Read-Only Attribute
Description

GeneratorWaitForStopCommand
Description:
Wait for generator to stop transmitting traffic.

GeneratorWaitForStopCommand Writable Attributes

Writable Attribute
Description
GeneratorList
A list of generators.
Type: handle
Default: 0
WaitTimeout
Maximum time to wait (in seconds) for generator to stop transmitting traffic.
Type: u32
Default: 604800
GeneratorWaitForStopCommand Read-Only Attributes

Read-Only Attribute
Description

genericError
Description:
1040
genericIpv4PrefixSubTlv
Parents: PPPoETag
Children: None
genericError Attributes
Attribute
Description
length
Type: OCTETSTRING
Default: 0000
Name
more information.
Type: string
type
Type: OCTETSTRING
Default: 0203
value
Type: OCTETSTRING
Description:
Children: None
genericIpv4PrefixSubTlv Attributes
Attribute
Description
ipv4Prefix
Type: IPV4ADDR
Default: 192.168.1.1
length
Type: INTEGER
Default: 5
Name
Type: string
prefixLength
Type: INTEGER
Default: 24
reserved
Type: ALIGNMENTPAD
Default: 0
type
Type: INTEGER
Default: 14
Description:
Children: None
1041
GetAllEndpointCommand
genericIpv6PrefixSubTlv Attributes
Attribute
Description
ipv6Prefix
Type: IPV6ADDR
Default: 2000::1
length
Type: INTEGER
Default: 17
Name
Type: string
prefixLength
Type: INTEGER
Default: 64
reserved
Type: ALIGNMENTPAD
Default: 0
type
Type: INTEGER
Default: 15
GetAllEndpointCommand
Description:
To return a tree of Endpoints are supported for multi-port.

Children: EndpointNode
GetAllEndpointCommand Writable Attributes

Writable Attribute
Description
Port
Port handle.
Type: handle
Default: 0
GetAllEndpointCommand Read-Only Attributes

Read-Only Attribute
Description

GetAllSupportedEndpointTypeCommand
Description:
To return a vector of Endpoints type that are supported.
1042
GetAllSupportedProtocolCommand

Children: SupportedEndpointType
GetAllSupportedEndpointTypeCommand Writable Attributes

Writable Attribute
Description
GetAllSupportedEndpointTypeCommand Read-Only Attributes

Read-Only Attribute
Description

GetAllSupportedProtocolCommand
Description:
To return a vector of Protocols and their ProtocolConfig type that are supported.

Children: SupportedProtocol
GetAllSupportedProtocolCommand Writable Attributes

Writable Attribute
Description
GetAllSupportedProtocolCommand Read-Only Attributes

Read-Only Attribute
Description

GetBfdLoggingConfigCommand
Description:

1043
GetBgpLoggingConfigCommand
GetBfdLoggingConfigCommand Writable Attributes

Writable Attribute
Description
PortGroupHandleList
Port group list to get logging status.

Type: handle
Default: 0
GetBfdLoggingConfigCommand Read-Only Attributes

Read-Only Attribute
Description

PortGroupLoggingConfigHandleList
Output of port group logging status list.

Type: handle
Default: 0
GetBgpLoggingConfigCommand
Description:

GetBgpLoggingConfigCommand Writable Attributes

Writable Attribute
Description
PortGroupHandleList

Type: handle
Default: 0
GetBgpLoggingConfigCommand Read-Only Attributes

Read-Only Attribute
Description

Output of Port group logging status list.

Type: handle
Default: 0
GetChassisLicenseInfoCommand
Description:
Command to query a chassis for licensing information.
1044
GetConfigInfoCommand

GetChassisLicenseInfoCommand Writable Attributes

Writable Attribute
Description
Chassis
Chassis to query licensing information for.

Type: handle
Default: 0
GetChassisLicenseInfoCommand Read-Only Attributes

Read-Only Attribute
Description

FeatureList
List of one or more licensed features for the chassis(for example, "PACKET GENERATOR AND ANALYZER BASE
PACKAGE A").
Type: handle
Default: 0
LicenseCheckDate
License date based version(DBV) required by the application.

Type: string
LicenseType
Type of license detected for the chassis(for example, "CHASSIS_LICENSE").

Type: enum
Default: UNKNOWN_LICENSE
Possible Values:
Value
Description
UNKNOWN_LICENSE No license file detected for the chassis.
LOCAL_LICENSE
Local demo or SE license file detected for the chassis.
CHASSIS_LICENSE
License file is installed on the chassis.
SERVER_LICENSE
Floating licenses for the chassis are managed by a license server(currently not used).
GetConfigInfoCommand
Description:

GetConfigInfoCommand Writable Attributes

Writable Attribute
Description
QueryRoots
Type: handle
Default: 0
1045
GetEquipmentLogsCommand
GetConfigInfoCommand Read-Only Attributes

Read-Only Attribute
Description

Names
Type: string
Values
Type: string
GetEquipmentLogsCommand
Description:
Download chassis logs.

Parents: Sequencer
GetEquipmentLogsCommand Writable Attributes

Writable Attribute
Description
DstDir
Directory where the logs will be saved.

EquipmentList
Type: handle
Default: 0
GetEquipmentLogsCommand Read-Only Attributes

GetFcFcoeLoggingConfigCommand
Description:

GetFcFcoeLoggingConfigCommand Writable Attributes

Writable Attribute
Description
PortGroupHandleList

Type: handle
Default: 0
1046
GetFieldOffsetCommand
GetFcFcoeLoggingConfigCommand Read-Only Attributes

Read-Only Attribute
Description


Type: handle
Default: 0
GetFieldOffsetCommand
Description:
Get the offset (in bits) of a PDU field from the FrameConfig of a stream block.

GetFieldOffsetCommand Writable Attributes

Writable Attribute
Description
PduField
A string of the form "ip1.tos" that uniquely points to a PDU element.

Type: string
StreamBlock

Type: handle
Default: 0
GetFieldOffsetCommand Read-Only Attributes

Read-Only Attribute
Description

Offset
Offset (in bits) of the PDU element.

Type: u32
Default: 0
GetHighResolutionSamplingResultCommand
Description:
Command to get high resolution sampling results.

1047
GetIeee1588v2LoggingConfigCommand
GetHighResolutionSamplingResultCommand Writable Attributes

Writable Attribute
Description
ConfigType
Configuration class ID.

Type: string
Default: HighResolutionPortConfig
HandleList
Handle of port or high resolution config to get results.

Type: handle
Default: 0
ViewAttribute
Counter name for which to get statistics.

Type: string
GetHighResolutionSamplingResultCommand Read-Only Attributes

Read-Only Attribute
Description

GetIeee1588v2LoggingConfigCommand
Description:

GetIeee1588v2LoggingConfigCommand Writable Attributes

Writable Attribute
Description
PortGroupHandleList
Type: handle
Default: 0
GetIeee1588v2LoggingConfigCommand Read-Only Attributes

Read-Only Attribute
Description
ElapsedTime, EndTime, ProgressCurrentStep, ProgressCurrentStepName,

ProgressCurrentValue, ProgressDisplayCounter, ProgressMaxValue, ProgressStepsCount,
StartTime, State, Status
Type: handle
Default: 0
1048
GetIsisLoggingConfigCommand
GetIsisLoggingConfigCommand
Description:

GetIsisLoggingConfigCommand Writable Attributes

Writable Attribute
Description
PortGroupHandleList

Type: handle
Default: 0
GetIsisLoggingConfigCommand Read-Only Attributes

Read-Only Attribute
Description


Type: handle
Default: 0
GetLacpLoggingConfigCommand
Description:

GetLacpLoggingConfigCommand Writable Attributes

Writable Attribute
Description
PortGroupHandleList

Type: handle
Default: 0
GetLacpLoggingConfigCommand Read-Only Attributes

Read-Only Attribute
Description


Type: handle
Default: 0
1049
GetLdpLoggingConfigCommand
GetLdpLoggingConfigCommand
Description:

GetLdpLoggingConfigCommand Writable Attributes

Writable Attribute
Description
PortGroupHandleList

Type: handle
Default: 0
GetLdpLoggingConfigCommand Read-Only Attributes

Read-Only Attribute
Description


Type: handle
Default: 0
GetLldpLoggingConfigCommand
Description:

GetLldpLoggingConfigCommand Writable Attributes

Writable Attribute
Description
PortGroupHandleList

Type: handle
Default: 0
GetLldpLoggingConfigCommand Read-Only Attributes

Read-Only Attribute
Description


Type: handle
Default: 0
1050
GetObjectInfoCommand
GetObjectInfoCommand
Description:
Retrieves the type of an object. Examples of object types: Project, BgpRouterConfig, EthIIIf, PingStartCommand.

Parents: Sequencer
GetObjectInfoCommand Writable Attributes

Writable Attribute
Description
Object
Handle of the object to get the type of.

Type: handle
Default: 0
GetObjectInfoCommand Read-Only Attributes

Read-Only Attribute
Description
ObjectType
Type of the object. This is returned by the command.

Type: string
GetObjectsCommand
Description:
Returns a list of objects matching input parameters.
Tcl example: set lstDevices [ stc::perform GetObjects rootlist project1 class EmulatedDevice condition RouterId != 10.0.0.1 ]

GetObjectsCommand Writable Attributes

Writable Attribute
Description
ClassName
Type: string
Condition
Conditional expression used to filter the returned objects. L-operand is the property name. Operator can
either be "=" or "!=" and R-operand is a string literal.
Type: string
RootList
Limits scope of search to objects under the Root List. If not specified, System is used.
Type: handle
Default: 0
1051
GetOspfv2LoggingConfigCommand
GetObjectsCommand Read-Only Attributes

Read-Only Attribute
Description

ObjectList
List of object handles that were gotten.

Type: handle
Default: 0
Description:

GetOspfv2LoggingConfigCommand Writable Attributes

Writable Attribute
Description
PortGroupHandleList

Type: handle
Default: 0
GetOspfv2LoggingConfigCommand Read-Only Attributes

Read-Only Attribute
Description


Type: handle
Default: 0
Description:

GetOspfv3LoggingConfigCommand Writable Attributes

Writable Attribute
Description
1052
GetPimLoggingConfigCommand
Writable Attribute
Description
PortGroupHandleList

Type: handle
Default: 0
GetOspfv3LoggingConfigCommand Read-Only Attributes

Read-Only Attribute
Description


Type: handle
Default: 0
GetPimLoggingConfigCommand
Description:

GetPimLoggingConfigCommand Writable Attributes

Writable Attribute
Description
PortGroupHandleList

Type: handle
Default: 0
GetPimLoggingConfigCommand Read-Only Attributes

Read-Only Attribute
Description


Type: handle
Default: 0
GetPluginInfoCommand
Description:
Returns the list of PluginInfo children.

1053
GetPreviewDataCommand

Children: PluginInfo
GetPluginInfoCommand Writable Attributes

Writable Attribute
Description
GetPluginInfoCommand Read-Only Attributes

Read-Only Attribute
Description

GetPreviewDataCommand
Description:
Get the preview data for a port-level stream block.

GetPreviewDataCommand Writable Attributes

Writable Attribute
Description
EncapOption
Option to display all streams, resolved only streams or unresolved streams.

Type: enum
Default: SHOW_ALL
Possible Values:
Value
Description
SHOW_ALL
Display all streams.
SHOW_RESOLVED_ONLY
Only display the streams with whose encapsulations are resolved.
SHOW_UNRESOLVED_ONLY Only display the streams with whose encapsulations are unresolved.
IncludePathDescriptor
Indicate if the preview data will contain the information from path descriptor.
Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
Include
FALSE Exclude
RowCount
Number of rows to preview.

Type: u32
Default: 0
StartingRowIndex
Starting index (zero-based) of rows in the traffic path to preview. Each row corresponds to a flow/stream.
Type: u32
Default: 0
1054
GetPropertyTypeMetaInfoCommand
Writable Attribute
Description
StreamBlock
Stream block for which to generate preview data.

Type: handle
Default: 0
TrafficPathIndex
Index of the traffic path to preview.

Type: u32
Default: 0
GetPreviewDataCommand Read-Only Attributes

Read-Only Attribute
Description

PreviewData
Handle of the preview data object for the traffic path.

Type: handle
Default: 0
GetPropertyTypeMetaInfoCommand
Description:
Returns the list of property names and their types for the given object.

GetPropertyTypeMetaInfoCommand Writable Attributes

Writable Attribute
Description
ClassName
Name of the class to retrieve the properties information from.

Type: string
Default: 0
GetPropertyTypeMetaInfoCommand Read-Only Attributes

Read-Only Attribute
Description

PropertyNames
List of property names for the class.

Type: string
Default: 0
PropertyTypes
List of property types for the class.

Type: string
Default: 0
1055
GetRelationsMetaInfoCommand
GetRelationsMetaInfoCommand
Description:
Retrieves the relation role information for the object.

GetRelationsMetaInfoCommand Writable Attributes

Writable Attribute
Description
Config
Handle of the object to retrieve relation role information from.

Type: handle
Default: 0
Direction
Direction of the relations to retrieve. There are three choices: forward, backward, and bidirectional. There are several
equivalent strings for each choice, as follows (case-sensitive):
forward = children = child = downward = down
backward = parent = upward = up
bidirectional = both = all
NOTE: The default of "Destination" is not valid.
Type: enum
Default: DESTINATION
Possible Values:
Value
Description
DESTINATION
CHILD
CHILDREN
DOWN
DOWNWARD
FORWARD
SOURCE
PARENT
UP
UPWARD
BACKWARD
BIDIRECTIONAL
BOTH
ALL
GetRelationsMetaInfoCommand Read-Only Attributes

Read-Only Attribute
Description

RolesList
List of relation roles.

Type: string
Default: 0
1056
GetRelativesCommand
GetRelativesCommand
Description:
Gets the relatives of an object.

GetRelativesCommand Writable Attributes

Writable Attribute
Description
Config
Object handle to get relatives from.

Type: handle
Default: 0
Direction
Direction of the relations. There are three choices: forward, backward, and bidirectional. There are several equivalent
strings for each choice, as follows (case-sensitive):
NOTE: The default of "Destination" is not valid.
Type: enum
Possible Values:
Value
Description
DESTINATION
CHILD
CHILDREN
DOWN
DOWNWARD
FORWARD
SOURCE
PARENT
UP
UPWARD
BACKWARD
BIDIRECTIONAL
BOTH
ALL
RelationType
Relation type.
Type: string
Default: ParentChild
GetRelativesCommand Read-Only Attributes

Read-Only Attribute
Description

RelativesList
After command completes, this list will contain a list of relatives.

Type: handle
Default: 0
1057
GetRipLoggingConfigCommand
GetRipLoggingConfigCommand
Description:

GetRipLoggingConfigCommand Writable Attributes

Writable Attribute
Description
PortGroupHandleList

Type: handle
Default: 0
GetRipLoggingConfigCommand Read-Only Attributes

Read-Only Attribute
Description


Type: handle
Default: 0
GetRsvpLoggingConfigCommand
Description:

GetRsvpLoggingConfigCommand Writable Attributes

Writable Attribute
Description
PortGroupHandleList

Type: handle
Default: 0
GetRsvpLoggingConfigCommand Read-Only Attributes

Read-Only Attribute
Description


Type: handle
Default: 0
1058
GetStpLoggingConfigCommand
GetStpLoggingConfigCommand
Description:

GetStpLoggingConfigCommand Writable Attributes

Writable Attribute
Description
PortGroupHandleList

Type: handle
Default: 0
GetStpLoggingConfigCommand Read-Only Attributes

Read-Only Attribute
Description


Type: handle
Default: 0
GetSyncEthLoggingConfigCommand
Description:
Get SyncE IL logging configuration.

GetSyncEthLoggingConfigCommand Writable Attributes

Writable Attribute
Description
PortGroupHandleList

Type: handle
Default: 0
GetSyncEthLoggingConfigCommand Read-Only Attributes

Read-Only Attribute
Description


Type: handle
Default: 0
1059
GetSystemPathsCommand
GetSystemPathsCommand
Description:
Returns several file paths used by Spirent TestCenter.

GetSystemPathsCommand Writable Attributes

Writable Attribute
Description
CommonDataPath
The location where common application data files are installed.

Usual value on non-Vista Windows:
C:/Program Files/Spirent communications/Spirent TestCenter <version>/Spirent TestCenter Application/
Where <version> is the Spirent TestCenter version number.
Usual value on Windows Vista:
C:/ProgramData/Spirent/TestCenter <version>/
Type: string
Default: (none)
SessionDataPath
The location where log files are written for this session.
C:/Documents and Settings/<username>/My Documents/Spirent/TestCenter <version>/Logs/<timestamp>/
Where <username> is your Windows user ID, <version> is the Spirent TestCenter version number, and <timestamp> is a
timestamp for this session.
Example:
C:/Documents and Settings/R Smith/My Documents/Spirent/TestCenter 3.00/Logs/2009-04-17_22-20-53/
Type: string
Default: (none)
UserDataPath
The location where user data files are saved. Some examples of this kind of file are configuration files, log files, and user-defined
result view template files.
C:/Documents and Settings/<username>/My Documents/Spirent/TestCenter <version>/
Where <username> is your Windows user ID and <version> is the Spirent TestCenter version number.
Usual value on Windows Vista:
C:/Users/<username>/Documents/Spirent/TestCenter <version>/
Usual value on Linux and Solaris:
~/Spirent/TestCenter <version>/
Type: string
Default: (none)
GetSystemPathsCommand Read-Only Attributes

GetTestResultSettingPathsCommand
Description:
Returns paths that show where output files are written. Use the ConfigurationFileName attribute on the Project object to control the "Untitled" part of the paths.
Use the TestResultSetting object to control the placement of the paths.

GetTestResultSettingPathsCommand Writable Attributes

1060
gffIdAccept
GetTestResultSettingPathsCommand Read-Only Attributes

Read-Only Attribute
Description
OutputBasePath
The path where output files are written.

Type: string
Default: <drive>/Untitled/
ResultDbBasePath
The path where results database files are written.

Type: string
Default: <drive>/Results/Untitled/
gffIdAccept
Description:
gffIdAccept Attributes
Attribute
Description
fc4Features
Type: OCTETSTRING
Name
more information.
Type: string
GffIdAccept (fcgs:GffIdAccept)
Description:
GffIdAccept Attributes
Attribute
Description
fc4Features
Type: OCTETSTRING
Name
more information.
Type: string
1061
gfnAccept
gfnAccept
Description:
gfnAccept Attributes
Attribute
Description
interconnectElementFabricName
Type: WWN
Default: 10:00:10:94:00:00:00:00
Name
Type: string
GfnAccept (fcgs:GfnAccept)
Description:
GfnAccept Attributes
Attribute
Description
interconnectElementFabricName
Type: WWN
Default: 10:00:10:94:00:00:00:00
Name
Type: string
gfpnIdAccept
Description:
gfpnIdAccept Attributes
Attribute
Description
fabricPortName
Type: WWN
Default: 10:00:10:94:00:00:00:00
Name
Type: string
1062
GfpnIdAccept
GfpnIdAccept (fcgs:GfpnIdAccept)
Description:
GfpnIdAccept Attributes
Attribute
Description
fabricPortName
Type: WWN
Default: 10:00:10:94:00:00:00:00
Name
Type: string
gftIdAccept
Description:
gftIdAccept Attributes
Attribute
Description
fc4Types
Type: OCTETSTRING
Name
more information.
Type: string
GftIdAccept (fcgs:GftIdAccept)
Description:
GftIdAccept Attributes
Attribute
Description
fc4Types
Type: OCTETSTRING
Name
more information.
Type: string
1063
gidFtAccept
gidFtAccept
Description:
Children: ctIuPreamble, portIdentifiers
gidFtAccept Attributes
Attribute
Description
Name
information.
Type: string
GidFtAccept (fcgs:GidFtAccept)
Description:
GidFtAccept Attributes
Attribute
Description
Name
information.
Type: string
gidNnAccept
Description:
gidNnAccept Attributes
Attribute
Description
Name
information.
Type: string
GidNnAccept (fcgs:GidNnAccept)
Description:
1064
gidPnAccept
GidNnAccept Attributes
Attribute
Description
Name
information.
Type: string
gidPnAccept
Description:
gidPnAccept Attributes
Attribute
Description
Name
Type: string
portIdentifier
Type: OCTETSTRING
Default: 000000
reserved
Type: OCTETSTRING
Default: 00
GidPnAccept (fcgs:GidPnAccept)
Description:
GidPnAccept Attributes
Attribute
Description
Name
Type: string
portIdentifier
Type: OCTETSTRING
Default: 000000
reserved
Type: OCTETSTRING
Default: 00
1065
gidPtAccept
gidPtAccept
Description:
gidPtAccept Attributes
Attribute
Description
Name
information.
Type: string
GidPtAccept (fcgs:GidPtAccept)
Description:
GidPtAccept Attributes
Attribute
Description
Name
information.
Type: string
gieilAccept
Description:
gieilAccept Attributes
Attribute
Description
listLength
Type: INTEGER
Default: 0
modelNameNumber
Type: ASCII
Name
Type: string
releaseCode
Type: ASCII
1066
GieilAccept
Attribute
Description
reserved1
Type: OCTETSTRING
Default: 000000
reserved2
Type: ALIGNMENTPAD
vendorName
Type: ASCII
Type: ASCII
GieilAccept (fcgs:GieilAccept)
Description:
GieilAccept Attributes
Attribute
Description
listLength
Type: INTEGER
Default: 0
modelNameNumber
Type: ASCII
Name
Type: string
releaseCode
Type: ASCII
reserved1
Type: OCTETSTRING
Default: 000000
reserved2
Type: ALIGNMENTPAD
vendorName
Type: ASCII
Type: ASCII
giel
Description:
1067
Giel
giel Attributes
Attribute
Description
Name
information.
Type: string
Giel (fcgs:Giel)
Description:
Giel Attributes
Attribute
Description
Name
information.
Type: string
gielAccept
Description:
Children: ctIuPreamble, interconnectElementEntries
gielAccept Attributes
Attribute
Description
Name
Type: string
numberOfInterconnectElementEntries
Type: INTEGER
Default: 0
GielAccept (fcgs:GielAccept)
Description:
Children: ctIuPreamble, interconnectElementEntries
1068
gielnAccept
GielAccept Attributes
Attribute
Description
Name
Type: string
numberOfInterconnectElementEntries
Type: INTEGER
Default: 0
gielnAccept
Description:
gielnAccept Attributes
Attribute
Description
logicalName
Type: ASCII
logicalNameLength
Type: INTEGER
Default: 0
Name
Type: string
reserved1
GielnAccept (fcgs:GielnAccept)
Description:
GielnAccept Attributes
Attribute
Description
logicalName
Type: ASCII
logicalNameLength
Type: INTEGER
Default: 0
1069
gietAccept
Attribute
Description
Name
Type: string
reserved1
gietAccept
Description:
gietAccept Attributes
Attribute
Description
interconnectElementType
Type: InterconnectElementType
Default: 00
Possible Values:
Value Description
00
Unknown
01
Switch
02
Hub
03
Bridge
Name
Type: string
reserved
Type: OCTETSTRING
Default: 000000
GietAccept (fcgs:GietAccept)
Description:
1070
globalFlags
GietAccept Attributes
Attribute
Description
Default: 00
Possible Values:
Value Description
00
Unknown
01
Switch
02
Hub
03
Bridge
Name
Type: string
reserved
Type: OCTETSTRING
Default: 000000
globalFlags
Description:
Parents: header
Children: None
globalFlags Attributes
Attribute
Description
Name
Type: string
reserved
Type: BITSTRING
Default: 000000000000000
validateFecStackBit
Type: BITSTRING
Default: 0
gmalAccept
Description:
Children: ctIuPreamble, managementAddressEntries
1071
GmalAccept
gmalAccept Attributes
Attribute
Description
Name
Type: string
numberOfManagementAddressEntries
Type: INTEGER
GmalAccept (fcgs:GmalAccept)
Description:
GmalAccept Attributes
Attribute
Description
Name
Type: string
Type: INTEGER
gmidAccept
Description:
gmidAccept Attributes
Attribute
Description
interconnectElementManagementIdentifier
Type: OCTETSTRING
Default: 000000
Name
Type: string
reserved1
Type: OCTETSTRING
Default: 00
1072
GmidAccept
GmidAccept (fcgs:GmidAccept)
Description:
GmidAccept Attributes
Attribute
Description
interconnectElementManagementIdentifier
Type: OCTETSTRING
Default: 000000
Name
Type: string
reserved1
Type: OCTETSTRING
Default: 00
gnid
Description:
gnid Attributes
Attribute
Description
Name
Type: string
nodeIdentificationDataFormat
Type: OCTETSTRING
Default: 00
platformNodeName
Type: WWN
Default: 10:00:10:94:00:00:00:00
reserved
Type: OCTETSTRING
Default: 000000
Gnid (fcgs:Gnid)
Description:
1073
gnidAccept
Gnid Attributes
Attribute
Description
Name
Type: string
Type: OCTETSTRING
Default: 00
platformNodeName
Type: WWN
Default: 10:00:10:94:00:00:00:00
reserved
Type: OCTETSTRING
Default: 000000
gnidAccept
Description:
Children: commonIdentificationData, ctIuPreamble, specificIdentificationData
gnidAccept Attributes
Attribute
Description
command
Type: OCTETSTRING
Default: 02000000
commonIdentificationDataLength
Type: OCTETSTRING
Default: 00
Name
Type: string
Type: OCTETSTRING
Default: 00
reserved
Type: OCTETSTRING
Default: 00
specificIdentificationDataLength
Type: OCTETSTRING
Default: 00
GnidAccept (fcgs:GnidAccept)
Description:
Children: commonIdentificationData, ctIuPreamble, specificIdentificationData
1074
gnnFtAccept
GnidAccept Attributes
Attribute
Description
command
Type: OCTETSTRING
Default: 02000000
commonIdentificationDataLength
Type: OCTETSTRING
Default: 00
Name
Type: string
Type: OCTETSTRING
Default: 00
reserved
Type: OCTETSTRING
Default: 00
specificIdentificationDataLength
Type: OCTETSTRING
Default: 00
gnnFtAccept
Description:
Children: ctIuPreamble, nodeNames
gnnFtAccept Attributes
Attribute
Description
Name
information.
Type: string
GnnFtAccept (fcgs:GnnFtAccept)
Description:
Children: ctIuPreamble, nodeNames
GnnFtAccept Attributes
Attribute
Description
Name
information.
Type: string
1075
gnnIdAccept
gnnIdAccept
Description:
gnnIdAccept Attributes
Attribute
Description
Name
more information.
Type: string
nodeName
Type: WWN
Default: 10:00:10:94:00:00:00:00
GnnIdAccept (fcgs:GnnIdAccept)
Description:
GnnIdAccept Attributes
Attribute
Description
Name
more information.
Type: string
nodeName
Type: WWN
Default: 10:00:10:94:00:00:00:00
gnpl
Description:
gnpl Attributes
Attribute
Description
Name
Type: string
platformNodeName
Type: WWN
Default: 10:00:10:94:00:00:00:00
1076
Gnpl
Gnpl (fcgs:Gnpl)
Description:
Gnpl Attributes
Attribute
Description
Name
Type: string
platformNodeName
Type: WWN
Default: 10:00:10:94:00:00:00:00
gnplAccept
Description:
gnplAccept Attributes
Attribute
Description
Name
Type: string
platformName
Type: ASCII
platformNameFormat
Type: OCTETSTRING
Default: 02
platformNameLength
Type: INTEGER
Default: 0
reserved1
GnplAccept (fcgs:GnplAccept)
Description:
1077
gpabAccept
GnplAccept Attributes
Attribute
Description
Name
Type: string
platformName
Type: ASCII
platformNameFormat
Type: OCTETSTRING
Default: 02
platformNameLength
Type: INTEGER
Default: 0
reserved1
gpabAccept
Description:
Children: ctIuPreamble, platformAttributeEntries
gpabAccept Attributes
Attribute
Description
Name
Type: string
numberOfPlatformAttributeEntries
Type: INTEGER
GpabAccept (fcgs:GpabAccept)
Description:
Children: ctIuPreamble, platformAttributeEntries
GpabAccept Attributes
Attribute
Description
Name
Type: string
1078
gpfcpAccept
Attribute
Description
numberOfPlatformAttributeEntries
Type: INTEGER
gpfcpAccept
Description:
gpfcpAccept Attributes
Attribute
Description
fcp2FeaturesBitMask
Type: OCTETSTRING
Default: 00000000
Name
Type: string
GpfcpAccept (fcgs:GpfcpAccept)
Description:
GpfcpAccept Attributes
Attribute
Description
fcp2FeaturesBitMask
Type: OCTETSTRING
Default: 00000000
Name
Type: string
gplAccept
Description:
Children: ctIuPreamble, portEntries
1079
GplAccept
gplAccept Attributes
Attribute
Description
Name
Type: string
numberOfPortEntires
Type: INTEGER
Default: 0
GplAccept (fcgs:GplAccept)
Description:
Children: ctIuPreamble, portEntries
GplAccept Attributes
Attribute
Description
Name
Type: string
numberOfPortEntires
Type: INTEGER
Default: 0
gpliAccept
Description:
Children: ctIuPreamble, osLunMapEntries
gpliAccept Attributes
Attribute
Description
Name
Type: string
numberOfLunMapEntries
Type: INTEGER
GpliAccept (fcgs:GpliAccept)
1080
gplmlAccept
Description:
GpliAccept Attributes
Attribute
Description
Name
Type: string
Type: INTEGER
gplmlAccept
Description:
gplmlAccept Attributes
Attribute
Description
Name
Type: string
Type: INTEGER
GplmlAccept (fcgs:GplmlAccept)
Description:
GplmlAccept Attributes
Attribute
Description
Name
Type: string
Type: INTEGER
1081
gplnlAccept
gplnlAccept
Description:
Children: ctIuPreamble, platformNodeNameEntries
gplnlAccept Attributes
Attribute
Description
Name
Type: string
numberOfPlatformNodeNameEntries
Type: INTEGER
Default: 0
GplnlAccept (fcgs:GplnlAccept)
Description:
Children: ctIuPreamble, platformNodeNameEntries
GplnlAccept Attributes
Attribute
Description
Name
Type: string
Type: INTEGER
Default: 0
gpltAccept
Description:
gpltAccept Attributes
Attribute
Description
Name
more information.
Type: string
platformType
Type: OCTETSTRING
Default: 00000002
1082
GpltAccept
GpltAccept (fcgs:GpltAccept)
Description:
GpltAccept Attributes
Attribute
Description
Name
more information.
Type: string
platformType
Type: OCTETSTRING
Default: 00000002
gpnFtAccept
Description:
Children: ctIuPreamble, portNames
gpnFtAccept Attributes
Attribute
Description
Name
information.
Type: string
GpnFtAccept (fcgs:GpnFtAccept)
Description:
Children: ctIuPreamble, portNames
GpnFtAccept Attributes
Attribute
Description
Name
information.
Type: string
1083
gpnIdAccept
gpnIdAccept
Description:
gpnIdAccept Attributes
Attribute
Description
Name
more information.
Type: string
portName
Type: WWN
Default: 20:00:10:94:00:00:00:00
GpnIdAccept (fcgs:GpnIdAccept)
Description:
GpnIdAccept Attributes
Attribute
Description
Name
more information.
Type: string
portName
Type: WWN
Default: 20:00:10:94:00:00:00:00
gpnl
Description:
gpnl Attributes
Attribute
Description
Name
information.
Type: string
1084
Gpnl
Gpnl (fcgs:Gpnl)
Description:
Gpnl Attributes
Attribute
Description
Name
information.
Type: string
gpnlAccept
Description:
Children: ctIuPreamble, platformNameEntries
gpnlAccept Attributes
Attribute
Description
Name
Type: string
numberOfPlatformNameEntries
Type: INTEGER
GpnlAccept (fcgs:GpnlAccept)
Description:
Children: ctIuPreamble, platformNameEntries
GpnlAccept Attributes
Attribute
Description
Name
Type: string
numberOfPlatformNameEntries
Type: INTEGER
1085
gppnAccept
gppnAccept
Description:
gppnAccept Attributes
Attribute
Description
Name
Type: string
physicalPortNumber
Type: OCTETSTRING
Default: 00000000
GppnAccept (fcgs:GppnAccept)
Description:
GppnAccept Attributes
Attribute
Description
Name
Type: string
physicalPortNumber
Type: OCTETSTRING
Default: 00000000
gpsAccept
Description:
gpsAccept Attributes
Attribute
Description
Name
more information.
Type: string
1086
GpsAccept
Attribute
Description
portState
Type: PortState
Default: 00
Possible Values:
Value Description
portType
00
Unknown
01
Online
02
Offline
03
Testing
04
Fault
Type: PortType
Default: 00
Possible Values:
Value Description
00
Unidentified
01
N_Port
02
NL_Port
03
F/NL_Port
7F
Nx_Port
81
F_Port
82
FL_Port
84
E_Port
85
B_Port
reserved1
Type: OCTETSTRING
Default: 000000
reserved2
Type: OCTETSTRING
Default: 000000
GpsAccept (fcgs:GpsAccept)
Description:
GpsAccept Attributes
Attribute
Description
Name
more information.
Type: string
portState
Type: PortState
Default: 00
Possible Values:
Value Description
00
Unknown
01
Online
02
Offline
03
Testing
04
Fault
1087
gpscAccept
Attribute
Description
portType
Type: PortType
Default: 00
Possible Values:
Value Description
00
Unidentified
01
N_Port
02
NL_Port
03
F/NL_Port
7F
Nx_Port
81
F_Port
82
FL_Port
84
E_Port
85
B_Port
reserved1
Type: OCTETSTRING
Default: 000000
reserved2
Type: OCTETSTRING
Default: 000000
gpscAccept
Description:
gpscAccept Attributes
Attribute
Description
Name
Type: string
portOperatingSpeed
Type: OCTETSTRING
Default: 0000
portSpeedCapabilities
Type: OCTETSTRING
Default: 0000
GpscAccept (fcgs:GpscAccept)
Description:
1088
gptAccept
GpscAccept Attributes
Attribute
Description
Name
Type: string
portOperatingSpeed
Type: OCTETSTRING
Default: 0000
portSpeedCapabilities
Type: OCTETSTRING
Default: 0000
gptAccept
Description:
gptAccept Attributes
Attribute
Description
Name
more information.
Type: string
portType
Type: PortType
Default: 00
Possible Values:
Value Description
reserved
00
Unidentified
01
N_Port
02
NL_Port
03
F/NL_Port
7F
Nx_Port
81
F_Port
82
FL_Port
84
E_Port
85
B_Port
Type: OCTETSTRING
Default: 000000
GptAccept (fcgs:GptAccept)
Description:
1089
gptIdAccept
GptAccept Attributes
Attribute
Description
Name
more information.
Type: string
portType
Type: PortType
Default: 00
Possible Values:
Value Description
reserved
00
Unidentified
01
N_Port
02
NL_Port
03
F/NL_Port
7F
Nx_Port
81
F_Port
82
FL_Port
84
E_Port
85
B_Port
Type: OCTETSTRING
Default: 000000
gptIdAccept
Description:
gptIdAccept Attributes
Attribute
Description
Name
information.
Type: string
portType
Type: PortType
Default: 00
Possible Values:
Value Description
00
Unidentified
01
N_Port
02
NL_Port
03
F/NL_Port
7F
Nx_Port
81
F_Port
82
FL_Port
84
E_Port
85
B_Port
1090
GptIdAccept
GptIdAccept (fcgs:GptIdAccept)
Description:
GptIdAccept Attributes
Attribute
Description
Name
information.
Type: string
portType
Type: PortType
Default: 00
Possible Values:
Value Description
00
Unidentified
01
N_Port
02
NL_Port
03
F/NL_Port
7F
Nx_Port
81
F_Port
82
FL_Port
84
E_Port
85
B_Port
Gre (gre:Gre)
Description:
Generic Routing Encapsulation header
Children: checksums, keys, seqNums
Next headers: ipv4:IPv4, ipv6:IPv6, mpls:Mpls, custom:Custom
Gre Attributes
Attribute
Description
ckPresent
Checksum Present bit

Type: BITSTRING
Default: 0
enableKeepAlive
Type: BITSTRING
Default: 0
endpointv4
IPv4 address of GRE tunnel (if applicable)

Type: IPV4ADDR
Default: 192.0.0.1
endpointv6
IPv6 address of GRE tunnel (if applicable)

Type: IPV6ADDR
Default: 2000::2
1091
Gre
Attribute
Description
keepAlivePeriod
Type: INTEGER
Default: 10
keepAliveRetries
Type: INTEGER
Default: 3
keyPresent
Key Present bit

Type: BITSTRING
Default: 0
Name
Type: string
protocolType
Protocol type of the payload packet

Type: EtherTypes
Default: 0800
Possible Values:
Value Description
0200
XEROX PUP
0201
PUP Addr Trans
0400
Nixdorf
0600
XEROX NS IDP
0660
DLOG
0661
DLOG2
0800
Internet IP
0801
X.75 Internet
0802
NBS Internet
0803
ECMA Internet
0804
Chaosnet
0805
X.25 Level 3
0806
ARP
0807
XNS Compatibility
0808
Frame Relay ARP
8035
RARP
86DD IPv6
880B PPP
8809
Slow Protocol
8847
MPLS Unicast
8848
MPLS Multicast
8863
PPPoE Discovery
8864
PPPoE Session
8906
FCoE
8914
FIP
reserved0
Reserved0
Type: INTEGER
Default: 0
routingPresent
Routing Present bit

Type: BITSTRING
Default: 0
seqNumPresent
Sequence Number Present bit

Type: BITSTRING
Default: 0
1092
GreChecksum
Attribute
Description
version
Version Number
Type: INTEGER
Default: 0
GreChecksum
Description:
Checksum and Reserved1 fields for the GRE header
Parents: checksums
Children: None
GreChecksum Attributes
Attribute
Description
Name
more information.
Type: string
reserved
Reserved1 field
Type: INTEGER
Default: 0
value
The checksum value

Type: INTEGER
Default: 0
GreIf
Description:
GRE interface object.

Result children (automatically created): GreIfResults
Relations:
Side name
(Type)
Relative
Description
DstBoundTo
(DstBinding)

StreamBlock.
EncapsulationSource
(Encapsulation)
PathDescriptor
1093
GreIf
Side name
(Type)
Relative
Description
NetworkLink
(LinkSrc)

VplsLdpCeToPeLink
MemberOfVpn
(MemberOfVpn)

VpnSiteInfoVplsLdp
Port

relation.

WimaxIf

PrimaryIfSource
(PrimaryIf)

SUT

the DUT.
RelayBlockConfig
(RelayIf)
(ResolvesInterface)

RsvpRouterConfig

ResultChild
(ResultChild)
GreIfResults

object.
SrcBoundTo
(SrcBinding)

StreamBlock.
StackedOn
(StackedOnEndpoint)

WimaxIf
TopLevelIfSource
(TopLevelIf)

SUT

interface stack.
Port

1094
GreIf
Side name
(Type)
Relative
Description
UsesIfSource
(UsesIf)


GreIf Writable Attributes

Writable Attribute
Description
Active, Name
ChecksumEnabled
Whether checksum should be enabled.

Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
Checksum should be enabled.
FALSE Checksum should be disabled.

EnableKeepAlive
Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
FALSE
IfCountPerLowerIf

Type: u32
Default: 1
IfRecycleCount
Not used on this object.

Type: u32
Default: 0
InFlowKeyFieldEnabled
Whether incoming GRE key field should be enabled.

Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE

IsLoopbackIf

Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
1095
GreIf
Writable Attribute
Description
IsRange

Type: bool
Default: TRUE
Possible Values:
Value Description
TRUE
Not used.
FALSE Not used.

KeepAlivePeriod
Type: u16
Default: 10
KeepAliveRetryCount
Type: u8
Default: 3
OutFlowKeyFieldEnabled
Whether outgoing GRE key field should be enabled.

Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE


Type: ip
Default: 192.0.0.1

Type: ipv6
Default: 2000::2
RxFlowKeyField
Incoming key field value.

Type: u32
Default: 0
SeqNumEnabled
Whether sequence number should be enabled.

Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
Sequence number should be enabled.
FALSE Sequence number should be disabled.

TxFlowKeyField
Outgoing key field value.

Type: u32
Default: 0
GreIf Read-Only Attributes

Read-Only Attribute
Description
EffectiveBlockCount

Type: u32
Default: 1
1096
GreIfPortResults
Read-Only Attribute
Description
IfState

Type: enum
Default: DISABLED
Possible Values:
Value
Description
READY
Ready.
DISABLED
Disabled.
DELETING
Deleting.
GreIfPortResults
Description:

Parents: Port
Relations:
Side name
(Type)
Relative
Description
ResultParent
(ResultChild)
Port
GreIfPortResults Writable Attributes

GreIfPortResults Read-Only Attributes

Read-Only Attribute
Description
RxCount
Type: u32
Default: 0
TxCount
Type: u32
Default: 0
GreIfResults
Description:

Parents: GreIf
Relations:
Side name
(Type)
Relative
Description
ResultParent
(ResultChild)
GreIf
1097
GreKey
GreIfResults Writable Attributes

GreIfResults Read-Only Attributes

Read-Only Attribute
Description
KeepAliveState
Type: enum
Default: DISABLED
Possible Values:
Value
Description
DISABLED
DOWN
INIT
UP
MULTICAST_MODE
Type: ip
Default: 0.0.0.0
RxCount
Type: u32
Default: 0
SrcIpAddress
Type: ip
Default: 0.0.0.0
TxCount
Type: u32
Default: 0
GreKey
Description:
The Key field of the GRE header
Parents: keys
Children: None
GreKey Attributes
Attribute
Description
Name
information.
Type: string
value
Value of the Key field

Type: INTEGER
Default: 0
GreSeqNum
Description:
Sequence Number field in the GRE header
1098
GridTopologyGenParams
Parents: seqNums
Children: None
GreSeqNum Attributes
Attribute
Description
Name
information.
Type: string
value
Value of the sequence number

Type: INTEGER
Default: 0
GridTopologyGenParams
Description:
Grid topology generation parameters. The specified grid topology is created on each emulated router.

GridTopologyGenParams Writable Attributes

Writable Attribute
Description
Active, Name
AttachColumnIndex
For an emulated router attached to a simulated router, 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, the column index in the grid where the emulated router is located.
Type: u16
Default: 1
Range: 1 - 10000
AttachRowIndex
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.
Type: u16
Default: 1
Range: 1 - 10000
Columns
Number of columns in the grid.

Type: u16
Default: 4
Range: 1 - 10000
EmulatedRouterPos
Location of the emulated router in the grid.

Type: enum
Default: ATTACHED_TO_GRID
Possible Values:
Value
Description
ATTACHED_TO_GRID Emulated router is attached to one of the simulated routers in the grid.
MEMBER_OF_GRID
Rows
Emulated router is a member of the grid.
Number of rows in the grid.

Type: u16
Default: 4
Range: 1 - 10000
1099
groupAddr
GridTopologyGenParams Read-Only Attributes

groupAddr (overloaded)
groupAddr (pim) - Object definition for the following paths:
StreamBlock.Pimv4RegisterStop.groupAddr
StreamBlock.Pimv4JoinPrune.groupRecords.JoinPrunev4GroupRecord.groupAddr
StreamBlock.Pimv4Assert.groupAddr
groupAddr (pim) - Object definition for the following paths:
StreamBlock.Pimv6RegisterStop.groupAddr
StreamBlock.Pimv6JoinPrune.groupRecords.JoinPrunev6GroupRecord.groupAddr
StreamBlock.Pimv6Assert.groupAddr
groupAddr Object (pim PDU library)

Description:
Parents: Pimv4RegisterStop (StreamBlock.Pimv4RegisterStop)

JoinPrunev4GroupRecord (StreamBlock.Pimv4JoinPrune.groupRecords.JoinPrunev4GroupRecord)
Pimv4Assert (StreamBlock.Pimv4Assert)
Children: None
groupAddr Attributes
Attribute
Description
address
Type: IPV4ADDR
Default: 225.0.0.1
1100
groupAddr
Attribute
Description
addrFamily
Type: AddressFamilies8Bit
Default: 1
Possible Values:
Value Description
1
IPv4
IPv6
NSAP
HDLC
BBN 1822
802
E.163
E.164
F.69
10
X.121
11
IPX
12
AppleTalk
13
Decnet IV
14
Banyan Vines
15
E.164 with NSAP format subaddress
16
DNS
17
Distinguished Name
18
AS Number
19
XTP over IPv4
20
XTP over IPv6
21
XTP native mode
22
Fiber Channel World-Wide Port Name
23
Fiber Channel World-Wide Node Name
24
GWID
bBit
Type: BITSTRING
Default: 0
encodingType
Type: INTEGER
Default: 0
maskLen
Type: INTEGER
Default: 24
Name
more information.
Type: string
reserved
Type: BITSTRING
Default: 000000
zBit
Type: BITSTRING
Default: 0
groupAddr Object (pim PDU library)

Description:
1101
groupAddr

JoinPrunev6GroupRecord (StreamBlock.Pimv6JoinPrune.groupRecords.JoinPrunev6GroupRecord)
Children: None
groupAddr Attributes
Attribute
Description
address
Type: IPV6ADDR
Default: FF1E:0000:0000:0000:0000:0000:0000:0001
addrFamily
Default: 2
Possible Values:
Value Description
1
IPv4
IPv6
NSAP
HDLC
BBN 1822
802
E.163
E.164
F.69
10
X.121
11
IPX
12
AppleTalk
13
Decnet IV
14
Banyan Vines
15
16
DNS
17
Distinguished Name
18
AS Number
19
XTP over IPv4
20
XTP over IPv6
21
XTP native mode
22
23
24
GWID
bBit
Type: BITSTRING
Default: 0
encodingType
Type: INTEGER
Default: 0
maskLen
Type: INTEGER
Default: 24
Name
more information.
Type: string
reserved
Type: BITSTRING
Default: 000000
1102
GroupCollection
Attribute
Description
zBit
Type: BITSTRING
Default: 0
GroupCollection
Description:
Specifies a collection of traffic groups.

Parents: Project
Children: TrafficGroup
Relations:
Side name
(Type)
Relative
Description
Config
DcbBackToBackTestCaseConfig, DcbMaximumForwardingRateTestCaseConfig,
DcbPfcLoadValidationTestCaseConfig, DcbPfcResponseTimeTestCaseConfig,
DcbQueueputTestCaseConfig, DcbStepTestCaseConfig
GroupCollection Writable Attributes

Writable Attribute
Description
Active, Name
GroupName
Specifies the traffic group collection name.

Type: string
GroupCollection Read-Only Attributes

GroupRecord
Description:
IGMPv3 Group Record. See RFC 3376.
Parents: grpRecords
Children: addrList
GroupRecord Attributes
Attribute
Description
auxDataLen
Type: INTEGER
Default: 0
mcastAddr
Type: IPV4ADDR
Default: 225.0.0.1
1103
groupRecords
Attribute
Description
Name
Type: string
numSource
Type: INTEGER
Default: 0
recordType
Type: Igmpv3RecordType
Possible Values:
Value Description
1
MODE_IS_INCLUDE
MODE_IS_EXCLUDE
CHANGE_TO_INCLUDE_MODE
CHANGE_TO_EXCLUDE_MODE
ALLOW_NEW_SOURCES
BLOCK_OLD_SOURCES
groupRecords (overloaded)
groupRecords (pim) - Object definition for the following paths:
StreamBlock.Pimv4JoinPrune.groupRecords
groupRecords (pim) - Object definition for the following paths:
StreamBlock.Pimv6JoinPrune.groupRecords
groupRecords Object (pim PDU library)

Description:
Parents: Pimv4JoinPrune (StreamBlock.Pimv4JoinPrune)

Children: JoinPrunev4GroupRecord
groupRecords Attributes
Attribute
Description
Name
information.
Type: string
1104
GroupType
groupRecords Object (pim PDU library)

Description:
Parents: Pimv6JoinPrune (StreamBlock.Pimv6JoinPrune)

Children: JoinPrunev6GroupRecord
groupRecords Attributes
Attribute
Description
Name
information.
Type: string
GroupType
Description:
Group type used to define groups of objects.

Parents: Project
Relations:
Side name
(Type)
Relative
Description
Config
(BenchmarkSideGroupType)
Rfc2544BackToBackFramesConfig, Rfc2544BackToBackFramesConfig,
Rfc2544FrameLossConfig, Rfc2544FrameLossConfig,
Rfc2544LatencyConfig, Rfc2544LatencyConfig, Rfc2544ThroughputConfig,
Rfc2544ThroughputConfig
TypeOfGroup
(GroupOfType)
DeviceGroup, HostGroup, PortGroup
Relation used to assign group type

to objects.
GroupType Writable Attributes

Writable Attribute
Description
Active, Name
GroupType Read-Only Attributes

grpRecords (overloaded)
grpRecords (icmpv6)
grpRecords (igmp)
1105
gsAccept
grpRecords Object (icmpv6 PDU library)

Description:
Parents: MLDv2Report (StreamBlock.MLDv2Report)

Children: MLDv2GroupRecord
grpRecords Attributes
Attribute
Description
Name
information.
Type: string
grpRecords Object (igmp PDU library)

Description:
Parents: Igmpv3Report (StreamBlock.Igmpv3Report)

Children: GroupRecord
grpRecords Attributes
Attribute
Description
Name
information.
Type: string
gsAccept
Description:
gsAccept Attributes
Attribute
Description
Name
information.
Type: string
1106
GsAccept
GsAccept (fcgs:GsAccept)
Description:
GsAccept Attributes
Attribute
Description
Name
information.
Type: string
gsDeregisterWithPlatformName
Description:
gsDeregisterWithPlatformName Attributes
Attribute
Description
Name
Type: string
platformName
Type: ASCII
platformNameFormat
Type: OCTETSTRING
Default: 02
platformNameLength
Type: INTEGER
Default: 0
reserved1
GsDeregisterWithPlatformName (fcgs:GsDeregisterWithPlatformName)
Description:
1107
gsesAccept
GsDeregisterWithPlatformName Attributes
Attribute
Description
Name
Type: string
platformName
Type: ASCII
platformNameFormat
Type: OCTETSTRING
Default: 02
platformNameLength
Type: INTEGER
Default: 0
reserved1
gsesAccept
Description:
Children: ctIuPreamble, zoningEnforcementStatusObjects
gsesAccept Attributes
Attribute
Description
Name
Type: string
numberOfZoningEnforcementStatusObjects
Type: INTEGER
Default: 0
GsesAccept (fcgs:GsesAccept)
Description:
Children: ctIuPreamble, zoningEnforcementStatusObjects
GsesAccept Attributes
Attribute
Description
Name
Type: string
1108
gsnnNnAccept
Attribute
Description
numberOfZoningEnforcementStatusObjects
Type: INTEGER
Default: 0
gsnnNnAccept
Description:
gsnnNnAccept Attributes
Attribute
Description
Name
Type: string
nameLength
Type: INTEGER
Default: 0
reserved1
symbolicNodeName
Type: ASCII
GsnnNnAccept (fcgs:GsnnNnAccept)
Description:
GsnnNnAccept Attributes
Attribute
Description
Name
Type: string
nameLength
Type: INTEGER
Default: 0
reserved1
symbolicNodeName
Type: ASCII
1109
gspnIdAccept
gspnIdAccept
Description:
gspnIdAccept Attributes
Attribute
Description
Name
Type: string
nameLength
Type: INTEGER
Default: 0
reserved1
symbolicPortName
Type: ASCII
GspnIdAccept (fcgs:GspnIdAccept)
Description:
GspnIdAccept Attributes
Attribute
Description
Name
Type: string
nameLength
Type: INTEGER
Default: 0
reserved1
symbolicPortName
Type: ASCII
gsReject
Description:
1110
GsReject
gsReject Attributes
Attribute
Description
Name
information.
Type: string
GsReject (fcgs:GsReject)
Description:
GsReject Attributes
Attribute
Description
Name
information.
Type: string
gsRequestWithFc4Type
Description:
gsRequestWithFc4Type Attributes
Attribute
Description
areaIdScope
Type: OCTETSTRING
Default: 00
domainIdScope
Type: OCTETSTRING
Default: 00
fc4TypeCode
Type: OCTETSTRING
Default: 00
Name
Type: string
reserved
Type: OCTETSTRING
Default: 00
1111
GsRequestWithFc4Type
GsRequestWithFc4Type (fcgs:GsRequestWithFc4Type)
Description:
GsRequestWithFc4Type Attributes
Attribute
Description
areaIdScope
Type: OCTETSTRING
Default: 00
domainIdScope
Type: OCTETSTRING
Default: 00
fc4TypeCode
Type: OCTETSTRING
Default: 00
Name
Type: string
reserved
Type: OCTETSTRING
Default: 00
gsRequestWithInterconnectElementName
Description:
gsRequestWithInterconnectElementName Attributes
Attribute
Description
interconnectElementName
Type: WWN
Default: 10:00:10:94:00:00:00:00
Name
Type: string
GsRequestWithInterconnectElementName
(fcgs:GsRequestWithInterconnectElementName)
Description:
1112
gsRequestWithNodeName
GsRequestWithInterconnectElementName Attributes
Attribute
Description
Type: WWN
Default: 10:00:10:94:00:00:00:00
Name
Type: string
gsRequestWithNodeName
Description:
gsRequestWithNodeName Attributes
Attribute
Description
Name
more information.
Type: string
nodeName
Type: WWN
Default: 10:00:10:94:00:00:00:00
GsRequestWithNodeName (fcgs:GsRequestWithNodeName)
Description:
GsRequestWithNodeName Attributes
Attribute
Description
Name
more information.
Type: string
nodeName
Type: WWN
Default: 10:00:10:94:00:00:00:00
gsRequestWithPlatformName
1113
GsRequestWithPlatformName
Description:
gsRequestWithPlatformName Attributes
Attribute
Description
Name
Type: string
platformName
Type: ASCII
platformNameFormat
Type: OCTETSTRING
Default: 02
platformNameLength
Type: INTEGER
Default: 0
reserved1
GsRequestWithPlatformName (fcgs:GsRequestWithPlatformName)
Description:
GsRequestWithPlatformName Attributes
Attribute
Description
Name
Type: string
platformName
Type: ASCII
platformNameFormat
Type: OCTETSTRING
Default: 02
platformNameLength
Type: INTEGER
Default: 0
reserved1
gsRequestWithPortIdentifier
Description:
1114
GsRequestWithPortIdentifier
gsRequestWithPortIdentifier Attributes
Attribute
Description
Name
Type: string
portIdentifier
Type: OCTETSTRING
Default: 000000
reserved
Type: OCTETSTRING
Default: 00
GsRequestWithPortIdentifier (fcgs:GsRequestWithPortIdentifier)
Description:
GsRequestWithPortIdentifier Attributes
Attribute
Description
Name
Type: string
portIdentifier
Type: OCTETSTRING
Default: 000000
reserved
Type: OCTETSTRING
Default: 00
gsRequestWithPortName
Description:
gsRequestWithPortName Attributes
Attribute
Description
Name
more information.
Type: string
portName
Type: WWN
Default: 20:00:10:94:00:00:00:00
1115
GsRequestWithPortName
GsRequestWithPortName (fcgs:GsRequestWithPortName)
Description:
GsRequestWithPortName Attributes
Attribute
Description
Name
more information.
Type: string
portName
Type: WWN
Default: 20:00:10:94:00:00:00:00
gsRequestWithPortType
Description:
gsRequestWithPortType Attributes
Attribute
Description
areaIdScope
Type: OCTETSTRING
Default: 00
domainIdScope
Type: OCTETSTRING
Default: 00
Name
Type: string
portType
Type: PortType
Default: 00
Possible Values:
Value Description
reserved
00
Unidentified
01
N_Port
02
NL_Port
03
F/NL_Port
7F
Nx_Port
81
F_Port
82
FL_Port
84
E_Port
85
B_Port
Type: OCTETSTRING
Default: 00
1116
GsRequestWithPortType
GsRequestWithPortType (fcgs:GsRequestWithPortType)
Description:
GsRequestWithPortType Attributes
Attribute
Description
areaIdScope
Type: OCTETSTRING
Default: 00
domainIdScope
Type: OCTETSTRING
Default: 00
Name
Type: string
portType
Type: PortType
Default: 00
Possible Values:
Value Description
reserved
00
Unidentified
01
N_Port
02
NL_Port
03
F/NL_Port
7F
Nx_Port
81
F_Port
82
FL_Port
84
E_Port
85
B_Port
Type: OCTETSTRING
Default: 00
gtin
Description:
gtin Attributes
Attribute
Description
interconnectElementDomainId
Type: OCTETSTRING
Default: 00
Name
Type: string
reserved1
Type: OCTETSTRING
Default: 0000000000
1117
Gtin
Attribute
Description
reserved2
Type: OCTETSTRING
Default: 000000000000
Gtin (fcgs:Gtin)
Description:
Gtin Attributes
Attribute
Description
Type: OCTETSTRING
Default: 00
Name
Type: string
reserved1
Type: OCTETSTRING
Default: 0000000000
reserved2
Type: OCTETSTRING
Default: 000000000000
gtinAccept
Description:
Children: ctIuPreamble, interconnectElementDomainIds, topologyInformationDescriptors
gtinAccept Attributes
Attribute
Description
Type: OCTETSTRING
Default: 00
Type: WWN
Default: 10:00:10:94:00:00:00:00
Name
Type: string
numberOfInterconnectElements
Type: INTEGER
Default: 0
numberOfPorts
Type: INTEGER
Default: 0
1118
GtinAccept
Attribute
Description
pad
reserved1
Type: OCTETSTRING
Default: 0000000000000000
reserved2
Type: OCTETSTRING
Default: 0000000000000000
reserved3
Type: OCTETSTRING
Default: 00000000
GtinAccept (fcgs:GtinAccept)
Description:
Children: ctIuPreamble, interconnectElementDomainIds, topologyInformationDescriptors
GtinAccept Attributes
Attribute
Description
Type: OCTETSTRING
Default: 00
Type: WWN
Default: 10:00:10:94:00:00:00:00
Name
Type: string
numberOfInterconnectElements
Type: INTEGER
Default: 0
numberOfPorts
Type: INTEGER
Default: 0
pad
reserved1
Type: OCTETSTRING
Default: 0000000000000000
reserved2
Type: OCTETSTRING
Default: 0000000000000000
reserved3
Type: OCTETSTRING
Default: 00000000
GTPv1 (gtpv1:GTPv1)
Description:
1119
GTPv1
Children: None
Next headers: custom:Custom, ipv4:IPv4, ipv6:IPv6, gtpv1_ext:GTPv1Ext
GTPv1 Attributes
Attribute
Description
eFlg
Type: gtpv1ExtHdrFlg
Default: 0
Possible Values:
Value Description
0
Extended Header Flag off
Extended Header Flag on
mlength
Type: INTEGER
Default: 8
msgType
Type: INTEGER
Default: 0
Name
more information.
Type: string
pnFlg
Type: gtpv1pnFlg
Default: 0
Possible Values:
Value Description
protcol
reserved
sFlg
N-PDU Number Flag off
N-PDU Number Flag on
Type: gtpv1ProtcolType
Default: 1
Possible Values:
Value Description
0
GTP'
GTP
Type: gtpv1Boolean
Default: 0
Possible Values:
Value Description
0
False
True
Type: gtpv1SeqNumFlg
Default: 0
Possible Values:
Value Description
0
Sequence Number Flag off
Sequence Number Flag on
teid
Type: INTEGER
Default: 0
version
Type: INTEGER
Default: 1
1120
GTPv1Ext
GTPv1Ext (gtpv1_ext:GTPv1Ext)
Description:
Children: None
Next headers: custom:Custom, ipv4:IPv4, ipv6:IPv6, gtpv1_ext:GTPv1Ext
GTPv1Ext Attributes
Attribute
Description
mlength
Type: INTEGER
Default: 0
Name
Type: string
nExtHdr
Type: INTEGER
Default: 0
nExtHdr
Type: INTEGER
Default: 0
Npdu
Type: INTEGER
Default: 0
pattern
Type: OCTETSTRING
Default: 00
seqno
Type: INTEGER
Default: 0
HdlcGetLinkConfigCommand
Description:
Returns the HDLC link configuration.

HdlcGetLinkConfigCommand Writable Attributes

Writable Attribute
Description
POSPhy
SONET phy handle (AtmPhy or PosPhy).

Type: handle
Default: 0
HdlcGetLinkConfigCommand Read-Only Attributes

Read-Only Attribute
Description

1121
HdlcIf
HdlcIf
Description:
HDLC interface object.

Relations:
Side name
(Type)
Relative
Description
ApplicableOnPhy
(ApplicableOnPhy)
POSPhy
DstBoundTo
(DstBinding)

StreamBlock.
EncapsulationSource
(Encapsulation)
PathDescriptor
NetworkLink
(LinkSrc)

VplsLdpCeToPeLink
MemberOfVpn
(MemberOfVpn)

VpnSiteInfoVplsLdp
Port

relation.

WimaxIf

PrimaryIfSource
(PrimaryIf)

SUT

the DUT.
RelayBlockConfig
(RelayIf)
(ResolvesInterface)

RsvpRouterConfig

SrcBoundTo
(SrcBinding)

StreamBlock.
StackedOn
(StackedOnEndpoint)

WimaxIf
1122
HdlcIf
Side name
(Type)
Relative
Description
TopLevelIfSource
(TopLevelIf)

SUT

interface stack.
Port

UsesIfSource
(UsesIf)


HdlcIf Writable Attributes

Writable Attribute
Description
Active, Name
IfCountPerLowerIf

Type: u32
Default: 1
IfRecycleCount

Type: u32
Default: 0
IsLoopbackIf

Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE

IsRange

Type: bool
Default: TRUE
Possible Values:
Value Description
TRUE
Not used.
FALSE Not used.

ProtocolType
Protocol type.
Type: enum
Default: HDLC_PROTOCOL_TYPE_IPV4
Possible Values:
Value
Description
IPv4 protocol.
IPv6 protocol.
HDLC_PROTOCOL_TYPE_MPLS MPLS protocol.
1123
HdlcLinkConfig
HdlcIf Read-Only Attributes

Read-Only Attribute
Description
AddrResolveState
Address resolve state.

Type: enum
Possible Values:
Value
Description
RESOLVE_DONE
Resolve is done.
RESOLVE_NEEDED
Resolve is needed.
RESOLVE_FAILED
Resolve failed.
RESOLVE_IN_PROGRESS

EffectiveBlockCount

Type: u32
Default: 1
IfState

Type: enum
Default: DISABLED
Possible Values:
Value
Description
READY
Ready.
DISABLED
Disabled.
DELETING
Deleting.
HdlcLinkConfig
Description:
Link configuration parameters for HDLC.

Automatically created from: POSPhy
HdlcLinkConfig Writable Attributes

Writable Attribute
Description
Active, Name
Enabled
Enable HDLC keepalive.

Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
Enable
FALSE Disable
KeepAliveInterval
Keep alive interval (ms).

Type: u32
Default: 10000
Range: 100 - 60000
1124
HdlcSetLinkConfigCommand
Writable Attribute
Description
KeepAliveRxSeqNumEnabled
Enable keep alive receive.

Type: bool
Default: TRUE
Possible Values:
Value Description
TRUE
Enable
FALSE Disable
KeepAliveTxSeqNumEnabled
Enable keep alive transmit.

Type: bool
Default: TRUE
Possible Values:
Value Description
TRUE
Enable
FALSE Disable
MaxDropCount
Max drop count.

Type: u32
Default: 3
Range: 1 - 10
HdlcLinkConfig Read-Only Attributes

Read-Only Attribute
Description
LinkStatus
Link status.
Type: enum
Default: NONE
Possible Values:
Value Description
DOWN Link is down.
UP
Link is up.
NONE No link present.
HdlcSetLinkConfigCommand
Description:
Sets the HDLC link configuration.

HdlcSetLinkConfigCommand Writable Attributes

Writable Attribute
Description
POSPhy

Type: handle
Default: 0
1125
hdrAuthSelectCrypto
HdlcSetLinkConfigCommand Read-Only Attributes

Read-Only Attribute
Description

hdrAuthSelectCrypto
Description:
Parents: authSelect
Children: None
hdrAuthSelectCrypto Attributes
Attribute
Description
authType
Type: INTEGER
Default: 2
authValue1
Type: INTEGER
Default: 0
authValue2
Type: INTEGER
Default: 0
Name
Type: string
hdrAuthSelectNone
Description:
Parents: authSelect
Children: None
hdrAuthSelectNone Attributes
Attribute
Description
authType
Type: INTEGER
Default: 0
authValue1
Type: INTEGER
Default: 0
authValue2
Type: INTEGER
Default: 0
Name
Type: string
1126
hdrAuthSelectPassword
hdrAuthSelectPassword
Description:
Parents: authSelect
Children: None
hdrAuthSelectPassword Attributes
Attribute
Description
authType
Type: INTEGER
Default: 1
authValue1
Type: INTEGER
Default: 0
authValue2
Type: INTEGER
Default: 0
Name
Type: string
hdrAuthSelectUserDef
Description:
Parents: authSelect
Children: None
hdrAuthSelectUserDef Attributes
Attribute
Description
authType
Type: INTEGER
Default: 3
authValue1
Type: INTEGER
Default: 0
authValue2
Type: INTEGER
Default: 0
Name
Type: string
header (overloaded)
header (bfd)
header (lldp) - Object definition for the following paths:
StreamBlock.DcbxTlvt1.value.DcbxSubTlvt1.customTlv.header
StreamBlock.DcbxTlvt2.value.DcbxSubTlvt2.customTlv.header
1127
header
StreamBlock.DcbxTlvt1.value.DcbxSubTlvt1.nivTlv.header
StreamBlock.DcbxTlvt2.value.DcbxSubTlvt2.nivTlv.header
StreamBlock.DcbxTlvt1.value.DcbxSubTlvt1.pgTlv.header
StreamBlock.DcbxTlvt1.value.DcbxSubTlvt1.pfcTlv.header
StreamBlock.DcbxTlvt1.value.DcbxSubTlvt1.bcnTlv.header
StreamBlock.DcbxTlvt1.value.DcbxSubTlvt1.applicatonTlv.header
StreamBlock.DcbxTlvt1.value.DcbxSubTlvt1.logicLinkDownTlv.header
StreamBlock.DcbxTlvt2.value.DcbxSubTlvt2.pgTlv.header
StreamBlock.DcbxTlvt2.value.DcbxSubTlvt2.pfcTlv.header
StreamBlock.DcbxTlvt2.value.DcbxSubTlvt2.applicatonTlv.header
header (lspping)
header (ospfv2) - Object definition for the following paths:
StreamBlock.Ospfv2Unknown.header
StreamBlock.Ospfv2Hello.header
StreamBlock.Ospfv2DatabaseDescription.header
StreamBlock.Ospfv2LinkStateRequest.header
StreamBlock.Ospfv2LinkStateUpdate.header
StreamBlock.Ospfv2LinkStateAcknowledge.header
StreamBlock.Ospfv2DatabaseDescription.lsaHeaders.header
StreamBlock.Ospfv2LinkStateUpdate.updatedLsas.Ospfv2Lsa.ospfv2RouterLsa.header
StreamBlock.Ospfv2LinkStateAcknowledge.lsaHeaders.header
StreamBlock.Ospfv2LinkStateUpdate.updatedLsas.Ospfv2Lsa.ospfv2NetworkLsa.header
StreamBlock.Ospfv2LinkStateUpdate.updatedLsas.Ospfv2Lsa.ospfv2SummaryLsa.header
StreamBlock.Ospfv2LinkStateUpdate.updatedLsas.Ospfv2Lsa.ospfv2SummaryAsbrLsa.header
StreamBlock.Ospfv2LinkStateUpdate.updatedLsas.Ospfv2Lsa.ospfv2AsExternalLsa.header
header (pim) - Object definition for the following paths:
StreamBlock.Pimv4Hello.header
StreamBlock.Pimv4Register.header
StreamBlock.Pimv4RegisterStop.header
StreamBlock.Pimv4JoinPrune.header
StreamBlock.Pimv4Assert.header
StreamBlock.Pimv4NullRegister.header
header (pim) - Object definition for the following paths:
StreamBlock.Pimv6Hello.header
StreamBlock.Pimv6Register.header
StreamBlock.Pimv6RegisterStop.header
StreamBlock.Pimv6JoinPrune.header
StreamBlock.Pimv6Assert.header
header Object (bfd PDU library)

Description:
Parents: BFD (StreamBlock.BFD)

BFDSimpleAuth (StreamBlock.BFDSimpleAuth)
BFDCryptoAuth (StreamBlock.BFDCryptoAuth)
Children: None
1128
header
header Attributes
Attribute
Description
Type: BITSTRING
Default: 0
Type: BITSTRING
Default: 0
Type: BITSTRING
Default: 0
DesiredMinTxInterval
Type: INTEGER
diagnostic
Type: DiagnosticType
Default: 0
Possible Values:
Value Description
0
0-No diagnostic
1-Control Detection Time Expired
2-Echo Function Failed
3-Neighbor Signalled Session Down
4-Forwarding Plane Reset
5-Path Down
6-Concatenated Path Down
7-Administratively Down
8-Reverse Concatenated Path Down
DTM
Type: INTEGER
Default: 0
Type: BITSTRING
Default: 0
Length
Type: INTEGER
Default: 0
Type: BITSTRING
Default: 0
MyDiscriminator
Type: INTEGER
Default: 0
Name
Type: string
Type: BITSTRING
Default: 0
ReqMinEchoRxInterval
Type: INTEGER
ReqMinRxInterval
Type: INTEGER
1129
header
Attribute
Description
state
Type: StateType
Default: 0
Possible Values:
Value Description
0
0-AdminDown
1-Down
2-Init
3-Up
version
Type: INTEGER
Default: 1
YourDiscriminator
Type: INTEGER
Default: 0
header Object (lldp PDU library)

Description:
Parents: customTlv (StreamBlock.DcbxTlvt1.value.DcbxSubTlvt1.customTlv)

customTlv (StreamBlock.DcbxTlvt2.value.DcbxSubTlvt2.customTlv)
Children: None
header Attributes
Attribute
Description
en
Type: INTEGER
Default: 1
er
Type: INTEGER
Default: 0
length
Type: INTEGER
Default: 0
maxVer
Type: INTEGER
Default: 0
Name
Type: string
operVer
Type: INTEGER
Default: 0
reserved
Type: INTEGER
Default: 0
subtype
Type: INTEGER
Default: 0
type
Type: INTEGER
Default: 10
1130
header
Attribute
Description
Type: INTEGER
Default: 1

Description:
Parents: nivTlv (StreamBlock.DcbxTlvt1.value.DcbxSubTlvt1.nivTlv)

nivTlv (StreamBlock.DcbxTlvt2.value.DcbxSubTlvt2.nivTlv)
Children: None
header Attributes
Attribute
Description
en
Type: INTEGER
Default: 1
er
Type: INTEGER
Default: 0
length
Type: INTEGER
Default: 12
maxVer
Type: INTEGER
Default: 0
Name
Type: string
operVer
Type: INTEGER
Default: 0
reserved
Type: INTEGER
Default: 0
subtype
Type: INTEGER
Default: 0
type
Type: INTEGER
Default: 7
Type: INTEGER
Default: 0

Description:
1131
header
Parents: pgTlv (StreamBlock.DcbxTlvt1.value.DcbxSubTlvt1.pgTlv)

Children: None
header Attributes
Attribute
Description
en
Type: INTEGER
Default: 1
er
Type: INTEGER
Default: 0
length
Type: INTEGER
Default: 28
maxVer
Type: INTEGER
Default: 0
Name
Type: string
operVer
Type: INTEGER
Default: 0
reserved
Type: INTEGER
Default: 0
subtype
Type: INTEGER
Default: 0
type
Type: INTEGER
Default: 2
Type: INTEGER
Default: 1

Description:
Parents: pfcTlv (StreamBlock.DcbxTlvt1.value.DcbxSubTlvt1.pfcTlv)

Children: None
header Attributes
Attribute
Description
en
Type: INTEGER
Default: 1
er
Type: INTEGER
Default: 0
length
Type: INTEGER
Default: 5
1132
header
Attribute
Description
maxVer
Type: INTEGER
Default: 0
Name
Type: string
operVer
Type: INTEGER
Default: 0
reserved
Type: INTEGER
Default: 0
subtype
Type: INTEGER
Default: 0
type
Type: INTEGER
Default: 3
Type: INTEGER
Default: 1

Description:
Parents: bcnTlv (StreamBlock.DcbxTlvt1.value.DcbxSubTlvt1.bcnTlv)

Children: None
header Attributes
Attribute
Description
en
Type: INTEGER
Default: 1
er
Type: INTEGER
Default: 0
length
Type: INTEGER
Default: 66
maxVer
Type: INTEGER
Default: 0
Name
Type: string
operVer
Type: INTEGER
Default: 0
reserved
Type: INTEGER
Default: 0
subtype
Type: INTEGER
Default: 0
1133
header
Attribute
Description
type
Type: INTEGER
Default: 4
Type: INTEGER
Default: 1

Description:
Parents: applicatonTlv (StreamBlock.DcbxTlvt1.value.DcbxSubTlvt1.applicatonTlv)

Children: None
header Attributes
Attribute
Description
en
Type: INTEGER
Default: 1
er
Type: INTEGER
Default: 0
length
Type: INTEGER
Default: 5
maxVer
Type: INTEGER
Default: 0
Name
Type: string
operVer
Type: INTEGER
Default: 0
reserved
Type: INTEGER
Default: 0
subtype
Type: INTEGER
Default: 0
type
Type: INTEGER
Default: 5
Type: INTEGER
Default: 0
1134
header
Description:
Parents: logicLinkDownTlv (StreamBlock.DcbxTlvt1.value.DcbxSubTlvt1.logicLinkDownTlv)

Children: None
header Attributes
Attribute
Description
en
Type: INTEGER
Default: 1
er
Type: INTEGER
Default: 0
length
Type: INTEGER
Default: 5
maxVer
Type: INTEGER
Default: 0
Name
Type: string
operVer
Type: INTEGER
Default: 0
reserved
Type: INTEGER
Default: 0
subtype
Type: INTEGER
Default: 0
type
Type: INTEGER
Default: 6
Type: INTEGER
Default: 1

Description:
Parents: pgTlv (StreamBlock.DcbxTlvt2.value.DcbxSubTlvt2.pgTlv)

Children: None
header Attributes
Attribute
Description
en
Type: INTEGER
Default: 1
er
Type: INTEGER
Default: 0
1135
header
Attribute
Description
length
Type: INTEGER
Default: 17
maxVer
Type: INTEGER
Default: 0
Name
Type: string
operVer
Type: INTEGER
Default: 0
reserved
Type: INTEGER
Default: 0
subtype
Type: INTEGER
Default: 0
type
Type: INTEGER
Default: 2
Type: INTEGER
Default: 1

Description:
Parents: pfcTlv (StreamBlock.DcbxTlvt2.value.DcbxSubTlvt2.pfcTlv)

Children: None
header Attributes
Attribute
Description
en
Type: INTEGER
Default: 1
er
Type: INTEGER
Default: 0
length
Type: INTEGER
Default: 6
maxVer
Type: INTEGER
Default: 0
Name
Type: string
operVer
Type: INTEGER
Default: 0
reserved
Type: INTEGER
Default: 0
1136
header
Attribute
Description
subtype
Type: INTEGER
Default: 0
type
Type: INTEGER
Default: 3
Type: INTEGER
Default: 1

Description:
Parents: applicatonTlv (StreamBlock.DcbxTlvt2.value.DcbxSubTlvt2.applicatonTlv)

Children: None
header Attributes
Attribute
Description
en
Type: INTEGER
Default: 1
er
Type: INTEGER
Default: 0
length
Type: INTEGER
Default: 0
maxVer
Type: INTEGER
Default: 0
Name
Type: string
operVer
Type: INTEGER
Default: 0
reserved
Type: INTEGER
Default: 0
subtype
Type: INTEGER
Default: 0
type
Type: INTEGER
Default: 4
Type: INTEGER
Default: 0
1137
header
header Object (lspping PDU library)

Description:
Parents: LspPing (StreamBlock.LspPing)

Children: globalFlags
header Attributes
Attribute
Description
messageType
Type: MessageTypeType
Default: 1
Possible Values:
Value Description
1
1-MPLS Echo Request
2-MPLS Echo Reply
Name
Type: string
replyMode
Type: ReplyModeType
Default: 2
Possible Values:
Value Description
1
1-Do not reply
2-Reply via an IPv4/IPv6 UDP Packet
3-Reply via an IPv4/IPv6 UDP Packet with Router Alert
4-Reply via application level control channel
returnCode
Type: INTEGER
Default: 0
senderHandle
Type: INTEGER
Default: 1
timeStampReceived
Type: OCTETSTRING
Default: 0000000000000000
timeStampSent
Type: OCTETSTRING
Default: 0000000000000000
version
Type: INTEGER
Default: 1
header Object (ospfv2 PDU library)

Description:
Parents: Ospfv2Unknown (StreamBlock.Ospfv2Unknown)

Ospfv2Hello (StreamBlock.Ospfv2Hello)
Ospfv2DatabaseDescription (StreamBlock.Ospfv2DatabaseDescription)
Ospfv2LinkStateRequest (StreamBlock.Ospfv2LinkStateRequest)
Ospfv2LinkStateUpdate (StreamBlock.Ospfv2LinkStateUpdate)
Ospfv2LinkStateAcknowledge (StreamBlock.Ospfv2LinkStateAcknowledge)
Children: authSelect
1138
header
header Attributes
Attribute
Description
areaID
Type: IPV4ADDR
Default: 0.0.0.0
checksum
Type: OCTETSTRING
Default: 0000
Name
Type: string
packetLength
Type: INTEGER
Default: 0
routerID
Type: IPV4ADDR
Default: 1.1.1.1
type
Type: Ospfv2PacketTypes
Default: 0
Possible Values:
Value Description
version
Unknown
Hello
Database Description
Link State Request
Link State Update
Link State Acknowledgement
Type: INTEGER
Default: 2

Description:
Parents: lsaHeaders (StreamBlock.Ospfv2DatabaseDescription.lsaHeaders)

ospfv2RouterLsa (StreamBlock.Ospfv2LinkStateUpdate.updatedLsas.Ospfv2Lsa.ospfv2RouterLsa)
lsaHeaders (StreamBlock.Ospfv2LinkStateAcknowledge.lsaHeaders)
Children: lsaHdrOptions
header Attributes
Attribute
Description
advertisingRouter
Type: IPV4ADDR
Default: 1.1.1.1
linkStateId
Type: IPV4ADDR
Default: 1.1.1.1
lsaAge
Type: INTEGER
Default: 0
1139
header
Attribute
Description
lsaLength
Type: INTEGER
Default: 0
lsChecksum
Type: OCTETSTRING
Default: 0000
lsSequenceNumber
Type: OCTETSTRING
Default: 80000001
lsType
Type: Ospfv2LsTypes
Default: 1
Possible Values:
Value Description
Name
Router
Network
Summary
Summary-ASBR
AS-External Type-5
AS-External Type-7
Type: string

Description:
Parents: ospfv2NetworkLsa (StreamBlock.Ospfv2LinkStateUpdate.updatedLsas.Ospfv2Lsa.ospfv2NetworkLsa)

header Attributes
Attribute
Description
advertisingRouter
Type: IPV4ADDR
Default: 1.1.1.1
linkStateId
Type: IPV4ADDR
Default: 1.1.1.1
lsaAge
Type: INTEGER
Default: 0
lsaLength
Type: INTEGER
Default: 0
lsChecksum
Type: OCTETSTRING
Default: 0000
lsSequenceNumber
Type: OCTETSTRING
Default: 80000001
1140
header
Attribute
Description
lsType
Type: Ospfv2LsTypes
Default: 2
Possible Values:
Value Description
Name
Router
Network
Summary
Summary-ASBR
AS-External Type-5
AS-External Type-7
Type: string

Description:
Parents: ospfv2SummaryLsa (StreamBlock.Ospfv2LinkStateUpdate.updatedLsas.Ospfv2Lsa.ospfv2SummaryLsa)

header Attributes
Attribute
Description
advertisingRouter
Type: IPV4ADDR
Default: 1.1.1.1
linkStateId
Type: IPV4ADDR
Default: 1.1.1.1
lsaAge
Type: INTEGER
Default: 0
lsaLength
Type: INTEGER
Default: 0
lsChecksum
Type: OCTETSTRING
Default: 0000
lsSequenceNumber
Type: OCTETSTRING
Default: 80000001
1141
header
Attribute
Description
lsType
Type: Ospfv2LsTypes
Default: 3
Possible Values:
Value Description
Name
Router
Network
Summary
Summary-ASBR
AS-External Type-5
AS-External Type-7
Type: string

Description:
Parents: ospfv2SummaryAsbrLsa (StreamBlock.Ospfv2LinkStateUpdate.updatedLsas.Ospfv2Lsa.ospfv2SummaryAsbrLsa)

header Attributes
Attribute
Description
advertisingRouter
Type: IPV4ADDR
Default: 1.1.1.1
linkStateId
Type: IPV4ADDR
Default: 1.1.1.1
lsaAge
Type: INTEGER
Default: 0
lsaLength
Type: INTEGER
Default: 0
lsChecksum
Type: OCTETSTRING
Default: 0000
lsSequenceNumber
Type: OCTETSTRING
Default: 80000001
1142
header
Attribute
Description
lsType
Type: Ospfv2LsTypes
Default: 4
Possible Values:
Value Description
Name
Router
Network
Summary
Summary-ASBR
AS-External Type-5
AS-External Type-7
Type: string

Description:
Parents: ospfv2AsExternalLsa (StreamBlock.Ospfv2LinkStateUpdate.updatedLsas.Ospfv2Lsa.ospfv2AsExternalLsa)

header Attributes
Attribute
Description
advertisingRouter
Type: IPV4ADDR
Default: 1.1.1.1
linkStateId
Type: IPV4ADDR
Default: 1.1.1.1
lsaAge
Type: INTEGER
Default: 0
lsaLength
Type: INTEGER
Default: 0
lsChecksum
Type: OCTETSTRING
Default: 0000
lsSequenceNumber
Type: OCTETSTRING
Default: 80000001
1143
header
Attribute
Description
lsType
Type: Ospfv2LsTypes
Default: 5
Possible Values:
Value Description
Name
Router
Network
Summary
Summary-ASBR
AS-External Type-5
AS-External Type-7
Type: string
header Object (pim PDU library)

Description:
Parents: Pimv4Hello (StreamBlock.Pimv4Hello)

Pimv4Register (StreamBlock.Pimv4Register)
Pimv4RegisterStop (StreamBlock.Pimv4RegisterStop)
Pimv4JoinPrune (StreamBlock.Pimv4JoinPrune)
Pimv4NullRegister (StreamBlock.Pimv4NullRegister)
Children: None
header Attributes
Attribute
Description
checksum
Type: INTEGER
Default: 0
Name
more information.
Type: string
reserved
Type: INTEGER
Default: 0
1144
header
Attribute
Description
type
Type: PimMessageType
Default: 0
Possible Values:
Value Description
version
Hello
Register
Register-Stop
Join/Prune
Bootstrap
Assert
Graft
Graft-Ack
Candidate-RP-Advertisement
Type: INTEGER
Default: 2
header Object (pim PDU library)

Description:

Pimv6Register (StreamBlock.Pimv6Register)
Pimv6RegisterStop (StreamBlock.Pimv6RegisterStop)
Children: None
header Attributes
Attribute
Description
checksum
Type: INTEGER
Default: 0
Name
more information.
Type: string
reserved
Type: INTEGER
Default: 0
1145
helloOptions
Attribute
Description
type
Type: PimMessageType
Default: 0
Possible Values:
Value Description
version
Hello
Register
Register-Stop
Join/Prune
Bootstrap
Assert
Graft
Graft-Ack
Candidate-RP-Advertisement
Type: INTEGER
Default: 2
helloOptions
Description:
OSPFv2 Hello Options field. See RFC 2328.
Children: None
helloOptions Attributes
Attribute
Description
dcBit
Type: BITSTRING
Default: 0
eaBit
Type: BITSTRING
Default: 0
eBit
Type: BITSTRING
Default: 0
mcBit
Type: BITSTRING
Default: 0
Name
Type: string
npBit
Type: BITSTRING
Default: 0
reserved0
Type: BITSTRING
Default: 0
reserved6
Type: BITSTRING
Default: 0
reserved7
Type: BITSTRING
Default: 0
1146
HelpCommand
HelpCommand
Description:
Provides help information for objects.

HelpCommand Writable Attributes

Writable Attribute
Description
HelpKey
Item to display help information on. This can be a stringHandle, a class name, or a subclass name.
Type: string
Default: Scriptable
HelpCommand Read-Only Attributes

Read-Only Attribute
Description

HelpInfo
Class's help information.

Type: string
Default: 0
HighResolutionSamplingGetChartCommand
Description:
Retrieves the high resolution sampling chart.

HighResolutionSamplingGetChartCommand Writable Attributes

Writable Attribute
Description
ConfigClassId

Type: string
Default: 0
ResultClassId
Result class ID.

Type: string
Default: 0
ResultDataSet
Handle of result data set that need to do high resolution sampling.

Type: handle
Default: 0
1147
HighResolutionSamplingPortConfig
HighResolutionSamplingGetChartCommand Read-Only Attributes

Read-Only Attribute
Description

Description:
Configuration parameters for port-level high resolution measurement.

Result children (automatically created): HighResolutionSamplingPortResults
Relations:
Side name
(Type)
Relative
Description
ResultChild
(ResultChild)
HighResolutionSamplingPortResults
HighResolutionSamplingPortConfig Writable Attributes

Writable Attribute
Description
Active, Name
BaselineSampleCount

Type: u8
Default: 3
EnableTrigger

Type: bool
Default: TRUE
Possible Values:
Value Description
TRUE
Enable triggering.

SamplingDuration
Duration of the sample polling period in ms.

Type: u16
Default: 10
Range: 1 - 100
SamplingInterval
Interval for polling the samples in ms.

Type: u16
Default: 10
Range: 1 - 100
TimingMode
Mode used for timing purposes.

Type: enum
Default: INTERVAL
Possible Values:
Value
Description
INTERVAL Interval timing mode.
DURATION Duration timing mode.
1148
Writable Attribute
Description
TriggerCondition

Type: enum
Default: LESS_THAN
Possible Values:
Value
Description
LESS_THAN
LESS_THAN_OR_EQUAL
Less than or equal to.
GREATER_THAN
Greater than.
GREATER_THAN_OR_EQUAL Greater than or equal to.

EQUAL
Equal to.
NOT_EQUAL
Not equal to.
TriggerLocation
Trigger location.
Type: u8
Default: 20
Range: 0 - 99
TriggerStat

Type: string
Default: TotalFrameRate
TriggerValue
Value to use for the trigger.

Type: double
Default: 95

Type: enum
Possible Values:
Value
Description
PERCENT_BASELINE
Percent of baseline.
ABSOLUTE
Absolute value.
KILOBITS_PER_SECOND
Bit rate in Kbps.
MEGABITS_PER_SECOND Bit rate in Mbps.

GIGABITS_PER_SECOND
Bit rate in Gbps.
HighResolutionSamplingPortConfig Read-Only Attributes

Read-Only Attribute
Description
BufferingState
Stored buffer state.

Type: enum
Default: READY
Possible Values:
Value
Description
READY
Ready
FILLED
Filled
RUNNING
Running
PENDING_START Starting
PENDING_STOP
EventTriggeredStatus
Stopping
Trigger status.
Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
Enabled
FALSE Disabled
1149
Read-Only Attribute
Description
TotalSamples
Total number of samples supported for port high resolution.

Type: u16
Default: 1000
Description:
Result object for high resolution.

Parents: HighResolutionSamplingPortConfig
Relations:
Side name
(Type)
Relative
Description
ParentResult
(ResultChild)
HighResolutionSamplingPortResults Writable Attributes

HighResolutionSamplingPortResults Read-Only Attributes

Read-Only Attribute
Description
StartRealSampleIndex
Start index for real samples.

Type: u16
Default: 0
TimeList
Collection of timestamp for sampling instances.

Type: double
Default: 0
TriggerIndex
Location of the trigger, if any. -1 no trigger index.

Type: s64
Default: -1
TriggerName
Name of the trigger to display.

Type: string
Default: N/A
TriggerValue
Actual trigger value - use to render the baseline, -1 means no trigger value.
Type: s64
Default: 0
ValueList
Collection of values for sampling instances.

Type: double
Default: 0
HighResolutionSamplingStartCommand
Description:
1150
HighResolutionSamplingStopCommand
Start high resolution measurement.

HighResolutionSamplingStartCommand Writable Attributes

Writable Attribute
Description
ConfigClassId

Type: string
Default: 0
HandleList
List of object handles to start high resolution sampling.

Type: handle
Default: 0
ResultClassId
Result class ID.

Type: string
Default: 0
HighResolutionSamplingStartCommand Read-Only Attributes

Read-Only Attribute
Description

HighResolutionSamplingStopCommand
Description:
Stop high resolution measurement.

HighResolutionSamplingStopCommand Writable Attributes

Writable Attribute
Description
ConfigClassId

Type: string
Default: 0
HandleList
List of object handles to start high resolution sampling.

Type: handle
Default: 0
ResultClassId
Result class ID.

Type: string
Default: 0
1151
HighResolutionSamplingStreamBlockConfig
HighResolutionSamplingStopCommand Read-Only Attributes

Read-Only Attribute
Description

Description:
Result object for high resolution stream block sampling.

Parents: Analyzer
Result children (automatically created): HighResolutionSamplingStreamBlockResults
Relations:
Side name
(Type)
Relative
Description
AffiliationStreamBlock
(AffiliationHighResolutionStreamBlock)
StreamBlock
Related stream block. for which sampling is performed.
CarryChainTo
(CarryChainFrom)
Sample on which start sampling is depend on.
ResultChild
(ResultChild)
HighResolutionSamplingStreamBlockResults
HighResolutionSamplingStreamBlockConfig Writable Attributes

Writable Attribute
Description
Active, Name
BaselineSampleCount

Type: u8
Default: 3
EnableTrigger

Type: bool
Default: TRUE
Possible Values:
Value Description
TRUE
Enable triggering.

SamplingDuration

Type: u16
Default: 10
Range: 1 - 100
SamplingInterval

Type: u16
Default: 10
Range: 1 - 100
1152
Writable Attribute
Description
TimingMode

Type: enum
Default: INTERVAL
Possible Values:
Value
Description
INTERVAL Interval timing mode.
DURATION Duration timing mode.
TotalSamples
Total number of samples supported for high resolution sampling.

Type: u16
Default: 1000
TriggerCondition

Type: enum
Default: LESS_THAN
Possible Values:
Value
Description
LESS_THAN
LESS_THAN_OR_EQUAL
Less than or equal to.
GREATER_THAN
Greater than.
GREATER_THAN_OR_EQUAL Greater than or equal to.

EQUAL
Equal to.
NOT_EQUAL
Not equal to.
TriggerLocation
Trigger location.
Type: u8
Default: 20
Range: 0 - 99
TriggerStat

Type: string
Default: TotalFrameRate
TriggerValue
Value to use for trigger condition.

Type: double
Default: 95

Type: enum
Possible Values:
Value
Description
PERCENT_BASELINE
Percent of baseline.
ABSOLUTE
Absolute value.
KILOBITS_PER_SECOND
Bit rate in Kbps.
MEGABITS_PER_SECOND Bit rate in Mbps.

GIGABITS_PER_SECOND
Bit rate in Gbps.
1153
HighResolutionSamplingStreamBlockConfig Read-Only Attributes

Read-Only Attribute
Description
BufferingState
Stored buffer state.

Type: enum
Default: READY
Possible Values:
Value
Description
READY
Ready
FILLED
Filled
RUNNING
Running
PENDING_START Starting
PENDING_STOP
EventTriggeredStatus
Stopping
Trigger status.
Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
Enabled
FALSE Disabled
Description:
High resolution sampling stream block results.

Parents: HighResolutionSamplingStreamBlockConfig
Relations:
Side name
(Type)
Relative
Description
ParentResult
(ResultChild)
HighResolutionSamplingStreamBlockResults Writable Attributes

HighResolutionSamplingStreamBlockResults Read-Only Attributes

Read-Only Attribute
Description
StartRealSampleIndex
Start index for real samples.

Type: u16
Default: 0
TimeList
Collection of timestamp for sampling instances.

Type: double
Default: 0
TriggerIndex
Location of the trigger, if any. -1 no trigger index.

Type: s64
Default: -1
1154
HighResolutionSamplingTriggerCommand
Read-Only Attribute
Description
TriggerName
Name of the trigger to display.

Type: string
Default: N/A
TriggerValue
Actual trigger value - use to render the baseline, -1 means no trigger value.
Type: s64
Default: 0
ValueList
Collection of values for sampling instances.

Type: double
Default: 0
HighResolutionSamplingTriggerCommand
Description:
Manually set trigger point for high resolution sampling on a port or ports.

HighResolutionSamplingTriggerCommand Writable Attributes

Writable Attribute
Description
ConfigClassId

Type: string
Default: 0
HandleList
List of object handles to trigger high resolution sampling.

Type: handle
Default: 0
ResultClassId
Result class ID.

Type: string
Default: 0
HighResolutionSamplingTriggerCommand Read-Only Attributes

Read-Only Attribute
Description

HighResolutionStreamBlockOptions
Description:
Config objects for stream block sampling common parameter for ports.
1155
HloReq
Parents: Analyzer
HighResolutionStreamBlockOptions Writable Attributes

Writable Attribute
Description
Active, Name
SamplingDuration

Type: u16
Default: 10
Range: 1 - 100
SamplingInterval

Type: u16
Default: 10
Range: 1 - 100
TimingMode

Type: enum
Default: INTERVAL
Possible Values:
Value
Description
INTERVAL Interval as sampling time mode.
DURATION Duration as sampling time mode.
HighResolutionStreamBlockOptions Read-Only Attributes

HloReq (fcsw:HloReq)
Description:
Children: fspfHeader
HloReq Attributes
Attribute
Description
deadInterval
Type: INTEGER
Default: 80
helloInterval
Type: INTEGER
Default: 20
Name
Type: string
originatingPortIndex
Type: INTEGER
Default: 0
recipientDomainID
Type: OCTETSTRING
Default: 00000001
reserved1
Type: OCTETSTRING
Default: 00000000
1156
hloRequest
Attribute
Description
reserved2
Type: OCTETSTRING
Default: 00
hloRequest
Description:
Children: fspfHeader
hloRequest Attributes
Attribute
Description
deadInterval
Type: INTEGER
Default: 80
helloInterval
Type: INTEGER
Default: 20
Name
Type: string
originatingPortIndex
Type: INTEGER
Default: 0
recipientDomainID
Type: OCTETSTRING
Default: 00000001
reserved1
Type: OCTETSTRING
Default: 00000000
reserved2
Type: OCTETSTRING
Default: 00
holdTime
Description:
The Hold Time option in the PIM Hello message. See RFC 3973.
Children: None
holdTime Attributes
Attribute
Description
length
Type: INTEGER
Default: 2
1157
Host
Attribute
Description
Name
more information.
Type: string
type
Type: INTEGER
Default: 1
value
Type: INTEGER
Default: 105
Host
Description:
Host device object.

Parents: Project
Automatically created from: ExternalDevicePort, Port
Relations:
Side name
(Type)
Relative
Description
AffiliatedRouter
(AffiliatedRouter)
EmulatedDevice
AffiliatedPort
(AffiliationPort)
Port
PrimaryIf
(PrimaryIf)


DUT.
TopLevelIf
(TopLevelIf)


interface stack.
Host Writable Attributes

Writable Attribute
Description
Active, Name
DeviceCount
Type: u32
Default: 1
EnablePingResponse
Enable host to response ping.

Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
FALSE
RouterId
Type: ip
Default: 192.0.0.1
1158
HostGenParams
Host Read-Only Attributes

HostGenParams
Description:
Defines parameters for generating Host objects.

Relations:
Side name
(Type)
Relative
Description
TopLevelIf

Port
(SelectedPort)
Port
Collection of ports to generate hosts on.
HostGenParams Writable Attributes

Writable Attribute
Description
Active, Name
BlockMode
Host objects may be used to represent a single host or a block of many hosts for higher scalability. Host blocks are
not supported by all protocols and have less granularity of control at the protocol level and in traffic configuration.
Type: enum
Default: ONE_NETWORK_PER_BLOCK
Possible Values:
Value
Description
ONE_HOST_PER_BLOCK
One Host block is created for each host.
ONE_DEVICE_PER_BLOCK
One Host block is created for each host.
ONE_NETWORK_PER_BLOCK
One Host block is created for each network.
MULTIPLE_NETWORKS_PER_BLOCK One Host block may represent multiple networks. Note: There are
limitations to what can be represented as a single Host block using this
mode.
Count
Number of Hosts to create per port/VLAN.

Type: u32
Default: 1
Range: 1 - 4294967295
1159
HostGroup
Writable Attribute
Description
GroupAssignmentMode

Type: enum
Possible Values:
Value
Description
ALL_SAME_GROUPS All hosts are assigned to the same group(s).
PortType
Type of port to generate hosts on.

Type: enum
Default: ETHERNET
Possible Values:
Value
Description
ETHERNET Ethernet.
POS
POS (PPP/HDLC).
ATM
ATM.
FC
PreviewMaxCount
Maximum number of Hosts to return in the preview.

Type: u32
Default: 1000
Range: 1 - 100000
Maximum number of hosts to show in the preview for each increment level (for example, port, VLAN, host, and so
on). This is used to reduce the number of items in the preview. This option is only applicable in PARTIAL preview
mode.
Type: u32
Default: 3
Range: 1 - 100000
PreviewMode
Preview mode.
Type: enum
Default: FULL
Possible Values:
Value
Description
FULL
Show all hosts in the preview.
PARTIAL Show a subset of the hosts in the preview.

BLOCK
StepOrder
Show all host blocks in the preview.
Type: string
HostGenParams Read-Only Attributes

HostGroup
Description:
Used to define a grouping of host objects.

Parents: Project
1160
hostName
Relations:
Side name
(Type)
Relative
MemberOfGroup
(GroupMembership)
DeviceGroup, EmulatedDevice
GroupTypeSource
(GroupOfType)
GroupType
Description
HostGroup Writable Attributes

Writable Attribute
Description
Active, Name
GroupName
Name of the group.

Type: string
HostGroup Read-Only Attributes

hostName
Description:
Used to specify a host name for the DHCP message
Parents: DHCPOption
Children: None
hostName Attributes
Attribute
Description
length
Type: OCTETSTRING
Default: 06
Name
more information.
Type: string
type
Type: OCTETSTRING
Default: 0C
value
Type: OCTETSTRING
Default: 636c69656e74
hostUniq
Description:
Parents: PPPoETag
Children: None
1161
HostUuidTlv
hostUniq Attributes
Attribute
Description
length
Type: OCTETSTRING
Default: 0000
Name
more information.
Type: string
type
Type: OCTETSTRING
Default: 0103
value
Type: OCTETSTRING
HostUuidTlv
Description:
Children: None
HostUuidTlv Attributes
Attribute
Description
HostUuid
Type: OCTETSTRING
Length
Type: INTEGER
Default: 0
Name
more information.
Type: string
Type
Type: INTEGER
Default: 8
HttpClientProtocolConfig
Description:

Result children (automatically created): HttpClientResults
Relations:
1162
Side name
(Type)
Relative
Description
ClientLoadProfile
ClientLoadProfile
ClientProfile
ClientProfile
ResultChild
(ResultChild)
HttpClientResults
UsesIf
(UsesIf)


HttpClientProtocolConfig Writable Attributes

Writable Attribute
Description
Active, Name
ClientName
User-defined name for the client. Relevant only to the user.

Type: string
DynamicLoad
Type: s32
Default: 30
Range: 1 - 500000

Type: enum
Default: PAIR
Possible Values:
Value
Description
PAIR
Pair connections.
BACKBONE_SRC_FIRST
BACKBONE_DST_FIRST


Type: u32
Default: 10
Range: 1 - 4294967295
Unused.
Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
Unused.
FALSE Unused.
1163
HttpClientProtocolProfile
HttpClientProtocolConfig Read-Only Attributes

Read-Only Attribute
Description
LoadProfileRunState

Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
Is running.
HttpClientProtocolProfile
Description:
HTTP protocol-specific attributes for a potential HTTP client.

Parents: ClientProfile
HttpClientProtocolProfile Writable Attributes

Writable Attribute
Description
Active, Name
EnableKeepAlive
Indicate if client should use connection control to maintain open connection to server.
Type: bool
Default: TRUE
Possible Values:
Value Description
TRUE
Use connection control to maintain open connect to server.
FALSE Don't use connection control to maintain open connect to server.

EnablePipelining
Indicate if client should pipeline HTTP requests to server.

Type: bool
Default: TRUE
Possible Values:
Value Description
TRUE
Pipeline HTTP requests.
FALSE Don't pipeline HTTP requests.

HttpVersion
HTTP version to be used by the server.

Type: enum
Default: VERSION_1_1
Possible Values:
Value
Description
VERSION_1_0 HTTP version 1.0.
MaxPipelineDepth
Maximum depth of HTTP request pipeline.

Type: u8
Default: 8
Range: 1 - 255
UserAgentHeader
String to enter a user agent header.

Type: string
1164
HttpClientResults
HttpClientProtocolProfile Read-Only Attributes

HttpClientResults
Description:
HTTP client results.

Parents: HttpClientProtocolConfig
Relations:
Side name
(Type)
Relative
Description
ResultParent
(ResultChild)
HttpClientResults Writable Attributes

HttpClientResults Read-Only Attributes

Read-Only Attribute
Description
AbortedConnections

Type: u64
Default: 0
Type: u64
Default: 0
AbortedTransactions

Type: u64
Default: 0
Type: u64
Default: 0
ActiveConnections
Number of connections open or attempting for this client at this instant. Note: Active Connections on
the server will typically be fewer in number than Active Connections on the associated client due to
differences in the events that inform the server and client processes that a connection has been
started and terminated.
Type: u32
Default: 0
Total number of attempted connections from the client block.

Type: u64
Default: 0
Type: u64
Default: 0

Type: u64
Default: 0
1165
HttpClientResults
Read-Only Attribute
Description
Type: u64
Default: 0
AvgResponseTimePerUrlMsec
Average response time per URL in milliseconds.

Type: u64
Default: 0
BlockIndex
Internally-allocated index for this HTTP client block.

Type: u32
Default: 0
ElapsedSeconds
Time duration in seconds that this client block instance has been running.
Type: u64
Default: 0
GoodputAvgRxRateBps

Type: u64
Default: 0
GoodputAvgTxRateBps

Type: u64
Default: 0
GoodputMaxRxRateBps

Type: u64
Default: 0
GoodputMaxTxRateBps

Type: u64
Default: 0
GoodputMinRxRateBps

Type: u64
Default: 0
GoodputMinTxRateBps

Type: u64
Default: 0
GoodputRxBps

Type: u64
Default: 0
GoodputRxBytes

Type: u64
Default: 0
GoodputTxBps

Type: u64
Default: 0
GoodputTxBytes

Type: u64
Default: 0
IntendedLoad
Type: u32
Default: 0
MaxResponseTimePerUrlMsec
Maximum response time per URL in milliseconds.

Type: u64
Default: 0
1166
HttpProtocolParams
Read-Only Attribute
Description
MinResponseTimePerUrlMsec
Minimum response time per URL in milliseconds.

Type: u64
Default: 0
ParentName
Name of parent protocol for which the results apply.

Type: string
RxResponseCode200

Type: u64
Default: 0
RxResponseCode400

Type: u64
Default: 0
RxResponseCode404

Type: u64
Default: 0
RxResponseCode405

Type: u64
Default: 0

Type: u64
Default: 0
Type: u64
Default: 0

Type: u64
Default: 0
Type: u64
Default: 0
SumResponseTimePerUrlMsec
Sum of response times per URL in milliseconds.

Type: u64
Default: 0

Type: u64
Default: 0
Type: u64
Default: 0

Type: u64
Default: 0
Type: u64
Default: 0
HttpProtocolParams
1167
HttpServerProtocolConfig
Description:
Configure HTTP specific parameters in the ALP Traffic Wizard.

Relations:
Side name
(Type)
Relative
ClientLoadProfile
ClientLoadProfile
ClientProfile
ClientProfile
ServerProfile
ServerProfile
Description
HttpProtocolParams Writable Attributes

Writable Attribute
Description
Active, Name

Type: u32
Default: 10
Range: 1 - 4294967295

Type: u32
Default: 4294967295
Range: 1 - 4294967295

Type: u32
Default: 10
Range: 1 - 4294967295
HttpProtocolParams Read-Only Attributes

Description:
HTTP protocol client.

Result children (automatically created): HttpServerResults
Relations:
Side name
(Type)
Relative
Description
ServerProfile
ServerProfile
Specifies server profile used by a server.
1168
HttpServerProtocolProfile
Side name
(Type)
Relative
Description
ResultChild
(ResultChild)
HttpServerResults
UsesIf
(UsesIf)


HttpServerProtocolConfig Writable Attributes

Writable Attribute
Description
Active, Name

Type: u32
Default: 10
Range: 1 - 4294967295

Type: u32
Default: 4294967295
Range: 1 - 4294967295
ServerName
Type: string
Unused.
Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
Unused.
FALSE Unused.
HttpServerProtocolConfig Read-Only Attributes

HttpServerProtocolProfile
Description:
HTTP protocol-specific attributes for a potential HTTP server.

Children: BinaryResponseHeaderConfig, TextHtmlResponseHeaderConfig
Automatically-created children: BinaryResponseHeaderConfig, HttpServerResponseConfig, TextHtmlResponseHeaderConfig
HttpServerProtocolProfile Writable Attributes

Writable Attribute
Description
Active, Name
1169
HttpServerResponseConfig
Writable Attribute
Description
HttpServerTypes
Type of HTTP server to be emulated.

Type: enum
Default: MICROSOFT_IIS
Possible Values:
Value
Description
MICROSOFT_IIS Microsoft Internet Information Services.
APACHE
HttpVersion
Apache HTTP Server.
HTTP version to be used by the server.

Type: enum
Default: VERSION_1_1
Possible Values:
Value
Description
ServerPortNum

Type: u16
Default: 80
Range: 1 - 65535
HttpServerProtocolProfile Read-Only Attributes

HttpServerResponseConfig
Description:
Common response configuration options for an HTTP server.

Automatically created from: HttpServerProtocolProfile
HttpServerResponseConfig Writable Attributes

Writable Attribute
Description
Active, Name
BodyContentType

Type: enum
Default: ASCII
Possible Values:
Value
Description
ASCII
ASCII content type.

BodySizeType

Type: enum
Default: FIXED
Possible Values:
Value
Description
FIXED
Fixed body size.
1170
HttpServerResults
Writable Attribute
Description
FixedBodySize

Type: u32
Default: 64
Type: u32
Default: 0
RandomBodySizeMean
Type: u32
Default: 0
Type: u32
Default: 0

Type: u32
Default: 0
Type: u32
Default: 0
ResponseTimingType

Type: enum
Default: FIXED
Possible Values:
Value
Description
FIXED
HttpServerResponseConfig Read-Only Attributes

HttpServerResults
Description:
HTTP server results.

Parents: HttpServerProtocolConfig
Relations:
Side name
(Type)
Relative
Description
ResultParent
(ResultChild)
HttpServerResults Writable Attributes

1171
HttpServerResults
HttpServerResults Read-Only Attributes

Read-Only Attribute
Description
ActiveConnections
Number of connections open (accepted) for this server at this instant. Note: Active Connections on the
server will typically be fewer in number than Active Connections on the associated client due to
differences in the events that inform the server and client processes that a connection has been started
and terminated.
Type: u32
Default: 0
BlockIndex
Internally-allocated index for this HTTP server block.

Type: u32
Default: 0
ElapsedSeconds
Time duration in seconds that this server block has been running.
Type: u64
Default: 0
GoodputAvgRxRateBps

Type: u64
Default: 0
GoodputAvgTxRateBps

Type: u64
Default: 0
GoodputMaxRxRateBps

Type: u64
Default: 0
GoodputMaxTxRateBps

Type: u64
Default: 0
GoodputMinRxRateBps

Type: u64
Default: 0
GoodputMinTxRateBps

Type: u64
Default: 0
GoodputRxBps

Type: u64
Default: 0
GoodputRxBytes

Type: u64
Default: 0
GoodputTxBps

Type: u64
Default: 0
GoodputTxBytes

Type: u64
Default: 0
ParentName

Type: string
Total number of successful transactions from the server block.

Type: u64
Default: 0
1172
HubSpokeTopologyGenParams
Read-Only Attribute
Description
Total number of successful transactions per second from the server block.
Type: u64
Default: 0
TotalConnections
Total number of connections handled by this HTTP server.

Type: u64
Default: 0
TotalConnectionsPerSecond
Total number of connections per second from the server block.

Type: u64
Default: 0
TxResponseCode200

Type: u64
Default: 0
TxResponseCode400

Type: u64
Default: 0
TxResponseCode404

Type: u64
Default: 0
TxResponseCode405

Type: u64
Default: 0
Total number of unsuccessful transactions from the server block.

Type: u64
Default: 0
Total number of unsuccessful transactions per second from the server block.
Type: u64
Default: 0
HubSpokeTopologyGenParams
Description:
Hub and spoke topology generation parameters. The specified hub and spoke topology is created on each emulated router.

HubSpokeTopologyGenParams Writable Attributes

Writable Attribute
Description
Active, Name
1173
IcmpDestUnreach
Writable Attribute
Description
EmulatedRouterPos
Location of the emulated router in the hub and spoke topology.

Type: enum
Default: ATTACHED_TO_HUB
Possible Values:
Value
Description
ATTACHED_TO_HUB
Emulated router is attached to a hub simulated router.
ATTACHED_TO_SPOKE Emulated router is attached to a spoke simulated router.
NumRouters
MEMBER_HUB
Emulated router is a member as a hub.
MEMBER_SPOKE
Emulated router is a member as a spoke.
Total number of routers in the hub and spoke topology.

Type: u16
Default: 10
Range: 1 - 100
HubSpokeTopologyGenParams Read-Only Attributes

IcmpDestUnreach (icmp:IcmpDestUnreach)
Description:
ICMP Destination Unreachable message. See RFC 792.
Children: ipData
IcmpDestUnreach Attributes
Attribute
Description
checksum
Type: INTEGER
Default: 0
code
Type: IcmpDestUnreachCode
Default: 0
Possible Values:
Value Description
Name
Net Unreachable
Host Unreachable
Protocol Unreachable
Port Unreachable
Fragmentation Needed
Source Route Failed
information.
Type: string
1174
IcmpEchoReply
Attribute
Description
type
Type: IcmpType
Default: 3
Possible Values:
Value Description
unused
Echo Reply
Destination Unreachable
Source Quench
Redirect
Echo Request
11
Time Exceeded
12
Parameter Problem
13
Timestamp Request
14
Timestamp Reply
15
Information Request
16
Information Reply
Type: INTEGER
Default: 0
IcmpEchoReply (icmp:IcmpEchoReply)
Description:
ICMP Echo Reply message. See RFC 792.
Children: None
IcmpEchoReply Attributes
Attribute
Description
checksum
Type: INTEGER
Default: 0
code
Type: INTEGER
Default: 0
data
Type: OCTETSTRING
Default: 0000
identifier
Type: INTEGER
Default: 0
Name
more information.
Type: string
seqNum
Type: INTEGER
Default: 0
1175
IcmpEchoRequest
Attribute
Description
type
Type: IcmpType
Default: 0
Possible Values:
Value Description
0
Echo Reply
Source Quench
Redirect
Echo Request
11
Time Exceeded
12
Parameter Problem
13
Timestamp Request
14
Timestamp Reply
15
Information Request
16
Information Reply
IcmpEchoRequest (icmp:IcmpEchoRequest)
Description:
ICMP echo request message. See RFC 792.
Children: None
IcmpEchoRequest Attributes
Attribute
Description
checksum
Type: INTEGER
Default: 0
code
Type: INTEGER
Default: 0
data
Type: OCTETSTRING
Default: 0000
identifier
Type: INTEGER
Default: 0
Name
more information.
Type: string
seqNum
Type: INTEGER
Default: 0
1176
IcmpInfoReply
Attribute
Description
type
Type: IcmpType
Default: 8
Possible Values:
Value Description
0
Echo Reply
Source Quench
Redirect
Echo Request
11
Time Exceeded
12
Parameter Problem
13
Timestamp Request
14
Timestamp Reply
15
Information Request
16
Information Reply
IcmpInfoReply (icmp:IcmpInfoReply)
Description:
ICMP Information Reply message. See RFC 792.
Children: None
IcmpInfoReply Attributes
Attribute
Description
checksum
Type: INTEGER
Default: 0
code
Type: INTEGER
Default: 0
identifier
Type: INTEGER
Default: 0
Name
more information.
Type: string
seqNum
Type: INTEGER
Default: 0
1177
IcmpInfoRequest
Attribute
Description
type
Type: IcmpType
Default: 16
Possible Values:
Value Description
0
Echo Reply
Source Quench
Redirect
Echo Request
11
Time Exceeded
12
Parameter Problem
13
Timestamp Request
14
Timestamp Reply
15
Information Request
16
Information Reply
IcmpInfoRequest (icmp:IcmpInfoRequest)
Description:
ICMP Information Request message. See RFC 792.
Children: None
IcmpInfoRequest Attributes
Attribute
Description
checksum
Type: INTEGER
Default: 0
code
Type: INTEGER
Default: 0
identifier
Type: INTEGER
Default: 0
Name
more information.
Type: string
seqNum
Type: INTEGER
Default: 0
1178
IcmpParameterProblem
Attribute
Description
type
Type: IcmpType
Default: 15
Possible Values:
Value Description
0
Echo Reply
Source Quench
Redirect
Echo Request
11
Time Exceeded
12
Parameter Problem
13
Timestamp Request
14
Timestamp Reply
15
Information Request
16
Information Reply
IcmpParameterProblem (icmp:IcmpParameterProblem)
Description:
ICMP Parameter Problem message. See RFC 792.
Children: ipData
IcmpParameterProblem Attributes
Attribute
Description
checksum
Type: INTEGER
Default: 0
code
Type: IcmpParameterProblemCode
Default: 0
Possible Values:
Value Description
0
Pointer Indicates Error
Name
information.
Type: string
pointer
Type: INTEGER
Default: 0
1179
IcmpRedirect
Attribute
Description
type
Type: IcmpType
Default: 12
Possible Values:
Value Description
unused
Echo Reply
Source Quench
Redirect
Echo Request
11
Time Exceeded
12
Parameter Problem
13
Timestamp Request
14
Timestamp Reply
15
Information Request
16
Information Reply
Type: INTEGER
Default: 0
IcmpRedirect (icmp:IcmpRedirect)
Description:
ICMP Redirect message. See RFC 792.
Children: ipData
IcmpRedirect Attributes
Attribute
Description
checksum
Type: INTEGER
Default: 0
code
Type: IcmpRedirectCode
Default: 0
Possible Values:
Value Description
0
Redirect Datagrams for Network
Redirect Datagrams for Host
Redirect Datagrams for ToS and Network
Redirect Datagrams for ToS and Host
gateway
Type: IPV4ADDR
Default: 192.0.0.1
Name
information.
Type: string
1180
IcmpSourceQuench
Attribute
Description
type
Type: IcmpType
Default: 5
Possible Values:
Value Description
0
Echo Reply
Source Quench
Redirect
Echo Request
11
Time Exceeded
12
Parameter Problem
13
Timestamp Request
14
Timestamp Reply
15
Information Request
16
Information Reply
IcmpSourceQuench (icmp:IcmpSourceQuench)
Description:
ICMP Source Quench message. See RFC 792.
Children: ipData
IcmpSourceQuench Attributes
Attribute
Description
checksum
Type: INTEGER
Default: 0
code
Type: INTEGER
Default: 0
Name
information.
Type: string
type
Type: IcmpType
Default: 4
Possible Values:
Value Description
0
Echo Reply
Source Quench
Redirect
Echo Request
11
Time Exceeded
12
Parameter Problem
13
Timestamp Request
14
Timestamp Reply
15
Information Request
16
Information Reply
1181
IcmpTimeExceeded
Attribute
Description
unused
Type: INTEGER
Default: 0
IcmpTimeExceeded (icmp:IcmpTimeExceeded)
Description:
ICMP Time Exceeded message. See RFC 792.
Children: ipData
IcmpTimeExceeded Attributes
Attribute
Description
checksum
Type: INTEGER
Default: 0
code
Type: IcmpTimeExceededCode
Default: 0
Possible Values:
Value Description
0
Time To Live Exceeded
Fragment Reassembly Time Exceeded
Name
information.
Type: string
type
Type: IcmpType
Default: 11
Possible Values:
Value Description
unused
Echo Reply
Source Quench
Redirect
Echo Request
11
Time Exceeded
12
Parameter Problem
13
Timestamp Request
14
Timestamp Reply
15
Information Request
16
Information Reply
Type: INTEGER
Default: 0
IcmpTimestampReply (icmp:IcmpTimestampReply)
1182
IcmpTimestampRequest
Description:
ICMP Timestamp Reply message. See RFC 792.
Children: None
IcmpTimestampReply Attributes
Attribute
Description
checksum
Type: INTEGER
Default: 0
code
Type: INTEGER
Default: 0
identifier
Type: INTEGER
Default: 0
Name
Type: string
originate
Type: INTEGER
Default: 0
receive
Type: INTEGER
Default: 0
seqNum
Type: INTEGER
Default: 0
transmit
Type: INTEGER
Default: 0
type
Type: IcmpType
Default: 14
Possible Values:
Value Description
0
Echo Reply
Source Quench
Redirect
Echo Request
11
Time Exceeded
12
Parameter Problem
13
Timestamp Request
14
Timestamp Reply
15
Information Request
16
Information Reply
IcmpTimestampRequest (icmp:IcmpTimestampRequest)
Description:
ICMP Timestamp message. See RFC 792.
Children: None
1183
Icmpv6DestUnreach
IcmpTimestampRequest Attributes
Attribute
Description
checksum
Type: INTEGER
Default: 0
code
Type: INTEGER
Default: 0
identifier
Type: INTEGER
Default: 0
Name
Type: string
originate
Type: INTEGER
Default: 0
receive
Type: INTEGER
Default: 0
seqNum
Type: INTEGER
Default: 0
transmit
Type: INTEGER
Default: 0
type
Type: IcmpType
Default: 13
Possible Values:
Value Description
0
Echo Reply
Source Quench
Redirect
Echo Request
11
Time Exceeded
12
Parameter Problem
13
Timestamp Request
14
Timestamp Reply
15
Information Request
16
Information Reply
Icmpv6DestUnreach (icmpv6:Icmpv6DestUnreach)
Description:
ICMPv6 Destination Unreachable message. See RFC 2463.
Children: ipData
1184
Icmpv6EchoReply
Icmpv6DestUnreach Attributes
Attribute
Description
checksum
Type: INTEGER
Default: 0
code
Type: Icmpv6DestUnreachCode
Default: 0
Possible Values:
Value Description
0
No Route To Destination
Communication with Destination Prohibited
Address Unreachable
Port Unreachable
Name
Type: string
type
Type: Icmpv6Type
Default: 1
Possible Values:
Value Description
unused
Packet Too Big
Time Exceeded
Parameter Problem
128
Echo Request
129
Echo Reply
130
MLDv1 Query
131
MLDv1 Listener Report
132
MLDv1 Listener Done
133
Router Solicitation
134
Router Advertisement
135
Neighbor Solicitation
136
Neighbor Advertisement
137
Redirect
143
Type: INTEGER
Default: 0
Icmpv6EchoReply (icmpv6:Icmpv6EchoReply)
Description:
ICMPv6 Echo Reply message. See RFC 2463.
Children: None
1185
Icmpv6EchoRequest
Icmpv6EchoReply Attributes
Attribute
Description
checksum
Type: INTEGER
Default: 0
code
Type: INTEGER
Default: 0
data
Type: OCTETSTRING
Default: 0000
identifier
Type: INTEGER
Default: 0
Name
information.
Type: string
seqNum
Type: INTEGER
Default: 0
type
Type: Icmpv6Type
Default: 129
Possible Values:
Value Description
1
Packet Too Big
Time Exceeded
Parameter Problem
128
Echo Request
129
Echo Reply
130
MLDv1 Query
131
132
MLDv1 Listener Done
133
Router Solicitation
134
135
136
137
Redirect
143
Icmpv6EchoRequest (icmpv6:Icmpv6EchoRequest)
Description:
ICMPv6 Echo Request message. See RFC 2463.
Children: None
Icmpv6EchoRequest Attributes
Attribute
Description
checksum
Type: INTEGER
Default: 0
1186
Icmpv6PacketTooBig
Attribute
Description
code
Type: INTEGER
Default: 0
data
Type: OCTETSTRING
Default: 0000
identifier
Type: INTEGER
Default: 0
Name
information.
Type: string
seqNum
Type: INTEGER
Default: 0
type
Type: Icmpv6Type
Default: 128
Possible Values:
Value Description
1
Packet Too Big
Time Exceeded
Parameter Problem
128
Echo Request
129
Echo Reply
130
MLDv1 Query
131
132
MLDv1 Listener Done
133
Router Solicitation
134
135
136
137
Redirect
143
Icmpv6PacketTooBig (icmpv6:Icmpv6PacketTooBig)
Description:
ICMPv6 Packet Too Big message. See RFC 2463.
Children: ipData
Icmpv6PacketTooBig Attributes
Attribute
Description
checksum
Type: INTEGER
Default: 0
code
Type: INTEGER
Default: 0
1187
Icmpv6ParameterProblem
Attribute
Description
mtu
Type: INTEGER
Default: 0
Name
information.
Type: string
type
Type: Icmpv6Type
Default: 2
Possible Values:
Value Description
1
Packet Too Big
Time Exceeded
Parameter Problem
128
Echo Request
129
Echo Reply
130
MLDv1 Query
131
132
MLDv1 Listener Done
133
Router Solicitation
134
135
136
137
Redirect
143
Icmpv6ParameterProblem (icmpv6:Icmpv6ParameterProblem)
Description:
ICMPv6 Parameter Problem message. See RFC 2463.
Children: ipData
Icmpv6ParameterProblem Attributes
Attribute
Description
checksum
Type: INTEGER
Default: 0
code
Type: Icmpv6ParameterProblemCode
Default: 0
Possible Values:
Value Description
Name
Erroneous Header Field
Unrecognized Next Header Type
Unrecognized IPv6 Option
Type: string
1188
Icmpv6TimeExceeded
Attribute
Description
pointer
Type: INTEGER
Default: 0
type
Type: Icmpv6Type
Default: 4
Possible Values:
Value Description
1
Packet Too Big
Time Exceeded
Parameter Problem
128
Echo Request
129
Echo Reply
130
MLDv1 Query
131
132
MLDv1 Listener Done
133
Router Solicitation
134
135
136
137
Redirect
143
Icmpv6TimeExceeded (icmpv6:Icmpv6TimeExceeded)
Description:
ICMPv6 Time Exceeded message. See RFC 2463.
Children: ipData
Icmpv6TimeExceeded Attributes
Attribute
Description
checksum
Type: INTEGER
Default: 0
code
Type: Icmpv6TimeExceededCode
Default: 0
Possible Values:
Value Description
Name
Hop Limit Exceeded
Fragment Reassembly Time Exceeded
Type: string
1189
IdleFrame
Attribute
Description
type
Type: Icmpv6Type
Default: 3
Possible Values:
Value Description
unused
Packet Too Big
Time Exceeded
Parameter Problem
128
Echo Request
129
Echo Reply
130
MLDv1 Query
131
132
MLDv1 Listener Done
133
Router Solicitation
134
135
136
137
Redirect
143
Type: INTEGER
Default: 0
IdleFrame (RPR:IdleFrame)
Description:
Children: baseControl
IdleFrame Attributes
Attribute
Description
idlePayLoad
Type: OCTETSTRING
Default: 00000000
Name
more information.
Type: string
srcMac
Type: MACADDR
Default: 00:00:01:00:00:02
ttl
Type: OCTETSTRING
Default: 1
Description:
1190

Result children (automatically created): ClockSynchronizationResult, ForeignMasterClockResults, Ieee1588v2ClockResult, ParentClockInfoResult,
TimePropertiesResult
Relations:
Side name
(Type)
Relative
Description
ResultChild
(ResultChild)
ClockSynchronizationResult, ForeignMasterClockResults,
Ieee1588v2ClockResult, ParentClockInfoResult,
TimePropertiesResult
UsesIf
(UsesIf)


Ieee1588v2ClockConfig Writable Attributes

Writable Attribute
Description
Active, Name
AnnounceReceiptTimeout
Type: u8
Default: 3
Range: 3 - 255
ClockClass
Type: u8
Default: 248
ClockIdentity
Type: u64
Default: 0xACDE480000000000
ConfigCorrectionField
Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
FALSE
DelayMechanism
Type: enum
Default: REQUEST_RESPONSE
Possible Values:
Value
Description
REQUEST_RESPONSE
DelayRequestCorrectionField
Type: s64
Default: 0
DelayResponseCorrectionField
Type: s64
Default: 0
DomainNum
Type: u8
Default: 0
Encap
Type: enum
Default: UDP_IPV4
Possible Values:
Value
Description
UDP_IPV4
UDP_IPV6
ETHERNET
1191
Writable Attribute
Description
FollowUpCorrectionField
Type: s64
Default: 0
LogAnnounceInterval
Type: s8
Default: 0
Range: -128 - 127
LogMinDelayRequestInterval
Type: s8
Default: 0
Range: -128 - 127
LogSyncInterval
Type: s8
Default: 0
Range: -128 - 127
PortNum
Type: u16
Default: 1
Priority1
Type: u8
Default: 0
Priority2
Type: u8
Default: 0
SlaveOnly
Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
FALSE
StepMode
Type: enum
Default: TWO_STEP
Possible Values:
Value
Description
TWO_STEP
SyncCorrectionField
Type: s64
Default: 0
1192
Writable Attribute
Description
TimeSrc
Type: enum
Default: INTERNAL_OSCILLATOR
Possible Values:
Value
Description
ATOMIC_CLOCK
GPS
TERRESTRIAL_RADIO
PTP
NTP
HAND_SET
OTHER
INTERNAL_OSCILLATOR
PTP_PROFILE240
PTP_PROFILE241
PTP_PROFILE242
PTP_PROFILE243
PTP_PROFILE244
PTP_PROFILE245
PTP_PROFILE246
PTP_PROFILE247
PTP_PROFILE248
PTP_PROFILE249
PTP_PROFILE250
PTP_PROFILE251
PTP_PROFILE252
PTP_PROFILE253
PTP_PROFILE254
TxDelayResponseFrameDroppedPercentage
Type: u8
Default: 0
Range: 0 - 100
TxFollowUpFrameDroppedPercentage
Type: u8
Default: 0
Range: 0 - 100
TxFrameCrcErrorPercentage
Type: u8
Default: 0
Range: 0 - 100
TxFrameTimeStampErrorPercentage
Type: u8
Default: 0
Range: 0 - 100
UnicastDiscovery
Type: enum
Default: DISABLED
Possible Values:
Value
Description
DISABLED
Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
FALSE
1193
Ieee1588v2ClockResult
Ieee1588v2ClockConfig Read-Only Attributes

Read-Only
Attribute
Description
ClockState
Type: enum
Default: IEEE1588_STATE_NONE
Possible Values:
Value
Description
IEEE1588_STATE_NONE
No state detected.
IEEE1588_STATE_INITIALIZING
Initializing data sets, hardware, and communication facilities.
IEEE1588_STATE_FAULTY
Multiple Pdelay_Resp messages were received.
IEEE1588_STATE_DISABLED
Does not implement the delay mechanism.
IEEE1588_STATE_LISTENING
Waiting for the announceReceiptTimeout to expire or to receive an Announce message from

a master.
IEEE1588_STATE_PRE_MASTER
No Announce message was received within the required time. Allowing changes to propagate
from points in the system between the local clock and possible masters visible from the port
before assuming the Master state.
IEEE1588_STATE_MASTER
Operating as the master clock.
IEEE1588_STATE_PASSIVE
Not the master on the path. Not synchronizing to a master.
IEEE1588_STATE_UNCALIBRATED One or more master ports have been detected in the domain.
IEEE1588_STATE_SLAVE
Synchronizing to the selected master port.
Ieee1588v2ClockResult
Description:
IEEE 1588v2 clock results.

Relations:
Side name
(Type)
Relative
Description
ResultParent
(ResultChild)
Ieee1588v2ClockResult Writable Attributes

Ieee1588v2ClockResult Read-Only Attributes

Read-Only Attribute
Description
ClockDomain
Clock domain.
Type: u8
Default: 0
ClockIdentity
Clock idenitity.
Type: u64
Default: 0
PortNum
Type: u16
Default: 0
1194
Ieee1588v2StateSummary
Read-Only Attribute
Description
RxAnnounceCount
Number of Announce messages received.

Type: u64
Default: 0
RxDelayRequestCount
Number of Delay_Req messages received.

Type: u64
Default: 0
RxDelayResponseCount
Number of Delay_Resp messages received.

Type: u64
Default: 0
RxFollowUpCount
Number of Follow_Up messages received.

Type: u64
Default: 0
RxSyncCount
Number of Sync messages received.

Type: u64
Default: 0
TxAnnounceCount
Number of Announce messages sent.

Type: u64
Default: 0
TxDelayRequestCount
Number of Delay_Req messages sent.

Type: u64
Default: 0
TxDelayResponseCount
Number of Delay_Resp messages sent.

Type: u64
Default: 0
TxFollowUpCount
Number of Follow_Up messages sent.

Type: u64
Default: 0
TxSyncCount
Number of Sync messages sent.

Type: u64
Default: 0
Ieee1588v2StateSummary
Description:
IEEE 1588v2 state summary results.

Relations:
Side name
(Type)
Relative
Description
ResultParent
(ResultChild)
Port, Project
Ieee1588v2StateSummary Writable Attributes

1195
IfManager
Ieee1588v2StateSummary Read-Only Attributes

Read-Only Attribute
Description
DisabledCount
Number of IEEE 1588v2 routers in the DISABLED state.

Type: u64
Default: 0
FaultyCount
Number of IEEE 1588v2 routers in the FAULTY state.

Type: u64
Default: 0
InitializingCount
Type: u64
Default: 0
ListeningCount
Number of IEEE 1588v2 routers in the LISTENING state.

Type: u64
Default: 0
MasterCount
Number of IEEE 1588v2 routers in the MASTER state.

Type: u64
Default: 0
NotStartedCount
Type: u32
Default: 0
PassiveCount
Number of IEEE 1588v2 routers in the PASSIVE state.

Type: u64
Default: 0
PreMasterCount
Number of IEEE 1588v2 routers in the PRE_MASTER state.

Type: u64
Default: 0
RouterDownCount
Number of IEEE 1588v2 routers in the DOWN state.

Type: u32
Default: 0
RouterUpCount
Number of IEEE 1588v2 routers in the UP state.

Type: u32
Default: 0
SlaveCount
Number of IEEE 1588v2 routers in the SLAVE state.

Type: u64
Default: 0
UncalibratedCount
Number of IEEE 1588v2 routers in the UNCALIBRATED state.

Type: u64
Default: 0
IfManager
Description:
This is an internal object that manages network interfaces and validation of interfaces.

Parents: StcSystem
1196
IfStackAddCommand
IfManager Writable Attributes

Writable Attribute
Description
Active, Name
IfManager Read-Only Attributes

IfStackAddCommand
Description:
Adds an interface stack to a device.

IfStackAddCommand Writable Attributes

Writable Attribute
Description
DeviceList
Device under which the interface stack needs to be added.

Type: handle
Default: 0
IfCount
Interface block count for each of the elements specified in the IfStack attribute. Must have the same list count as
the IfStack attribute.
Type: u32
Default: 1
IfStack

Type: string
IsPrimaryIf
Type: bool
Default: TRUE
Possible Values:
Value Description
TRUE
FALSE
LoopbackIf
Whether the specified interface stack refers to a loopback interface.

Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
Interface stack refers to a loopback interface.
FALSE Interface stack does not refer to a loopback interface.
1197
IfStackAttachCommand
IfStackAddCommand Read-Only Attributes

Read-Only Attribute
Description

IfStackAttachCommand
Description:
Attaches an interface stack to an existing lower layer interface.

IfStackAttachCommand Writable Attributes

Writable Attribute
Description
AttachToIf
Lower layer interface to which this interface stack is to be attached.

Type: handle
Default: 0
DeviceList
Device under which interface stack is to be attached.

Type: handle
Default: 0
IfCount
Interface block count for each of the elements specified in the IfStack attribute. Must have the same list count
as the IfStack attribute.
Type: u32
Default: 1
IfStack

Type: string
IsPrimaryIf
Type: bool
Default: TRUE
Possible Values:
Value Description
TRUE
FALSE
IfStackAttachCommand Read-Only Attributes

Read-Only Attribute
Description

1198
IfStackGetCommand
IfStackGetCommand
Description:

IfStackGetCommand Writable Attributes

Writable Attribute
Description
StartIf
Type: handle
Default: 0
IfStackGetCommand Read-Only Attributes

Read-Only Attribute
Description

ArpNdIf
Type: handle
Default: 0
IfStack
Type: handle
Default: 0
IfStackRemoveCommand
Description:
Removes an interface stack from a device.

IfStackRemoveCommand Writable Attributes

Writable Attribute
Description
DeviceList
Device whose interface stack is to be removed.

Type: handle
Default: 0
TopIf
Top level interface of the interface stack to be removed.

Type: handle
Default: 0
1199
IfStackReplaceCommand
IfStackRemoveCommand Read-Only Attributes

Read-Only Attribute
Description

IfStackReplaceCommand
Description:
Replaces an existing interface stack on a device.

IfStackReplaceCommand Writable Attributes

Writable Attribute
Description
CurrentIfStack
Existing interface stack that is to be replaced.

Type: handle
Default: 0
DeviceList
Device whose interface stack is to be replaced.

Type: handle
Default: 0
IsPrimaryIf
Type: bool
Default: TRUE
Possible Values:
Value Description
TRUE
FALSE
NewIfStack
New interface stack that will replace the existing stack.

Type: handle
Default: 0
IfStackReplaceCommand Read-Only Attributes

Read-Only Attribute
Description

IgmpEotHostResults
Description:
End of test state and statistics of the IGMP host object.

1200
IgmpGroupMembership
Automatically created from: IgmpHostConfig
IgmpEotHostResults Writable Attributes

IgmpEotHostResults Read-Only Attributes

Read-Only Attribute
Description
AvgJoinLatency
Average join latency, in milliseconds, of all hosts within the block.

Type: double
Default: 0
AvgLeaveLatency
Average leave latency, in milliseconds, of all hosts within the block.

Type: double
Default: 0
DuplicateJoinCount
Number of duplicate joins of all hosts within the block.

Type: u32
Default: 0
HostName
Name of the host block.

Type: string
Default: 0
JoinFailCount
Number of join failures of all hosts within the block.

Type: u32
Default: 0
MaxJoinLatency
Maximum join latency, in milliseconds, of all hosts within the block.

Type: double
Default: 0
MaxLeaveLatency
Maximum leave latency, in milliseconds, of all hosts within the block.

Type: double
Default: 0
MinJoinLatency
Minimum join latency, in milliseconds, of all hosts within the block.

Type: double
Default: 0
MinLeaveLatency
Minimum leave latency, in milliseconds, of all hosts within the block.

Type: double
Default: 0
IgmpGroupMembership
Description:
Creates blocks of IGMP host group memberships.

Parents: IgmpHostConfig, MldHostConfig
Result children (automatically created): IgmpGroupMembershipResults
Relations:
Side name
(Type)
Relative
Description
ResultChild
(ResultChild)
IgmpGroupMembershipResults
1201
IgmpGroupMembership
Side name
(Type)
Relative
Description
MulticastGroup
(SubscribedGroups)
Ipv4Group, Ipv6Group
Relationship between the IGMP group membership object and an

IPv4 multicast group object.
MulticastSource
(SubscribedSources)
EmulatedDevice
Relationship between the IGMP group membership object and a host

object emulating a multicast source.
IgmpGroupMembership Writable Attributes

Writable Attribute
Description
Active, Name
CalculateLatency
Specifies whether or not to interactively calculate join/leave latency for the group associated to this membership.
Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
Enables join/leave latency to be calculated interactively. Refer to CalculateLatencyDelay property on the

PortConfig to configure the delay to calculate latency.
FALSE Disables join/leave latency from being calculated interactively.

DeviceGroupMapping
Specifies the mapping between the device and subscribed multicast group within their respective blocks.
Type: enum
Default: MANY_TO_MANY
Possible Values:
Value
Description
MANY_TO_MANY Creates a full mesh of devices and groups.
ONE_TO_ONE
FilterMode
Assigns one device to each group. The mapping stops when it reaches the end of either devices or
groups. The extra devices or groups are not mapped.
Specifies the filter mode for the associated multicast groups and sources.
Type: enum
Default: EXCLUDE
Possible Values:
Value
Description
INCLUDE Select INCLUDE to enable the host to receive multicast data only from the sources specified in the Source
Filters field.
EXCLUDE Select EXCLUDE to reject multicast data from the sources specified in the Source Filters field.
IsSourceList
Specifies whether sources are defined as a list or range of addresses.

Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
Enables the use of a discrete list of user-defined sources.
FALSE Enables the use of a range of user-defined sources.

UserDefinedSources
Controls the use of user-defined multicast sources.

Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
Enables the use of user-defined multicast sources.
FALSE Disables the use of user-defined multicast sources.
IgmpGroupMembership Read-Only Attributes

1202
Description:
IGMP device-group results.

Parents: IgmpGroupMembership
Relations:
Side name
(Type)
Relative
Description
ResultParent
(ResultChild)
IgmpGroupMembership
IgmpGroupMembershipResults Writable Attributes

IgmpGroupMembershipResults Read-Only Attributes

Read-Only Attribute
Description
DuplicateJoin
Indicates whether or not the DUT was already forwarding multicast prior to a join being sent.
NOTE: To enable this LED, For interactive tests, under Test Configuration, select All Devices or a device, click the
IGMP/MLD tab, and select Calculate Latency. For Command Sequencer tests, select the Calculate Join Latency checkbox
in the IGMP/MLD: Join Groups command.
Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
DUT was forwarding multicast traffic for this group prior to the join being sent.
FALSE No duplicate join report detected.

GroupAddr
Group's IP multicast address.

Type: ip
Default: 0.0.0.0
GroupHandle
IL group handle.
Type: u32
Default: 0
HostAddr
Host's IP address.
Type: ip
Default: 0.0.0.0
JoinFail
Indicates whether or not multicast traffic was received.

Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
Multicast traffic was not received.
FALSE Multicast traffic was received.

JoinLatency
Time between sending an IGMP join message, and receiving multicast data from the group specified in the join message.
Type: double
Default: 0
JoinTimestamp
Transmit timestamp of the initial IGMP join message.

Type: string
Default: 0
LeaveLatency
Time between sending an IGMP leave message to a multicast group, and when the multicast data stopped traffic.
Type: double
Default: 0
1203
IgmpHostConfig
Read-Only Attribute
Description
LeaveTimestamp
Transmit timestamp of the IGMP leave message.

Type: string
Default: 0
ResultIf
Object handle returned from the call to create the IGMP group membership object.
Type: u32
Default: 0
State
Current state of the IGMP group.

Type: enum
Default: UNDEFINED
Possible Values:
Value
Description
UNDEFINED
Host is in an undefined state.
NON_MEMBER
Host does not belong to the group on the interface. This state applies only to IGMPv1 and IGMPv2
and is the initial state for all memberships on all network interfaces.
DELAYING_MEMBER Host belongs to the group on the interface and has a report delay timer running for that membership.
This state applies to IGMPv1 and IGMPv2only.
IDLE_MEMBER
Host belongs to the group on the interface and does not have a report delay timer running for that
membership. This state applies to IGMPv1 and IGMPv2 only.
RETRYING_MEMBER This state applies to IGMPv1/IGMPv2 hosts when ForceRobustJoin is True. The host is retransmitting
its initial join before transitioning from the NON_MEMBER state to the DELAYING_MEMBER or
IDLE_MEMBER state.
StateChangeTimestamp
INCLUDE
Data from the specified sources are filtered and forwarded to the host by the multicast router. This
state applies to IGMPv3 only.
EXCLUDE
Data from the specified sources are filtered and not forwarded to the host by the multicast router.
This state applies to IGMPv3 only.
Timestamp of the IGMP group membership state change.

Type: string
Default: 0
IgmpHostConfig
Description:
Configures one or more host blocks on the IGMP port.

Children: IgmpGroupMembership, MldGroupMembership
Automatically-created children: IgmpEotHostResults
Result children (automatically created): IgmpEotHostResults, IgmpHostResults
Relations:
Side name
(Type)
Relative
Description
IptvParameter
(MulticastParam)
IptvStbBlockConfig
Relationship between the IPTV set-top box block configuration

object, and the IGMP host configuration object.
ResultChild
(ResultChild)
IgmpHostResults
VqAnalyzerChannelMembership
(SubscribedHosts)
VqAnalyzerChannelMembershipGenParams
Relationship between an IGMP/MLD host and a Video Quality

channel membership. Used exclusively in the Video Quality
wizard.
1204
IgmpHostConfig
Side name
(Type)
Relative
Description
UsesIf
(UsesIf)
Aal5If, EthIIIf, FcIf, GreIf, HdlcIf, Ipv4If, Ipv6If,

ItagIf, L2tpv2If, MplsIf, PppIf, PppoeIf, VlanIf,
WimaxIf

IgmpHostConfig Writable Attributes

Writable Attribute
Description
Active, Name
ForceLeave
Affects all hosts except the last one, which is always required to send an IGMPv2 leave report. IGMPv2 hosts leaving a
multicast group may optionally send a leave report to the all-routers multicast group. The ForceLeave flag controls whether
or not all hosts are required to send leave reports when leaving the multicast group.
Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
Force the IGMPv2 host(s) to send a Leave Group message when leaving a multicast group.
FALSE Do not force the IGMPv2 host(s) to send a Leave Group message when leaving a multicast group.
ForceRobustJoin
When an IGMPv1/IGMPv2 host joins a multicast group, it immediately transmits an initial unsolicited membership report for
that group, in case it is the first member of that group on the network. In case the initial report gets damaged or lost, a second
unsolicited report is recommended be sent out. The ForceRobustJoin flag controls whether or not a second report is transmitted.
Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
Forces the host to send a second IGMPv1/IGMPv2 join report.
FALSE Does not force the host to send a second IGMPv1/IGMPv2 join report.
ForceSimpleJoin
Forces the IGMP host(s) to send a single join report per group. Enabling this option effectively bypasses the RFC defined
behavior of sending (Robustness Variable - 1) reports. Otherwise, IGMP host(s) will behave according to RFC specification.
Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
Force IGMP host(s) to send a single join report per group.
FALSE Default behavior that is compliant to RFC specification. IGMP host(s) will send (Robustness Variable - 1) reports.
InsertCheckSumErrors
Controls the insertion of checksum errors into IGMP messages by the hardware.
Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
IGMP checksum of the transmitted packet is flipped by the protocol stack.
FALSE IGMP checksum of the transmitted packet is not modified.

InsertLengthErrors
Controls the insertion of message length errors into the IGMP messages by the IGMP stack.
Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
Every IGMP packet transmitted by the host will be 2 bytes shorter than normal.
FALSE IGMP packet lengths will not be modified.
1205
IgmpHostConfig
Writable Attribute
Description
Ipv4DontFragment
Controls the fragmentation of packets larger than the MTU (Maximum Transmission Unit) size.
Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
Packets larger than the allowable MTU are not fragmented.
FALSE Packets larger than the allowable MTU will be divided into fragments.
Ipv4Tos
Specifies the value of the TOS field in the IPv4 header.

Type: u8
Default: 192
PackReports
Allows IGMPv3 host(s) to send reports that contain multiple group records, to allow reporting of full current state using fewer
packets.
Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
Reports will contain multiple group records.
FALSE An individual report will be sent for each group record.

RobustnessVariable
Specifies the variable used in the calculation of default values for various timers and counters.
Type: u8
Default: 2
Range: 2 - 255
UnsolicitedReportInterval
Time between repetitions of a host's initial report of membership in a group.

Type: u32
Default: 10
Range: 0 - 604800
Controls the usage of partial block state.

Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
Enables the usage of partial block state.
FALSE Disables the usage of partial block state.

V1RouterPresentTimeout
Amount of time a host must wait after hearing a Version 1 Query before it may send any IGMPv2 messages.
Type: u32
Default: 400
Version
Selects the multicast protocol used to manage multicast group memberships.

Type: enum
Default: IGMP_V2
Possible Values:
Value
Description
IGMP_V2 IGMP version specified in RFC 2236. Improved IGMP version that adds leave messages, shortening the amount
of time required for a router to determine that no stations are in a particular group.
IGMP_V3 Specified in RFC 3376, this major revision of the IGMP protocol adds the ability to specify the source(s) that a
receiver is willing to listen to.
MLD_V1
MLD_V2
1206
IgmpHostResults
IgmpHostConfig Read-Only Attributes

Read-Only Attribute
Description
BlockState
State of the IGMP/MLD host block.

Type: enum
Default: NON_MEMBER
Possible Values:
Value
Description
UNDEFINED
Undefined.
NON_MEMBER No device in the block is joined to a group, and there are no initial unsolicited reports to be sent.
JOINING
At least one device in the block has yet to send its initial unsolicited non-Leave report.
MEMBER
At least one device in the block is joined to a group, and there are no initial unsolicited reports to be sent.
LEAVING
One or more devices in the block have yet to send their initial unsolicited Leave reports, and no device in
the block is sending non-Leave reports.
IgmpHostResults
Description:
IGMP results.

Parents: IgmpHostConfig
Relations:
Side name
(Type)
Relative
Description
ResultParent
(ResultChild)
IgmpHostConfig
IgmpHostResults Writable Attributes

IgmpHostResults Read-Only Attributes

Read-Only Attribute
Description
AvgJoinLatency
Average Join Latency for this host.

Type: double
Default: 0
AvgLeaveLatency
Average Leave Latency for this host.

Type: double
Default: 0
1207
IgmpHostResults
Read-Only Attribute
Description
HostState

Type: enum
Default: NON_MEMBER
Possible Values:
Value
Description
UNDEFINED
Undefined.
NON_MEMBER No device in the block is joined to a group, and there are no initial unsolicited reports to be
sent.
JOINING
MEMBER
At least one device in the block is joined to a group, and there are no initial unsolicited
reports to be sent.
LEAVING
One or more devices in the block have yet to send their initial unsolicited Leave reports,
and no device in the block is sending non-Leave reports.
IfHandle
IL interface handle.
Type: u32
Default: 0
MaxJoinLatency
Maximum Join Latency for this host.

Type: double
Default: 0
MaxLeaveLatency
Maximum Leave Latency for this host.

Type: double
Default: 0
McastCompatibilityMode
IGMP version the host block is currently operating as.

Type: enum
Default: V2
Possible Values:
Value Description
V1
IGMPv1
V2
IGMPv2
V3
IGMPv3
MinJoinLatency
Minimum Join Latency for this host.

Type: double
Default: 0
MinLeaveLatency
Minimum Leave Latency for this host.

Type: double
Default: 0
RouterState
State of the IGMP/MLD querier block.

Type: enum
Default: NOT_STARTED
Possible Values:
Value
Description
UNDEFINED
Undefined.
NOT_STARTED Not started.

UP
Already started and up.
RxFrameCount
Total number of IGMP frames received.

Type: u32
Default: 0
RxIgmpCheckSumErrorCount
Total number of IGMP messages received with checksum errors.

Type: u32
Default: 0
RxIgmpLengthErrorCount
Total number of IGMP messages received with length errors.

Type: u32
Default: 0
1208
IgmpMldJoinGroupsCommand
Read-Only Attribute
Description
RxUnknownTypeCount
Total number of frames of unknown type received.

Type: u32
Default: 0
Timestamp
Timestamp in seconds of last statistic update.

Type: double
Default: 0
TxFrameCount
Total number of IGMP frames transmitted.

Type: u32
Default: 0
IgmpMldJoinGroupsCommand
Description:
Instructs the host block to join a multicast group.

IgmpMldJoinGroupsCommand Writable Attributes

Writable Attribute
Description
BlockList
List of multicast host block handles to apply the join group command.
Type: handle
Default: 0
CalculateLatency
Controls calculation of join latencies.

Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
Enable calculation of join latencies.
FALSE Disable calculation of join latencies.

JoinLeaveDelay
Amount of time (in seconds) to wait before sending joins.

Type: u32
Default: 0
RxDataDuration
Amount of time (in seconds) to wait before the latency calculation is performed.
Type: u32
Default: 10
WaitForTxReports
Controls whether command should wait for all reports to be transmitted. This property only applies when the
command is run in the sequencer.
Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
Command will wait for all reports to be transmitted before completing.
FALSE Command will not wait for all reports to be transmitted before completing.
1209
IgmpMldLeaveGroupsCommand
IgmpMldJoinGroupsCommand Read-Only Attributes

Read-Only Attribute
Description

IgmpMldLeaveGroupsCommand
Description:
Instructs the host block to leave a multicast group.

IgmpMldLeaveGroupsCommand Writable Attributes

Writable Attribute
Description
BlockList
List of multicast host block handles to apply the leave group command.
Type: handle
Default: 0
CalculateLatency
Controls calculation of leave latencies.

Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
Enable calculation of leave latencies.
FALSE Disable calculation of leave latencies.

JoinLeaveDelay
Amount of time (in seconds) to wait before sending leaves.

Type: u32
Default: 0
RxDataDuration
See IgmpMldJoinGroupsCommand.
Type: u32
Default: 10
WaitForTxReports
Controls whether command should wait for all reports to be transmitted. This property only applies when the
command is run in the sequencer.
Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
Command will wait for all reports to be transmitted before completing.
FALSE Command will not wait for all reports to be transmitted before completing.
IgmpMldLeaveGroupsCommand Read-Only Attributes

Read-Only Attribute
Description

1210
IgmpMldRejoinGroupsCommand
IgmpMldRejoinGroupsCommand
Description:
Instructs the host block to rejoin a multicast group.

IgmpMldRejoinGroupsCommand Writable Attributes

Writable Attribute
Description
BlockList
List of multicast host block handles to apply the rejoin group command.
Type: handle
Default: 0
CalculateLatency
Not applicable.
Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
Not applicable.
FALSE Not applicable.

JoinLeaveDelay
Not applicable.
Type: u32
Default: 0
RxDataDuration
Not applicable.
Type: u32
Default: 10
WaitForTxReports
Not applicable.
Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
Not applicable.
FALSE Not applicable.
IgmpMldRejoinGroupsCommand Read-Only Attributes

Read-Only Attribute
Description

IgmpMldStartQuerierCommand
Description:
Starts the querier router object. The router will then periodically send general host-query messages to solicit group membership information. The messages
are sent to the all-systems multicast group address, 224.0.0.1.

1211
IgmpMldStopQuerierCommand
IgmpMldStartQuerierCommand Writable Attributes

Writable Attribute
Description
BlockList
List of multicast router block handles to apply the start querier command.
Type: handle
Default: 0
IgmpMldStartQuerierCommand Read-Only Attributes

Read-Only Attribute
Description

IgmpMldStopQuerierCommand
Description:
Stops the querier router object. The router will stop sending general host-query messages that solicits group membership information. These messages are
sent to the all-systems multicast group address, 224.0.0.1.

IgmpMldStopQuerierCommand Writable Attributes

Writable Attribute
Description
BlockList
List of multicast router block handles to apply the stop querier command.
Type: handle
Default: 0
IgmpMldStopQuerierCommand Read-Only Attributes

Read-Only Attribute
Description

IgmpPortConfig
Description:
Creates/configures an IGMP port.

1212
IgmpPortResults
Result children (automatically created): IgmpPortResults

Relations:
Side name
(Type)
Relative
Description
ResultChild
(ResultChild)
IgmpPortResults
IgmpPortConfig Writable Attributes

Writable Attribute
Description
Active, Name
CalculateLatencyDelay
Specifies the delay (in seconds) before latency is calculated. The timer starts after reports are sent for each device.
Note: Applies to interactive latency tests only.
Type: u32
Default: 10
Range: 1 - 3600
MaxBurst
Short-term maximum burst size in packets. A value of 0 specifies the maximum possible burst size.
Type: u32
Default: 0
RatePps
Long-term, maximum packet rate (in packets per second). A value of 0 specifies the maximum possible output rate.
Type: u32
Default: 0
VlanSubFilter
Specifies whether to filter on the Outer or Inner VLAN tag when calculating latency for devices with a PPPoE and
stacked VLAN encapsulation.
Type: enum
Default: OUTER
Possible Values:
Value Description
OUTER Specifies that the analyzer filter will be programmed to use the Outer VLAN ID.
INNER Specifies that the analyzer filter will be programmed to use the Inner VLAN ID.
IgmpPortConfig Read-Only Attributes

IgmpPortResults
Description:
IGMP port results.

Parents: IgmpPortConfig
Relations:
Side name
(Type)
Relative
Description
ResultParent
(ResultChild)
IgmpPortConfig
IgmpPortResults Writable Attributes

1213
IgmpPortResults
IgmpPortResults Read-Only Attributes

Read-Only Attribute
Description
RxFrameCount

Type: u32
Default: 0
RxGeneralQueryCount
Total number of IGMP General Queries received. The General Query is used to learn which groups have
members on an attached network.
Type: u32
Default: 0
RxGroupAndSourceSpecificQueryCount
Group- and source-specific queries are sent by a multicast router whenever a host leave a specific source of
a group. This is to make sure that there are no other hosts of that source and group.
Type: u32
Default: 0
RxGroupSpecificQueryCount
Total number of IGMP group-specific queries transmitted. The Group-Specific Query is used to learn if a particular
group has any members on an attached network.
Type: u32
Default: 0

Type: u32
Default: 0

Type: u32
Default: 0
RxUnknownTypeCount
Total number of IGMP frames of unknown type received.

Type: u32
Default: 0
RxV1QueryCount
IGMPv1 Host membership query messages are sent to discover which group have members.
Type: u32
Default: 0
RxV1ReportCount
IGMPv1 reports are sent to multicast routers to indicate that hosts have listeners interested in joining multicast
groups whose multicast address is listed in the router's list.
Type: u32
Default: 0
RxV2QueryCount
Total number of IGMPv2 queries received. Routers use Multicast Listener Query messages to query a subnet
for multicast listeners.
Type: u32
Default: 0
RxV2ReportCount
Similar to IGMPv1 reports, IGMPv2 reports are sent by IGMPv2 hosts if they detect an IGMPv2 router.
Type: u32
Default: 0
RxV3QueryCount
IGMPv3 Membership Queries are sent by IP multicast routers to query the multicast reception state of neighboring
interfaces.
Type: u32
Default: 0
RxV3ReportCount
While functionally similar to IGMPv2 reports, IGMPv3 reports add support for source filtering. This means a
host may report interest in receiving packets only from specific addresses. Or, from all but specific addresses
sent to a multicast address. This information may be used to avoid delivering multicast packets from specific
sources to networks where there are no interested hosts.
Type: u32
Default: 0
Timestamp

Type: double
Default: 0
1214
IgmpPortResults
Read-Only Attribute
Description
TxFrameCount

Type: u32
Default: 0
TxGeneralQueryCount
Total number of IGMP General Queries transmitted. General Query is used to learn which groups have members
on an attached network.
Type: u32
Default: 0
TxGroupAndSourceSpecificQueryCount
Type: u32
Default: 0
TxGroupSpecificQueryCount
Total number of IGMP group-specific queries transmitted. The Group-Specific Query is used to learn if a particular
group has any members on an attached network.
Type: u32
Default: 0
TxLeaveGroupCount
When an IGMP host leaves a multicast group, it may send a Leave Group message to the all-routers multicast
group.
Type: u32
Default: 0
TxV1QueryCount
interfaces.
Type: u32
Default: 0
TxV1ReportCount
IGMPv1 reports are sent to multicast routers to indicate that hosts have listeners interested in joining multicast
Type: u32
Default: 0
TxV2QueryCount
interfaces.
Type: u32
Default: 0
TxV2ReportCount
Similar to IGMPv1 reports, IGMPv2 reports are sent by IGMPv2 hosts if they detect an IGMPv2 router.
Type: u32
Default: 0
TxV3AllowNewSourcesCount
A Source-List-Change Record (SLCR) indicating the group's associated sources have changed such that data
from a new set of sources are to be received.
Type: u32
Default: 0
TxV3BlockOldSourcesCount
A Source-List-Change Record (SLCR) indicating the group's associated sources have changed such that data
from an existing set of sources are not required.
Type: u32
Default: 0
TxV3ChangeToExcludeModeCount
A Filter-Mode-Change Record (FMCR) indicating the filter-mode of the reception state has changed to exclude
mode.
Type: u32
Default: 0
TxV3ChangeToIncludeModeCount
A Filter-Mode-Change Record (FMCR) indicating the filter-mode of the reception state has changed to include
mode.
Type: u32
Default: 0
TxV3ModeIsExcludeCount
A Current-State Record (CSR) indicating the current reception state with respect to 1 multicast group at a given
interface. The state contains the exclude filter mode.
Type: u32
Default: 0
1215
IgmpRouterConfig
Read-Only Attribute
Description
TxV3ModeIsIncludeCount
A Current-State Record (CSR) indicating the current reception state with respect to 1 multicast group at a given
interface. The state contains the include filter mode.
Type: u32
Default: 0
TxV3QueryCount
interfaces.
Type: u32
Default: 0
TxV3ReportCount
While functionally similar to IGMPv2 reports, IGMPv3 reports add support for source filtering. This means a
host may report interest in receiving packets only from specific addresses. Or, from all but specific addresses
sent to a multicast address. This information may be used to avoid delivering multicast packets from specific
sources to networks where there are no interested hosts.
Type: u32
Default: 0
IgmpRouterConfig
Description:
Configures an IGMP querier on the port.

Result children (automatically created): IgmpRouterResults
Relations:
Side name
(Type)
Relative
Description
ResultChild
(ResultChild)
IgmpRouterResults
UsesIf
(UsesIf)


IgmpRouterConfig Writable Attributes

Writable Attribute
Description
Active, Name
IgnoreV1Reports
Specifies whether to ignore IGMPv1 messages on the interface. Valid only for IGMPv2.
Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
Ignores IGMPv1 messages.
FALSE Processes IGMPv1 messages.
1216
IgmpRouterConfig
Writable Attribute
Description
Ipv4DontFragment
Controls the fragmentation of packets larger than the MTU (Maximum Transmission Unit) size.
Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
Packets larger than the allowable MTU are not fragmented.
FALSE Packets larger than the allowable MTU will be divided into fragments.
Ipv4Tos
Specifies the value of the TOS field in the IPv4 header.

Type: u8
Default: 192
LastMemberQueryCount
Value for the Max Response Time field (in milliseconds) that is inserted into Group-Specific and Group-and-Source-Specific
Query messages in response to Leave Group messages. This value also specifies the interval between transmissions
of Group-Specific and Group-and-Source-Specific Query messages. This field does not apply to IGMPv1.
Type: u8
Default: 2
LastMemberQueryInterval
Maximum amount of time between group-specific query messages, including those sent in response to leave-group
messages.
Type: u32
Default: 1000
QueryInterval
Duration (in seconds) between transmissions of General Query messages. General Query messages are used to learn
which multicast groups have members on a connected network.
Type: u32
Default: 125
QueryResponseInterval
Value for the Max Response Time field (in milliseconds) that is inserted into the General Query messages. This time is
the maximum amount allowed for a host to send a responding report to the General Query message. This interval must
be less than the Query Interval. This field does not apply to IGMPv1.
Type: u32
Default: 10000
RobustnessVariable
Type: u8
Default: 2
Range: 2 - 255
StartupQueryCount
Number of queries sent out on startup, separated by the Startup Query Interval.
Type: u8
Default: 2
Range: 1 - 255

Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE

Version

Type: enum
Default: IGMP_V2
Possible Values:
Value
Description
MLD_V1
MLD_V2
1217
IgmpRouterResults
IgmpRouterConfig Read-Only Attributes

Read-Only Attribute
Description
BlockState

Type: enum
Possible Values:
Value
Description
UNDEFINED
Undefined.

UP
IgmpRouterResults
Description:
IGMP Querier results.

Parents: IgmpRouterConfig
Relations:
Side name
(Type)
Relative
Description
ResultParent
(ResultChild)
IgmpRouterConfig
IgmpRouterResults Writable Attributes

IgmpRouterResults Read-Only Attributes

Read-Only Attribute
Description
HostState

Type: enum
Default: NON_MEMBER
Possible Values:
Value
Description
UNDEFINED
Undefined.
sent.
IfHandle
JOINING
MEMBER
At least one device in the block is joined to a group, and there are no initial unsolicited reports
to be sent.
LEAVING
One or more devices in the block have yet to send their initial unsolicited Leave reports, and
no device in the block is sending non-Leave reports.
Type: u32
Default: 0
1218
Igmpv1
Read-Only Attribute
Description
IGMP version the router block is currently operating as.

Type: enum
Default: V2
Possible Values:
Value Description
RouterState
V1
IGMPv1
V2
IGMPv2
V3
IGMPv3

Type: enum
Possible Values:
Value
Description
UNDEFINED
Undefined.

UP
RxFrameCount

Type: u32
Default: 0

Type: u32
Default: 0

Type: u32
Default: 0
RxUnknownTypeCount

Type: u32
Default: 0
Timestamp

Type: double
Default: 0
TxFrameCount

Type: u32
Default: 0
Igmpv1 (igmp:Igmpv1)
Description:
IGMPv1 message. See RFC 1112.
Children: None
Igmpv1 Attributes
Attribute
Description
checksum
Type: INTEGER
Default: 0
1219
Igmpv2
Attribute
Description
groupAddress
Type: IPV4ADDR
Default: 225.0.0.1
Name
Type: string
type
Type: Igmpv1MessageType
Default: 2
Possible Values:
Value Description
1
v1 Query
v1 Report
unused
Type: INTEGER
Default: 0
version
Type: INTEGER
Default: 1
Igmpv2 (igmp:Igmpv2)
Description:
IGMPv2 message. See RFC 2236.
Children: None
Igmpv2 Attributes
Attribute
Description
checksum
Type: INTEGER
Default: 0
groupAddress
Type: IPV4ADDR
Default: 225.0.0.1
maxRespTime
Type: INTEGER
Default: 0
Name
Type: string
type
Type: Igmpv2MessageType
Default: 16
Possible Values:
Value Description
11
Membership Query
16
Version 2 Membership Report
17
Leave Group
1220
Igmpv2Query
Igmpv2Query (igmp:Igmpv2Query)
Description:
Children: None
Igmpv2Query Attributes
Attribute
Description
checksum
Type: INTEGER
Default: 0
groupAddress
Type: IPV4ADDR
Default: 225.0.0.1
maxRespTime
Type: INTEGER
Default: 100
Name
Type: string
type
Type: OCTETSTRING
Default: 11
Igmpv2Report (igmp:Igmpv2Report)
Description:
Children: None
Igmpv2Report Attributes
Attribute
Description
checksum
Type: INTEGER
Default: 0
groupAddress
Type: IPV4ADDR
Default: 225.0.0.1
maxRespTime
Type: INTEGER
Default: 0
Name
Type: string
type
Type: Igmpv2ReportMessageType
Default: 16
Possible Values:
Value Description
16
Version 2 Membership Report
17
Leave Group
1221
Igmpv3Query
Igmpv3Query (igmp:Igmpv3Query)
Description:
IGMPv3 Membership Query message. See RFC 3376.
Children: addrList
Igmpv3Query Attributes
Attribute
Description
checksum
Type: INTEGER
Default: 0
groupAddress
Type: IPV4ADDR
Default: 225.0.0.1
maxRespTime
Type: INTEGER
Default: 100
Name
Type: string
numSource
Type: INTEGER
Default: 0
qqic
Type: INTEGER
Default: 0
qrv
Type: BITSTRING
Default: 0
resv
Type: INTEGER
Default: 0
sFlag
Type: BITSTRING
Default: 1
type
Type: OCTETSTRING
Default: 11
Igmpv3Report (igmp:Igmpv3Report)
Description:
IGMPv3 Membership Report message. See RFC 3376.
Children: grpRecords
Igmpv3Report Attributes
Attribute
Description
checksum
Type: INTEGER
Default: 0
Name
Type: string
1222
IncarnationNumTlv
Attribute
Description
numGrpRecords
Type: INTEGER
Default: 0
reserved
Type: INTEGER
Default: 0
reserved2
Type: INTEGER
Default: 0
type
Type: OCTETSTRING
Default: 22
IncarnationNumTlv
Description:
Children: None
IncarnationNumTlv Attributes
Attribute
Description
IncarnationNumber
Type: OCTETSTRING
Default: 00000000
Length
Type: INTEGER
Default: 0
Name
Type: string
Type
Type: INTEGER
Default: 10
Info
Description:
Parents: ProvisioningInfoTLV
Children: ProvList
Info Attributes
Attribute
Description
Name
information.
Type: string
1223
InfoOAMPDU
InfoOAMPDU (LinkOAM:InfoOAMPDU)
Description:
Children: OAMBH, thepadData, TLV
InfoOAMPDU Attributes
Attribute
Description
Code
Type: OCTETSTRING
Default: 00
Name
information.
Type: string
InfoOAMPDUTLVList
Description:
Parents: TLV
Children: LI, OS, RI
InfoOAMPDUTLVList Attributes
Attribute
Description
Name
information.
Type: string
Ingress_Port_ID
Description:
Parents: theIPID
Children: None
Ingress_Port_ID Attributes
Attribute
Description
IngressPortID
Type: OCTETSTRING
Name
more information.
Type: string
1224
Ingress_Port_ID_Length
Ingress_Port_ID_Length
Description:
Parents: theIPIDL
Children: None
Ingress_Port_ID_Length Attributes
Attribute
Description
IngressPortIDLength
Type: OCTETSTRING
Default: 00
Name
Type: string
Ingress_Port_ID_Subtype
Description:
Parents: theIPIDLS
Children: None
Ingress_Port_ID_Subtype Attributes
Attribute
Description
IngressPortIDLengthSub
Type: OCTETSTRING
Default: 00
Name
Type: string
InstallFirmwareCommand
Description:
Install a firmware version for one or more chassis including the test modules in each chassis.
NOTE: You must call SetFirmwareArchivesDirCommand before calling this command, unless the firmware packages are located in the default firmware
directory (example: "{application installation directory}/Firmware/bundle").

InstallFirmwareCommand Writable Attributes

Writable Attribute
Description
1225
InstallRawImageCommand
Writable Attribute
Description
EquipmentList
One or more handles for the chassis to install the specified firmware on.
Type: handle
Default: 0
Version
Firmware version to install. Example: "2.0.100".

Type: string
Default: 2.0.0
InstallFirmwareCommand Read-Only Attributes

Read-Only Attribute
Description

InstallRawImageCommand
Description:
Install a raw image on one or more chassis or test modules.
NOTE: You must call SetRawArchivesDirCommand before calling this command, unless the raw images are located in the default raw image directory (example:
"{application installation directory}/Firmware/rawimg").
Tcl example:
# Connect to the chassis
stc::connect $chassisIpAddr
# Set the directory where the raw images are located
stc::perform SetRawArchivesDir -Dir $imageDir
# Get the physical chassis manager handle
set mgr [stc::get system1 -children-physicalchassismanager]
# Get the handle to the physical chassis
set chassisHandle [stc::get $mgr -children-physicalchassis]
# Get the handle to the physical test modules
set moduleHandles [stc::get $chassisHandle -children-physicaltestmodule]
# Build module list
set installList {}
foreach handle $moduleHandles {
set slot [stc::get $handle SlotNumber]
foreach module $moduleList {
if {$module == $slot } {
puts "Adding test module $module to the install list"
lappend installList $handle
}
}
}
# Install the raw image on the test modules
stc::perform InstallRawImage -HandleList $installList -Version $imageVersion

InstallRawImageCommand Writable Attributes

Writable Attribute
Description
1226
InstallTestPackageCommand
Writable Attribute
Description
EquipmentList
One or more handles for the chassis or test modules to install the specified raw image on.
Type: handle
Default: 0
Version
Raw image version to install. Example: "2.0.100".

Type: string
Default: 2.0.0
InstallRawImageCommand Read-Only Attributes

Read-Only Attribute
Description

InstallTestPackageCommand
Description:
Install a test package bundle (example: "stc") on one or more port groups.
NOTE: You must call SetFirmwareArchivesDirCommand before calling this command, unless the test package bundle is located in the default firmware directory
(example: "{application installation directory}/Firmware/bundle").

InstallTestPackageCommand Writable Attributes

Writable Attribute
Description
PortGroupList
One or more handles for the port groups to install a test package on.
Type: handle
Default: 0
TestPackage
Test package bundle (example: "stc") to install on the specified port group or groups.
Type: string
Default: l2l3
Version
Test package version (example: "2.0.100") to install on the specified port group or groups.
Type: string
Default: 2.0.0
InstallTestPackageCommand Read-Only Attributes

Read-Only Attribute
Description

1227
InterarrivalTimeHistogram
InterarrivalTimeHistogram
Description:
Inter-Arrival Time histogram configuration. Total, minimum, maximum, and average inter-arrival times, and 16 histogram bin counters can be retrieved from
the results.

Relations:
Side name
(Type)
Relative
Description
ActiveParent
(ActiveHistogram)
AnalyzerConfig

object.
InterarrivalTimeHistogram Writable Attributes

Writable Attribute
Description
Active, Name
BucketSizeList
Type: u32
Default: 0
ConfigMode

Type: enum
Possible Values:
Value
Description
Description

Type: string
Default: (ns)
DistributionMode
mode.
Type: enum
Possible Values:
Value
Description
LEFT_MODE
RIGHT_MODE

CUSTOM_MODE
Type: u32
Default: 1024
LimitList
Type: u32
Default: 0
Type: u32
Default: 8
1228
InterConnectElementDomainId
InterarrivalTimeHistogram Read-Only Attributes

Description:
Parents: interconnectElementDomainIds
Children: None
InterConnectElementDomainId Attributes
Attribute
Description
Type: OCTETSTRING
Default: 00
Name
Type: string
Description:
Parents: interconnectElementDomainIds
Children: None
InterConnectElementDomainId Attributes
Attribute
Description
Type: OCTETSTRING
Default: 00
Name
Type: string
interconnectElementDomainIds (overloaded)
interconnectElementDomainIds (fc)
interconnectElementDomainIds (fcgs)
1229
interconnectElementEntries
interconnectElementDomainIds Object (fc PDU library)

Description:
Parents: gtinAccept (StreamBlock.FCoE.fc.fcPayloads.FCPayload-Choice.gtinAccept)

Children: InterConnectElementDomainId
interconnectElementDomainIds Attributes
Attribute
Description
Name
information.
Type: string
interconnectElementDomainIds Object (fcgs PDU library)

Description:
Parents: gtinAccept (StreamBlock.GtinAccept)

Children: InterConnectElementDomainId
interconnectElementDomainIds Attributes
Attribute
Description
Name
information.
Type: string
interconnectElementEntries (overloaded)
interconnectElementEntries (fc)
interconnectElementEntries (fcgs)
interconnectElementEntries Object (fc PDU library)

Description:
Parents: gielAccept (StreamBlock.FCoE.fc.fcPayloads.FCPayload-Choice.gielAccept)

Children: InterconnectElementEntry
1230
InterconnectElementEntry
interconnectElementEntries Attributes
Attribute
Description
Name
information.
Type: string
interconnectElementEntries Object (fcgs PDU library)

Description:
Parents: gielAccept (StreamBlock.GielAccept)

Children: InterconnectElementEntry
interconnectElementEntries Attributes
Attribute
Description
Name
information.
Type: string
Description:
Parents: interconnectElementEntries
Children: None
InterconnectElementEntry Attributes
Attribute
Description
Type: WWN
Default: 10:00:10:94:00:00:00:00
Default: 00
Possible Values:
Value Description
00
Unknown
01
Switch
02
Hub
03
Bridge
1231
Attribute
Description
Name
Type: string
reserved
Type: OCTETSTRING
Default: 000000
Description:
Parents: interconnectElementEntries
Children: None
InterconnectElementEntry Attributes
Attribute
Description
Type: WWN
Default: 10:00:10:94:00:00:00:00
Default: 00
Possible Values:
Value Description
00
Unknown
01
Switch
02
Hub
03
Bridge
Name
Type: string
reserved
Type: OCTETSTRING
Default: 000000
InterestingStreamsResults
Description:
Provides stream results for the streams matching the chosen CounterResultFilter.

Parents: Analyzer
Relations:
Side name
(Type)
Relative
Description
ResultParent
(ResultChild)
Analyzer
1232
InterestingStreamsResults Writable Attributes

InterestingStreamsResults Read-Only Attributes

Read-Only Attribute
Description
AvgInterarrivalTime

Type: double
Default: 0
AvgJitter
will be measured.
Type: double
Default: 0
AvgLatency

Type: double
Default: 0
BitCount
Count of total bits received.

Type: u64
Default: 0
BitRate

Type: u64
Default: 0
CellCount
Count of total cells received.

Type: u64
Default: 0
CellRate

Type: u64
Default: 0
Comp16_1
Type: u16
Default: 0
Comp16_2
Type: u16
Default: 0
Comp16_3
Type: u16
Default: 0
Comp16_4
Type: u16
Default: 0
Comp32
Type: u32
Default: 0
CounterTimestamp

Type: u64
Default: 0
DroppedFrameCount

Type: u64
Default: 0
DroppedFramePercent

Type: double
Default: 0
1233
Read-Only Attribute
Description

Type: double
Default: 0
DroppedFrameRate

Type: u64
Default: 0
DuplicateFrameCount

Type: u64
Default: 0
DuplicateFrameRate

Type: u64
Default: 0
ExpectedSeqNum

Type: u64
Default: 0
FcsErrorFrameCount

Type: u64
Default: 0
FcsErrorFrameRate
Type: u64
Default: 0
FilteredName_1
Filtered name 1.
Type: string
FilteredName_10
Filtered name 10.

Type: string
FilteredName_2
Filtered name 2.
Type: string
FilteredName_3
Filtered name 3.
Type: string
FilteredName_4
Filtered name 4.
Type: string
FilteredName_5
Filtered name 5.
Type: string
FilteredName_6
Filtered name 6.
Type: string
FilteredName_7
Filtered name 7.
Type: string
FilteredName_8
Filtered name 8.
Type: string
FilteredName_9
Filtered name 9.
Type: string
1234
Read-Only Attribute
Description
FilteredValue_1
Filtered value 1.
Type: string
FilteredValue_10
Filtered value 10.

Type: string
FilteredValue_2
Filtered value 2.
Type: string
FilteredValue_3
Filtered value 3.
Type: string
FilteredValue_4
Filtered value 4.
Type: string
FilteredValue_5
Filtered value 5.
Type: string
FilteredValue_6
Filtered value 6.
Type: string
FilteredValue_7
Filtered value 7.
Type: string
FilteredValue_8
Filtered value 8.
Type: string
FilteredValue_9
Filtered value 9.
Type: string
FirstArrivalTime
Type: double
Default: 0
FrameCount

Type: u64
Default: 0
FrameRate

Type: u64
Default: 0
HistBin10Count

Type: u64
Default: 0
HistBin10Name

Type: string
HistBin10Rate
Type: u64
Default: 0
HistBin11Count

Type: u64
Default: 0
1235
Read-Only Attribute
Description
HistBin11Name

Type: string
HistBin11Rate
Type: u64
Default: 0
HistBin12Count

Type: u64
Default: 0
HistBin12Name

Type: string
HistBin12Rate
Type: u64
Default: 0
HistBin13Count

Type: u64
Default: 0
HistBin13Name

Type: string
HistBin13Rate
Type: u64
Default: 0
HistBin14Count

Type: u64
Default: 0
HistBin14Name

Type: string
HistBin14Rate
Type: u64
Default: 0
HistBin15Count

Type: u64
Default: 0
HistBin15Name

Type: string
HistBin15Rate
Type: u64
Default: 0
HistBin16Count

Type: u64
Default: 0
HistBin16Name

Type: string
HistBin16Rate
Type: u64
Default: 0
1236
Read-Only Attribute
Description
HistBin1Count

Type: u64
Default: 0
HistBin1Name

Type: string
HistBin1Rate
Type: u64
Default: 0
HistBin2Count

Type: u64
Default: 0
HistBin2Name

Type: string
HistBin2Rate
Type: u64
Default: 0
HistBin3Count

Type: u64
Default: 0
HistBin3Name

Type: string
HistBin3Rate
Type: u64
Default: 0
HistBin4Count

Type: u64
Default: 0
HistBin4Name

Type: string
HistBin4Rate
Type: u64
Default: 0
HistBin5Count

Type: u64
Default: 0
HistBin5Name

Type: string
HistBin5Rate
Type: u64
Default: 0
HistBin6Count

Type: u64
Default: 0
HistBin6Name

Type: string
1237
Read-Only Attribute
Description
HistBin6Rate
Type: u64
Default: 0
HistBin7Count

Type: u64
Default: 0
HistBin7Name

Type: string
HistBin7Rate
Type: u64
Default: 0
HistBin8Count

Type: u64
Default: 0
HistBin8Name

Type: string
HistBin8Rate
Type: u64
Default: 0
HistBin9Count

Type: u64
Default: 0
HistBin9Name

Type: string
HistBin9Rate
Type: u64
Default: 0
InOrderFrameCount

Type: u64
Default: 0
InOrderFrameRate

Type: u64
Default: 0
InSeqFrameCount

Type: u64
Default: 0
InSeqFrameRate
Type: u64
Default: 0

Type: u64
Default: 0
Type: u64
Default: 0
L1BitCount
Count of total layer1 bits received.

Type: u64
Default: 0
1238
Read-Only Attribute
Description
L1BitRate

Type: u64
Default: 0
LastArrivalTime
Type: double
Default: 0
LastSeqNum

Type: u64
Default: 0
LateFrameCount

Type: u64
Default: 0
LateFrameRate

Type: u64
Default: 0
MaxFrameLength

Type: u64
Default: 0
MaxInterarrivalTime

Type: double
Default: 0
MaxJitter
Maximum jitter measured in 1 microsecond units. Although jitter value could be negative, only absolute
value will be measured.
Type: double
Default: 0
MaxLatency

Type: double
Default: 0
MinFrameLength

Type: u64
Default: 0
MinInterarrivalTime

Type: double
Default: 0
MinJitter
will be measured.
Type: double
Default: 0
MinLatency

Type: double
Default: 0
OctetCount

Type: u64
Default: 0
OctetRate

Type: u64
Default: 0
OutSeqFrameCount

Type: u64
Default: 0
1239
Read-Only Attribute
Description
OutSeqFrameRate
Type: u64
Default: 0
PortStrayFrames
Type: enum
Default: NA
Possible Values:
Value Description
NA
YES
NO
PrbsBitErrorCount

Type: u64
Default: 0
PrbsBitErrorRate
Type: u64
Default: 0
PrbsBitErrorRatio

Type: double
Default: 0
PrbsErrorFrameCount

Type: u64
Default: 0
PrbsErrorFrameRate

Type: u64
Default: 0
PrbsFillOctetCount

Type: u64
Default: 0
PrbsFillOctetRate
Type: u64
Default: 0
ReorderedFrameCount

Type: u64
Default: 0
ReorderedFrameRate

Type: u64
Default: 0

Type: double
Default: 0
SeqRunLength
sequence run can contain reordered frames (in which the received sequence number is less than the
expected sequence number) but no discontinuities (in which the received sequence number is greater than
the expected sequence number). Sequence runs have no missing sequence numbers between start and
end values.
Type: u64
Default: 0

Type: double
Default: 0
1240
interface
Read-Only Attribute
Description
ShortTermAvgJitter

Type: double
Default: 0
ShortTermAvgLatency

Type: double
Default: 0
SigFrameCount

Type: u64
Default: 0
SigFrameRate

Type: u64
Default: 0
StreamIndex
Type: u32
Default: 0

Type: u64
Default: 0
Type: u64
Default: 0

Type: u64
Default: 0
TotalJitter
Total jitter measured in 1 microsecond units. Although jitter value could be negative, only absolute value
will be measured.
Type: u64
Default: 0
TotalJitterRate

Type: u64
Default: 0
interface
Description:
Children: None
interface Attributes
Attribute
Description
ipv4Address
Type: IPV4ADDR
Default: 192.168.1.1
ipv6Address
Type: IPV6ADDR
Default: 2000::1
1241
interfaceAlias
Attribute
Description
Name
Type: string
interfaceAlias
Description:
Parents: chassisid
Children: None
interfaceAlias Attributes
Attribute
Description
id
Type: ASCII
Default: SPIRENT
Name
information.
Type: string
subtype
Default: 02
Possible Values:
Value Description
01
Chassis Component
02
Interface Alias
03
Port Component
04
MAC Address
05
Network Address
06
Interface Name
07
Locally Assigned
interfaceAlias
Description:
Children: None
interfaceAlias Attributes
Attribute
Description
ChassisID
Type: ASCII
Default: SPIRENT
1242
interfaceAndLabelStackTlv
Attribute
Description
ChassisIDSubtype
Default: 02
Possible Values:
Value Description
Name
01
Chassis Component
02
Interface Alias
03
Port Component
04
MAC Address
05
Network Address
06
Interface Name
07
Locally Assigned
more information.
Type: string
interfaceAndLabelStackTlv
Description:
Children: interface, ipAddress
interfaceAndLabelStackTlv Attributes
Attribute
Description
addressType
Type: AddressTypeType
Default: 1
Possible Values:
Value Description
1
1-IPv4 Numbered
2-IPv4 Unnumbered
3-IPv6 Numbered
4-IPv6 Unnumbered
labelStack
Type: OCTETSTRING
Default: 00000000
length
Type: INTEGER
Default: 16
Name
Type: string
reserved
Type: INTEGER
Default: 0
type
Type: INTEGER
Default: 7
1243
interfaceName
interfaceName
Description:
Parents: chassisid
Children: None
interfaceName Attributes
Attribute
Description
id
Type: ASCII
Default: SPIRENT
Name
information.
Type: string
subtype
Default: 06
Possible Values:
Value Description
01
Chassis Component
02
Interface Alias
03
Port Component
04
MAC Address
05
Network Address
06
Interface Name
07
Locally Assigned
interfaceName
Description:
Children: None
interfaceName Attributes
Attribute
Description
ChassisID
Type: ASCII
Default: SPIRENT
ChassisIDSubtype
Default: 06
Possible Values:
Value Description
01
Chassis Component
02
Interface Alias
03
Port Component
04
MAC Address
05
Network Address
06
Interface Name
07
Locally Assigned
1244
InterfaceStatusTLV
Attribute
Description
Name
more information.
Type: string
InterfaceStatusTLV (overloaded)
InterfaceStatusTLV (EOAM)
InterfaceStatusTLV (serviceoam)
InterfaceStatusTLV Object (EOAM PDU library)

Description:

Children: None
InterfaceStatusTLV Attributes
Attribute
Description
IntStatusValues
Type: intTLVvalues
Default: 01
Possible Values:
Value Description
01
Up
02
Down
03
Testing
04
Unknown
05
Dormant
06
notPresent
07
lowerLayerDown
Length
Type: OCTETSTRING
Default: 0000
Name
more information.
Type: string
Type
Type: OCTETSTRING
Default: 04
1245
intermediateSwitchsPathInformation
InterfaceStatusTLV Object (serviceoam PDU library)

Description:

Children: None
InterfaceStatusTLV Attributes
Attribute
Description
IntStatusValues
Type: intTLVvalues
Default: 01
Possible Values:
Value Description
01
Up
02
Down
03
Testing
04
Unknown
05
Dormant
06
notPresent
07
lowerLayerDown
Length
Type: OCTETSTRING
Default: 0000
Name
more information.
Type: string
Type
Type: OCTETSTRING
Default: 04
intermediateSwitchsPathInformation (overloaded)
intermediateSwitchsPathInformation (fc)
intermediateSwitchsPathInformation (fcgs)
intermediateSwitchsPathInformation Object (fc PDU library)

Description:
Parents: ftrAccept (StreamBlock.FCoE.fc.fcPayloads.FCPayload-Choice.ftrAccept)

1246
IntStat
intermediateSwitchsPathInformation Attributes
Attribute
Description
Name
information.
Type: string
intermediateSwitchsPathInformation Object (fcgs PDU library)

Description:
Parents: ftrAccept (StreamBlock.FtrAccept)

intermediateSwitchsPathInformation Attributes
Attribute
Description
Name
information.
Type: string
IntStat (EOAMTLV:IntStat)
Description:
Children: None
IntStat Attributes
Attribute
Description
IntStatusValues
Type: intTLVvalues
Default: 01
Possible Values:
Value Description
01
Up
02
Down
03
Testing
04
Unknown
05
Dormant
06
notPresent
07
lowerLayerDown
1247
IP
Attribute
Description
Length
Type: OCTETSTRING
Default: 0000
Name
more information.
Type: string
Type
Type: OCTETSTRING
Default: 04
IP (ip:IP)
Description:
Children: tosDiffserv
Next headers: ipv4:IPv4, ipv6:IPv6, icmp:IcmpDestUnreach, icmp:IcmpTimeExceeded, icmp:IcmpParameterProblem, icmp:IcmpSourceQuench, icmp:IcmpRedirect,
icmp:IcmpEchoRequest, icmp:IcmpEchoReply, icmp:IcmpTimestampRequest, icmp:IcmpTimestampReply, icmp:IcmpInfoRequest, icmp:IcmpInfoReply,
igmp:Igmpv1, igmp:Igmpv2, igmp:Igmpv2Query, igmp:Igmpv2Report, igmp:Igmpv3Query, igmp:Igmpv3Report, tcp:Tcp, udp:Udp, gre:Gre, ospfv2:Ospfv2Unknown,
ospfv2:Ospfv2Hello, ospfv2:Ospfv2DatabaseDescription, ospfv2:Ospfv2LinkStateRequest, ospfv2:Ospfv2LinkStateUpdate, ospfv2:Ospfv2LinkStateAcknowledge,
pim:Pimv4Hello, pim:Pimv4Register, pim:Pimv4RegisterStop, pim:Pimv4JoinPrune, pim:Pimv4Assert, custom:Custom
IP Attributes
Attribute
Description
gateway
Type: IPV4ADDR
Default: 192.85.1.1
Name
Type: string
prefixLength
Type: INTEGER
Default: 24
sourceAddr
Type: IPV4ADDR
Default: 192.85.1.2
ttl
Type: INTEGER
Default: 255
v6gateway
Type: IPV6ADDR
Default: 2000::1
v6hopLimit
Type: INTEGER
Default: 255
v6llhopLimit
Type: INTEGER
Default: 255
v6llprefixLength
Type: INTEGER
Default: 128
v6llsourceAddr
Type: IPV6ADDR
Default: FE80::1
v6lltrafficClass
Type: INTEGER
Default: 0
1248
ipAddress
Attribute
Description
v6prefixLength
Type: INTEGER
Default: 64
v6sourceAddr
Type: IPV6ADDR
Default: 2000::2
v6trafficClass
Type: INTEGER
Default: 0
ipAddress
Description:
Children: None
ipAddress Attributes
Attribute
Description
ipv4Address
Type: IPV4ADDR
Default: 192.168.1.1
ipv6Address
Type: IPV6ADDR
Default: 2000::1
Name
Type: string
ipData (overloaded)
ipData (icmp)
ipData (icmpv6)
ipData Object (icmp PDU library)

Description:
Parents: IcmpDestUnreach (StreamBlock.IcmpDestUnreach)

IcmpTimeExceeded (StreamBlock.IcmpTimeExceeded)
IcmpParameterProblem (StreamBlock.IcmpParameterProblem)
IcmpSourceQuench (StreamBlock.IcmpSourceQuench)
IcmpRedirect (StreamBlock.IcmpRedirect)
Children: ipHdr
1249
IpForwardingLink
ipData Attributes
Attribute
Description
data
Type: OCTETSTRING
Default: 0000000000000000
Name
information.
Type: string
ipData Object (icmpv6 PDU library)

Description:
Parents: Icmpv6DestUnreach (StreamBlock.Icmpv6DestUnreach)

Icmpv6PacketTooBig (StreamBlock.Icmpv6PacketTooBig)
Icmpv6TimeExceeded (StreamBlock.Icmpv6TimeExceeded)
Icmpv6ParameterProblem (StreamBlock.Icmpv6ParameterProblem)
RedirectedHeader (StreamBlock.Redirect.redirectedHdrOption.RedirectedHeader)
Children: ipHdr
ipData Attributes
Attribute
Description
data
Type: OCTETSTRING
Default: 0000000000000000
Name
information.
Type: string
IpForwardingLink
Description:
Link between two IP devices. In most cases, L3ForwardingLink should be used instead of IpForwardingLink.

Relations:
Side name
(Type)
Relative
Description
Container
(ContainedLink)

(LinkDst)
1250
ipHdr
Side name
(Type)
Relative
Description
LinkDstDevice
(LinkDstDevice)
EmulatedDevice
NetworkLinkSource
(LinkSrc)
IpForwardingLink Writable Attributes

Writable Attribute
Description
Active, Name
IpForwardingLink Read-Only Attributes

Read-Only Attribute
Description
LinkType
Name of Link Type.

Type: string
ipHdr (overloaded)
ipHdr (ipv4)
ipHdr (ipv6)
ipHdr Object (ipv4 PDU library)

Description:
Parents: ipData (StreamBlock.IcmpDestUnreach.ipData)

ipData (StreamBlock.IcmpTimeExceeded.ipData)
ipData (StreamBlock.IcmpParameterProblem.ipData)
ipData (StreamBlock.IcmpSourceQuench.ipData)
ipData (StreamBlock.IcmpRedirect.ipData)
StreamBlock (StreamBlock)
Children: flags, options, tosDiffserv
ipHdr Attributes
Attribute
Description
checksum
Type: INTEGER
Default: 0
destAddr
Type: IPV4ADDR
Default: 192.0.0.1
destPrefixLength
Type: INTEGER
Default: 24
1251
ipHdr
Attribute
Description
fragOffset
Type: INTEGER
Default: 0
gateway
Type: IPV4ADDR
Default: 192.85.1.1
identification
Type: INTEGER
Default: 0
ihl
Type: INTEGER
Default: 5
Name
information.
Type: string
padding
Type: ALIGNMENTPAD
Default: 0
prefixLength
Type: INTEGER
Default: 24
1252
ipHdr
Attribute
Description
protocol
Type: IpProtocolNumbers
Default: 253
Possible Values:
1253
ipHdr
Attribute
Description
Value Description
0
HOPOPT
ICMP
IGMP
GGP
IP
ST
TCP
CBT
EGP
IGP
10
BBN-RCC-MON
11
NVP-II
12
PUP
13
ARGUS
14
EMCON
15
XNET
16
CHAOS
17
UDP
18
MUX
19
DCN-MEAS
20
HMP
21
PRM
22
XNS-IDP
23
TRUNK-1
24
TRUNK-2
25
LEAF-1
26
LEAF-2
27
RDP
28
IRTP
29
ISO-TP4
30
NETBLT
31
MFE-NSP
32
MERIT-INP
33
SEP
34
3PC
35
IDPR
36
XTP
37
DDP
38
IDPR-CMTP
39
TP++
40
IL
41
IPv6
42
SDRP
43
IPv6-Route
44
IPv6-Frag
45
IDRP
46
RSVP
47
GRE
48
MHRP
49
BNA
1254
ipHdr
Attribute
Description
Value Description
50
ESP
51
AH
52
I-NLSP
53
SWIPE
54
NARP
55
MOBILE
56
TLSP
57
SKIP
58
IPv6-ICMP
59
IPv6-NoNxt
60
IPv6-Opts
62
CFTP
64
SAT-EXPAK
65
KRYPTOLAN
66
RVD
67
IPPC
69
SAT-MON
70
VISA
71
IPCV
72
CPNX
73
CPHB
74
WSN
75
PVP
76
BR-SAT-MON
77
SUN-ND
78
WB-MON
79
WB-EXPAK
80
ISO-IP
81
VMTP
82
SECURE-VMTP
83
VINES
84
TTP
85
NSFNET-IGP
86
DGP
87
TCF
88
EIGRP
89
OSPFIGP
90
Sprite-RPC
91
LARP
92
MTP
93
AX.25
94
IPIP
95
MICP
96
SCC-SP
97
ETHERIP
98
ENCAP
100
GMTP
101
IFMP
102
PNNI
103
PIM
1255
ipHdr
Attribute
Description
Value Description
104
ARIS
105
SCPS
106
QNX
107
A/N
108
IPComp
109
SNP
110
Compaq-Peer
111
IPX-in-IP
112
VRRP
113
PGM
115
L2TP
116
DDX
117
IATP
118
STP
119
SRP
120
UTI
121
SMP
122
SM
123
PTP
124
ISIS over IPv4
125
FIRE
126
CRTP
127
CRUDP
128
SSCOPMCE
129
IPLT
130
SPS
131
PIPE
132
SCTP
133
FC
134
RSVP-E2E-IGNORE
135
Mobility Header
136
UDPLite
137
MPLS-in-IP
253
Experimental
255
Reserved
sourceAddr
Type: IPV4ADDR
Default: 192.85.1.2
totalLength
Type: INTEGER
Default: 20
ttl
Type: INTEGER
Default: 255
version
Type: INTEGER
Default: 4
1256
ipHdr
ipHdr Object (ipv6 PDU library)

Description:
Parents: ipData (StreamBlock.Icmpv6DestUnreach.ipData)

ipData (StreamBlock.Icmpv6PacketTooBig.ipData)
ipData (StreamBlock.Icmpv6TimeExceeded.ipData)
ipData (StreamBlock.Icmpv6ParameterProblem.ipData)
ipData (StreamBlock.Redirect.redirectedHdrOption.RedirectedHeader.ipData)
StreamBlock (StreamBlock)
Children: None
ipHdr Attributes
Attribute
Description
destAddr
Type: IPV6ADDR
Default: 2000::1
destPrefixLength
Type: INTEGER
Default: 64
flowLabel
Type: INTEGER
Default: 0
gateway
Type: IPV6ADDR
Default: ::0
hopLimit
Type: INTEGER
Default: 255
Name
information.
Type: string
1257
ipHdr
Attribute
Description
nextHeader
Default: 59
Possible Values:
1258
ipHdr
Attribute
Description
Value Description
0
HOPOPT
ICMP
IGMP
GGP
IP
ST
TCP
CBT
EGP
IGP
10
BBN-RCC-MON
11
NVP-II
12
PUP
13
ARGUS
14
EMCON
15
XNET
16
CHAOS
17
UDP
18
MUX
19
DCN-MEAS
20
HMP
21
PRM
22
XNS-IDP
23
TRUNK-1
24
TRUNK-2
25
LEAF-1
26
LEAF-2
27
RDP
28
IRTP
29
ISO-TP4
30
NETBLT
31
MFE-NSP
32
MERIT-INP
33
SEP
34
3PC
35
IDPR
36
XTP
37
DDP
38
IDPR-CMTP
39
TP++
40
IL
41
IPv6
42
SDRP
43
IPv6-Route
44
IPv6-Frag
45
IDRP
46
RSVP
47
GRE
48
MHRP
49
BNA
1259
ipHdr
Attribute
Description
Value Description
50
ESP
51
AH
52
I-NLSP
53
SWIPE
54
NARP
55
MOBILE
56
TLSP
57
SKIP
58
IPv6-ICMP
59
IPv6-NoNxt
60
IPv6-Opts
62
CFTP
64
SAT-EXPAK
65
KRYPTOLAN
66
RVD
67
IPPC
69
SAT-MON
70
VISA
71
IPCV
72
CPNX
73
CPHB
74
WSN
75
PVP
76
BR-SAT-MON
77
SUN-ND
78
WB-MON
79
WB-EXPAK
80
ISO-IP
81
VMTP
82
SECURE-VMTP
83
VINES
84
TTP
85
NSFNET-IGP
86
DGP
87
TCF
88
EIGRP
89
OSPFIGP
90
Sprite-RPC
91
LARP
92
MTP
93
AX.25
94
IPIP
95
MICP
96
SCC-SP
97
ETHERIP
98
ENCAP
100
GMTP
101
IFMP
102
PNNI
103
PIM
1260
ipHdr
Attribute
Description
Value Description
104
ARIS
105
SCPS
106
QNX
107
A/N
108
IPComp
109
SNP
110
Compaq-Peer
111
IPX-in-IP
112
VRRP
113
PGM
115
L2TP
116
DDX
117
IATP
118
STP
119
SRP
120
UTI
121
SMP
122
SM
123
PTP
124
ISIS over IPv4
125
FIRE
126
CRTP
127
CRUDP
128
SSCOPMCE
129
IPLT
130
SPS
131
PIPE
132
SCTP
133
FC
134
RSVP-E2E-IGNORE
135
Mobility Header
136
UDPLite
137
MPLS-in-IP
253
Experimental
255
Reserved
payloadLength
Type: INTEGER
Default: 0
prefixLength
Type: INTEGER
Default: 64
sourceAddr
Type: IPV6ADDR
Default: 2000::2
trafficClass
Type: INTEGER
Default: 0
version
Type: INTEGER
Default: 6
1261
IptvChannelBlock
IptvChannelBlock
Description:
Global block of channels corresponding to the global list of multicast groups.

Parents: Project
Children: Dhcpv4ServerDefaultPoolConfig, Dhcpv4ServerPoolConfig, Dhcpv6ServerAddrPoolConfig, Dhcpv6ServerDefaultAddrPoolConfig,
Dhcpv6ServerDefaultPrefixPoolConfig, Dhcpv6ServerPrefixPoolConfig, Ipv4NetworkBlock, Ipv6NetworkBlock, MacBlock, Pimv4JoinSrc, Pimv4PruneSrc,
Pimv6JoinSrc, Pimv6PruneSrc, PppoeServerIpv4PeerPool, PppoxServerIpv4PeerPool, PppoxServerIpv6PeerPool, VlanBlock
Relations:
Side name
(Type)
Relative
Description
McastParameter
(MulticastParam)
Multicast groups corresponding to the channels.
EmulatedDevice
(TrafficSources)
EmulatedDevice
List of sources for source specific multicast (IGMPv3/MLDv2).
IptvChannelBlock Writable Attributes

Writable Attribute
Description
Active, Name
ChannelName
A name for the IPTV channel block. Emulated IPTV channels simulate different types of television programming (e.g.,
sports and news) transmitted by multicast servers.
Type: string
Default: news
ChannelStart
Channel number for the first multicast group in the channel block.
Type: u32
Default: 1
Range: 1 - 32000
FilterMode
Describes whether the sources specified should be used or excluded from global list of sources. Select INCLUDE to
enable the IPTV channel group to receive multicast data only from the sources specified in the Subscribed Sources field.
Select EXCLUDE to reject multicast data from the sources specified in the Subscribed Sources field.
Type: enum
Default: INCLUDE
Possible Values:
Value
Description
INCLUDE Specifies that the host should be used.
EXCLUDE Specifies that the host must be excluded.
RtpNackEnable
Indicates whether or not STBs shall send RTP NACK messages for this channel block.
Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
RTP NACK messages will be sent.
FALSE RTP NACK messages will not be sent.

UdpDestinationPort
A destination UDP port parameter which shall be used to populate the ChannelUDP port field in the RTCP Join messages
for the first channel in the Channel block in a FCC test.
Type: u16
Default: 40005
Range: 1 - 65535
UdpDestinationPortStep
A destination UDP port step parameter which shall be used to populate the Channel UDP port field in the RTCP Join
messages for channels other than the first channel in the Channel block in a FCC test. The UDP port number for the Nth
channel in a Channel block shall be the base UDP port for the Channel block plus (N-1) times the UDP port step value.
Type: u16
Default: 1
1262
IptvChannelResults
Writable Attribute
Description
UserDefinedSources
Defines the source IP addresses instead of using pre-defined hosts.

Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
Source IP address for source-specific multicast is provided by the user.
FALSE Source IP address for source-specific multicast is taken from hosts specified by the user.
IptvChannelBlock Read-Only Attributes

IptvChannelResults
Description:
Channel results aggregated on the block of viewed channels.
NOTE: The frame count and error count statistics always have a value of zero if Environment was set to Real World Environment either in the IPTV Test
dialog box (see Setting Up IPTV Test Parameters) or in the IPTV wizard (see Using the IPTV Wizard). These statistics cannot be obtained when a real video
source is used in the test. For more information about latency calculations, see IPTV Test Diagram. For information about IPTV results displayed by Results
Reporter, see IPTV Results in Results Reporter.

Parents: IptvViewedChannels
Relations:
Side name
(Type)
Relative
Description
ResultParent
(ResultChild)
IptvViewedChannels
IptvChannelResults Writable Attributes

IptvChannelResults Read-Only Attributes

Read-Only Attribute
Description
AvgJoinLatency
Average length of time (in msec) it took to receive data on a channel once the first Join message for that channel
was sent.
Type: double
Default: 0
AvgLeaveLatency
Average length of time (in msec) it took to stop receiving data on a channel once the first Leave message for
that channel was sent.
Type: double
Default: 0
AvgRetransmissionLatency
Average retransmission latency, among channels in this viewed channel block.

Type: double
Default: 0
AvgUnicastJoinLatency
Average latency from the transmission of the unicast Join message for a channel and the receipt of the first
unicast packet for that channel, among channels in this viewed channel block.
Type: double
Default: 0
1263
IptvChannelResults
Read-Only Attribute
Description
AvgUnicastLeaveLatency
Average latency from the transmission of the unicast Leave message for a channel and the receipt of the last
Type: double
Default: 0
AvgUnicastMulticastPktGap
Average number of packets that were missing between the end of the unicast stream for a channel and the
start of the corresponding multicast stream for that channel, among channels in this viewed channel block.
Type: double
Default: 0
AvgUnicastMulticastPktOverlap
Average number of packets received in the unicast stream for a channel that were duplicated in the corresponding
multicast stream, among channels in this viewed channel block.
Type: double
Default: 0
AvgUnicastPktRateNosb
Average non-Sbit packet rate of all STBs, among channels in this viewed channel block.
Type: double
Default: 0
AvgUnicastPktRateSbit
Average non-Sbit packet rate of all STBs, among channels in this viewed channel block.
Type: double
Default: 0
ChannelName
Name of the viewed channels profile.

Type: string
Default: NA
DroppedFrameCount
Total number of packets lost in transit, aggregated on the viewed channel block.
Type: u64
Default: 0
DroppedUnicastFrameCount
Dropped packets in the unicast streams, aggregated on this viewed channel block.
Type: u64
Default: 0
DuplicateFrameCount
Total number of duplicate packets, aggregated on the viewed channel block.

Type: u64
Default: 0
DuplicateJoins
Number of times that a Join message was sent for a channel for which multicast packets were already being
received. Duplicate Joins occur when the client is changing to a channel and multicast data for that channel is
being received before the Join message is sent.
Type: double
Default: 0
DuplicateUnicastFrameCount
Duplicate packets in the unicast streams, aggregated on this viewed channel block.
Type: u64
Default: 0
DuplicateUnicastJoins
Number of duplicate unicast Joins, aggregated on this viewed channel block.

Type: double
Default: 0
ErroredStreams
Number of errored streams received.

Type: double
Default: 0
ErroredUnicastStreams
Number of errored unicast streams, aggregated on this viewed channel block.

Type: double
Default: 0
FailedRetransmissionCount
Number of failed RTP retranmissions, aggregated on the viewed channel block.

Type: u64
Default: 0
FlaggedRetransmissionCount
Number of flagged RTP retranmissions, aggregated on the viewed channel block.

Type: u64
Default: 0
1264
IptvChannelResults
Read-Only Attribute
Description
InvalidFirstPktCount
Count of packets with an invalid first packet timestamp, aggregated on the viewed channel block.
Type: u64
Default: 0
InvalidLastPktCount
Count of packets with an invalid last packet timestamp, aggregated on the viewed channel block.
Type: u64
Default: 0
JoinFails
Number of times that a channel was joined but no multicast data for the channel was received before a Leave
message was sent for the next channel that was joined.
Type: double
Default: 0
LateFrameCount
Total number of late packets, aggregated on the viewed channel block.

Type: u64
Default: 0
LateUnicastFrameCount
Late packets in the unicast streams, aggregated on this viewed channel block.
Type: u64
Default: 0
MaxJoinLatency
Maximum length of time (in msec) it took to receive data on a channel once the first Join message for that
channel was sent.
Type: double
Default: 0
MaxLeaveLatency
Maximum length of time (in msec) it took to stop receiving data on a channel once the first Leave message for
Type: double
Default: 0
MaxRetransmissionLatency
Maximum retransmission latency, among channels in this viewed channel block.

Type: double
Default: 0
MaxUnicastJoinLatency
The largest latency from the transmission of the unicast Join message for a channel and the receipt of the first
Type: double
Default: 0
MaxUnicastLeaveLatency
Maximum latency from the transmission of the unicast Leave message for a channel and the receipt of the last
Type: double
Default: 0
MaxUnicastMulticastPktGap
Maximum number of packets that were missing between the end of the unicast stream for a channel and the
Type: double
Default: 0
MaxUnicastMulticastPktOverlap
Maximum number of packets received in the unicast stream for a channel that were duplicated in the
corresponding multicast stream, among channels in this viewed channel block.
Type: double
Default: 0
MaxUnicastPktRateNosb
Maximum non-Sbit packet rate of any STB, among channels in this viewed channel block.
Type: double
Default: 0
MaxUnicastPktRateSbit
Maximum Sbit packet rate of any STB, among channels in this viewed channel block.
Type: double
Default: 0
MinJoinLatency
Minimum length of time (in msec) it took to receive data on a channel once the first Join message for that
channel was sent.
Type: double
Default: 0
1265
IptvChannelResults
Read-Only Attribute
Description
MinLeaveLatency
Minimum length of time (in msec) it took to stop receiving data on a channel after the first Leave message for
Type: double
Default: 0
MinRetransmissionLatency
Minimum retransmission latency, among channels in this viewed channel block.

Type: double
Default: 0
MinUnicastJoinLatency
Smallest latency from the transmission of the unicast Join message for a channel and the receipt of the first
Type: double
Default: 0
MinUnicastLeaveLatency
Minimum latency from the transmission of the unicast Leave message for a channel and the receipt of the last
Type: double
Default: 0
MinUnicastMulticastPktGap
Minimum number of packets that were missing between the end of the unicast stream for a channel and the
Type: double
Default: 0
MinUnicastMulticastPktOverlap
Minimum number of packets received in the unicast stream for a channel that were duplicated in the
corresponding multicast stream for that channel, among channels in this viewed channel block.
Type: double
Default: 0
MinUnicastPktRateNosb
Minimum non-Sbit packet rate of any STB, among channels in this viewed channel block.
Type: double
Default: 0
MinUnicastPktRateSbit
Minimum Sbit packet rate of any STB, among channels in this viewed channel block.
Type: double
Default: 0
NumOfChannelChanges
Number of channel changes in the test.

Type: double
Default: 0
NumOfChannels
Number of channels in the profile.

Type: u32
Default: 0
PrbsErrorCount
Total number of pseudo-random binary sequence errors, aggregated on the viewed channel block.
Type: u64
Default: 0
ReorderedFrameCount
Total number of packets re-ordered, aggregated on the viewed channel block.

Type: u64
Default: 0
ReorderedUnicastFrameCount
Reordered packets in the unicast streams, aggregated on this viewed channel block.
Type: u64
Default: 0
Timestamp

Type: double
Default: 0
TotalMulticastPktRate
Sum of multicast packets over sum of multicast durations, for channels aggregated on the viewed channel
block.
Type: double
Default: 0
1266
IptvPortResults
Read-Only Attribute
Description
TotalMulticastPkts
Total packets received in the multicast streams, aggregated on the viewed channel block.
Type: double
Default: 0
TotalPktRate
Total packet receive rate (in packets/sec).

Type: double
Default: 0
TotalPkts
Total packets received in the multicast and/or unicast streams, aggregated on the viewed channel block.
Type: double
Default: 0
TotalUnicastPktRate
Sum of unicast packets over sum of unicast durations, for channels aggregated on the viewed channel block.
Type: double
Default: 0
TotalUnicastPktRateNosb
Sum of unicast packets without sbit over sum of unicast durations without sbit, for channels aggregated on the
viewed channel block.
Type: double
Default: 0
TotalUnicastPktRateSbit
Sum of unicast packets with sbit over sum of unicast durations with sbit, for channels aggregated on the viewed
channel block.
Type: double
Default: 0
TotalUnicastPkts
Total packets received in the unicast streams, aggregated on the viewed channel block.
Type: double
Default: 0
TotalUnicastPktsNosb
Total packets received in the unicast streams, without Sbit flag set, for channels aggregated on the viewed
channel block.
Type: double
Default: 0
TotalUnicastPktsSbit
Total packets received in the unicast streams, with Sbit flag set, for channels aggregated on the viewed channel
block.
Type: double
Default: 0
UnicastJoinFails
Number of times that a channel was joined but no unicast data for the channel was received before a Leave
message was sent for the next channel that was joined, aggregated on the viewed channel block.
Type: double
Default: 0
UnicastPrbsErrorCount
Unicast PRBS Bit Error Count in the unicast streams, aggregated on this viewed channel block.
Type: u64
Default: 0
IptvPortResults
Description:
Results aggregated at port level.

Parents: Port
Relations:
1267
IptvStartTestCommand
Side name
(Type)
Relative
Description
ResultParent
(ResultChild)
Port
IptvPortResults Writable Attributes

IptvPortResults Read-Only Attributes

Read-Only Attribute
Description
DroppedFrameCount
Total number of dropped (lost) frames for the port.

Type: u64
Default: 0
DuplicateFrameCount
Total number of duplicate packets received aggregated on the port.

Type: u64
Default: 0
DuplicatePkts
Number of duplicate packets.

Type: double
Default: 0
LateFrameCount
Total number of late packets received aggregated on the port.

Type: u64
Default: 0
LatePkts
Number of late packets.

Type: double
Default: 0
PrbsErrorCount
Total number of pseudo-random binary sequence errors for the port.

Type: u64
Default: 0
ReorderedFrameCount
Total number of packets re-ordered aggregated on the port.

Type: u64
Default: 0
Timestamp

Type: double
Default: 0
TotalPktRate

Type: double
Default: 0
TotalPkts
Total number of packets received for the port.

Type: double
Default: 0
Description:
Start the configured IPTV test on the specified blocks of STBs.

1268
IptvStartTestCommand Writable Attributes

Writable Attribute
Description
AddToIterationResults
Adds IPTV results database into the iteration results database.

Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
If true, the IPTV database is moved and added into the iteration results database, if the Save Iteration Results
command is present. (Sequencer only.)
FALSE If false, the IPTV database is not added into the iteration results database and instead resides at its normal
location.
DatabaseFileName
File name for the end-of-test (EOT) database in which results are stored. The file name is only applicable for interactive
tests. For tests run via the command sequencer, an automatically generated file name will be used.
Default: iptvTest.db
ExtHdrCheckEnable
Enable extension header validation.

Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
Check extension header.
FALSE Do not check extension header.

ExtHdrCheckPatternPeriod
This period will define the frequency that the header field pattern, which is to be checked against the contents of the first
unicast packet, is present in the Spirent TestCenter-generated channel stream. The period shall be represented by a number
N, such that the frequency of the pattern in the stream is 1 in N packets.
Type: u32
Default: 10
InterStbStartDelayStep
Start delay (in msec) for the blocks of STB.

Type: u32
Default: 0
JoinFailPercentageThreshold
A percentage. If the number of failed Joins divided by the total number of channel changes is greater than this percentage,
then the IPTV test event in the Event Scheduler fails. A failed Join occurs when a Join message is sent and the corresponding
channel data is not received within a certain time period. (Set this percentage to 100 for the event to pass regardless of the
number of failed Joins.)
Type: u32
Default: 100
Range: 0 - 100
MaxSbitDelay
Defines the latest time to check for the presence of the Sbit in the unicast stream.
Type: u32
Default: 2000
MinSbitDelay
Defines the earliest time to check for the presence of the Sbit in the unicast stream.
Type: u32
Default: 0
MulticastJoinTrigger
The event that begins the countdown until the multicast Join will be performed.
Type: enum
Default: UNICAST_JOIN_AND_DELAY
Possible Values:
Value
Description
UNICAST_JOIN_AND_DELAY If the "Unicast Join + Delay" multicast Join trigger is selected for a FCC test, the multicast
Join message for a channel shall be transmitted after a multicast Join trigger delay following
the transmission of the corresponding unicast Join message.
SBIT_AND_DELAY
If the "S-Bit + Delay" multicast Join trigger is selected for a FCC test, the multicast Join
message for a channel shall be transmitted after a multicast Join trigger delay following
the receipt of the first unicast packet with the S-bit set for the corresponding channel.
1269
Writable Attribute
Description
RtpRetransmitThreshold
Time by which a RTP retransmission must be received for the retransmission to be considered successful.
Type: u32
Default: 50
StbBlockList
List of handles corresponding to the blocks of STBs that will be used in the test.
Type: handle
Default: 0
TestEnv
Specifies the set up of source side traffic.

Type: enum
Default: TESTING_ENV
Possible Values:
Value
Description
TESTING_ENV
Testing environment (The traffic sources are set up in the test using Spirent TestCenter.)
REAL_WORLD_ENV Real world environment (The traffic is generated from a non-Spirent TestCenter source.)
TestName
User-defined test name.

Type: string
Default: IptvTest
TestTime
Duration (in seconds) that the test runs.

Type: double
Default: 300
Range: 0 - 429496729
TypeOfTest
Type of test under IPTV testing scenario.

Type: enum
Default: CHANNEL_VERIFICATION_TEST
Possible Values:
Value
Description
CHANNEL_ZAPPING_TEST
The channel zapping test is used to monitor zapping characteristics for a large
number of subscribers. Select the channel zapping test for stress testing a DUT
or SUT.
CHANNEL_VERIFICATION_TEST
The channel verification test is used to verify that each multicast channel is
properly received by a small number of subscribers. Select the channel verification
test for initial functional testing.
FAST_CHANNEL_CHANGE_TEST
RELIABLE_RETRANSMISSION_TEST
FCC_WITH_RRR_TEST
UdpPortNum
Port number on which packets are filtered.

Type: u32
Default: 3357
UdpPortTypeFilter
Select to filter on the source or destination UDP port. (Applicable only for real world test environment.)
Type: enum
Default: SOURCE
Possible Values:
Value
Description
SOURCE
UDP port to be filtered on this source.
DESTINATION Received packets to be filtered on the destination UDP ports.

UnicastLeaveTrigger
The event that begins the countdown until the unicast Leave will be performed.
Type: enum
Default: UNICAST_JOIN_AND_DELAY
Possible Values:
Value
Description
UNICAST_JOIN_AND_DELAY
If the "Unicast Join + Delay" unicast Leave trigger is selected for a FCC test, the unicast
Leave message for a channel shall be transmitted after a unicast Leave trigger delay
following the transmission of the corresponding unicast Join message.
MULTICAST_PKT_AND_DELAY If the "Multicast Packet + Delay" unicast Leave trigger is selected for a FCC test, the
unicast Leave message for a channel shall be transmitted after a unicast Leave trigger
delay following the receipt of the first multicast packet for the corresponding channel.
1270
IptvStbBlockConfig
Writable Attribute
Description
VlanSubFilter
For ports with PPP and VLAN stacking enabled, one subfilter is dedicated to the PPP session ID while the other available
subfilter can be used for either the outer VLAN ID or inner VLAN ID.
Type: enum
Default: OUTER
Possible Values:
Value Description
OUTER Filters the hosts on the outer VLAN ID.
INNER Filters the IGMP/MLD hosts based on the inner VLAN ID.
IptvStartTestCommand Read-Only Attributes

Read-Only Attribute
Description

IptvStbBlockConfig
Description:
This object aggregates set top boxes into a block with a common profile and viewed channels. It is a child of host and has an associated multicast configuration.

Result children (automatically created): IptvStbBlockResults
Relations:
Side name
(Type)
Relative
Description
ProfileForStb
(IptvProfile)
IptvViewingProfileConfig
Profile describing viewing behavior of block.
McastParameter
(MulticastParam)
IgmpHostConfig, MldHostConfig
Multicast configuration of the block of STBs.
ResultChild
(ResultChild)
IptvStbBlockResults
ChannelForStb
(StbChannel)
IptvViewedChannels
Channels that the boxes belonging to the block will view during the
test. Multiple viewed channels can be associated with a block. The
channels specified cannot overlap.
IptvStbBlockConfig Writable Attributes

Writable Attribute
Description
Active, Name
FccServerAddrV4
IPv4 address of the FCC server.

Type: ip
Default: 3.3.3.3
FccServerAddrV6
IPv6 address of the FCC server.

Type: ipv6
Default: 2000::3333
1271
IptvStbBlockConfig
Writable Attribute
Description
FccServerPort
IP port of the FCC server.

Type: u16
Default: 4096
Range: 1 - 65535
InterClientStartDelayStep
Delay period (in msec) between the first Join messages of consecutive IPTV clients in the block.
Type: u32
Default: 0
MinBufferLevel
Each STB block shall include a Minimum Buffer Level parameter which shall be used to populate the Client Required
Minimum Buffer Level field in the RTCP Join messages in a FCC test.
Type: u16
Default: 300
RrrServerAddrV4
Destination IPv4 address in the RTCP NACK messages sent from hosts that are members of the STB block.
Type: ip
Default: 3.3.3.3
RrrServerAddrV6
Destination IPv6 address in the RTCP NACK messages sent from hosts that are members of the STB block.
Type: ipv6
Default: 2000::3333
RrrServerPort
Destination UDP port in the RTCP NACK messages sent from hosts that are members of the STB block.
Type: u16
Default: 4098
Range: 1 - 65535
RtpNackDelay
Indicates the approximate delay between receipt of an RTP packet for the NACK-enabled channel used for RTP
sequence number identification and the subsequent transmission of the NACK message.
Type: u32
Default: 200
RtpNackEnable
Indicates whether or not STBs in the block shall send RTP NACK messages for RTP NACK-enabled channels.
Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
RTP NACK messages will be sent.
FALSE RTP NACK messages will not be sent.

RtpNackInterval
Indicates the approximate period at which STBs in the RTP NACK-enabled STB block shall send RTP NACKs for
received channels that are RTP NACK-enabled.
Type: u32
Default: 5000
RtpNackSeqBitmask
Indicates the bit field of lost packets (BLP) to include in the RTP NACK message sent by the STBs in the block for
RTP NACK-enabled channels.
Type: u16
Default: 0
SaveTimeStamps
Saves the time stamps of individual events in end-of-test database.

Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
If true, the timestamps are saved.
FALSE If false, the timestamps are not saved. Only block level results are available at end-of-test.
UdpSourcePort
A UDP port parameter which shall be used in a FCC test for the source UDP port in the RTCP Join and Leave
messages sent from the first host of the STB block in a FCC test.
Type: u16
Default: 30005
Range: 1 - 65535
1272
IptvStbBlockResults
Writable Attribute
Description
UdpSourcePortStep
A UDP port step parameter which shall be used in a FCC test for the source UDP port in the RTCP Join and Leave
messages sent from hosts other than the first host in the STB block in a FCC test. The UDP port number for the Nth
host in a STB block shall be the base UDP port for the STB block plus (N-1) times the UDP port step value.
Type: u16
Default: 1
IptvStbBlockConfig Read-Only Attributes

IptvStbBlockResults
Description:
Results aggregated on block of set top boxes.

Parents: IptvStbBlockConfig
Relations:
Side name
(Type)
Relative
Description
ResultParent
(ResultChild)
IptvStbBlockConfig
IptvStbBlockResults Writable Attributes

IptvStbBlockResults Read-Only Attributes

Read-Only Attribute
Description
AvgChangeLatency
Average length of time (in msec) it took from when the Leave message was sent for the previous channel to
when the first data packet was received for the next channel, for STBs in this STB block.
Type: double
Default: 0
AvgGapLatency
Average length of time (in msec) between when the last multicast packet for a channel is received (for which a
Leave message was sent) and the receipt of the first multicast packet for the newly joined channel. This is
measured only when the original multicast stream ceases prior to the receipt of the newly joined multicast stream.
Type: double
Default: 0
AvgJoinLatency
was sent.
Type: double
Default: 0
AvgLeaveJoinDelay
Average time in msec to send a Join message for a channel after sending a Leave message for the previous
channel. Should approximately reflect the user input.
Type: double
Default: 0
AvgLeaveLatency
Average length of time (in msec) it took to stop receiving data on a channel once the first Leave message for
Type: double
Default: 0
1273
IptvStbBlockResults
Read-Only Attribute
Description
AvgLeaveToLeaveInterval
Average time interval (in msec) between two consecutive Leave messages. Should approximately reflect user
input if Leave-to-Leave interval was chosen in type of zap interval.
Type: double
Default: 0
AvgMulticastPktToLeaveInterval
Average time interval (in msec) between the multicast packet received for a channel and the following Leave
message for that channel.
Type: double
Default: 0
AvgOverlapLatency
Leave message was sent) and the receipt of the first multicast packet for the newly joined channel. This time is
measured only when the original multicast stream ceases after the receipt of the newly joined multicast stream.
Type: double
Default: 0
Average retransmission latency, performed by STBs in this STB block.

Type: double
Default: 0
Average length of time (in msec) it took to receive unicast packets on a channel once the first unicast Join
message for that channel was sent, for STBs in this STB block.
Type: double
Default: 0
Average observed delay between unicast Leave sent and last unicast packet received, for STBs in this STB
block.
Type: double
Default: 0
Average number of packets that were missing between the end of the unicast stream for a channel and the start
of the corresponding multicast stream, for STBs in this STB block.
Type: double
Default: 0
multicast stream, for STBs in this STB block.
Type: double
Default: 0
Average non-Sbit packet rate of all STBs, among channel events performed by STBs in this STB block.
Type: double
Default: 0
Average non-Sbit packet rate of all STBs, among channel events performed by STBs in this STB block.
Type: double
Default: 0
AvgUnicastPktToLeaveInterval
Average time between first unicast packet and the unicast Leave, for STBs in this STB Block.
Type: double
Default: 0
DroppedFrameCount
Total number of packets lost in transit aggregated on the block of STBs.

Type: u64
Default: 0
Total number of unicast packets lost in transit, aggregated on the block of STBs.
Type: u64
Default: 0
DuplicateFrameCount
Total number of duplicate packets aggregated on the block of STBs.

Type: u64
Default: 0
1274
IptvStbBlockResults
Read-Only Attribute
Description
DuplicateJoins
Type: double
Default: 0
Total number of duplicate unicast packets, aggregated on the block of STBs.

Type: u64
Default: 0
This result is incremented each time the unicast traffic for a channel is received before the transmission of the
unicast Join message for the channel, aggregated on the STB block.
Type: double
Default: 0
ErroredStreams

Type: double
Default: 0
Number of errored unicast streams received aggregated on the STB block.

Type: double
Default: 0
ExtHdrErrors
This result is incremented each time the RTP extension header validation check fails, aggregated on the STB
block.
Type: double
Default: 0
Number of failed RTP retranmissions, aggregated on the STB block.

Type: u64
Default: 0
FlaggedJoins
Total number of Joins for which multicast channel data was not received within the Join latency threshold.
Type: double
Default: 0
FlaggedLeaves
Total number of Leaves for which the host was still receiving multicast channel data after the Leave latency
threshold.
Type: double
Default: 0
Number of flagged RTP retranmissions, aggregated on the STB block.

Type: u64
Default: 0
FlaggedUnicastJoins
Total number of unicast Joins for which unicast channel data was not received within the unicast Join latency
threshold, aggregated on the STB block.
Type: double
Default: 0
FlaggedUnicastLeaves
Total number of unicast Leaves for which the host was still receiving unicast channel data after the unicast Leave
latency threshold, aggregated on the STB block.
Type: double
Default: 0
Count of packets with an invalid first packet timestamp.

Type: u64
Default: 0
InvalidLastPktCount
Count of packets with an invalid last packet timestamp.

Type: u64
Default: 0
JoinFails
Type: double
Default: 0
1275
IptvStbBlockResults
Read-Only Attribute
Description
JoinLatencyThreshold
Maximum acceptable Join latency (in msec). If the Join latency is greater than this threshold, the test fails.
Type: double
Default: 0
LateFrameCount
Total number of late packets aggregated on the block of STBs.

Type: u64
Default: 0
Total number of late unicast packets aggregated on the STB block.

Type: u64
Default: 0
MaxChangeLatency
Maximum length of time (in msec) it took from when the Leave message was sent for the previous channel to
Type: double
Default: 0
MaxGapLatency
Maximum length of time (in msec) between when the last multicast packet for a channel is received (for which
a Leave message was sent) and the receipt of the first multicast packet for the newly joined channel. This time
is measured only when the original multicast stream ceases prior to the receipt of the newly joined multicast
stream.
Type: double
Default: 0
MaxJoinLatency
Maximum length of time (in msec) it took to receive data on a channel once the first Join message for that channel
was sent.
Type: double
Default: 0
MaxLeaveJoinDelay
Maximum time (in msec) to send a Join message for a channel after sending a Leave message for the previous
channel.
Type: double
Default: 0
MaxLeaveLatency
Type: double
Default: 0
MaxLeaveToLeaveInterval
Maximum time interval (in msec) between two consecutive Leave messages.
Type: double
Default: 0
MaxMulticastPktToLeaveInterval
Maximum time interval (in msec) between the multicast packet received for a channel and the following Leave
Type: double
Default: 0
MaxOverlapLatency
Maximum length of time (in msec) between when the last multicast packet for a channel is received (for which
a Leave message was sent) and the receipt of the first multicast packet for the newly joined channel. This time
is measured only when the original multicast stream ceases after the receipt of the newly joined multicast stream.
Type: double
Default: 0
Maximum retransmission latency, performed by STBs in this STB block.

Type: double
Default: 0
Maximum length of time (in msec) it took to receive unicast packets on a channel once the first unicast Join
Type: double
Default: 0
Maximum observed delay between unicast Leave sent and last unicast packet received, for STBs in this STB
block.
Type: double
Default: 0
1276
IptvStbBlockResults
Read-Only Attribute
Description
Maximum number of packets that were missing between the end of the unicast stream for a channel and the
start of the corresponding multicast stream, for STBs in this STB block.
Type: double
Default: 0
Maximum number of packets received in the unicast stream for a channel that were duplicated in the corresponding
Type: double
Default: 0
Maximum non-Sbit packet rate of any STB, among channel events performed by STBs in this STB block.
Type: double
Default: 0
Maximum Sbit packet rate of any STB, among channel events performed by STBs in this STB block.
Type: double
Default: 0
MaxUnicastPktToLeaveInterval
Maximum time between first unicast packet and the unicast Leave, for STBs in this STB Block.
Type: double
Default: 0
MinChangeLatency
Minimum length of time (in msec) it took from when the Leave message was sent for the previous channel to
Type: double
Default: 0
MinGapLatency
Minimum length of time (in msec) between when the last multicast packet for a channel is received (for which a
Type: double
Default: 0
MinJoinLatency
Minimum length of time (in msec) it took to receive data on a channel once the first Join message for that channel
was sent.
Type: double
Default: 0
MinLeaveJoinDelay
Minimum time (in msec) to send a Join message for a channel after sending a Leave message for the previous
channel.
Type: double
Default: 0
MinLeaveLatency
Minimum length of time (in msec) it took to stop receiving data on a channel after the first Leave message for
Type: double
Default: 0
MinLeaveToLeaveInterval
Minimum time interval (in msec) between two consecutive Leave messages.
Type: double
Default: 0
MinMulticastPktToLeaveInterval
Minimum time interval (in msec) between the multicast packet received for a channel and the following Leave
Type: double
Default: 0
MinOverlapLatency
Type: double
Default: 0
Minimum retransmission latency, performed by STBs in this STB block.

Type: double
Default: 0
1277
IptvStbBlockResults
Read-Only Attribute
Description
Minimum length of time (in msec) it took to receive unicast packets on a channel once the first unicast Join
Type: double
Default: 0
Minimum observed delay between unicast Leave sent and last unicast packet received, for STBs in this STB
block.
Type: double
Default: 0
Minimum number of packets that were missing between the end of the unicast stream for a channel and the start
of the corresponding multicast stream, for STBs in this STB block.
Type: double
Default: 0
Minimum number of packets received in the unicast stream for a channel that were duplicated in the corresponding
Type: double
Default: 0
Minimum non-Sbit packet rate of any STB, among channel events performed by STBs in this STB block.
Type: double
Default: 0
Minimum Sbit packet rate of any STB, among channel events performed by STBs in this STB block.
Type: double
Default: 0
MinUnicastPktToLeaveInterval
Minimum time between first unicast packet and the unicast Leave, for STBs in this STB Block.
Type: double
Default: 0
NumClients
Number of clients.
Type: u32
Default: 0
NumOfChannelChanges

Type: double
Default: 0
PrbsErrorCount
Total number of pseudo-random binary sequence errors aggregated on the block of STBs.
Type: u64
Default: 0
ProfileName
Descriptive name for set-top profile.

Type: string
ReorderedFrameCount
Total number of packets re-ordered aggregated on the block of STBs.

Type: u64
Default: 0
Total number of reordered unicast packets aggregated on the STB block.

Type: u64
Default: 0
SbitFailures
This result is incremented each time the unicast traffic fails to transition to Sbit-enabled traffic, aggregated on
the STB block.
Type: double
Default: 0
Timestamp
Timestamp of last statistic update, in seconds.

Type: double
Default: 0
Sum of multicast packets over sum of multicast durations, aggregated on the block of STBs.
Type: double
Default: 0
1278
IptvStopTestCommand
Read-Only Attribute
Description
TotalMulticastPkts
Total packets received in the multicast streams, aggregated on the block of STBs.
Type: double
Default: 0
TotalPktRate

Type: double
Default: 0
TotalPkts
Total number of packets received.

Type: double
Default: 0
TotalUnicastPktRate
Sum of unicast packets over sum of unicast durations, aggregated on the block of STBs.
Type: double
Default: 0
Sum of unicast packets without sbit over sum of unicast durations without sbit, aggregated on the block of STBs.
Type: double
Default: 0
Sum of unicast packets with sbit over sum of unicast durations with sbit, aggregated on the block of STBs.
Type: double
Default: 0
TotalUnicastPkts
Total packets received in the unicast streams, aggregated on the block of STBs.
Type: double
Default: 0
Total packets received in the unicast streams, without Sbit flag set, aggregated on the block of STBs.
Type: double
Default: 0
Total packets received in the unicast streams, with Sbit flag set, aggregated on the block of STBs.
Type: double
Default: 0
UnicastJoinFails
This result is incremented each time the unicast traffic for a channel is not received following transmission of the
unicast Join message for the channel, aggregated on the block of STBs.
Type: double
Default: 0
Total number of unicast pseudo-random binary sequence errors, aggregated on the block of STBs.
Type: u64
Default: 0
IptvStopTestCommand
Description:
Stop a running test.

IptvStopTestCommand Writable Attributes

Writable Attribute
Description
1279
IptvTestResults
IptvStopTestCommand Read-Only Attributes

Read-Only Attribute
Description

IptvTestResults
Description:
Overall test results.

Parents: Project
Relations:
Side name
(Type)
Relative
Description
ResultParent
(ResultChild)
Project
IptvTestResults Writable Attributes

IptvTestResults Read-Only Attributes

Read-Only Attribute
Description
TestEndTime
End time of the test.

Type: string
Default: NA
TestName
Test name specified by user.

Type: string
Default: test1
TestResult
Overall result of the test based on the percentage of failed Joins compared to the Join fail threshold given as
input.
Type: enum
Default: NA
Possible Values:
Value Description
FAIL
Percentage of Join fails exceeds the specified Join fail threshold.
PASS Percentage of Join fails is lower than the threshold.

NA
TestStartTime
Test result is not available (because a test has not started or is still running).
Start time of the test.

Type: string
Default: NA
IptvViewedChannels
Description:
1280
The channels that a block of set top boxes toggle through during a test are specified here. One set top block can have multiple viewed channels associated
with it. The viewed channels associated with a block of set top boxes must not have overlapping channels.

Parents: Project
Result children (automatically created): IptvChannelResults
Relations:
Side name
(Type)
Relative
Description
ResultChild
(ResultChild)
IptvChannelResults
Stb
(StbChannel)
IptvStbBlockConfig
Block of STBs with which it is associated.
IptvViewedChannels Writable Attributes

Writable Attribute
Description
Active, Name
ChannelBlock
Channel block used to validate this particular IPTV viewed channel object settings.
Type: handle
Default: 0
ChannelRangeEnd
The upper end of the channel range (or ending channel) defined by this viewed channel class. Each viewed channels
profile must have a unique set of channels (i.e., channels cannot overlap between profiles) in order to be used
concurrently by the same host block.
Type: u32
Default: 32
Range: 2 - 32000
ChannelRangeStart
The lower end of the channel range (or starting channel) defined by this viewed channel class. Each viewed channels
profile must have a unique set of channels (i.e., channels cannot overlap between profiles) in order to be used
concurrently by the same host block.
Type: u32
Default: 1
Range: 1 - 31999
ChannelRangeStep
Difference between two consecutive channels (i.e., the increment value) belonging to the viewed set of channels.
Type: u32
Default: 1
InitialChannelStart
The starting channel for the first set top box in the block of set top boxes with which this viewed channel is associated.
(This is the first channel to be joined by the first host in the block.)
Type: u32
Default: 1
Range: 1 - 32000
InitialChannelStep
The starting channel number for subsequent emulated set-tops (i.e., the increment value for each initial channel in the
profile). Use 0 to start all set-tops on the same channel. (This attribute is ignored if the Zap Direction attribute is set to
RANDOM.) Using this step, the starting channel for the boxes in a block can be staggered. For example, if initial start
channel is 5 and initial channel step is 3, host 1 first joins channel 5 and host 2 first joins channel 8.
Type: u32
Default: 1
IptvViewedChannels Read-Only Attributes

1281
Description:
Configuration settings for simulating the behavior of a person watching TV.

Parents: Project
Result children (automatically created): IptvViewingProfileResults
Relations:
Side name
(Type)
Relative
Description
Stb
(IptvProfile)
IptvStbBlockConfig
Set top block with which the profile is associated.
ResultChild
(ResultChild)
IptvViewingProfileResults
IptvViewingProfileConfig Writable Attributes

Writable Attribute
Description
Active, Name
ChangesBeforeView
This cell is enabled if Zap and View was selected under Zap Behavior. Enter the number of channel changes to make before
stopping on the last channel.
Type: u32
Default: 5
Interval
Time duration (in msec) between channel changes. Channels are changed according to the Leave-to-Leave interval.
Type: u32
Default: 5000
JoinLatencyThreshold
Maximum acceptable Join latency (in msec). If the Join latency is greater than this threshold, the test fails.
Type: u32
Default: 300
Range: 0 - 2000
LeaveLatencyThreshold
Time duration (in msec) for this threshold. If multicast channel data exceeds this period after the Leave message is sent, the
Leave message is counted as a flagged Leave. Any channel data that is then received is ignored.
Type: u32
Default: 3000
Range: 0 - 30000
MulticastJoinTriggerDelay
If the "S-Bit + Delay" multicast Join trigger is selected for a FCC test, the multicast Join message for a channel shall be
transmitted after a multicast Join trigger delay following the receipt of the first unicast packet with the S-bit set for the
corresponding channel. If the "Unicast Join + Delay" multicast Join trigger is selected, the multicast Join message for a
channel shall be transmitted after a multicast Join trigger delay following the receipt of the first unicast packet for the
corresponding channel.
Type: u32
Default: 0
SetTopLeaveJoinDelay
Time interval (in msec) between sending a Leave message for the current channel and sending a Join message for the next
channel.
Type: u32
Default: 0
UnicastJoinThreshold
For the FCC test, a flagged unicast Join shall be reported. This result is incremented each time the unicast Join latency
exceeds the configured unicast Join latency threshold.
Type: u32
Default: 300
Range: 0 - 2000
UnicastLeaveThreshold
For the FCC test, a flagged unicast Leave shall be reported. This result is incremented each time the unicast Leave latency
exceeds the configured unicast Leave latency threshold.
Type: u32
Default: 3000
Range: 0 - 30000
1282
Writable Attribute
Description
UnicastLeaveTriggerDelay
If the "Unicast Join + Delay" unicast Leave trigger is selected for a FCC test, the unicast Leave message for a channel shall
be transmitted after a unicast Leave trigger delay following the transmission of the corresponding unicast Join message. If
the "Multicast Packet + Delay" unicast Leave trigger is selected for a FCC test, the unicast Leave message for a channel
shall be transmitted after a unicast Leave trigger delay following the receipt of the first multicast packet for the corresponding
channel.
Type: u32
Default: 0
UnicastOnly
If true, perform only unicast Joins and Leaves, eschewing multicast Join and Leave operations and measurements.
Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
Perform only unicast Joins and Leaves, eschewing multicast Join and Leave operations and measurements.
FALSE Perform both unicast and multicast Join and Leaves as normal.
UnicastStay
An option to not send unicast Leave messages in a FCC test.

Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
Do not send unicast Leave messages.
FALSE Send unicast Leave messages as normal.

ViewDuration
This cell is enabled if Zap and View was selected under Zap Behavior. Type the time duration (in seconds) to view a channel
in the view phase. (Range is 0 - 3600.)
Type: u32
Default: 60
Range: 0 - 429496729
ZapBehavior
Channel changing behavior (zapping, viewing, or zapping and viewing) of the user. Often, this behavior includes a number
of channel changes before stopping to view a channel.
Type: enum
Default: ZAP_ONLY
Possible Values:
Value
Description
ZAP_ONLY
Viewer keeps changing through channels without viewing any channel.
ZAP_AND_VIEW Viewer changes through a certain number of channels before settling on one channel and viewing it for
a specific duration.
ZapDirection
Direction of channel changes when zapping.

Type: enum
Default: UP
Possible Values:
Value
Description
UP
Channel changes occur in sequence in increasing channel number.
DOWN
Channel changes occur in sequence in decreasing channel number.
RANDOM Channel changes occur in random fashion.
1283
Writable Attribute
Description
ZapIntervalType
Select the type of interval between channel changes. The zap interval type specifies what triggers the start of the interval
timer during the zap phase. The interval can be based upon the Leave-to-Leave interval or the multicast Packet-to-Leave
interval.
Type: enum
Default: LEAVE_TO_LEAVE
Possible Values:
Value
Description
LEAVE_TO_LEAVE
The Leave-to-Leave interval is the period between sending a Leave message for one
channel and sending a Leave message for the following channel. This interval can be fixed
or random but must be greater than the Leave-Join delay. Select this interval to simulate
clients changing from one channel to a specific channel.
MULTICAST_PKT_TO_LEAVE The Multicast Packet-to-Leave interval is the period between receiving the first Multicast
packet for one channel and sending the Leave message for that same channel. This interval
must be greater than the Leave-Join Delay.
UNICAST_PKT_TO_LEAVE
The Unicast Packet-to-Leave interval is the period between receiving the first Unicast
packet for one channel and sending the last Leave message for that same channel.
IptvViewingProfileConfig Read-Only Attributes

Description:
Results aggregated on viewing profile.

Parents: IptvViewingProfileConfig
Relations:
Side name
(Type)
Relative
Description
ResultParent
(ResultChild)
IptvViewingProfileResults Writable Attributes

IptvViewingProfileResults Read-Only Attributes

Read-Only Attribute
Description
AvgChangeLatency
Average length of time (in msec) it took from when the Leave message was sent for the previous channel to when
the first data packet was received for the next channel.
Type: double
Default: 0
AvgGapLatency
Leave message was sent) and the receipt of the first multicast packet for the newly joined channel. This is measured
only when the original multicast stream ceases prior to the receipt of the newly joined multicast stream.
Type: double
Default: 0
AvgJoinLatency
was sent.
Type: double
Default: 0
1284
Read-Only Attribute
Description
AvgLeaveLatency
Average length of time (in msec) it took to stop receiving data on a channel once the first Leave message for that
channel was sent.
Type: double
Default: 0
AvgOverlapLatency
Type: double
Default: 0
Average retransmission latency, among channel events performed by STBs using this Viewing Profile block.
Type: double
Default: 0
Average latency from the transmission of the unicast Join message for a channel and the receipt of the first unicast
packet for that channel, among channel events in this Viewing Profile block.
Type: double
Default: 0
Average latency from the transmission of the unicast Leave message for a channel and the receipt of the last
unicast packet for that channel, among channel events in this Viewing Profile block.
Type: double
Default: 0
Average number of packets that were missing between the end of the unicast stream for a channel and the start
of the corresponding multicast stream for that channel, among channel events in this Viewing Profile block.
Type: double
Default: 0
multicast stream, among channel events in this Viewing Profile block.
Type: double
Default: 0
Average non-Sbit packet rate of all STBs, among channel events performed by STBs using this Viewing Profile
block.
Type: double
Default: 0
Average non-Sbit packet rate of all STBs, among channel events performed by STBs using this Viewing Profile
block.
Type: double
Default: 0
DroppedFrameCount
Total number of packets lost in transit aggregated on the Viewing Profile block.
Type: u64
Default: 0
Dropped packets in the unicast streams aggregated on this Viewing Profile block.
Type: u64
Default: 0
DuplicateFrameCount
Total number of duplicate packets aggregated on the Viewing Profile block.

Type: u64
Default: 0
DuplicateJoins
Type: double
Default: 0
Duplicate packets in the unicast streams aggregated on this Viewing Profile block.
Type: u64
Default: 0
1285
Read-Only Attribute
Description
# Duplicate unicast Joins aggregated on this Viewing Profile block.

Type: double
Default: 0
ErroredStreams

Type: double
Default: 0
Number of errored unicast streams aggregated on this Viewing Profile block.

Type: double
Default: 0
Number of failed RTP retranmissions, aggregated on this Viewing Profile block.

Type: u64
Default: 0
Number of flagged RTP retranmissions, aggregated on this Viewing Profile block.

Type: u64
Default: 0
Count of packets with an invalid first packet timestamp.

Type: u64
Default: 0
InvalidLastPktCount
Count of packets with an invalid last packet timestamp.

Type: u64
Default: 0
JoinFails
Type: double
Default: 0
LateFrameCount
Total number of late packets aggregated on the Viewing Profile block.

Type: u64
Default: 0
Late packets in the unicast streams aggregated on this Viewing Profile block.
Type: u64
Default: 0
MaxChangeLatency
Maximum length of time (in msec) it took from when the Leave message was sent for the previous channel to
when the first data packet was received for the current channel.
Type: double
Default: 0
MaxGapLatency
Maximum length of time (in msec) between when the last multicast packet for a channel is received (for which a
Type: double
Default: 0
MaxJoinLatency
Maximum length of time (in msec) it took to receive data on a channel once the first Join message for that channel
was sent.
Type: double
Default: 0
MaxLeaveLatency
Type: double
Default: 0
MaxOverlapLatency
Maximum length of time (in msec) between when the last multicast packet for a channel is received (for which a
Type: double
Default: 0
1286
Read-Only Attribute
Description
Maximum retransmission latency, among channel events performed by STBs using this Viewing Profile block.
Type: double
Default: 0
The largest latency from the transmission of the unicast Join message for a channel and the receipt of the first
Type: double
Default: 0
Maximum latency from the transmission of the unicast Leave message for a channel and the receipt of the last
Type: double
Default: 0
Maximum number of packets that were missing between the end of the unicast stream for a channel and the start
Type: double
Default: 0
Maximum number of packets received in the unicast stream for a channel that were duplicated in the corresponding
multicast stream, among channel events in this Viewing Profile block.
Type: double
Default: 0
Maximum non-Sbit packet rate of any STB, among channel events performed by STBs using this Viewing Profile
block.
Type: double
Default: 0
Maximum Sbit packet rate of any STB, among channel events performed by STBs using this Viewing Profile block.
Type: double
Default: 0
MinChangeLatency
Minimum length of time (in msec) it took from when the Leave message was sent for the previous channel to when
the first data packet was received for the current channel.
Type: double
Default: 0
MinGapLatency
Type: double
Default: 0
MinJoinLatency
Minimum length of time (in msec) it took to receive data on a channel once the first Join message for that channel
was sent.
Type: double
Default: 0
MinLeaveLatency
Minimum length of time (in msec) it took to stop receiving data on a channel after the first Leave message for that
channel was sent.
Type: double
Default: 0
MinOverlapLatency
Type: double
Default: 0
Minimum retransmission latency, among channel events performed by STBs using this Viewing Profile block.
Type: double
Default: 0
Smallest latency from the transmission of the unicast Join message for a channel and the receipt of the first unicast
packet for that channel, among channel events in this Viewing Profile block.
Type: double
Default: 0
1287
Read-Only Attribute
Description
Minimum latency from the transmission of the unicast Leave message for a channel and the receipt of the last
Type: double
Default: 0
Minimum number of packets that were missing between the end of the unicast stream for a channel and the start
Type: double
Default: 0
Minimum number of packets received in the unicast stream for a channel that were duplicated in the corresponding
multicast stream for that channel, among channel events in this Viewing Profile block.
Type: double
Default: 0
Minimum non-Sbit packet rate of any STB, among channel events performed by STBs using this Viewing Profile
block.
Type: double
Default: 0
Minimum Sbit packet rate of any STB, among channel events performed by STBs using this Viewing Profile block.
Type: double
Default: 0
NumOfChannelChanges

Type: double
Default: 0
PrbsErrorCount
Total number of pseudo-random binary sequence errors aggregated on the Viewing Profile block.
Type: u64
Default: 0
ReorderedFrameCount
Total number of packets re-ordered aggregated on the Viewing Profile block.

Type: u64
Default: 0
Reordered packets in the unicast streams aggregated on this Viewing Profile block.
Type: u64
Default: 0
Timestamp

Type: double
Default: 0
Sum of multicast packets over sum of multicast durations, aggregated on the Viewing Profile block.
Type: double
Default: 0
TotalMulticastPkts
Total packets received in the multicast streams, aggregated on the Viewing Profile block.
Type: double
Default: 0
TotalPktRate

Type: double
Default: 0
TotalPkts
Total number of packets received.

Type: double
Default: 0
TotalUnicastPktRate
Sum of unicast packets over sum of unicast durations, aggregated on the Viewing Profile block.
Type: double
Default: 0
Sum of unicast packets without sbit over sum of unicast durations without sbit, aggregated on the Viewing Profile
block.
Type: double
Default: 0
1288
IptvWaitForTestCompletionCommand
Read-Only Attribute
Description
Sum of unicast packets with sbit over sum of unicast durations with sbit, aggregated on the Viewing Profile block.
Type: double
Default: 0
TotalUnicastPkts
Total packets received in the unicast streams, aggregated on the Viewing Profile block.
Type: double
Default: 0
Total packets received in the unicast streams, without Sbit flag set, aggregated on the Viewing Profile block.
Type: double
Default: 0
Total packets received in the unicast streams, with Sbit flag set, aggregated on the Viewing Profile block.
Type: double
Default: 0
UnicastJoinFails
Number of times that a channel was joined but no unicast data for the channel was received before a Leave
message was sent for the next channel that was joined, aggregated on the Viewing Profile block.
Type: double
Default: 0
Unicast PRBS Bit Error Count in the unicast streams aggregated on this Viewing Profile block.
Type: u64
Default: 0
IptvWaitForTestCompletionCommand
Description:
Wait until test is completed.

IptvWaitForTestCompletionCommand Writable Attributes

Writable Attribute
Description
IptvWaitForTestCompletionCommand Read-Only Attributes

Read-Only Attribute
Description

IPv4 (ipv4:IPv4)
Description:
Parents: StreamBlock, ipData
Children: flags, options, tosDiffserv
1289
IPv4

pim:Pimv4Hello, pim:Pimv4Register, pim:Pimv4NullRegister, pim:Pimv4RegisterStop, pim:Pimv4JoinPrune, pim:Pimv4Assert, custom:Custom
IPv4 Attributes
Attribute
Description
checksum
Type: INTEGER
Default: 0
destAddr
Type: IPV4ADDR
Default: 192.0.0.1
destPrefixLength
Type: INTEGER
Default: 24
fragOffset
Type: INTEGER
Default: 0
gateway
Type: IPV4ADDR
Default: 192.85.1.1
identification
Type: INTEGER
Default: 0
ihl
Type: INTEGER
Default: 5
Name
information.
Type: string
padding
Type: ALIGNMENTPAD
Default: 0
prefixLength
Type: INTEGER
Default: 24
1290
IPv4
Attribute
Description
protocol
Default: 253
Possible Values:
1291
IPv4
Attribute
Description
Value Description
0
HOPOPT
ICMP
IGMP
GGP
IP
ST
TCP
CBT
EGP
IGP
10
BBN-RCC-MON
11
NVP-II
12
PUP
13
ARGUS
14
EMCON
15
XNET
16
CHAOS
17
UDP
18
MUX
19
DCN-MEAS
20
HMP
21
PRM
22
XNS-IDP
23
TRUNK-1
24
TRUNK-2
25
LEAF-1
26
LEAF-2
27
RDP
28
IRTP
29
ISO-TP4
30
NETBLT
31
MFE-NSP
32
MERIT-INP
33
SEP
34
3PC
35
IDPR
36
XTP
37
DDP
38
IDPR-CMTP
39
TP++
40
IL
41
IPv6
42
SDRP
43
IPv6-Route
44
IPv6-Frag
45
IDRP
46
RSVP
47
GRE
48
MHRP
49
BNA
1292
IPv4
Attribute
Description
Value Description
50
ESP
51
AH
52
I-NLSP
53
SWIPE
54
NARP
55
MOBILE
56
TLSP
57
SKIP
58
IPv6-ICMP
59
IPv6-NoNxt
60
IPv6-Opts
62
CFTP
64
SAT-EXPAK
65
KRYPTOLAN
66
RVD
67
IPPC
69
SAT-MON
70
VISA
71
IPCV
72
CPNX
73
CPHB
74
WSN
75
PVP
76
BR-SAT-MON
77
SUN-ND
78
WB-MON
79
WB-EXPAK
80
ISO-IP
81
VMTP
82
SECURE-VMTP
83
VINES
84
TTP
85
NSFNET-IGP
86
DGP
87
TCF
88
EIGRP
89
OSPFIGP
90
Sprite-RPC
91
LARP
92
MTP
93
AX.25
94
IPIP
95
MICP
96
SCC-SP
97
ETHERIP
98
ENCAP
100
GMTP
101
IFMP
102
PNNI
103
PIM
1293
ipv4Addr
Attribute
Description
Value Description
104
ARIS
105
SCPS
106
QNX
107
A/N
108
IPComp
109
SNP
110
Compaq-Peer
111
IPX-in-IP
112
VRRP
113
PGM
115
L2TP
116
DDX
117
IATP
118
STP
119
SRP
120
UTI
121
SMP
122
SM
123
PTP
124
ISIS over IPv4
125
FIRE
126
CRTP
127
CRUDP
128
SSCOPMCE
129
IPLT
130
SPS
131
PIPE
132
SCTP
133
FC
134
RSVP-E2E-IGNORE
135
Mobility Header
136
UDPLite
137
MPLS-in-IP
253
Experimental
255
Reserved
sourceAddr
Type: IPV4ADDR
Default: 192.85.1.2
totalLength
Type: INTEGER
Default: 20
ttl
Type: INTEGER
Default: 255
version
Type: INTEGER
Default: 4
ipv4Addr
1294
Ipv4Addr
Description:
Children: None
ipv4Addr Attributes
Attribute
Description
addrSubtype
Default: 01
Possible Values:
Value Description
00
Other
01
IPv4
02
IPv6
03
nsap
04
hdlc
05
bbn1822
06
All 802
07
e163
08
e164
09
f69
0A
x121
0B
IPX
0C
Apple Talk
0D
DEC Net IV
0E
Banyan Vines
0F
E164 with NSAP
10
DNS
11
Distinguished Name
12
AS Number
13
XTP over IPv4
14
XTP over IPv6
15
XTP native mode XTP
16
Fibre Channel WWPN
17
Fibre Channel WWNN
18
Gateway Identifier
19
AFI
managementAddr
Type: IPV4ADDR
Name
information.
Type: string
Ipv4Addr
Description:
Parents: addrList
Children: None
1295
Ipv4Addr
Ipv4Addr Attributes
Attribute
Description
Name
information.
Type: string
value
Type: IPV4ADDR
Default: 192.0.0.1
Ipv4Addr
Description:
Parents: addrList
Children: None
Ipv4Addr Attributes
Attribute
Description
Name
information.
Type: string
value
Type: IPV4ADDR
Default: 192.0.0.1
Ipv4Addr
Description:
IPv4 address for PIMv4 Hello option
Parents: addrList
Children: None
Ipv4Addr Attributes
Attribute
Description
Name
information.
Type: string
value
Type: IPV4ADDR
Default: 192.0.0.1
1296
Description:

Children: BgpIpv4VpnFecInfo, BgpVplsFecInfo, GeneralizedPseudoWireFecInfo, Ipv4PrefixFecInfo, VcFecInfo
Relations:
Side name
(Type)
Relative
Description
FecInfo
(InnerMostFecInfo)

Ipv4EchoRequestConfig Writable Attributes

Writable Attribute
Description
Active, Name
DstAddr
Type: ip
Default: 127.0.0.1
EchoReplyMode
Type: enum
Default: IP
Possible Values:
Value
Description
NO_REPLY
IP
IP_WITH_ROUTE_ALERT
CONTROL_CHANNEL
EnableNilFecLabel
Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
FALSE
ExperimentalBits
Type: u8
Default: 0
Range: 0 - 7
OperationMode
Type: enum
Default: PING
Possible Values:
Value
Description
PING
TRACE_ROUTE
PadData
Type: u8
Default: 0
PadMode
Type: enum
Default: NO_PAD_TLV
Possible Values:
Value
NO_PAD_TLV
REQUEST_DROP_PAD_TLV
REQUEST_COPY_PAD_TLV
1297
Description
Ipv4Group
Writable Attribute
Description
PingInterval
Type: u32
Default: 5
Range: 1 - 2147483647
PingTimeout
Type: u16
Default: 2
Range: 1 - 65535
TimeToLive
Type: u8
Default: null
Range: 1 - 255
TraceRouteInterval
Type: u32
Default: 120
Range: 1 - 2147483647
TraceRouteTimeout
Type: u16
Default: 2
Range: 1 - 65535
ValidateFecStack
Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
FALSE
Ipv4EchoRequestConfig Read-Only Attributes

Ipv4Group
Description:
Creates/configures an IPv4 multicast group.

Parents: Project
Automatically-created children: Ipv4GroupResults, Ipv4NetworkBlock
Result children (automatically created): Ipv4GroupResults
Relations:
Side name
(Type)
Relative
Description
PimGroup
(JoinedGroup)
Pimv4GroupBlk, Pimv4RpMap
Relationship between the PIMv4 group block object, and the

IPv4 group object.
RsvpIngressTunnel
(MemberGroup)
RsvpIngressTunnelParams
Config
(MulticastGroupBinding)
Rfc3918Config
IptvParameter
(MulticastParam)
IptvChannelBlock
Relationship between the IPTV channel block object, and

the IPv4 group object.
ResultChild
(ResultChild)
Ipv4GroupResults
1298
Ipv4GroupResults
Side name
(Type)
Relative
Description
(SubscribedGroups)
IgmpGroupMembership,
MldGroupMembership
Relationship between the IGMP group membership block

object and the IPv4 group block object
Ipv4Group Writable Attributes

Writable Attribute
Description
Active, Name
Ipv4Group Read-Only Attributes

Ipv4GroupResults
Description:
Statistics for the parent IPv4 multicast group.

Automatically created from: Ipv4Group
Relations:
Side name
(Type)
Relative
Description
ResultParent
(ResultChild)
Ipv4Group
Ipv4GroupResults Writable Attributes

Ipv4GroupResults Read-Only Attributes

Read-Only Attribute
Description
AvgJoinLatency
Average Join Latency for this group.

Type: double
Default: 0
AvgLeaveLatency
Average Leave Latency for this group.

Type: double
Default: 0
MaxJoinLatency
Maximum Join Latency for this group.

Type: double
Default: 0
MaxLeaveLatency
Maximum Leave Latency for this group.

Type: double
Default: 0
MinJoinLatency
Minimum Join Latency for this group.

Type: double
Default: 0
1299
IPv4HeaderOption
Read-Only Attribute
Description
MinLeaveLatency
Minimum Leave Latency for this group.

Type: double
Default: 0
Timestamp
Creation time for these results

Type: double
Default: 0
IPv4HeaderOption
Description:
Parents: options
Children: addrExt, endOfOptlist, extSecurity, looseSrcRoute, mtuProbe, nop, recordRoute, rtrAlert, security, selBrdcast, streamId, strictSrcRoute, timestamp,
tracert
IPv4HeaderOption Attributes
Attribute
Description
Name
information.
Type: string
Ipv4If
Description:
IPv4 interface object.

Relations:
Side name
(Type)
Relative
Description
DstBoundTo
(DstBinding)

StreamBlock.
EncapsulationSource
(Encapsulation)
PathDescriptor
NetworkLink
(LinkSrc)

1300
Ipv4If
Side name
(Type)
Relative
Description
MemberOfVpn
(MemberOfVpn)

VpnSiteInfoVplsLdp
Port

relation.

WimaxIf

PrimaryIfSource
(PrimaryIf)

SUT

the DUT.
RelayBlockConfig
(RelayIf)
(ResolvesInterface)

RsvpRouterConfig

SrcBoundTo
(SrcBinding)

StreamBlock.
StackedOn
(StackedOnEndpoint)

WimaxIf
TopLevelIfSource
(TopLevelIf)

SUT

interface stack.
Port

relation.
UsesIfSource
(UsesIf)


Ipv4If Writable Attributes

Writable Attribute
Description
Active, Name
1301
Ipv4If
Writable Attribute
Description
Address
IPv4 address. You can generate more than one address by using combinations of Address, AddrRepeatCount,
AddrStep, AddrStepMask, and IfRecycleCount. If you do that, then Address is the starting address.
Type: ip
Default: 192.85.1.3
AddrList
A Tcl list of IPv4 addresses. To use this attribute, the IsRange attribute must be FALSE.
Type: ip
Default: 0
AddrRepeatCount
How many times to repeat the same IPv4 address before incrementing it. See IsRange for more information.
Type: u32
Default: 0
AddrResolver
Address resolver identifier.

Type: string
Default: default
AddrStep
Step value for generated IPv4 addresses. See IsRange for more information.
Type: ip
Default: 0.0.0.1
AddrStepMask
IPv4 address step mask. Indicates which parts of the IPv4 address will change when incremented. See IsRange
Type: ip
Default: 255.255.255.255
not use it.
Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
FALSE
Gateway
IPv4 gateway address. You can generate more than one address by using combinations of Gateway,
GatewayRepeatCount, GatewayStep, and GatewayRecycleCount. If you do that, then Gateway is the starting
address.
Type: ip
Default: 192.85.1.1
GatewayList
A Tcl list of IPv4 gateway addresses. To use this attribute, the IsRange attribute must be FALSE.
Type: ip
Default: 0
GatewayMac
Gateway MAC address.

Type: mac
Default: 00:00:01:00:00:01
GatewayMacResolver
Gateway MAC address resolver identifier.

Type: string
Default: default
GatewayRecycleCount
How many times to increment the IPv4 gateway address (Gateway attribute) before returning to the starting value.
Type: u32
Default: 0
GatewayRepeatCount
Type: u32
Default: 0
GatewayStep
Type: ip
Default: 0.0.0.0
1302
Ipv4If
Writable Attribute
Description
IfCountPerLowerIf

Type: u32
Default: 1
IfRecycleCount
How many times to increment the IPv4 address (Address attribute) before returning to the starting value. See
IsRange for more information.
Example: Address = 1.1.1.1, AddrRepeatCount = 0, AddrStep = 0.0.0.1, AddrStepMask = 0.0.0.255, IfRecycleCount
= 3. The generated values for Address will be 1.1.1.1, 1.1.1.2, 1.1.1.3, 1.1.1.1, 1.1.1.2, 1.1.1.3, and so on.
Type: u32
Default: 0
IsLoopbackIf

Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE

IsRange
Whether to use a combination of attributes to generate a range of addresses, or to use a list attribute (AddrList or
GatewayList) to specify the addresses.
Type: bool
Default: TRUE
Possible Values:
Value Description
TRUE
Generate a range of items using a combination of attributes. These attributes are in 2 sets as follows:
Set 1: Address, AddrRepeatCount, AddrStep, AddrStepMask, IfRecycleCount.
Set 2: Gateway, GatewayRepeatCount, GatewayStep, GatewayRecycleCount.
FALSE Use AddrList and GatewayList to specify the items.

NeedsAuthentication
Whether this interface needs authentication.

Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
This interface needs authentication.
FALSE This interface does not need authentication.

PrefixLength

Type: u8
Default: 24
Range: 0 - 32
ResolveGatewayMac
Whether to resolve the gateway MAC address.

Type: bool
Default: TRUE
Possible Values:
Value Description
TRUE
Resolve gateway MAC address.
FALSE Do not resolve gateway MAC address.

SkipReserved
Whether to skip reserved addresses.

Type: bool
Default: TRUE
Possible Values:
Value Description
TRUE
Skip reserved addresses.
FALSE Do not skip reserved addresses.

Tos
IPv4 ToS value.

Type: u8
Default: 192
Range: 0 - 255
1303
Ipv4If
Writable Attribute
Description
TosType
Type: enum
Default: TOS
Possible Values:
Value
Description
TOS
DIFFSERV
Ttl
IPv4 TTL value.

Type: u8
Default: 255
Range: 0 - 255
UseIpAddrRangeSettingsForGateway
Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
FALSE
UsePortDefaultIpv4Gateway
Whether to use the logical port's default IPv4 gateway.

Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
Use default IPv4 gateway.
FALSE Do not use default IPv4 gateway.
Ipv4If Read-Only Attributes

Read-Only Attribute
Description
AddrResolveState
IPv4 address resolve state.

Type: enum
Possible Values:
Value
Description
RESOLVE_DONE
Resolve is done.
RESOLVE_NEEDED
Resolve is needed.
RESOLVE_FAILED
Resolve failed.
RESOLVE_IN_PROGRESS

EffectiveBlockCount

Type: u32
Default: 1
GatewayLearningState

Type: enum
Possible Values:
Value
Description
RESOLVE_DONE
RESOLVE_IN_PROGRESS
RETRYING_GATEWAY
RESOLVE_NEEDED
RESOLVE_FAILED
FAILURE
SUCCESS
1304
Ipv4IngressPrefixLsp
Read-Only Attribute
Description
GatewayMacResolveState
Gateway MAC address resolve state.

Type: enum
Possible Values:
Value
Description
RESOLVE_DONE
Resolve is done.
RESOLVE_NEEDED
Resolve is needed.
RESOLVE_FAILED
Resolve failed.
RESOLVE_IN_PROGRESS

IfState

Type: enum
Default: DISABLED
Possible Values:
Value
Description
READY
Ready.
DISABLED
Disabled.
DELETING
Deleting.
Ipv4IngressPrefixLsp
Description:

Relations:
Side name
(Type)
Relative
Ipv4IngressPrefixLsp Writable Attributes

Writable Attribute
Description
FecType
Type: enum
Default: LDP_FEC_TYPE_PREFIX
Possible Values:
Value
Description
LDP_FEC_TYPE_PREFIX
Prefix
LDP_FEC_TYPE_HOST_ADDR Host address

LDP_FEC_TYPE_VC
VC
Ipv4IngressPrefixLsp Read-Only Attributes

1305
Description
Ipv4IsisRoutesConfig
Description:
ISIS IPv4 route.

Parents: IsisLspConfig
Ipv4IsisRoutesConfig Writable Attributes

Writable Attribute
Description
AdminTag
Administrative tag.
Type: u32
Default: 0
Metric
Standard 6-bit ISIS metric. Disabled if metric mode is set to wide.

Type: u8
Default: 1
Range: 1 - 63
MetricType
Indicates that the route has either an internal or external metric. Only the internal metric can be used to calculate the total
cost of the shortest path. (Enabled only if the metric mode is not wide.)
Type: enum
Default: INTERNAL
Possible Values:
Value
Description
INTERNAL Internal metric type.
EXTERNAL External metric type.
RouteCategory
Specifies the route type. Specifies how the route is to be treated by the SUT.
Type: enum
Default: UNDEFINED
Possible Values:
Value
Description
UNDEFINED
PRIMARY
Primary route.
RouteType
UNIQUE
Unique route.
ANY
ANY
Defines the TLV type. (Enabled only if metric mode is not wide.)
Type: enum
Default: INTERNAL
Possible Values:
Value
Description
INTERNAL Internal TLV type.
EXTERNAL External TLV type.
UpDown
If the up/down bit is set to down (1), it indicates that the route is advertised from Level 2 to Level 1.
Type: u8
Default: 0
Range: 0 - 1
WideMetric
The wide (4-octet) metric is used for traffic engineering. (Disabled if metric mode is set to narrow.)
Type: u32
Default: 1
Range: 0 - 16777215
Ipv4IsisRoutesConfig Read-Only Attributes

1306
Ipv4NetworkBlock
Ipv4NetworkBlock
Description:
IPv4 network block object.

Parents: EmulatedDevice, ExternalDevice, ExternalDevicePort, Host, IptvChannelBlock, Port, PppoeClientBlockConfig, Router, SUT
Automatically created from: AncpAccessNodeConfig, BfdIpv4ControlPlaneIndependentSession, BgpIpv4RouteConfig, ExternalLsaBlock, IgmpGroupMembership,
Ipv4Group, Ipv4IngressPrefixLsp, Ipv4IsisRoutesConfig, Ipv4PrefixLsp, L2tpv2BlockConfig, PppoaClientBlockConfig, PppoL2tpv2ClientBlockConfig,
Ripv4RouteParams, RouterLsaLink, RsvpIpv4ExplicitRouteParams, RsvpIpv4LsrParams, SummaryLsaBlock
Relations:
Side name
(Type)
Relative
Description
DstBoundTo
(DstBinding)

StreamBlock.
EncapsulationSource
(Encapsulation)
PathDescriptor
MemberOfVpn
(MemberOfVpn)

Port


VlanIf, WimaxIf

SrcBoundTo
(SrcBinding)

StreamBlock.
StackedOn
(StackedOnEndpoint)

VlanIf, WimaxIf
Port

Ipv4NetworkBlock Writable Attributes

Writable Attribute
Description
Active, Name
AddrIncrement
Network address increment.

Type: u32
Default: 1
NetworkCount
Number of networks.
Type: u32
Default: 1
1307
Ipv4OptionMtuReply
Writable Attribute
Description
PrefixLength

Type: u8
Default: 24
Range: 0 - 32
StartIpList
Start IPv4 address list.

Type: ip
Default: 192.0.1.0
Ipv4NetworkBlock Read-Only Attributes

Ipv4OptionMtuReply
Description:
Parents:
Children: None
Ipv4OptionMtuReply Attributes
Attribute
Description
length
Type: INTEGER
Default: 4
mtu
Type: INTEGER
Default: 0
Name
Type: string
type
Default: 12
Possible Values:
Value Description
0
End of Options List
NOP
130
Security
131
Loose Source Route
68
Time Stamp
133
Extended Security
Record Route
136
Stream Identifier
137
Strict Source Route
11
MTU Probe
12
MTU Reply
82
Traceroute
147
Address Extension
148
Router Alert
149
1308
Ipv4PrefixFecInfo
Ipv4PrefixFecInfo
Description:

Relations:
Side name
(Type)
Relative
Description
EchoRequestConfig
(InnerMostFecInfo)
DstFecInfo
(NextFecInfo)

Ipv4PrefixFecInfo Writable Attributes

Writable Attribute
Description
Active, Name
AddrIncrement
Type: u32
Default: 1
NetworkCount
Type: u32
Default: 1
Range: 1 - 4294967295
PrefixLength
Type: u8
Default: 24
Range: 1 - 32
Protocol
Type: enum
Default: BGP
Possible Values:
Value Description
BGP
LDP
StartIpAddr
Type: ip
Default: 192.0.1.0
Ipv4PrefixFecInfo Read-Only Attributes

Ipv4PrefixLsp
Description:
Define an IPv4 prefix/host LSP object.

Relations:
1309
Ipv4RouteGenParams
Side name
(Type)
Relative
Description
Ipv4PrefixLsp Writable Attributes

Writable Attribute
Description
FecType
Specifies the classification method (FEC) used to assign the packets in the current label block to a particular LSP.
Type: enum
Possible Values:
Value
Description
LDP_FEC_TYPE_PREFIX
Prefix
LDP_FEC_TYPE_HOST_ADDR Host address

LDP_FEC_TYPE_VC
VC
Ipv4PrefixLsp Read-Only Attributes

Ipv4RouteGenParams
Description:
Route/topology generator parameters for IPv4 routes.

Children: BgpRouteGenRouteAttrParams, IsisLspGenRouteAttrParams, Ospfv2LsaGenRouteAttrParams, Ospfv3LsaGenRouteAttrParams,
RipRouteGenRouteAttrParams
Ipv4RouteGenParams Writable Attributes

Writable Attribute
Description
Active, Name
Count
Total number of routes to generate for this Ipv4RouteGenParams instance.

Type: u32
Default: 0
CreateMultipleRouteBlocks
Create multiple route block with specified number of routes per route block.
Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
Create multiple routeblocks.
FALSE Do not create multiple routeblocks.
1310
Ipv4RouteGenParams
Writable Attribute
Description
DisableRouteAggregation
Enable this option to prevent route aggregation by distributing routes to the ports non-sequentially. Prevent aggregation to
stress the SUT's routing table capacity and processing power each time a packet arrives.
Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
Routes assigned to any given port will be incremented by 2 in order to prevent aggregation.
FALSE Routes assigned to any given port will be incremented by 1, which allows for aggregation.
DuplicationPercentage
Determines the percentage of routes that will be duplicated to another port. The duplicate routes are assigned the secondary
category.
Type: double
Default: 0
Range: 0 - 100
EmulatedRouters
Type of emulated router locations where routes will be added.

Type: enum
Default: NONE
Possible Values:
Value Description
NONE Do not add routes to any emulated routers.
ALL
EnableIpAddrOverride
Add routes to all emulated routers.
Determines if the IpAddrStart/IpAddrEnd values or the default start/end IP addresses will be used.
Type: bool
Default: TRUE
Possible Values:
Value Description
TRUE
Use the IpAddrStart and IpAddrEnd values.
FALSE Use the default start and end IP addresses.

IpAddrEnd
Ending IP address to use for generating the routes. If there are not enough addresses between the start and end IP address
to generate the specified number of routes, the route generator will generate as many routes as possible. This attribute is
valid only when the EnableIpAddrOverride attribute is set to true.
Type: ip
Default: 223.255.255.255
IpAddrIncrement
IP address increment.
Type: u32
Default: 1
IpAddrStart
Starting IP address to use for generating the routes. If multiple Ipv4RouteGenParams are used, the route generator will skip
addresses it has already used, but will generate the specified number of routes, if possible. This attribute is valid only when
the EnableIpAddrOverride attribute is set to true.
Type: ip
Default: 1.0.0.0
PrefixLengthDist
Percentage of routes to create for each prefix length. This attribute is valid when PrefixLengthDistType is CUSTOM.
Type: double
Default: 0
Range: 0 - 100
1311
Ipv4RouteGenParams
Writable Attribute
Description
PrefixLengthDistType
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.
Type: enum
Default: FIXED
Possible Values:
Value
Description
FIXED
All routes are generated with the prefix length specified by PrefixLengthStart.
LINEAR
Routes are distributed equally across prefix lengths from PrefixLengthStart to PrefixLengthEnd. 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.
For example, if the total number of routes is 20 with prefix lengths starting at 24 and ending at 32, there
would be 20/2 = 10 of 32-prefix routes, 20/4 = 5 of 31-prefix routes, 20/8 = 2 of 30-prefix routes, and 20/16
= 1 of 29-prefix routes. The remaining 2 routes will be added to the ending prefix lengths; thus, there
would be 10 + 2 = 12 of 32-prefix routes.
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 length.
PrefixLengthEnd
Maximum prefix length for the generated routes. This attribute is valid when the PrefixLengthDistType is FIXED, LINEAR,
or EXPONENTIAL.
Type: u8
Default: 24
Range: 1 - 32
PrefixLengthStart
Minimum prefix length for the generated routes. This attribute is valid when the PrefixLengthDistType is FIXED, LINEAR,
or EXPONENTIAL.
Type: u8
Default: 24
Range: 1 - 32
RoutesPerBlock
Number of routes per route block.

Type: u32
Default: 0
Range: 0 - 2147483647
SimulatedRouters
Type of simulated router locations where routes will be added. The SimulatedRouters option is available only for protocols
that are capable of advertising topologies (OSPF, ISIS) and when topology generation parameters are specified.
Type: enum
Default: ALL
Possible Values:
Value Description
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 available only for tree
topologies.
UseIpAddrIncrement
Whether to use IP address increment.

Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
Use IP addrress increment.
FALSE Do not use IP addrress increment.
1312
IPv6
Writable Attribute
Description
WeightRouteAssignment
Determines how the total number of routes will be distributed.

Type: enum
Default: BYROUTERS
Possible Values:
Value
Description
BYPORTS
Equal number of routes is 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 is assigned to each router.
Ipv4RouteGenParams Read-Only Attributes

IPv6 (ipv6:IPv6)
Description:
Parents: StreamBlock, ipData
Children: None
Next headers: ipv4:IPv4, ipv6:IPv6, ipv6:Ipv6FragmentHeader, ipv6:Ipv6HopByHopHeader, ipv6:Ipv6DestinationHeader, ipv6:Ipv6RoutingHeader,
ipv6:Ipv6AuthenticationHeader, ipv6:Ipv6EncapsulationHeader, tcp:Tcp, udp:Udp, icmpv6:Icmpv6DestUnreach, icmpv6:Icmpv6PacketTooBig,
icmpv6:Icmpv6TimeExceeded, icmpv6:Icmpv6ParameterProblem, icmpv6:Icmpv6EchoRequest, icmpv6:Icmpv6EchoReply, icmpv6:MLDv1, icmpv6:MLDv2Query,
icmpv6:MLDv2Report, icmpv6:RouterSolicitation, icmpv6:RouterAdvertisement, icmpv6:NeighborSolicitation, icmpv6:NeighborAdvertisement, icmpv6:Redirect,
gre:Gre, pim:Pimv6Hello, pim:Pimv6Register, pim:Pimv6RegisterStop, pim:Pimv6JoinPrune, pim:Pimv6Assert, custom:Custom
IPv6 Attributes
Attribute
Description
destAddr
Type: IPV6ADDR
Default: 2000::1
destPrefixLength
Type: INTEGER
Default: 64
flowLabel
Type: INTEGER
Default: 0
gateway
Type: IPV6ADDR
Default: ::0
hopLimit
Type: INTEGER
Default: 255
Name
information.
Type: string
1313
IPv6
Attribute
Description
nextHeader
Default: 59
Possible Values:
1314
IPv6
Attribute
Description
Value Description
0
HOPOPT
ICMP
IGMP
GGP
IP
ST
TCP
CBT
EGP
IGP
10
BBN-RCC-MON
11
NVP-II
12
PUP
13
ARGUS
14
EMCON
15
XNET
16
CHAOS
17
UDP
18
MUX
19
DCN-MEAS
20
HMP
21
PRM
22
XNS-IDP
23
TRUNK-1
24
TRUNK-2
25
LEAF-1
26
LEAF-2
27
RDP
28
IRTP
29
ISO-TP4
30
NETBLT
31
MFE-NSP
32
MERIT-INP
33
SEP
34
3PC
35
IDPR
36
XTP
37
DDP
38
IDPR-CMTP
39
TP++
40
IL
41
IPv6
42
SDRP
43
IPv6-Route
44
IPv6-Frag
45
IDRP
46
RSVP
47
GRE
48
MHRP
49
BNA
1315
IPv6
Attribute
Description
Value Description
50
ESP
51
AH
52
I-NLSP
53
SWIPE
54
NARP
55
MOBILE
56
TLSP
57
SKIP
58
IPv6-ICMP
59
IPv6-NoNxt
60
IPv6-Opts
62
CFTP
64
SAT-EXPAK
65
KRYPTOLAN
66
RVD
67
IPPC
69
SAT-MON
70
VISA
71
IPCV
72
CPNX
73
CPHB
74
WSN
75
PVP
76
BR-SAT-MON
77
SUN-ND
78
WB-MON
79
WB-EXPAK
80
ISO-IP
81
VMTP
82
SECURE-VMTP
83
VINES
84
TTP
85
NSFNET-IGP
86
DGP
87
TCF
88
EIGRP
89
OSPFIGP
90
Sprite-RPC
91
LARP
92
MTP
93
AX.25
94
IPIP
95
MICP
96
SCC-SP
97
ETHERIP
98
ENCAP
100
GMTP
101
IFMP
102
PNNI
103
PIM
1316
IPv6
Attribute
Description
Value Description
104
ARIS
105
SCPS
106
QNX
107
A/N
108
IPComp
109
SNP
110
Compaq-Peer
111
IPX-in-IP
112
VRRP
113
PGM
115
L2TP
116
DDX
117
IATP
118
STP
119
SRP
120
UTI
121
SMP
122
SM
123
PTP
124
ISIS over IPv4
125
FIRE
126
CRTP
127
CRUDP
128
SSCOPMCE
129
IPLT
130
SPS
131
PIPE
132
SCTP
133
FC
134
RSVP-E2E-IGNORE
135
Mobility Header
136
UDPLite
137
MPLS-in-IP
253
Experimental
255
Reserved
payloadLength
Type: INTEGER
Default: 0
prefixLength
Type: INTEGER
Default: 64
sourceAddr
Type: IPV6ADDR
Default: 2000::2
trafficClass
Type: INTEGER
Default: 0
version
Type: INTEGER
Default: 6
1317
ipv6Addr
ipv6Addr
Description:
Children: None
ipv6Addr Attributes
Attribute
Description
addrSubtype
Default: 02
Possible Values:
Value Description
00
Other
01
IPv4
02
IPv6
03
nsap
04
hdlc
05
bbn1822
06
All 802
07
e163
08
e164
09
f69
0A
x121
0B
IPX
0C
Apple Talk
0D
DEC Net IV
0E
Banyan Vines
0F
E164 with NSAP
10
DNS
11
Distinguished Name
12
AS Number
13
XTP over IPv4
14
XTP over IPv6
15
XTP native mode XTP
16
Fibre Channel WWPN
17
Fibre Channel WWNN
18
Gateway Identifier
19
AFI
managementAddr
Type: IPV6ADDR
Name
information.
Type: string
Ipv6Addr
Description:
IPv6 address used with ICMPv6
Parents: addrList
1318
Ipv6Addr
Children: None
Ipv6Addr Attributes
Attribute
Description
Name
information.
Type: string
value
Type: IPV6ADDR
Default: 2000::1
Ipv6Addr
Description:
Parents: nodes
Children: None
Ipv6Addr Attributes
Attribute
Description
Name
information.
Type: string
value
Type: IPV6ADDR
Default: 2000:0000:0000:0000:0000:0000:0000:0001
Ipv6Addr
Description:
IPv6 address for PIMv6 Hello option
Parents: addrList
Children: None
Ipv6Addr Attributes
Attribute
Description
Name
information.
Type: string
value
Type: IPV6ADDR
Default: 2000:0000:0000:0000:0000:0000:0000:0001
1319
Ipv6AuthenticationHeader
Ipv6AuthenticationHeader (ipv6:Ipv6AuthenticationHeader)
Description:
Children: None
Ipv6AuthenticationHeader Attributes
Attribute
Description
authData
Type: OCTETSTRING
Default: 0000
length
Type: INTEGER
Default: 0
Name
Type: string
1320
Attribute
Description
nxtHdr
Default: 59
Possible Values:
1321
Attribute
Description
Value Description
0
HOPOPT
ICMP
IGMP
GGP
IP
ST
TCP
CBT
EGP
IGP
10
BBN-RCC-MON
11
NVP-II
12
PUP
13
ARGUS
14
EMCON
15
XNET
16
CHAOS
17
UDP
18
MUX
19
DCN-MEAS
20
HMP
21
PRM
22
XNS-IDP
23
TRUNK-1
24
TRUNK-2
25
LEAF-1
26
LEAF-2
27
RDP
28
IRTP
29
ISO-TP4
30
NETBLT
31
MFE-NSP
32
MERIT-INP
33
SEP
34
3PC
35
IDPR
36
XTP
37
DDP
38
IDPR-CMTP
39
TP++
40
IL
41
IPv6
42
SDRP
43
IPv6-Route
44
IPv6-Frag
45
IDRP
46
RSVP
47
GRE
48
MHRP
49
BNA
1322
Attribute
Description
Value Description
50
ESP
51
AH
52
I-NLSP
53
SWIPE
54
NARP
55
MOBILE
56
TLSP
57
SKIP
58
IPv6-ICMP
59
IPv6-NoNxt
60
IPv6-Opts
62
CFTP
64
SAT-EXPAK
65
KRYPTOLAN
66
RVD
67
IPPC
69
SAT-MON
70
VISA
71
IPCV
72
CPNX
73
CPHB
74
WSN
75
PVP
76
BR-SAT-MON
77
SUN-ND
78
WB-MON
79
WB-EXPAK
80
ISO-IP
81
VMTP
82
SECURE-VMTP
83
VINES
84
TTP
85
NSFNET-IGP
86
DGP
87
TCF
88
EIGRP
89
OSPFIGP
90
Sprite-RPC
91
LARP
92
MTP
93
AX.25
94
IPIP
95
MICP
96
SCC-SP
97
ETHERIP
98
ENCAP
100
GMTP
101
IFMP
102
PNNI
103
PIM
1323
Ipv6DestinationHeader
Attribute
Description
Value Description
104
ARIS
105
SCPS
106
QNX
107
A/N
108
IPComp
109
SNP
110
Compaq-Peer
111
IPX-in-IP
112
VRRP
113
PGM
115
L2TP
116
DDX
117
IATP
118
STP
119
SRP
120
UTI
121
SMP
122
SM
123
PTP
124
ISIS over IPv4
125
FIRE
126
CRTP
127
CRUDP
128
SSCOPMCE
129
IPLT
130
SPS
131
PIPE
132
SCTP
133
FC
134
RSVP-E2E-IGNORE
135
Mobility Header
136
UDPLite
137
MPLS-in-IP
253
Experimental
255
Reserved
pad
Type: ALIGNMENTPAD
Default: 0
reserved
Type: INTEGER
Default: 0
seqNum
Type: INTEGER
Default: 0
spi
Type: INTEGER
Default: 0
Ipv6DestinationHeader (ipv6:Ipv6DestinationHeader)
1324
Description:
Children: options
Ipv6DestinationHeader Attributes
Attribute
Description
length
Type: INTEGER
Default: 0
Name
A text name for the object. This attribute is required when you use stream block modifiers such as RangeModifier, RandomModifier, and
TableModifier. See the description of the OffsetReference attribute for these modifier objects for more information.
Type: string
1325
Attribute
Description
nxtHdr
Default: 59
Possible Values:
1326
Attribute
Description
Value Description
0
HOPOPT
ICMP
IGMP
GGP
IP
ST
TCP
CBT
EGP
IGP
10
BBN-RCC-MON
11
NVP-II
12
PUP
13
ARGUS
14
EMCON
15
XNET
16
CHAOS
17
UDP
18
MUX
19
DCN-MEAS
20
HMP
21
PRM
22
XNS-IDP
23
TRUNK-1
24
TRUNK-2
25
LEAF-1
26
LEAF-2
27
RDP
28
IRTP
29
ISO-TP4
30
NETBLT
31
MFE-NSP
32
MERIT-INP
33
SEP
34
3PC
35
IDPR
36
XTP
37
DDP
38
IDPR-CMTP
39
TP++
40
IL
41
IPv6
42
SDRP
43
IPv6-Route
44
IPv6-Frag
45
IDRP
46
RSVP
47
GRE
48
MHRP
49
BNA
1327
Attribute
Description
Value Description
50
ESP
51
AH
52
I-NLSP
53
SWIPE
54
NARP
55
MOBILE
56
TLSP
57
SKIP
58
IPv6-ICMP
59
IPv6-NoNxt
60
IPv6-Opts
62
CFTP
64
SAT-EXPAK
65
KRYPTOLAN
66
RVD
67
IPPC
69
SAT-MON
70
VISA
71
IPCV
72
CPNX
73
CPHB
74
WSN
75
PVP
76
BR-SAT-MON
77
SUN-ND
78
WB-MON
79
WB-EXPAK
80
ISO-IP
81
VMTP
82
SECURE-VMTP
83
VINES
84
TTP
85
NSFNET-IGP
86
DGP
87
TCF
88
EIGRP
89
OSPFIGP
90
Sprite-RPC
91
LARP
92
MTP
93
AX.25
94
IPIP
95
MICP
96
SCC-SP
97
ETHERIP
98
ENCAP
100
GMTP
101
IFMP
102
PNNI
103
PIM
1328
Ipv6DestinationOption
Attribute
Description
Value Description
pad
104
ARIS
105
SCPS
106
QNX
107
A/N
108
IPComp
109
SNP
110
Compaq-Peer
111
IPX-in-IP
112
VRRP
113
PGM
115
L2TP
116
DDX
117
IATP
118
STP
119
SRP
120
UTI
121
SMP
122
SM
123
PTP
124
ISIS over IPv4
125
FIRE
126
CRTP
127
CRUDP
128
SSCOPMCE
129
IPLT
130
SPS
131
PIPE
132
SCTP
133
FC
134
RSVP-E2E-IGNORE
135
Mobility Header
136
UDPLite
137
MPLS-in-IP
253
Experimental
255
Reserved
Type: ALIGNMENTPAD
Default: 0
Ipv6DestinationOption
Description:
Parents: options
Children: custom, pad1, padN
1329
Ipv6EncapsulationHeader
Ipv6DestinationOption Attributes
Attribute
Description
Name
information.
Type: string
Ipv6EncapsulationHeader (ipv6:Ipv6EncapsulationHeader)
Description:
Children: None
Ipv6EncapsulationHeader Attributes
Attribute
Description
authData
Type: OCTETSTRING
Default: 0000
length
Type: INTEGER
Default: 0
Name
Type: string
1330
Attribute
Description
nxtHdr
Default: 59
Possible Values:
1331
Attribute
Description
Value Description
0
HOPOPT
ICMP
IGMP
GGP
IP
ST
TCP
CBT
EGP
IGP
10
BBN-RCC-MON
11
NVP-II
12
PUP
13
ARGUS
14
EMCON
15
XNET
16
CHAOS
17
UDP
18
MUX
19
DCN-MEAS
20
HMP
21
PRM
22
XNS-IDP
23
TRUNK-1
24
TRUNK-2
25
LEAF-1
26
LEAF-2
27
RDP
28
IRTP
29
ISO-TP4
30
NETBLT
31
MFE-NSP
32
MERIT-INP
33
SEP
34
3PC
35
IDPR
36
XTP
37
DDP
38
IDPR-CMTP
39
TP++
40
IL
41
IPv6
42
SDRP
43
IPv6-Route
44
IPv6-Frag
45
IDRP
46
RSVP
47
GRE
48
MHRP
49
BNA
1332
Attribute
Description
Value Description
50
ESP
51
AH
52
I-NLSP
53
SWIPE
54
NARP
55
MOBILE
56
TLSP
57
SKIP
58
IPv6-ICMP
59
IPv6-NoNxt
60
IPv6-Opts
62
CFTP
64
SAT-EXPAK
65
KRYPTOLAN
66
RVD
67
IPPC
69
SAT-MON
70
VISA
71
IPCV
72
CPNX
73
CPHB
74
WSN
75
PVP
76
BR-SAT-MON
77
SUN-ND
78
WB-MON
79
WB-EXPAK
80
ISO-IP
81
VMTP
82
SECURE-VMTP
83
VINES
84
TTP
85
NSFNET-IGP
86
DGP
87
TCF
88
EIGRP
89
OSPFIGP
90
Sprite-RPC
91
LARP
92
MTP
93
AX.25
94
IPIP
95
MICP
96
SCC-SP
97
ETHERIP
98
ENCAP
100
GMTP
101
IFMP
102
PNNI
103
PIM
1333
Attribute
Description
Value Description
104
ARIS
105
SCPS
106
QNX
107
A/N
108
IPComp
109
SNP
110
Compaq-Peer
111
IPX-in-IP
112
VRRP
113
PGM
115
L2TP
116
DDX
117
IATP
118
STP
119
SRP
120
UTI
121
SMP
122
SM
123
PTP
124
ISIS over IPv4
125
FIRE
126
CRTP
127
CRUDP
128
SSCOPMCE
129
IPLT
130
SPS
131
PIPE
132
SCTP
133
FC
134
RSVP-E2E-IGNORE
135
Mobility Header
136
UDPLite
137
MPLS-in-IP
253
Experimental
255
Reserved
pad
Type: ALIGNMENTPAD
Default: 0
padData
Type: OCTETSTRING
Default: 00
payloadData
Type: OCTETSTRING
Default: 0000
seqNum
Type: INTEGER
Default: 0
spi
Type: INTEGER
Default: 0
1334
Ipv6FragmentHeader
Ipv6FragmentHeader (ipv6:Ipv6FragmentHeader)
Description:
Children: None
Ipv6FragmentHeader Attributes
Attribute
Description
fragOffset
Type: INTEGER
Default: 0
ident
Type: INTEGER
Default: 0
length
Type: INTEGER
Default: 0
m_flag
Type: BITSTRING
Default: 0
Name
Type: string
1335
Ipv6FragmentHeader
Attribute
Description
nxtHdr
Default: 59
Possible Values:
1336
Ipv6FragmentHeader
Attribute
Description
Value Description
0
HOPOPT
ICMP
IGMP
GGP
IP
ST
TCP
CBT
EGP
IGP
10
BBN-RCC-MON
11
NVP-II
12
PUP
13
ARGUS
14
EMCON
15
XNET
16
CHAOS
17
UDP
18
MUX
19
DCN-MEAS
20
HMP
21
PRM
22
XNS-IDP
23
TRUNK-1
24
TRUNK-2
25
LEAF-1
26
LEAF-2
27
RDP
28
IRTP
29
ISO-TP4
30
NETBLT
31
MFE-NSP
32
MERIT-INP
33
SEP
34
3PC
35
IDPR
36
XTP
37
DDP
38
IDPR-CMTP
39
TP++
40
IL
41
IPv6
42
SDRP
43
IPv6-Route
44
IPv6-Frag
45
IDRP
46
RSVP
47
GRE
48
MHRP
49
BNA
1337
Ipv6FragmentHeader
Attribute
Description
Value Description
50
ESP
51
AH
52
I-NLSP
53
SWIPE
54
NARP
55
MOBILE
56
TLSP
57
SKIP
58
IPv6-ICMP
59
IPv6-NoNxt
60
IPv6-Opts
62
CFTP
64
SAT-EXPAK
65
KRYPTOLAN
66
RVD
67
IPPC
69
SAT-MON
70
VISA
71
IPCV
72
CPNX
73
CPHB
74
WSN
75
PVP
76
BR-SAT-MON
77
SUN-ND
78
WB-MON
79
WB-EXPAK
80
ISO-IP
81
VMTP
82
SECURE-VMTP
83
VINES
84
TTP
85
NSFNET-IGP
86
DGP
87
TCF
88
EIGRP
89
OSPFIGP
90
Sprite-RPC
91
LARP
92
MTP
93
AX.25
94
IPIP
95
MICP
96
SCC-SP
97
ETHERIP
98
ENCAP
100
GMTP
101
IFMP
102
PNNI
103
PIM
1338
Ipv6Group
Attribute
Description
Value Description
reserved
104
ARIS
105
SCPS
106
QNX
107
A/N
108
IPComp
109
SNP
110
Compaq-Peer
111
IPX-in-IP
112
VRRP
113
PGM
115
L2TP
116
DDX
117
IATP
118
STP
119
SRP
120
UTI
121
SMP
122
SM
123
PTP
124
ISIS over IPv4
125
FIRE
126
CRTP
127
CRUDP
128
SSCOPMCE
129
IPLT
130
SPS
131
PIPE
132
SCTP
133
FC
134
RSVP-E2E-IGNORE
135
Mobility Header
136
UDPLite
137
MPLS-in-IP
253
Experimental
255
Reserved
Type: BITSTRING
Default: 00
Ipv6Group
Description:
Creates/configures an IPv6 multicast group.

Parents: Project
Automatically-created children: Ipv6GroupResults, Ipv6NetworkBlock
Result children (automatically created): Ipv6GroupResults
1339
Ipv6GroupResults
Relations:
Side name
(Type)
Relative
Description
PimGroup
(JoinedGroup)
Pimv6GroupBlk, Pimv6RpMap
Relationship between the PIMv6 group block object, and the

IPv6 group object.
Config
Rfc3918Config
IptvParameter
(MulticastParam)
IptvChannelBlock
Relationship between the IPTV channel block object, and the

IPv6 group object.
ResultChild
(ResultChild)
Ipv6GroupResults
(SubscribedGroups)
IgmpGroupMembership,
MldGroupMembership
Relationship between the MLD group membership block object,

and the IPv6 group block object
Ipv6Group Writable Attributes

Writable Attribute
Description
Active, Name
Ipv6Group Read-Only Attributes

Ipv6GroupResults
Description:
See Ipv4GroupResults.

Automatically created from: Ipv6Group
Relations:
Side name
(Type)
Relative
Description
ResultParent
(ResultChild)
Ipv6Group
Ipv6GroupResults Writable Attributes

Ipv6GroupResults Read-Only Attributes

Read-Only Attribute
Description
AvgJoinLatency
Type: double
Default: 0
AvgLeaveLatency
Type: double
Default: 0
1340
Ipv6HopByHopHeader
Read-Only Attribute
Description
MaxJoinLatency
Type: double
Default: 0
MaxLeaveLatency
Type: double
Default: 0
MinJoinLatency
Type: double
Default: 0
MinLeaveLatency
Type: double
Default: 0
Timestamp
Type: double
Default: 0
Ipv6HopByHopHeader (ipv6:Ipv6HopByHopHeader)
Description:
Children: options
Ipv6HopByHopHeader Attributes
Attribute
Description
length
Type: INTEGER
Default: 0
Name
A text name for the object. This attribute is required when you use stream block modifiers such as RangeModifier, RandomModifier, and
TableModifier. See the description of the OffsetReference attribute for these modifier objects for more information.
Type: string
1341
Ipv6HopByHopHeader
Attribute
Description
nxtHdr
Default: 59
Possible Values:
1342
Ipv6HopByHopHeader
Attribute
Description
Value Description
0
HOPOPT
ICMP
IGMP
GGP
IP
ST
TCP
CBT
EGP
IGP
10
BBN-RCC-MON
11
NVP-II
12
PUP
13
ARGUS
14
EMCON
15
XNET
16
CHAOS
17
UDP
18
MUX
19
DCN-MEAS
20
HMP
21
PRM
22
XNS-IDP
23
TRUNK-1
24
TRUNK-2
25
LEAF-1
26
LEAF-2
27
RDP
28
IRTP
29
ISO-TP4
30
NETBLT
31
MFE-NSP
32
MERIT-INP
33
SEP
34
3PC
35
IDPR
36
XTP
37
DDP
38
IDPR-CMTP
39
TP++
40
IL
41
IPv6
42
SDRP
43
IPv6-Route
44
IPv6-Frag
45
IDRP
46
RSVP
47
GRE
48
MHRP
49
BNA
1343
Ipv6HopByHopHeader
Attribute
Description
Value Description
50
ESP
51
AH
52
I-NLSP
53
SWIPE
54
NARP
55
MOBILE
56
TLSP
57
SKIP
58
IPv6-ICMP
59
IPv6-NoNxt
60
IPv6-Opts
62
CFTP
64
SAT-EXPAK
65
KRYPTOLAN
66
RVD
67
IPPC
69
SAT-MON
70
VISA
71
IPCV
72
CPNX
73
CPHB
74
WSN
75
PVP
76
BR-SAT-MON
77
SUN-ND
78
WB-MON
79
WB-EXPAK
80
ISO-IP
81
VMTP
82
SECURE-VMTP
83
VINES
84
TTP
85
NSFNET-IGP
86
DGP
87
TCF
88
EIGRP
89
OSPFIGP
90
Sprite-RPC
91
LARP
92
MTP
93
AX.25
94
IPIP
95
MICP
96
SCC-SP
97
ETHERIP
98
ENCAP
100
GMTP
101
IFMP
102
PNNI
103
PIM
1344
Ipv6HopByHopOption
Attribute
Description
Value Description
pad
104
ARIS
105
SCPS
106
QNX
107
A/N
108
IPComp
109
SNP
110
Compaq-Peer
111
IPX-in-IP
112
VRRP
113
PGM
115
L2TP
116
DDX
117
IATP
118
STP
119
SRP
120
UTI
121
SMP
122
SM
123
PTP
124
ISIS over IPv4
125
FIRE
126
CRTP
127
CRUDP
128
SSCOPMCE
129
IPLT
130
SPS
131
PIPE
132
SCTP
133
FC
134
RSVP-E2E-IGNORE
135
Mobility Header
136
UDPLite
137
MPLS-in-IP
253
Experimental
255
Reserved
Type: ALIGNMENTPAD
Default: 0
Ipv6HopByHopOption
Description:
Parents: options
Children: custom, jumbo, pad1, padN, routerAlert
1345
Ipv6If
Ipv6HopByHopOption Attributes
Attribute
Description
Name
information.
Type: string
Ipv6If
Description:
IPv6 interface object.

Relations:
Side name
(Type)
Relative
Description
DstBoundTo
(DstBinding)

StreamBlock.
EncapsulationSource
(Encapsulation)
PathDescriptor
NetworkLink
(LinkSrc)

MemberOfVpn
(MemberOfVpn)

VpnSiteInfoVplsLdp
Port

relation.

WimaxIf

PrimaryIfSource
(PrimaryIf)

SUT

the DUT.
RelayBlockConfig
(RelayIf)
(ResolvesInterface)

RsvpRouterConfig
1346

Ipv6If
Side name
(Type)
Relative
Description
SrcBoundTo
(SrcBinding)

StreamBlock.
StackedOn
(StackedOnEndpoint)

WimaxIf
TopLevelIfSource
(TopLevelIf)

SUT

interface stack.
Port

relation.
UsesIfSource
(UsesIf)


Ipv6If Writable Attributes

Writable Attribute
Description
Active, Name
Address
IPv6 address. You can generate more than one address by using combinations of Address, AddrRepeatCount,
AddrStep, AddrStepMask, and IfRecycleCount. If you do that, then Address is the starting address.
Type: ipv6
Default: 2000::2
AddrList
A Tcl list of IPv6 addresses. To use this attribute, the IsRange attribute must be FALSE.
Type: ipv6
Default: 0
AddrRepeatCount
How many times to repeat the same IPv6 address before incrementing it. See IsRange for more information.
Type: u32
Default: 0
AddrResolver
IPv6 address resolver identifier.

Type: string
Default: default
AddrStep
Step value for generated IPv6 addresses. See IsRange for more information.
Type: ipv6
Default: 0000::1
1347
Ipv6If
Writable Attribute
Description
AddrStepMask
IPv6 address step mask. Indicates which parts of the IPv6 address will change when incremented. See IsRange
Type: ipv6
Default: FFFF:FFFF:FFFF:FFFF:FFFF:FFFF:FFFF:FFFF
AllocateEui64LinkLocalAddress
Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
FALSE
Whether to enable IPv6 learning for the gateway IP and MAC addresses. Learning begins when the ARP/ND
command is issued. If the learned value is not the same as the configured IPv6 gateway address, the learned
value is used instead.
Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
Enable gateway learning.
FALSE Disable gateway learning.

FlowLabel
Flow label.
Type: u32
Default: 7
Range: 0 - 1048575
Gateway
IPv6 gateway address. You can generate more than one address by using combinations of Gateway,
GatewayRepeatCount, GatewayStep, and GatewayRecycleCount. If you do that, then Gateway is the starting
address.
Type: ipv6
Default: ::0
GatewayList
A Tcl list of IPv6 gateway addresses. To use this attribute, the IsRange attribute must be FALSE.
Type: ipv6
Default: 0
GatewayMac
Gateway MAC address.

Type: mac
Default: 00:00:01:00:00:01
GatewayMacResolver
Gateway MAC address resolver identifier.

Type: string
Default: default
GatewayRecycleCount
Type: u32
Default: 0
GatewayRepeatCount
Type: u32
Default: 0
GatewayStep
Type: ipv6
Default: 0000::0000
HopLimit
Hop limit.
Type: u8
Default: 255
Range: 0 - 255
IfCountPerLowerIf

Type: u32
Default: 1
1348
Ipv6If
Writable Attribute
Description
IfRecycleCount
How many times to increment the IPv6 address (Address attribute) before returning to the starting value. See
IsRange for more information.
Type: u32
Default: 0
IsLoopbackIf

Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE

IsRange
Whether to use a combination of attributes to generate a range of addresses, or to use a list attribute (AddrList or
GatewayList) to specify the addresses. The beginning address attributes are Address and Gateway.
Type: bool
Default: TRUE
Possible Values:
Value Description
TRUE
Set 1: Address, AddrRepeatCount, AddrStep, AddrStepMask, IfRecycleCount.
Set 2: Gateway, GatewayRepeatCount, GatewayStep, GatewayRecycleCount.
FALSE Use AddrList and GatewayList to specify the items.

NeedsAuthentication
Whether this interface needs authentication.

Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
This interface needs authentication.
FALSE This interface does not need authentication.

PrefixLength

Type: u8
Default: 64
Range: 0 - 128
ResolveGatewayMac
Whether to resolve gateway MAC address.

Type: bool
Default: TRUE
Possible Values:
Value Description
TRUE
Resolve gateway MAC address.
FALSE Do not resolve gateway MAC address.

TrafficClass
Traffic class.
Type: u8
Default: 0
Range: 0 - 255
UseIpAddrRangeSettingsForGateway
Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
FALSE
1349
Ipv6If
Writable Attribute
Description
UsePortDefaultIpv6Gateway
Whether to use the logical port's default IPv6 gateway.

Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
Use default IPv6 gateway.
FALSE Do not use default IPv6 gateway.
Ipv6If Read-Only Attributes

Read-Only Attribute
Description
AddrResolveState
IPv6 address resolve state.

Type: enum
Possible Values:
Value
Description
RESOLVE_DONE
Resolve is done.
RESOLVE_NEEDED
Resolve is needed.
RESOLVE_FAILED
Resolve failed.
RESOLVE_IN_PROGRESS

EffectiveBlockCount

Type: u32
Default: 1
GatewayLearningState
Gateway IP learning resolution state.

Type: enum
Possible Values:
Value
Description
RESOLVE_DONE
Resolved.
RESOLVE_IN_PROGRESS Resolve in progress.
GatewayMacResolveState
RETRYING_GATEWAY
Retrying to resolved gateway.
RESOLVE_NEEDED
Resolved needed.
RESOLVE_FAILED
Failed to resolve gateway.
FAILURE
Resolve failed.
SUCCESS
Resolved.
Gateway MAC address resolve state.

Type: enum
Possible Values:
Value
Description
RESOLVE_DONE
Resolve is done.
RESOLVE_NEEDED
Resolve is needed.
RESOLVE_FAILED
Resolve failed.
RESOLVE_IN_PROGRESS
1350
Read-Only Attribute
Description
IfState

Type: enum
Default: DISABLED
Possible Values:
Value
Description
READY
Ready.
DISABLED
Disabled.
DELETING
Deleting.
Description:
ISIS IPv6 router.

Ipv6IsisRoutesConfig Writable Attributes

Writable Attribute
Description
RouteCategory
Specifies the route type.

Type: enum
Default: UNDEFINED
Possible Values:
Value
Description
UNDEFINED
PRIMARY
Primary route.
RouteType
UNIQUE
Unique route.
ANY
ANY
Defines the TLV type. (Enabled only if metric mode is not wide.)
Type: enum
Default: INTERNAL
Possible Values:
Value
Description
INTERNAL Internal TLV type.
EXTERNAL External TLV type.
UpDown
If the up/down bit is set to down (1), it indicates that the route is advertised from Level 2 to Level 1.
Type: u8
Default: 0
Range: 0 - 1
WideMetric
The wide (4-octet) metric is used for traffic engineering. (Disabled if metric mode is set to narrow.)
Type: u32
Default: 1
Range: 0 - 16777215
Ipv6IsisRoutesConfig Read-Only Attributes

1351
IPv6LL
IPv6LL (ip:IPv6LL)
Description:
Children: None
pim:Pimv4Hello, pim:Pimv4Register, pim:Pimv4RegisterStop, pim:Pimv4JoinPrune, pim:Pimv4Assert, custom:Custom
IPv6LL Attributes
Attribute
Description
Name
Type: string
v6gateway
Type: IPV6ADDR
Default: 2000::1
v6hopLimit
Type: INTEGER
Default: 255
v6llhopLimit
Type: INTEGER
Default: 255
v6llprefixLength
Type: INTEGER
Default: 128
v6llsourceAddr
Type: IPV6ADDR
Default: FE80::2
v6lltrafficClass
Type: INTEGER
Default: 0
v6prefixLength
Type: INTEGER
Default: 64
v6sourceAddr
Type: IPV6ADDR
Default: 2000::2
v6trafficClass
Type: INTEGER
Default: 0
Ipv6NetworkBlock
Description:
IPv6 network block.

Parents: EmulatedDevice, ExternalDevice, ExternalDevicePort, Host, IptvChannelBlock, Port, PppoaClientBlockConfig, PppoeClientBlockConfig,
PppoL2tpv2ClientBlockConfig, Router, SUT
Automatically created from: BfdIpv6ControlPlaneIndependentSession, BgpIpv6RouteConfig, Ipv6Group, Ipv6IsisRoutesConfig, MldGroupMembership,
Ospfv3AsExternalLsaBlock, Ospfv3InterAreaPrefixLsaBlk, Ospfv3IntraAreaPrefixLsaBlk, Ospfv3LinkLsaBlk, Ospfv3NssaLsaBlock, RipngRouteParams
Relations:
1352
Ipv6NetworkBlock
Side name
(Type)
Relative
Description
DstBoundTo
(DstBinding)

StreamBlock.
EncapsulationSource
(Encapsulation)
PathDescriptor
MemberOfVpn
(MemberOfVpn)

Port


VlanIf, WimaxIf

SrcBoundTo
(SrcBinding)

StreamBlock.
StackedOn
(StackedOnEndpoint)

VlanIf, WimaxIf
Port

Ipv6NetworkBlock Writable Attributes

Writable Attribute
Description
Active, Name
AddrIncrement
Network address increment.

Type: u32
Default: 1
NetworkCount
Number of networks.
Type: u32
Default: 1
PrefixLength

Type: u8
Default: 64
Range: 0 - 128
StartIpList

Type: ipv6
Default: 2000::1
Ipv6NetworkBlock Read-Only Attributes

1353
Ipv6RouteGenParams
Ipv6RouteGenParams
Description:
Route/topology generator parameters for IPv6 routes.

Children: BgpRouteGenRouteAttrParams, IsisLspGenRouteAttrParams, Ospfv2LsaGenRouteAttrParams, Ospfv3LsaGenRouteAttrParams,
Ipv6RouteGenParams Writable Attributes

Writable Attribute
Description
Active, Name
Count
Total number of routes to generate for this Ipv6RouteGenParams instance.

Type: u32
Default: 0
CreateMultipleRouteBlocks
Create multiple route block with specified number of routes per route block.
Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
Create multiple route blocks.
FALSE Do not create multiple route blocks.

DisableRouteAggregation
Enable this option to prevent route aggregation by distributing routes to the ports non-sequentially. Prevent aggregation to
stress the SUT's routing table capacity and processing power each time a packet arrives.
Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
Routes assigned to any given port will be incremented by 2 in order to prevent aggregation.
FALSE Routes assigned to any given port will be incremented by 1, which allows for aggregation.
DuplicationPercentage
Determines the percentage of routes that will be duplicated to another port. The duplicate routes are assigned the secondary
category.
Type: double
Default: 0
Range: 0 - 100
EmulatedRouters
Type of emulated router locations where routes will be added.

Type: enum
Default: NONE
Possible Values:
Value Description
NONE Do not add routes to any emulated routers.
ALL
EnableIpAddrOverride
Add routes to all emulated routers.
Determines if the IpAddrStart/IpAddrEnd values or the default start/end IP addresses will be used.
Type: bool
Default: TRUE
Possible Values:
Value Description
TRUE
Use the IpAddrStart and IpAddrEnd values.
FALSE Use the default start and end IP addresses.

IpAddrEnd
Ending IP address to use for generating the routes. If there are not enough addresses between the start and end IP address
to generate the specified number of routes, the route generator will generate as many routes as possible. This attribute is
valid only when the EnableIpAddrOverride attribute is set to true.
Type: ipv6
Default: 3ffe::
1354
Ipv6RouteGenParams
Writable Attribute
Description
IpAddrIncrement
IP address increment.
Type: u32
Default: 1
IpAddrStart
Starting IP address to use for generating the routes. If multiple Ipv6RouteGenParams are used, the route generator will skip
addresses it has already used, but will generate the specified number of routes, if possible. This attribute is valid only when
the EnableIpAddrOverride attribute is set to true.
Type: ipv6
Default: 2000::
PrefixLengthDist
Percentage of routes to create for each prefix length. This attribute is valid when PrefixLengthDistType is CUSTOM.
Type: double
Default: 0
Range: 0 - 100
PrefixLengthDistType
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.
Type: enum
Default: FIXED
Possible Values:
Value
Description
FIXED
All routes are generated with the prefix length specified by PrefixLengthStart.
LINEAR
Routes are distributed equally across prefix lengths from PrefixLengthStart to PrefixLengthEnd. 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.
For example, if the total number of routes is 20 with prefix lengths starting at 24 and ending at 32, there
would be 20/2 = 10 of 32-prefix routes, 20/4 = 5 of 31-prefix routes, 20/8 = 2 of 30-prefix routes, and 20/16
= 1 of 29-prefix routes. The remaining 2 routes will be added to the ending prefix lengths; thus, there would
be 10 + 2 = 12 of 32-prefix routes.
INTERNET
Routes are distributed across prefix lengths in a manner typical of the Internet's default-free router prefix
distribution. Note: No official IPv6 Internet prefix length distribution is available at this time. Spirent
TestCenter defines a placeholder (default) IPv6 prefix length distribution that will be updated when one is
available.
CUSTOM
Custom prefix length distribution allows you to define the percentage of routes for each prefix length.
PrefixLengthEnd
Maximum prefix length for the generated routes. This attribute is valid when the PrefixLengthDistType is FIXED, LINEAR, or
EXPONENTIAL.
Type: u8
Default: 64
Range: 1 - 128
PrefixLengthStart
Minimum prefix length for the generated routes. This attribute is valid when the PrefixLengthDistType is FIXED, LINEAR, or
EXPONENTIAL.
Note: While 1 through 128 are valid prefix lengths, 8 is the recommended starting prefix length for Spirent TestCenter testing.
Type: u8
Default: 64
Range: 1 - 128
RoutesPerBlock
Number of routes per route block.

Type: u32
Default: 0
Range: 0 - 2147483647
1355
Ipv6RoutingHeader
Writable Attribute
Description
SimulatedRouters
Type of simulated router locations where routes will be added. The SimulatedRouters option is available only for protocols
that are capable of advertising topologies (OSPF, ISIS) and when topology generation parameters are specified.
Type: enum
Default: ALL
Possible Values:
Value Description
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 available only for tree
topologies.
UseIpAddrIncrement
Specifies if IP address increment to be used.

Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
Use IP address increment.
FALSE Do not use IP address increment.

WeightRouteAssignment
Determines how the total number of routes will be distributed.

Type: enum
Default: BYROUTERS
Possible Values:
Value
Description
BYPORTS
Equal number of routes is 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 is assigned to each router.
Ipv6RouteGenParams Read-Only Attributes

Ipv6RoutingHeader (ipv6:Ipv6RoutingHeader)
Description:
Children: nodes
Ipv6RoutingHeader Attributes
Attribute
Description
length
Type: INTEGER
Default: 0
Name
Type: string
1356
Ipv6RoutingHeader
Attribute
Description
nxtHdr
Default: 59
Possible Values:
1357
Ipv6RoutingHeader
Attribute
Description
Value Description
0
HOPOPT
ICMP
IGMP
GGP
IP
ST
TCP
CBT
EGP
IGP
10
BBN-RCC-MON
11
NVP-II
12
PUP
13
ARGUS
14
EMCON
15
XNET
16
CHAOS
17
UDP
18
MUX
19
DCN-MEAS
20
HMP
21
PRM
22
XNS-IDP
23
TRUNK-1
24
TRUNK-2
25
LEAF-1
26
LEAF-2
27
RDP
28
IRTP
29
ISO-TP4
30
NETBLT
31
MFE-NSP
32
MERIT-INP
33
SEP
34
3PC
35
IDPR
36
XTP
37
DDP
38
IDPR-CMTP
39
TP++
40
IL
41
IPv6
42
SDRP
43
IPv6-Route
44
IPv6-Frag
45
IDRP
46
RSVP
47
GRE
48
MHRP
49
BNA
1358
Ipv6RoutingHeader
Attribute
Description
Value Description
50
ESP
51
AH
52
I-NLSP
53
SWIPE
54
NARP
55
MOBILE
56
TLSP
57
SKIP
58
IPv6-ICMP
59
IPv6-NoNxt
60
IPv6-Opts
62
CFTP
64
SAT-EXPAK
65
KRYPTOLAN
66
RVD
67
IPPC
69
SAT-MON
70
VISA
71
IPCV
72
CPNX
73
CPHB
74
WSN
75
PVP
76
BR-SAT-MON
77
SUN-ND
78
WB-MON
79
WB-EXPAK
80
ISO-IP
81
VMTP
82
SECURE-VMTP
83
VINES
84
TTP
85
NSFNET-IGP
86
DGP
87
TCF
88
EIGRP
89
OSPFIGP
90
Sprite-RPC
91
LARP
92
MTP
93
AX.25
94
IPIP
95
MICP
96
SCC-SP
97
ETHERIP
98
ENCAP
100
GMTP
101
IFMP
102
PNNI
103
PIM
1359
IsisAuthenticationParams
Attribute
Description
Value Description
104
ARIS
105
SCPS
106
QNX
107
A/N
108
IPComp
109
SNP
110
Compaq-Peer
111
IPX-in-IP
112
VRRP
113
PGM
115
L2TP
116
DDX
117
IATP
118
STP
119
SRP
120
UTI
121
SMP
122
SM
123
PTP
124
ISIS over IPv4
125
FIRE
126
CRTP
127
CRUDP
128
SSCOPMCE
129
IPLT
130
SPS
131
PIPE
132
SCTP
133
FC
134
RSVP-E2E-IGNORE
135
Mobility Header
136
UDPLite
137
MPLS-in-IP
253
Experimental
255
Reserved
reserved
Type: INTEGER
Default: 0
routingType
Type: INTEGER
Default: 0
segLeft
Type: INTEGER
Default: 0
IsisAuthenticationParams
Description:
ISIS authentication settings.
1360
IsisCapabilityTlv

Automatically created from: IsisDeviceGenProtocolParams, IsisRouterConfig, IsisSharedSessionParams, VpnIgpIsisSessionParams
IsisAuthenticationParams Writable Attributes

Writable Attribute
Description
Authentication
The authentication method to use.

Type: enum
Default: NONE
Possible Values:
Value
Description
NONE
No authentication.
SIMPLE The ISIS packet is accepted 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 viewing the ISIS
packets.
MD5
MD5 authentication.
Md5KeyId
MD5 key ID. ISIS packet contains a cryptographic checksum, but not the authentication key itself. The receiving router performs
a calculation based on the MD5 algorithm and an authentication key ID. The packet is accepted if the calculated checksum
matches. This method provides a stronger assurance that routing data originated from a router with a valid authentication key.
Type: u8
Default: 1
Password
Used for authentication of ISIS messages. This is used as a password string for simple authentication, or as a key string for
MD5.
If the SUT is configured to authenticate messages, this password must match the SUT password in order for the SUT to accept
ISIS packets.
Type: string
Default: Spirent
IsisAuthenticationParams Read-Only Attributes

IsisCapabilityTlv
Description:
ISIS capability TLV settings.

Children: IsisDeviceIdSubTlv, IsisFTagSubTlv, IsisInterestedVlansSubTlv, IsisNicknameSubTlv, IsisRootIdSubTlv, IsisRootPrioritySubTlv,
IsisRouterCapabilitySubTlv, IsisTreeRootIdSubTlv, IsisTreesSubTlv
IsisCapabilityTlv Writable Attributes

Writable Attribute
Description
Active, Name
1361
IsisClearOverloadBitCommand
Writable Attribute
Description
Flags
TLV options.
Type: enum
Default: SBIT
Possible Values:
Value
Description
SBIT
SBIT
DBIT
DBIT
Reserved1 Reserved part one.

Reserved2 Reserved part two.
Reserved3 Reserved part three.
Reserved4 Reserved part four.
Reserved5 Reserved part five.
Reserved6 Reserved part six.
RouterId
Router ID.
Type: ip
Default: 0.0.0.0
IsisCapabilityTlv Read-Only Attributes

IsisClearOverloadBitCommand
Description:
Readvertises a single LSP from the selected routers(s), with the overload bit cleared. This setting enables transit traffic on the router.

IsisClearOverloadBitCommand Writable Attributes

Writable Attribute
Description
RouterList
ISIS router handle list command to be executed.

Type: handle
Default: 0
IsisClearOverloadBitCommand Read-Only Attributes

Read-Only Attribute
Description

IsisDeviceGenProtocolParams
1362
IsisDeviceGenProtocolParams
Description:
IS-IS specific router generator parameters.

Automatically-created children: IsisAuthenticationParams
IsisDeviceGenProtocolParams Writable Attributes

Writable Attribute
Description
Active, Name
Area
Area that each router belongs to.

Type: string
Default: 000001
EnableBfd

Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
Enable BFD.
FALSE Disable BFD.

EnableGracefulRestart

Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
ISIS graceful restart is enabled.
FALSE ISIS graceful restart is disabled.

HelloPadding
Hello Padding in ISIS Hello Packets.

Type: bool
Default: TRUE
Possible Values:
Value Description
TRUE
Use Hello Padding.
FALSE Don't Use Hello Padding.

IpVersion
IP version used by the emulated router.

Type: enum
Default: IPV4
Possible Values:
Value
Description
IPV4
IPv4.
IPV6
IPv6.
IPV4_AND_IPV6 Both IPv4 and IPv6.

Level
"Circuit type" of the emulated router.

Type: enum
Default: LEVEL2
Possible Values:
Value
Description
LEVEL1
Level 1.
LEVEL2
Level 2.
LEVEL1_AND_2 Both level 1 and level 2.
1363
IsisDeviceIdSubTlv
Writable Attribute
Description
MetricMode
Metric style specifies the Type, Length, and Value (TLV) for an LSP.
Type: enum
Default: NARROW_AND_WIDE
Possible Values:
Value
Description
NARROW
Router advertises routes with a narrow (6-bit) metric.
WIDE
Router advertises routes with a wide (24- or 32-bit) metric.
NARROW_AND_WIDE Router advertises the same route with both metrics.

NetworkType
Network Type (broadcast or p2p).

Type: enum
Default: BROADCAST
Possible Values:
Value
Description
BROADCAST Broadcast.
P2P
Point-to-Point.
RouterPriority
On broadcast networks, router priority is used to determine which router should act as the designated router.
Type: u8
Default: 0
Range: 0 - 127
SystemId
System ID.
Type: mac
Default: 00:00:00:00:00:01
SystemIdStep
System ID step.
Type: mac
Default: 00:00:00:00:00:01
UseMacAsSystemId
Use MAC address as the System ID.

Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
Use MAC address as System ID.
FALSE Don't use MAC address as System ID.
IsisDeviceGenProtocolParams Read-Only Attributes

IsisDeviceIdSubTlv
Description:
ISIS Device ID sub TLV.

Parents: IsisCapabilityTlv
IsisDeviceIdSubTlv Writable Attributes

Writable Attribute
Description
Active, Name
1364
IsisFTagSubTlv
Writable Attribute
Description
DeviceId
Device ID.
Type: u16
Default: 0
Priority
Priority
Type: u8
Default: 0
Reserved1
Reserved1
Type: u8
Default: 0
Reserved2
Reserved2
Type: u8
Default: 0
IsisDeviceIdSubTlv Read-Only Attributes

IsisFTagSubTlv
Description:
ISIS FTag sub TLV.

IsisFTagSubTlv Writable Attributes

Writable Attribute
Description
Active, Name
FTag
F Tag.
Type: u32
Default: 0
GraphCount
Graph count.
Type: u16
Default: 0
GraphRootId
Graph root ID.

Type: mac
Default: 00:00:00:00:00:00
Nickname
Type: u16
Default: 0
IsisFTagSubTlv Read-Only Attributes

1365
IsisGroupAddressTlv
IsisGroupAddressTlv
Description:
ISIS Group Address TLV.

Children: IsisGroupIpv4AddrSubTlv, IsisGroupIpv6AddrSubTlv, IsisGroupMacAddrSubTlv
IsisGroupAddressTlv Writable Attributes

Writable Attribute
Description
Active, Name
IsisGroupAddressTlv Read-Only Attributes

IsisGroupIpv4AddrSubTlv
Description:
ISIS Group Address IPv4 address sub TLV.

Parents: IsisGroupAddressTlv
Children: IsisGroupIpv4Record
IsisGroupIpv4AddrSubTlv Writable Attributes

Writable Attribute
Description
Active, Name
Confidence
Type: u8
Default: 0
Nickname
Type: u16
Default: 0
VlanId
VLAN ID.
Type: u16
Default: 0
Range: 0 - 4095
IsisGroupIpv4AddrSubTlv Read-Only Attributes

IsisGroupIpv4Record
Description:
ISIS Group Address IPv4 record.
1366

Parents: IsisGroupIpv4AddrSubTlv
IsisGroupIpv4Record Writable Attributes

Writable Attribute
Description
Active, Name
AddrIncrement
Address increment.
Type: u32
Default: 1
Count
Number of addresses.
Type: u32
Default: 1
GroupIpv4Addr
Group IPv4 address.

Type: ip
Default: 0.0.0.0
PrefixLength
Prefix length.
Type: u8
Default: 24
Range: 0 - 32
Reserved
Reserved
Type: u8
Default: 0
StartIpList
Start IP address list.

Type: ip
Default: 192.0.1.0
IsisGroupIpv4Record Read-Only Attributes

Description:
ISIS Group Address IPv6 address sub TLV.

Children: IsisGroupIpv6Record
IsisGroupIpv6AddrSubTlv Writable Attributes

Writable Attribute
Description
Active, Name
Confidence
Type: u8
Default: 0
Nickname
Type: u16
Default: 0
1367
IsisGroupIpv6Record
Writable Attribute
Description
VlanId
VLAN ID.
Type: u16
Default: 0
Range: 0 - 4095
IsisGroupIpv6AddrSubTlv Read-Only Attributes

IsisGroupIpv6Record
Description:
ISIS Group Address IPv6 record.

Parents: IsisGroupIpv6AddrSubTlv
IsisGroupIpv6Record Writable Attributes

Writable Attribute
Description
Active, Name
AddrIncrement
Address increment.
Type: u32
Default: 1
Count
Type: u32
Default: 1
GroupIpv6Addr
Group IPv6 address.

Type: ipv6
Default: ::0
PrefixLength
Prefix length.
Type: u8
Default: 64
Range: 0 - 128
Reserved
Reserved
Type: u8
Default: 0
StartIpList

Type: ipv6
Default: 2000::1
IsisGroupIpv6Record Read-Only Attributes

IsisGroupMacAddrSubTlv
1368
IsisGroupMacRecord
Description:
ISIS Group Address MAC address sub TLV.

Children: IsisGroupMacRecord
IsisGroupMacAddrSubTlv Writable Attributes

Writable Attribute
Description
Active, Name
Confidence
Type: u8
Default: 0
Nickname
Type: u16
Default: 0
VlanId
VLAN ID.
Type: u16
Default: 0
Range: 0 - 4095
IsisGroupMacAddrSubTlv Read-Only Attributes

IsisGroupMacRecord
Description:
ISIS Group Address MAC record.

Parents: IsisGroupMacAddrSubTlv
IsisGroupMacRecord Writable Attributes

Writable Attribute
Description
Active, Name
AddrIncrement
Address increment.
Type: mac
Default: 00-00-00-00-00-01
Count
Type: u32
Default: 1
GroupMacAddr
Group Address MAC address.

Type: mac
Default: 00:00:00:00:00:00
Reserved
Reserved
Type: u8
Default: 0
StartMacList
Start MAC address list.

Type: mac
Default: 00-00-00-00-00-01
1369
IsisInterestedVlansSubTlv
IsisGroupMacRecord Read-Only Attributes

IsisInterestedVlansSubTlv
Description:
Interested VLANS SubTlv.

IsisInterestedVlansSubTlv Writable Attributes

Writable Attribute
Description
Active, Name
EndVlanId
End VLAN ID.

Type: u16
Default: 0
Range: 0 - 4095
ForwarderStatusLostCount
Type: u32
Default: 0
Nickname
Type: u16
Default: 0
StartVlanId
Start VLAN ID.

Type: u16
Default: 0
Range: 0 - 4095
SubTlvOptions
SubTlv Options.
Type: enum
Default: M4
Possible Values:
Value Description
SubTlvReservedOptions
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.
Option for Sub TLV Reserved Field.

Type: enum
Default: NONE
Possible Values:
Value
Description
NONE
None.
RESERVED1 Reserved bit 1.

TreeRootList
Tree root list.

Type: mac
Default: 00-00-00-00-00-01
1370
IsisLevel1PlsbLinkMetric
IsisInterestedVlansSubTlv Read-Only Attributes

Description:
ISIS level 1 PLSB link metric settings.

Automatically created from: IsisRouterConfig
IsisLevel1PlsbLinkMetric Writable Attributes

Writable Attribute
Description
Active, Name
LinkAttributes
PLSB instance link attributes.

Type: u32
Default: 0
Range: 0 - 16777215
LinkMetric
PLSB instance link metric.

Type: u32
Default: 8388608
Range: 0 - 16777215
PlsbInstance
PLSB instance.
Type: u8
Default: 0
Range: 0 - 255
IsisLevel1PlsbLinkMetric Read-Only Attributes

IsisLevel1TeParams
Description:
ISIS Level 1 TE parameters configuration object.

1371
IsisLevel1TeParams
IsisLevel1TeParams Writable Attributes

Writable Attribute
Description
BandwidthUnit
Unit of bandwidth value.

Type: enum
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.

SubTlv
ISIS TE subTLV flags.

Type: enum
Default: NONE
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
TeGroup
(Color) the 4-octet bit mask assigned by the network administrator. Each bit corresponds to one administrative
group assigned to the interface.
Type: u32
Default: 1
Range: 1 - 4294967295
TeLocalIpv4Addr

Type: ip
Default: 0.0.0.0
TeMaxBandwidth
Maximum bandwidth that can be reserved on the link from the emulated router.
Type: u32
Default: 100000
Range: 1 - 2147483647
TeRemoteIpv4Addr

Type: ip
Default: 0.0.0.0
TeRsvrBandwidth
Bandwidth that can be reserved on the link from the emulated router.
Type: u32
Default: 100000
Range: 1 - 2147483647
TeUnRsvrBandwidth0
Reservable bandwidth for priority level 0.

Type: u32
Default: 100000
Range: 1 - 2147483647
TeUnRsvrBandwidth1

Type: u32
Default: 100000
Range: 1 - 2147483647
TeUnRsvrBandwidth2

Type: u32
Default: 100000
Range: 1 - 2147483647
1372
Writable Attribute
Description
TeUnRsvrBandwidth3

Type: u32
Default: 100000
Range: 1 - 2147483647
TeUnRsvrBandwidth4

Type: u32
Default: 100000
Range: 1 - 2147483647
TeUnRsvrBandwidth5

Type: u32
Default: 100000
Range: 1 - 2147483647
TeUnRsvrBandwidth6

Type: u32
Default: 100000
Range: 1 - 2147483647
TeUnRsvrBandwidth7

Type: u32
Default: 100000
Range: 1 - 2147483647
IsisLevel1TeParams Read-Only Attributes

Description:
ISIS level 2 PLSB link metric settings.

IsisLevel2PlsbLinkMetric Writable Attributes

Writable Attribute
Description
Active, Name
LinkAttributes

Type: u32
Default: 0
Range: 0 - 16777215
LinkMetric

Type: u32
Default: 8388608
Range: 0 - 16777215
PlsbInstance
PLSB instance.
Type: u8
Default: 0
Range: 0 - 255
1373
IsisLevel2TeParams
IsisLevel2PlsbLinkMetric Read-Only Attributes

IsisLevel2TeParams
Description:
ISIS Level 2 TE parameters configuration object.

IsisLevel2TeParams Writable Attributes

Writable Attribute
Description
BandwidthUnit
Unit of bandwidth value.

Type: enum
Possible Values:
Value
Description
BITS_PER_SEC
Bandwidth values are in bits per second.
BYTES_PER_SEC Bandwidth values are in bytes per second.

SubTlv
ISIS TE SubTLV Flags.

Type: enum
Default: NONE
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 IS-IS).
REMOTE_IP
Disabled (not configured in IS-IS).
TeGroup
(Color) the 4-octet bit mask assigned by the network administrator. Each bit corresponds to one administrative
group assigned to the interface.
Type: u32
Default: 1
Range: 1 - 4294967295
TeLocalIpv4Addr

Type: ip
Default: 0.0.0.0
TeMaxBandwidth
Maximum bandwidth that can be reserved on the link from the emulated router.
Type: u32
Default: 100000
Range: 1 - 2147483647
TeRemoteIpv4Addr

Type: ip
Default: 0.0.0.0
1374
IsisLspConfig
Writable Attribute
Description
TeRsvrBandwidth
Bandwidth that can be reserved on the link from the emulated router.
Type: u32
Default: 100000
Range: 1 - 2147483647
TeUnRsvrBandwidth0

Type: u32
Default: 100000
Range: 1 - 2147483647
TeUnRsvrBandwidth1

Type: u32
Default: 100000
Range: 1 - 2147483647
TeUnRsvrBandwidth2

Type: u32
Default: 100000
Range: 1 - 2147483647
TeUnRsvrBandwidth3

Type: u32
Default: 100000
Range: 1 - 2147483647
TeUnRsvrBandwidth4

Type: u32
Default: 100000
Range: 1 - 2147483647
TeUnRsvrBandwidth5

Type: u32
Default: 100000
Range: 1 - 2147483647
TeUnRsvrBandwidth6

Type: u32
Default: 100000
Range: 1 - 2147483647
TeUnRsvrBandwidth7

Type: u32
Default: 100000
Range: 1 - 2147483647
IsisLevel2TeParams Read-Only Attributes

IsisLspConfig
Description:
ISIS LSP object configuration.

Parents: IsisRouterConfig
Children: Ipv4IsisRoutesConfig, Ipv6IsisRoutesConfig, IsisCapabilityTlv, IsisGroupAddressTlv, IsisLspNeighborConfig, IsisLspPlsbInstanceConfig,
IsisLspPlsbIsidAddrConfig, IsisMacReachabilityTlv
1375
IsisLspConfig
IsisLspConfig Writable Attributes

Writable Attribute
Description
Active, Name
Att
A bit that indicates that the simulated router is connected to other areas. (Only available for L1 router.)
Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
Att enabled.
FALSE Att disabled.

CheckSum
Whether the LSP is advertised with a good checksum or a bad checksum.

Type: enum
Default: GOOD
Possible Values:
Value Description
BAD
Bad
GOOD Good
Level
ISIS levels (L1 or L2) that LSPs are created on. An L1 router can only have L1 LSPs. An L2 router can only have L2 LSPs.
An L1/L2 router can have both L1 and L2 LSPs.
Type: enum
Default: LEVEL2
Possible Values:
Value
Description
LEVEL1 Level 1.
LEVEL2 Level 2.
Lifetime
Included in the LSP header, this is the remaining lifetime (in seconds) of the LSP.
Type: u16
Default: 1200
Range: 0 - 65535
NeighborPseudonodeId
One-octet ID of the simulated routers interface. The pseudonode, which is a virtual mode, is created by the Designated
Intermediate System (DIS). All routers on the broadcast link, including the DIS, form adjacencies with the pseduonode.
Type: u8
Default: 0
Range: 0 - 255
Ol
A bit that indicates that the simulated router is overloaded. Routers receiving an LSP with this bit set to 1 (enabled) do not
use the originating router as a transit router. However, the routers do route to destinations on the directly connected links
of the overloaded router.
Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
Overloaded.
FALSE Not overloaded.

PduType
PDU type for the LSP.

Type: enum
Default: STANDARD
Possible Values:
Value
Description
STANDARD Standard
MULTICAST Multicast
SeqNum
Sequence number of the LSP.

Type: u32
Default: 0x1
1376
IsisLspGenParams
Writable Attribute
Description
SystemId
Six-octet ID of the simulated router that originated the LSP.

Type: mac
Default: null
TeRouterId
A four-byte router ID used to identify the simulated node (LSP). Enabled only if the metric mode setting is narrow.
Type: ip
Default: null
IsisLspConfig Read-Only Attributes

IsisLspGenParams
Description:
ISIS LSP generator parameters.

Parents: Project
RingTopologyGenParams, TeParams, TreeTopologyGenParams
Relations:
Side name
(Type)
Relative
Description
EmulatedDevice
Routers that LSPs are generated on.
IsisLspGenParams Writable Attributes

Writable Attribute
Description
Active, Name
EnableLoopbackAdvertisement
Generates a /32 internal route 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.
Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
Advertise loopback addresses.
FALSE Do not advertise loopback addresses.

EnableRouterCapabilityTlv
Whether or not router capability TLV is enabled.

Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
Enable router capability TLV.
FALSE Disable router capability TLV.

Ipv4AddrEnd
Global/default ending IPv4 address value used for routes and interface addresses.
Type: ip
Default: 223.255.255.255
1377
IsisLspGenRouteAttrParams
Writable Attribute
Description
Ipv4AddrStart
Global/default starting IPv4 address value used for routes and interface addresses.
Type: ip
Default: 1.0.0.0
Ipv6AddrEnd
Global/default ending IPv6 address value used for routes and interface addresses.
Type: ipv6
Default: 3ffe::
Ipv6AddrStart
Global/default starting IPv6 address value used for routes and interface addresses.
Type: ipv6
Default: 2000::
Level
ISIS levels that LSPs are created on.

Type: enum
Default: LEVEL2
Possible Values:
Value
Description
LEVEL1
Creates Level 1 LSPs.
LEVEL2
Creates Level 2 LSPs.
LEVEL1_AND_2 Creates Level 1 and Level 2 LSPs. This option creates the same topology on both levels. To
generate different topologies on each level, run the LSP generator multiple times with different
options.
RouterIdStart
First 32-bit router ID to be used.

Type: ip
Default: 1.0.0.1
RouterIdStep
Step applied to the router ID for each subsequent router.

Type: ip
Default: 0.0.0.1
SystemIdStart
First system ID to be used.

Type: mac
Default: 10:00:00:00:00:01
SystemIdStep
Step applied to the system ID for each subsequent router.

Type: mac
Default: 00:00:00:00:00:01
TeEnabled
Determines if TE options are enabled.

Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
TE options enabled.
FALSE TE options disabled.
IsisLspGenParams Read-Only Attributes

IsisLspGenRouteAttrParams
Description:
ISIS specific route attribute parameters.

1378
IsisLspNeighborConfig
IsisLspGenRouteAttrParams Writable Attributes

Writable Attribute
Description
Active, Name
PrimaryMetric
ISIS route metric used for primary routes.

Type: u32
Default: 1
Range: 1 - 16777215
RouteType
Defines the TLV.

Type: enum
Default: EXTERNAL
Possible Values:
Value
Description
INTERNAL Internal route.
EXTERNAL External route.
SecondaryMetric
ISIS route metric used for secondary routes.

Type: u32
Default: 2
Range: 1 - 16777215
IsisLspGenRouteAttrParams Read-Only Attributes

IsisLspNeighborConfig
Description:
ISIS LSP neighbor object.

Children: IsisPlsbLinkMetricConfig
Automatically-created children: TeParams
IsisLspNeighborConfig Writable Attributes

Writable Attribute
Description
Active, Name
Metric
A standard (narrow) 6-bit ISIS metric. Disabled if metric mode is set to wide.
Type: u8
Default: 1
Range: 0 - 63
NeighborPseudonodeId
One-octet ID of the simulated routers interface. The pseudonode, which is a virtual mode, is created by the
Designated Intermediate System (DIS). All routers on the broadcast link, including the DIS, form adjacencies
with the pseduonode.
Type: u8
Default: 0
Range: 0 - 255
NeighborSystemId
Six-octet system ID of the neighbor.

Type: mac
Default: 00:00:00:00:00:00
1379
IsisLspPlsbInstanceConfig
Writable Attribute
Description
WideMetric
The wide (4-octet) metric is used for traffic engineering. Disabled if metric mode is set to narrow.
Type: u32
Default: 1
Range: 0 - 16777215
IsisLspNeighborConfig Read-Only Attributes

IsisLspPlsbInstanceConfig
Description:
ISIS PLSB LSP instance settings.

IsisLspPlsbInstanceConfig Writable Attributes

Writable Attribute
Description
Active, Name
DateOfBirth
Date of Birth.
Type: u32
Default: 0
Range: 0 - 4294967295
EcmpReserved
ECMP reserved.
Type: u32
Default: 0
Range: 0 - 16777215
InstanceAttributes
Instance attributes.
Type: u32
Default: 0
Range: 0 - 16777215
MulticastOui
Multicast OUI.
Type: string
Default: 03-00-00
PlsbInstance
PLSB instance.
Type: u8
Default: 0
Range: 0 - 255
IsisLspPlsbInstanceConfig Read-Only Attributes

IsisLspPlsbIsidAddrConfig
Description:
1380
IsisLspPlsbIsidAddrIsidConfig
ISIS PLSB LSP isid address settings.

Children: IsisLspPlsbIsidAddrIsidConfig
IsisLspPlsbIsidAddrConfig Writable Attributes

Writable Attribute
Description
Active, Name
BMacAddr
B-MAC address.
Type: mac
Default: null
BMacMetric
B-MAC metric.
Type: u32
Default: 0
Range: 0 - 16777215
PlsbInstance
PLSB instance.
Type: u8
Default: 0
Range: 0 - 255
IsisLspPlsbIsidAddrConfig Read-Only Attributes

IsisLspPlsbIsidAddrIsidConfig
Description:
ISIS PLSB LSP isid address isid settings.

Parents: IsisLspPlsbIsidAddrConfig
IsisLspPlsbIsidAddrIsidConfig Writable Attributes

Writable Attribute
Description
Active, Name
Isid
ISID ID.
Type: u32
Default: 0
Range: 0 - 16777215
IsidMembershipType
ISID membership type.

Type: enum
Default: TRANSMIT_AND_RECEIVE
Possible Values:
Value
Description
NONE
ISID membership type is None.
TRANSMIT
ISID membership type is Transmit.
RECEIVE
ISID membership type is Receive.
TRANSMIT_AND_RECEIVE ISID membership type is both Transmit and Receive.
1381
IsisMacReachabilityTlv
Writable Attribute
Description
UnusedBits
Unused bits.
Type: u8
Default: 0
Range: 0 - 63
IsisLspPlsbIsidAddrIsidConfig Read-Only Attributes

IsisMacReachabilityTlv
Description:
ISIS MAC Reachability TLV.

IsisMacReachabilityTlv Writable Attributes

Writable Attribute
Description
Active, Name
AddrIncrement
Address increment.
Type: mac
Default: 00-00-00-00-00-01
Confidence
Type: u8
Default: 0
Count
Type: u32
Default: 1
Nickname
Type: u16
Default: 0
StartMacList

Type: mac
Default: 00-00-00-00-00-01
VlanId
VLAN ID.
Type: u16
Default: 0
Range: 0 - 4095
IsisMacReachabilityTlv Read-Only Attributes

IsisNicknameRecord
Description:
1382
IsisNicknameSubTlv

Automatically created from: IsisNicknameSubTlv
IsisNicknameRecord Writable Attributes

Writable Attribute
Description
Active, Name
Nickname
Type: u16
Default: 0
NicknamePriority
Type: u8
Default: 0
TreeRootPriority
Type: u16
Default: 0
IsisNicknameRecord Read-Only Attributes

IsisNicknameSubTlv
Description:

Automatically-created children: IsisNicknameRecord
IsisNicknameSubTlv Writable Attributes

Writable Attribute
Description
Active, Name
IsisNicknameSubTlv Read-Only Attributes

IsisPlsbGlobalConfig
Description:
ISIS PLSB global settings.

IsisPlsbGlobalConfig Writable Attributes

Writable Attribute
Description
Active, Name
1383
IsisPlsbLinkMetricConfig
Writable Attribute
Description
PlsbInstanceTlvType
PLSB instance TLV type.

Type: u8
Default: 180
Range: 0 - 255
PlsbIsidAddrTlvType
PLSB ISID address TLV type.

Type: u8
Default: 181
Range: 0 - 255
PlsbLinkMetricSubTlvType
PLSB link metric sub-TLV type.

Type: u8
Default: 17
Range: 0 - 255
PlsbNlpid
PLSB NLPID.
Type: u8
Default: 0x8F
Range: 0x0 - 0xFF
IsisPlsbGlobalConfig Read-Only Attributes

IsisPlsbLinkMetricConfig
Description:
ISIS PLSB link metric settings.

Parents: IsisLspNeighborConfig
IsisPlsbLinkMetricConfig Writable Attributes

Writable Attribute
Description
Active, Name
LinkAttributes

Type: u32
Default: 0
Range: 0 - 16777215
LinkMetric

Type: u32
Default: 8388608
Range: 0 - 16777215
PlsbInstance
PLSB Instance.
Type: u8
Default: 0
Range: 0 - 255
IsisPlsbLinkMetricConfig Read-Only Attributes

1384
IsisReadvertiseLspsCommand
IsisReadvertiseLspsCommand
Description:
Readvertises previously flapped LSPs from a single area or from all areas.

IsisReadvertiseLspsCommand Writable Attributes

Writable Attribute
Description
RouterList

Type: handle
Default: 0
IsisReadvertiseLspsCommand Read-Only Attributes

Read-Only Attribute
Description

IsisRemoveLspNeighborCommand
Description:
Removes the specified neighbor from the specified LSP and advertises the modified LSP to the SUT.

IsisRemoveLspNeighborCommand Writable Attributes

Writable Attribute
Description
IsisLspNeighborList
Removes LSP neighbor to be executed.

Type: handle
Default: 0
IsisRemoveLspNeighborCommand Read-Only Attributes

Read-Only Attribute
Description

1385
IsisRestartIsisRouterCommand
IsisRestartIsisRouterCommand
Description:
Performs the ISIS graceful restart for the specified routers.

IsisRestartIsisRouterCommand Writable Attributes

Writable Attribute
Description
RouterList

Type: handle
Default: 0
IsisRestartIsisRouterCommand Read-Only Attributes

Read-Only Attribute
Description

IsisResumeHellosCommand
Description:
Resumes hellos on selected ISIS router(s).

IsisResumeHellosCommand Writable Attributes

Writable Attribute
Description
RouterList
ISIS router handle list command to be executed on.

Type: handle
Default: 0
IsisResumeHellosCommand Read-Only Attributes

Read-Only Attribute
Description

1386
IsisRootIdSubTlv
IsisRootIdSubTlv
Description:
ISIS Root ID sub TLV.

IsisRootIdSubTlv Writable Attributes

Writable Attribute
Description
Active, Name
BroadcastRootSystemId
Broadcast Root System ID.

Type: mac
Default: 00:00:00:00:00:00
MulticastRootSystemId
Multicast Root System ID.

Type: mac
Default: 00:00:00:00:00:00
IsisRootIdSubTlv Read-Only Attributes

IsisRootPrioritySubTlv
Description:
ISIS Root Priority sub TLV.

IsisRootPrioritySubTlv Writable Attributes

Writable Attribute
Description
Active, Name
BroadcastRootPriority
Broadcast Root Priority.

Type: u16
Default: 0
MultiDstTreeCount
Multidestination tree count.

Type: u16
Default: 0
IsisRootPrioritySubTlv Read-Only Attributes

IsisRouterCapabilitySubTlv
Description:
1387
IsisRouterConfig
ISIS router capability sub-TLV settings.

IsisRouterCapabilitySubTlv Writable Attributes

Writable Attribute
Description
Active, Name
SubTlvOptions
Sub-TLV options.
Type: enum
Default: BBIT
Possible Values:
Value
Description
BBIT
BBIT
EBIT
EBIT
MBIT
MBIT
PBIT
PBIT
UNUSED5 Unused bit 5.

IsisRouterCapabilitySubTlv Read-Only Attributes

IsisRouterConfig
Description:
ISIS router configuration parameters.

Children: IsisLspConfig
Automatically-created children: IsisAuthenticationParams, IsisLevel1PlsbLinkMetric, IsisLevel1TeParams, IsisLevel2PlsbLinkMetric, IsisLevel2TeParams
Result children (automatically created): IsisRouterResults
Relations:
Side name
(Type)
Relative
Description
(This description is to be automated.)
ResultChild
(ResultChild)
IsisRouterResults
UsesIf
(UsesIf)

WimaxIf

IsisRouterConfig Writable Attributes

Writable Attribute
Description
Active, Name
1388
IsisRouterConfig
Writable Attribute
Description
Area1
Area address (3- to 14-octet address). Spirent TestCenter supports up to three addresses per emulated router. Area 1
address is mandatory.
Type: string
Default: 000001
Area2
Optional 3- to 14-octet address. Area #1 must be present before area #2 can be configured.
Type: string
Area3
Optional 3- to 14-octet address. Area #1 and #2 must be present before area #3 can be configured.
Type: string
CircuitId
1-octet Hex identifier of the emulated router interface. (Applies to non-Ethernet connections only. This field is blank and
disabled for Ethernet ports.)
Type: u8
Default: 1
Range: 0 - 255
DisableIp
Whether or not IP is disabled.

Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
Enable IP.
FALSE Disable IP.

EnableBfd
Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
Enable BFD.
FALSE Disable BFD.

Specifies if ISIS graceful restart is enabled.

Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
ISIS graceful restart is enabled. The T1 timer and remaining time parameters must be set.

EnableL2mp
Enables L2MP PDUs and TLVs.

Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
Enable L2MP.
FALSE Disable L2MP.

EnablePlsb
Whether or not PLSB is enabled.

Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
Enable PLSB.
FALSE Disable PLSB.
1389
IsisRouterConfig
Writable Attribute
Description
FloodDelay
Period of time that the IS waits (in ms) after sending an LSP or CSNP before sending updated LSPs or CSNPs on the same
broadcast link.
Type: u16
Default: 33
Range: 33 - 3000
HelloInterval
Specifies how often (in seconds) an emulated router sends hello PDUs to ISIS neighbors. (Actual interval is 7.5 to 10 sec:
hello interval - random jitter = actual send time.)
Type: u16
Default: 10
Range: 1 - 300
HelloMultiplier
This is the number by which the intermediate system multiplies the hello interval to calculate hold time. Hold time is the
period a router waits without seeing a hello from the sending router before it considers the sending router to be down.
Type: u16
Default: 3
Range: 1 - 100
HelloPadding
Insert Hello Padding in Hello Packets.

Type: bool
Default: TRUE
Possible Values:
Value Description
TRUE
Enable Hello Padding.
FALSE Disable Hello Padding.

InstanceId
Instance ID for the router.

Type: u16
Default: 0
IpVersion
Specifies the IP version used by emulated routers.

Type: enum
Default: IPV4
Possible Values:
Value
Description
IPV4
IPv4.
IPV6
IPv6.
IPV4_AND_IPV6 Both IPv4 and IPv6.

L1Metric
Metric of the emulated router interface. It is advertised in L1 IS neighbors TLV and is used for Level 1 traffic. Available when
router level is 1. Blank and disabled if level setting is L2 or metric mode setting is wide.
Type: u8
Default: 1
Range: 1 - 63
L1WideMetric
3-octet traffic engineering metric of a link from the emulated router to the SUT. It is advertised in the extended IS reachability
TLV of the L1 LSP originated by the emulated router. Available when router level is 1. Blank and disabled if level setting is
L2 or metric mode setting is narrow.
Type: u32
Default: 1
Range: 0 - 16777215
L2Metric
router level is 2. Disabled if level is L1 or metric mode is wide.
Type: u8
Default: 1
Range: 1 - 63
L2WideMetric
TLV of the L2 LSP originated by the emulated router. Available when router level is 2. Disabled if level is L1 or metric mode
setting is narrow.
Type: u32
Default: 1
Range: 0 - 16777215
1390
IsisRouterConfig
Writable Attribute
Description
Level
This is the "circuit type" of the emulated router. It defines the type of adjacency that Spirent TestCenter establishes with the
SUT.
Type: enum
Default: LEVEL2
Possible Values:
Value
Description
LEVEL1
Level 1.
LEVEL2
Level 2.

LspRefreshTime
LSP refresh time (in seconds).

Type: u16
Default: 900
Range: 1 - 65535
LspSize
Maximum size of a link state PDU. Link state information is segmented into multiple PDUs if its total size exceeds the
maximum LSP size.
Type: u16
Default: 1492
Range: 100 - 1492
MetricMode
Metric style specifies the Type, Length, and Value (TLV) for an LSP. TLVs specify data types, the maximum data length,
and the valid data values. One data type that is controlled by the TLV is the default metric of a route.
Type: enum
Possible Values:
Value
Description
NARROW
WIDE

MtId
Type: string
NetworkType
Defines type of ISIS interface.

Type: enum
Default: BROADCAST
Possible Values:
Value
Description
BROADCAST Broadcast.
P2P
Point to Point.
PsnInterval
Specifies how often (in seconds) non-designated ISs send a Partial Sequence Number PDU (PSNP). The PSNP is used to
acknowledge or request individual LSPs. (Applies to non-Ethernet connections only. This field is blank and disabled for
Ethernet ports.)
Type: u16
Default: 2
Range: 1 - 20
RemainingTime
Remaining holding time (in seconds). The allowable duration for a graceful restarting router to recover. If the value is not
set or is set to 0, the emulated router calculates this value based upon the expiry of the adjacency. If the field is set to any
non-zero value, the emulated router uses the value. (Available when EnableGracefulRestart is true.)
Type: u16
Default: null
Range: 0 - 65535
RetransmissionInterval
Number of seconds that the IS waits between successive retransmissions of the same LSP on the point-to-point link. (Blank
and disabled for Ethernet.)
Type: u16
Default: 5
Range: 1 - 100
1391
IsisRouterConfig
Writable Attribute
Description
RouterPriority
Type: u8
Default: 0
Range: 0 - 127
SystemId
Included as a part of the Network Entity Title (NET), the system ID is used to identify an emulated router. All routers in the
same area must have a system ID of the same length.
Type: mac
Default: 00:00:00:00:00:01
T1Timer
Indicates the time (in sec) after which an unacknowledged restart attempt is repeated. (Available when EnableGracefulRestart
is true.)
Type: u16
Default: 3
Range: 0 - 65535
TeRouterId
Four-byte router ID used to identify the emulated router in traffic engineering topologies. (Disabled if the metric mode setting
is narrow.)
Type: ip
Default: null

Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE

ViewRoutes
View received ISIS LSPs and routes for a router.

Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
Enable view routes.
FALSE Disable view routes.
IsisRouterConfig Read-Only Attributes

Read-Only Attribute
Description
AdjacencyThreeWayState
Adjacency state of three-way Hello in point-to-point network.

Type: enum
Default: NONE
Possible Values:
Value Description
UP
Up
INIT
Init
DOWN Down
NONE None
NA
NA
1392
IsisRouterResults
Read-Only Attribute
Description
L1LanAdjacencyState
Adjacency state of Level 1 broadcast router.

Type: enum
Default: NONE
Possible Values:
Value
Description
NONE
None
IDLE
Idle
INIT
Init
DIS_OTHER Dis Other

DIS
Dis
GR
Gr
GR_HELPER Gr Helper
NA
L2LanAdjacencyState
NA
Adjacency state of Level 2 broadcast router.

Type: enum
Default: NONE
Possible Values:
Value
Description
NONE
None
IDLE
Idle
INIT
Init
DIS_OTHER Dis Other

DIS
Dis
GR
Gr
GR_HELPER Gr Helper
NA
NA
NeighborExtendedCircuitIdLearned
Learned extended CircuitId of the adjacent neighbor after three-way Hello exchange.
Type: string
Default: NA
NeighborSystemIdLearned
Learned System ID of the adjacent neighbor after three-way Hello exchange.

Type: string
Default: NA
RouterState
State of adjacency with the SUT (run-time results only).

Type: enum
Default: NONE
Possible Values:
Value
Description
NONE
None
IDLE
Idle
INIT
Init
UP
UP
GR
GR
GR_HELPER GR helper
IsisRouterResults
Description:
Counters and statistics for each ISIS emulated router, during run-time and at the end of the test.

1393
IsisRouterResults
Parents: IsisRouterConfig
Relations:
Side name
(Type)
Relative
Description
ResultParent
(ResultChild)
IsisRouterConfig
IsisRouterResults Writable Attributes

IsisRouterResults Read-Only Attributes

Read-Only Attribute
Description
AdjacencyLevel
Adjacency level.
Type: string
Default: NA
RxL1CsnpCount
Number of L1 Rx CSNPs received from the SUT.

Type: u64
Default: 0
RxL1LanHelloCount
Number of L1 Rx LAN hellos received from the SUT.

Type: u64
Default: 0
RxL1LspCount
Number of L1 Rx LSPs received from the SUT.

Type: u64
Default: 0
RxL1PsnpCount
Number of L1 Rx PSNPs received from the SUT.

Type: u64
Default: 0
RxL2CsnpCount
Number of L2 Rx CSNPs received from the SUT.

Type: u64
Default: 0
RxL2LanHelloCount
Number of L2 Rx LAN hellos received from the SUT.

Type: u64
Default: 0
RxL2LspCount
Number of L2 Rx LSPs received from the SUT.

Type: u64
Default: 0
RxL2PsnpCount
Number of L2 Rx PSNPs received from the SUT.

Type: u64
Default: 0
RxPtpHelloCount
Number of Rx point-to-point hellos received from the SUT.

Type: u64
Default: 0
TxL1CsnpCount
Number of L1 Tx CSNPs sent to the SUT.

Type: u64
Default: 0
TxL1LanHelloCount
Number of L1 Tx LAN hellos sent to the SUT.

Type: u64
Default: 0
TxL1LspCount
Number of L1 Tx LSPs sent to the SUT.

Type: u64
Default: 0
1394
IsisSetOverloadBitCommand
Read-Only Attribute
Description
TxL1PsnpCount
Number of L1 Tx PSNPs sent to the SUT.

Type: u64
Default: 0
TxL2CsnpCount
Number of L2 Tx CSNPs sent to the SUT.

Type: u64
Default: 0
TxL2LanHelloCount
Number of L2 Tx LAN hellos sent to the SUT.

Type: u64
Default: 0
TxL2LspCount
Number of L2 Tx LSPs sent to the SUT.

Type: u64
Default: 0
TxL2PsnpCount
Number of L2 Tx PSNPs sent to the SUT.

Type: u64
Default: 0
TxPtpHelloCount
Number of Tx point-to-point hellos sent to the SUT.

Type: u64
Default: 0
IsisSetOverloadBitCommand
Description:
Readvertises a single LSP from the selected router(s), with the overload bit set. This setting disables transit traffic.

IsisSetOverloadBitCommand Writable Attributes

Writable Attribute
Description
RouterList

Type: handle
Default: 0
IsisSetOverloadBitCommand Read-Only Attributes

Read-Only Attribute
Description

IsisSharedSessionParams
Description:
1395
IsisSharedSessionParams
ISIS shared session parameters used by wizards.

Automatically-created children: IsisAuthenticationParams
IsisSharedSessionParams Writable Attributes

Writable Attribute
Description
Active, Name
Area1
Area address (3- to 14-octet address). Spirent TestCenter supports up to three addresses per emulated router. Area 1 address
is mandatory.
Type: string
Default: 000001
Area2
Optional 3- to 14-octet address. Area #1 must be present before area #2 can be configured.
Type: string
Area3
Optional 3- to 14-octet address. Area #1 and #2 must be present before area #3 can be configured.
Type: string
CircuitId
1-octet Hex identifier of the emulated router interface. (Applies to non-Ethernet connections only. This field is blank and
disabled for Ethernet ports.)
Type: u8
Default: 1
Range: 0 - 255
EnableBfd
Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
Enable BFD.
FALSE Disable BFD.

Specifies if ISIS graceful restart is enabled.

Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
ISIS graceful restart is enabled. The T1 timer and remaining time parameters must be set.

HelloPadding
Insert Hello Padding in Hello Packets.

Type: bool
Default: TRUE
Possible Values:
Value Description
TRUE
Enable Hello Padding.
FALSE Disable Hello Padding.

L1Metric
router level is 1. Blank and disabled if level setting is L2 or metric mode setting is wide.
Type: u8
Default: 1
Range: 1 - 63
L1WideMetric
TLV of the L1 LSP originated by the emulated router. Available when router level is 1. Blank and disabled if level setting is
L2 or metric mode setting is narrow.
Type: u32
Default: 1
Range: 0 - 16777215
1396
IsisStateSummary
Writable Attribute
Description
L2Metric
router level is 2. Disabled if level is L1 or metric mode is wide.
Type: u8
Default: 1
Range: 1 - 63
L2WideMetric
TLV of the L2 LSP originated by the emulated router. Available when router level is 2. Disabled if level is L1 or metric mode
setting is narrow.
Type: u32
Default: 1
Range: 0 - 16777215
Level
This is the "circuit type" of the emulated router. It defines the type of adjacency that Spirent TestCenter establishes with the
SUT.
Type: enum
Default: LEVEL2
Possible Values:
Value
Description
LEVEL1
Level 1.
LEVEL2
Level 2.

MetricMode
Metric style specifies the Type, Length, and Value (TLV) for an LSP. TLVs specify data types, the maximum data length, and
the valid data values. One data type that is controlled by the TLV is the default metric of a route.
Type: enum
Possible Values:
Value
Description
NARROW
WIDE

NetworkType
Type of ISIS Interface.

Type: enum
Default: BROADCAST
Possible Values:
Value
Description
BROADCAST Broadcast
P2P
RouterPriority
Point-To-Point
Type: u8
Default: 0
Range: 0 - 127
IsisSharedSessionParams Read-Only Attributes

IsisStateSummary
Description:
ISIS router states summarized at port and project level.

Relations:
1397
IsisStopHellosCommand
Side name
(Type)
Relative
Description
ResultParent
(ResultChild)
Port, Project
IsisStateSummary Writable Attributes

IsisStateSummary Read-Only Attributes

Read-Only Attribute
Description
GrCount
Number of routers in GR state.

Type: u32
Default: 0
GrHelperCount
Number of routers in GR Helper state.

Type: u32
Default: 0
IdleCount
Number of routers in Idle state.

Type: u32
Default: 0
InitCount
Number of routers in the Init state.

Type: u32
Default: 0
NotStartedCount

Type: u32
Default: 0
RouterDownCount
Number of routers in any state other than Up.

Type: u32
Default: 0
RouterUpCount
Number of routers in the Up state.

Type: u32
Default: 0
UpCount
Number of routers in Up state.

Type: u32
Default: 0
IsisStopHellosCommand
Description:
Stops hellos on selected ISIS router(s).

IsisStopHellosCommand Writable Attributes

Writable Attribute
Description
1398
IsisTreeRootIdSubTlv
Writable Attribute
Description
RouterList
ISIS router handle list command to be executed on.

Type: handle
Default: 0
IsisStopHellosCommand Read-Only Attributes

Read-Only Attribute
Description

IsisTreeRootIdSubTlv
Description:

IsisTreeRootIdSubTlv Writable Attributes

Writable Attribute
Description
Active, Name
NicknameList
Type: u16
Default: 0
StartTreeRootId
Type: u16
Default: 1
IsisTreeRootIdSubTlv Read-Only Attributes

IsisTreesSubTlv
Description:

IsisTreesSubTlv Writable Attributes

Writable Attribute
Description
Active, Name
MaxComputableTreesCount
Type: u16
Default: 0
TreesToComputeCount
Type: u16
Default: 0
1399
IsisViewRoutesCommand
Writable Attribute
Description
TreesToUseCount
Type: u16
Default: 0
IsisTreesSubTlv Read-Only Attributes

IsisViewRoutesCommand
Description:
View ISIS routes for the selected emulated router.

IsisViewRoutesCommand Writable Attributes

Writable Attribute
Description
FileName
View route file name.

Default: routes.txt
RouterList
Router list handle.

Type: handle
Default: 0
IsisViewRoutesCommand Read-Only Attributes

Read-Only Attribute
Description

IsisWithdrawIpRoutesCommand
Description:
Withdraws specified IPv4 or IPv6 routes for the selected router.

IsisWithdrawIpRoutesCommand Writable Attributes

Writable Attribute
Description
1400
IsisZeroAgeLspCommand
Writable Attribute
Description
CategoryFilter
Select routes with specified category.

Type: enum
Default: ANY
Possible Values:
Value
Description
UNDEFINED
Category is undefined.
PRIMARY
Category is primary.
SECONDARY Category is secondary.

UNIQUE
Category is unique.
ANY
Category is any.
IsisIpRouteList
IP route handle list withdraw IP routes to be executed.

Type: handle
Default: 0
PercentFilter
Select specified percentage of routes from the route block.

Type: double
Default: 100.0
Range: 0 - 100
PrefixFilter
Select routes with specified prefix. Prefix 0 means select all route prefixes.
Type: u8
Default: 0
Range: 0 - 128
IsisWithdrawIpRoutesCommand Read-Only Attributes

Read-Only Attribute
Description

IsisZeroAgeLspCommand
Description:
Readvertises a specified LSP with age = 0. The SUT purges LSPs with zero age from its routing table.

IsisZeroAgeLspCommand Writable Attributes

Writable Attribute
Description
IsisLspList
ISIS LSP handle list zero age LSP to be executed.

Type: handle
Default: 0
1401
islFlowControl
IsisZeroAgeLspCommand Read-Only Attributes

Read-Only Attribute
Description

islFlowControl
Description:
Children: rrdy
islFlowControl Attributes
Attribute
Description
Name
information.
Type: string
iTag (MAC-in-MAC:iTag)
Description:
Children: None
Next headers: mimethernet:EncapEthernetII, mimethernet:EncapEthernet8023Raw, mimethernet:EncapEthernet8022, mimethernet:EncapEthernetSnap,
MAC-in-MAC:EncapMAC-in-MAC
iTag Attributes
Attribute
Description
BackboneDstMac
Type: MACADDR
Default: 00:00:01:00:00:01
cDstMac
Type: MACADDR
Default: 00:00:01:00:00:01
cSrcMac
Type: MACADDR
Default: 00:10:94:00:00:02
iDEI
Type: BITSTRING
Default: 0
iPCP
Type: BITSTRING
Default: 000
ISID
Type: INTEGER
Default: 0
1402
ItagIf
Attribute
Description
Name
Type: string
res1
Type: BITSTRING
Default: 0
res2
Type: BITSTRING
Default: 00
UCA
Type: BITSTRING
Default: 1
ItagIf
Description:
802.1ah I-TAG interface object.

Relations:
Side name
(Type)
Relative
Description
DstBoundTo
(DstBinding)

StreamBlock.
EncapsulationSource
(Encapsulation)
PathDescriptor
NetworkLink
(LinkSrc)

MemberOfVpn
(MemberOfVpn)

VpnSiteInfoVplsLdp
Port

relation.

WimaxIf

PrimaryIfSource
(PrimaryIf)

SUT

the DUT.
1403
ItagIf
Side name
(Type)
Relative
Description
RelayBlockConfig
(RelayIf)
(ResolvesInterface)

RsvpRouterConfig

SrcBoundTo
(SrcBinding)

StreamBlock.
StackedOn
(StackedOnEndpoint)

WimaxIf
TopLevelIfSource
(TopLevelIf)

SUT

interface stack.
Port

relation.
UsesIfSource
(UsesIf)


ItagIf Writable Attributes

Writable Attribute
Description
Active, Name
BackboneDstMac
MAC address of the service destination.

Type: mac
Default: 00:00:01:00:00:01
DropEligible
Select to configure the service as drop eligible for congestion control.

Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
Service is drop eligible for congestion control.
FALSE Service is NOT drop eligible for congestion control.

IfCountPerLowerIf

Type: u32
Default: 1
1404
ItagIf
Writable Attribute
Description
IfRecycleCount
How many times to increment the ISID before returning to the starting value. See Isid for more information.
Type: u32
Default: 0
Isid
Service ID. You can generate more than one ISID by using IsidRepeatCount, IsidStep, and IfRecycleCount. If you
do that, then the value of this attribute is the starting ISID.
Type: u32
Default: 0
Range: 0 - 16777216
IsidList
A Tcl list of ISIDs. To use this attribute, the IsRange attribute must be FALSE.
Type: u32
Default: 0
IsidRepeatCount
How many times to repeat the same ISID before incrementing it. See Isid for more information.
Type: u32
Default: 0
IsidStep
ISID step value. See Isid for more information.

Type: s32
Default: 1
IsLoopbackIf

Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE

IsRange
Whether to use a combination of attributes to generate a range of ISIDs, or to use the IsidList attribute to specify the
ISIDs.
Type: bool
Default: TRUE
Possible Values:
Value Description
TRUE
Use a combination of attributes to generate a range of ISIDs. The attributes are Isid, IsidStep,
IsidRepeatCount, and IfRecycleCount. See Isid for more information.
FALSE Use the IsidList attribute to specify the ISIDs.

Priority
Priority of the service.

Type: u8
Default: 7
Range: 0 - 7
ReservedBits1
Value of reserved bits.

Type: u8
Default: 0
ReservedBits2
Value of reserved bits.

Type: u8
Default: 0
UseCustomerAddresses
Select to indicate that the source and destination addresses in the I-Tag are valid customer addresses.
Type: bool
Default: TRUE
Possible Values:
Value Description
TRUE
Indicates that the source and destination addresses in the I-Tag are valid customer addresses.
FALSE Indicates that the source and destination addresses in the I-Tag are NOT valid customer addresses.
1405
ItagServiceLink
ItagIf Read-Only Attributes

Read-Only Attribute
Description
EffectiveBlockCount

Type: u32
Default: 1
IfState

Type: enum
Default: DISABLED
Possible Values:
Value
Description
READY
Ready.
DISABLED
Disabled.
DELETING
Deleting.
ItagServiceLink
Description:
An I-Tag Service Link connects two devices to create MAC-in-MAC topologies. The created I-Tag interface on the destination device is stacked on the Ethernet
interface or, if it exists, on a single VLAN interface stack.

Relations:
Side name
(Type)
Relative
Description
Container
(ContainedLink)

(LinkDst)
LinkDstDevice
(LinkDstDevice)
EmulatedDevice
NetworkLinkSource
(LinkSrc)
ItagServiceLink Writable Attributes

Writable Attribute
Description
Active, Name
ItagServiceLink Read-Only Attributes

Read-Only Attribute
Description
LinkType
Type of link.
Type: string
1406
IterateBurstSizeCommand
IterateBurstSizeCommand
Description:
Adjust the burst size from iteration to iteration. The method of adjustment is set by IterationMode.

IterateBurstSizeCommand Writable Attributes

Writable Attribute
Description
CustomBurstSizeList
List of burst sizes in the format of a native Tcl list. Applicable when BurstSizeType is CUSTOM.
Type: u16
Default: 0
Range: 1 - 65535
FixedBurstSize
Sets the fixed burst size in bytes when BurstSizeType is FIXED.

Type: u16
Default: 1
Range: 1 - 65535
InterFrameGap
Size of the interframe gap in bytes.

Type: u32
Default: 12
Range: 11 - 16383
Inter frame gap configuration mode.

Type: enum
Default: MINIMUM
Possible Values:
Value
Description
MINIMUM MINIMUM
USER
IterationMode
USER
Method of setting the burst size.

Type: enum
Default: FIXED
Possible Values:
Value
Description
CUSTOM Customized burst sizes. CustomBurstSizeList specifies all burst sizes. When all custom burst sizes
have been set, the IterateBurstSizeCommand automatically breaks out of its parent loop.
FIXED
Burst size is constant and equal to FixedBurstSize. The IterateBurstSizeCommand automatically breaks
out of its parent loop when the iteration count is greater than one.
STEP
Burst size increases by BurstSizeStep with each test iteration, beginning with BurstSizeStart and
increasing to BurstSizeEnd. When all step burst sizes have been set, the IterateBurstSizeCommand
automatically breaks out of its parent loop.
StepBurstSizeEnd
Maximum burst size when using Step mode for incrementing the burst size. This attribute is ignored if BurstSizeType
is set to FIXED or CUSTOM.
Type: u16
Default: 1
Range: 1 - 65535
StepBurstSizeStart
Starting frame size when using Step mode for incrementing the frame size. This attribute is ignored if FrameSizeType
is set to RANDOM, FIXED or CUSTOM.
Type: u16
Default: 1
Range: 1 - 65535
1407
IterateComboCommand
Writable Attribute
Description
StepBurstSizeStep
Step value for incrementing the burst size from BurstSizeStart to BurstSizeEnd. This attribute is ignored if
BurstSizeType is set to FIXED or CUSTOM.
Type: u16
Default: 1
Range: 1 - 65535
StreamBlockList
Type: handle
Default: 0
IterateBurstSizeCommand Read-Only Attributes

Read-Only Attribute
Description

TestStatus
Type: string
IterateComboCommand
Description:
Iterate parameters over a combination of iteration commands.

Children: DcbIteratePfcPauseTimeCommand, DcbIteratePfcQuantaValueCommand, DcbIteratePfcResponseTimeCommand, IterateBurstSizeCommand,
IterateFrameSizeCommand, IterateLoadSizeCommand, TrafficGroupWeightedLoadSearchCommand
IterateComboCommand Writable Attributes

Writable Attribute
Description
IterateComboCommand Read-Only Attributes

Read-Only Attribute
Description

TestStatus
Test status.
Type: string
IterateFrameSizeCommand
Description:
Adjust the frame size from iteration to iteration. The method of adjustment is set by FrameSizeType.
1408
IterateFrameSizeCommand

IterateFrameSizeCommand Writable Attributes

Writable Attribute
Description
CustomFrameSizeList
List of frame sizes in the format of a native Tcl list. Applicable when FrameSizeType is CUSTOM.
Type: u16
Default: 0
FixedFrameSize

Type: u16
Default: 128
Range: 40 - 16383
FrameSizeEnd
Maximum frame size when using Step mode for incrementing the frame size. This attribute is ignored if FrameSizeType
Type: u16
Default: 256
Range: 40 - 16383
FrameSizeStart
Type: u16
Default: 128
Range: 40 - 16383
FrameSizeStep
Step value for incrementing the frame size from FrameSizeStart to FrameSizeEnd. This attribute is ignored if
FrameSizeType is set to RANDOM, FIXED or CUSTOM.
Type: u16
Default: 128
Range: 1 - 16383
FrameSizeType
Method of setting the frame size.

Type: enum
Default: FIXED
Possible Values:
Value
Description
FIXED
Frame size is constant and equal to FixedFrameSize. The IterateFrameSizeCommand will automatically
break out of its parent loop when the iteration count is greater than one.
STEP
Frame size increases by FrameSizeStep with each test iteration, beginning with FrameSizeStart and
increasing to FrameSizeEnd. When all step frame sizes have been set, the IterateFrameSizeCommand
will automatically break out of its parent loop.
CUSTOM Customized frame sizes. CustomFrameSizeList specifies all frame sizes. When all custom frame sizes
have been set, the IterateFrameSizeCommand will automatically break out of its parent loop.
IMIX
Frame sizes defined by existing iMIX distribution.
RANDOM Frame size is randomly chosen within the range set by RandomMinFrameSize and RandomMaxFrameSize.
The IterateFrameSizeCommand will automatically break out of its parent loop when the iteration count is
greater than one.
NONE
Frame size type not specified.
ImixDistributionList
Specifies the list of selected iMIX distributions to iterate.

Type: handle
Default: 0
RandomMaxFrameSize
FIXED or CUSTOM.
Type: u16
Default: 256
Range: 40 - 16383
1409
IterateLoadSizeCommand
Writable Attribute
Description
RandomMinFrameSize
Minimum frame size when FrameSizeType is RANDOM. This attribute is ignored if FrameSizeType is set to STEP,
FIXED or CUSTOM.
Type: u16
Default: 128
Range: 40 - 16383
StreamBlockList
List of stream blocks to iterate frame sizes.

Type: handle
Default: 0
IterateFrameSizeCommand Read-Only Attributes

Read-Only Attribute
Description

TestStatus
Specifies the status of the test.

Type: string
Description:
Adjust the load size from iteration to iteration.

IterateLoadSizeCommand Writable Attributes

Writable Attribute
Description
AdjustStreamBlockLoad
Type: enum
Default: NONE
Possible Values:
Value
Description
NONE
PER_PORT
CustomLoadList
List of frame sizes in the format of a native Tcl list. Applicable when FrameSizeType is CUSTOM.
Type: double
Default: 0
FixedLoad
Sets the fixed load size when LoadType is FIXED.

Type: double
Default: 10
LoadEnd
When LoadType is STEP, the maximum load for each port. This attribute is ignored if LoadType is set to CUSTOM, RANDOM
or FIXED.
Type: double
Default: 50
1410
Writable Attribute
Description
LoadStart
When LoadType is STEP, the starting load for each port. This attribute is ignored if LoadType is set to CUSTOM, RANDOM
or FIXED.
Type: double
Default: 10
LoadStep
Step value for incrementing the load from LoadStart to LoadEnd. This attribute is ignored if LoadType is set to CUSTOM,
RANDOM or FIXED.
Type: double
Default: 10
Range: 0.001 - 100000000000.0
LoadType

Type: enum
Default: FIXED
Possible Values:
Value
Description
CUSTOM Customized load rates. CustomLoadList specifies all load rates. When all custom load sizes have been set,
the IterateLoadSizeCommand will automatically break out of its parent loop.
FIXED
Load rate is constant and equal to FixedLoad. The IterateLoadSizeCommand will automatically break out of
its parent loop when the iteration count is greater than one.
RANDOM Load rate is randomly chosen within the range set by RandomMinLoad and RandomMaxLoad. The
IterateLoadSizeCommand will automatically break out of its parent loop when the iteration count is greater
than one.
STEP
LoadUnits
Load rate increases by LoadStep with each test iteration, beginning with LoadStart and increasing to LoadEnd.
When all step frame sizes have been set, the IterateLoadSizeCommand will automatically break out of its
parent loop.
Type: enum
Possible Values:
Value
Description
PERCENT_LINE_RATE
FRAMES_PER_SECOND
Frames per second.
INTER_BURST_GAP

KILOBITS_PER_SECOND
BITS_PER_SECOND
Bits per second.
RandomMaxLoad
When using Random mode for load on the ports, the maximum load for each port. This attribute is ignored if LoadType is
set to CUSTOM, FIXED or STEP.
Type: double
Default: 50
RandomMinLoad
When using Random mode for load on the ports, the minimum load for each port. This attribute is ignored if LoadType is
set to CUSTOM, FIXED or STEP.
Type: double
Default: 10
StreamBlockList
List of ports to iterate load sizes. If the generator scheduling mode is set to "Port Based" then load will be set on the port.
If the generator scheduling mode is set to "Priority Based" or "Rate Based" then load will be set on stream blocks.
Type: handle
Default: 0
IterateLoadSizeCommand Read-Only Attributes

Read-Only Attribute
Description

TestStatus

Type: string
1411
IterateMulticastGroupCountCommand
IterateMulticastGroupCountCommand
Description:
Command that modifies the number of multicast groups specified by a set of MulticastGroup objects.

IterateMulticastGroupCountCommand Writable Attributes

Writable Attribute
Description
CustomGroupCountList
User specifies list of group counts.

Type: u32
Default: 100
DistributionType

Type: enum
Default: EVEN
Possible Values:
Value
Description
EVEN

FixedGroupCount
Specifies the fixed group count.

Type: u32
Default: 100
GroupCountEnd
Specifies the end group count.

Type: u32
Default: 100
GroupCountStart
Specifies the start group count.

Type: u32
Default: 10
GroupCountStep
Specifies the step for group count.

Type: u32
Default: 10
Range: 1 - 32768
GroupCountType
Specifies the iteration mode of the object.

Type: enum
Default: CUSTOM
Possible Values:
Value
Description
CUSTOM Enumeration type of the iteration mode for multicast group count.
FIXED
Iterate over a fixed value of multicast group count.
STEP
Iterate over a range of values of multicast group count, incrementing in steps.
RANDOM Iterate over a randomly generated value of multicast group count.

MulticastGroupList
List of handles of multicast groups.

Type: handle
Default: 0
RandomMaxGroupCount
Specifies maximum value for random group count.

Type: u32
Default: 10
RandomMinGroupCount
Specifies minimum value for random group count.

Type: u32
Default: 10
1412
IterateThroughputCommand
Writable Attribute
Description
RandomSeedValue
Specify random seed value.

Type: u32
Default: 4814
IterateMulticastGroupCountCommand Read-Only Attributes

Read-Only Attribute
Description

TestStatus
Test status.
Type: string
IterateThroughputCommand
Description:
Adjust the throughput rate for each iteration on stream blocks or ports.

IterateThroughputCommand Writable Attributes

Writable Attribute
Description
AcceptableFrameLoss
Maximum number of frames that can be lost during an iteration in order for the iteration to be considered successful.
Type: double
Default: 0
Range: 0.0 - 100.0
Backoff
Rate at which the load decreases after the DUT fails at the current load. Applicable when LoadType is BINARY or COMBO.
Type: double
Default: 50
Range: 0.001 - 99.999
IgnoreMinMaxLimits
Specifies whether the search stops at the specified RateLowerLimit or RateUpperLimit value, or whether it continues
beyond those limits if an acceptable load has not yet been found. This attribute is ignored if LoadType is set to BINARY.
Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
Continues beyond minimum and maximum limits to find acceptable load
FALSE Search stops at the RateLowerLimit or RateUpperLimit value.

InitalRate
If LoadType is set to BINARY, the load rate at the beginning of the test. This attribute is ignored if LoadType is set to
STEP.
Type: double
Default: 10
1413
IterateTrialCommand
Writable Attribute
Description
LoadType

Type: enum
Default: BINARY
Possible Values:
Value
Description
STEP
Load rate increases by RateStep with each test iteration, beginning with RateLowerLimit and increasing to
RateUpperLimit.
BINARY A binary search algorithm is used to determine the load rate, beginning at RateInitial.
COMBO Test begins in step mode and then switches to binary mode when a step iteration fails.
RateLowerLimit
If LoadType is set to STEP, the starting throughput rate for each port. This attribute is ignored if LoadType is set to
BINARY.
Type: double
Default: 10.0
RateStep
Amount the throughput increases from iteration to iteration. This attribute is ignored if LoadType is set to BINARY.
Type: double
Default: 1
Range: 0.001 - 100000000000.0
RateUpperLimit
If LoadType is set to STEP, the maximum throughput rate for each port. This attribute is ignored if LoadType is set to
BINARY.
Type: double
Default: 100
Resolution
Finest adjustment possible for the load from iteration to iteration. If the required adjustment to the current load for the
next iteration is less than the resolution, the search stops. Applicable when LoadType is BINARY or COMBO.
Type: double
Default: 1.0
Range: 0.001 - 1000.0
StreamBlockList
List of stream blocks or ports to calculate throughput.

Type: handle
Default: 0
IterateThroughputCommand Read-Only Attributes

Read-Only Attribute
Description

TestStatus

Type: string
IterateTrialCommand
Description:
Iterate the component commands for a specified number of Trials.

1414
JitterHistogram
IterateTrialCommand Writable Attributes

Writable Attribute
Description
NumTrials
Number of Trials to execute the component command sequence for.

Type: u16
Default: 1
Range: 1 - 10000
IterateTrialCommand Read-Only Attributes

Read-Only Attribute
Description

TestStatus
Test status.
Type: string
JitterHistogram
Description:
Jitter histogram configuration. Total, minimum, maximum, and average jitter values, and 16 histogram bin counters can be retrieved from the results.

Relations:
Side name
(Type)
Relative
Description
ActiveParent
(ActiveHistogram)
AnalyzerConfig

object.
JitterHistogram Writable Attributes

Writable Attribute
Description
Active, Name
BucketSizeList
Type: u32
Default: 0
ConfigMode

Type: enum
Possible Values:
Value
Description
Description

Type: string
Default: (ns)
1415
joinedSources
Writable Attribute
Description
DistributionMode
mode.
Type: enum
Possible Values:
Value
Description
LEFT_MODE
RIGHT_MODE

CUSTOM_MODE
Type: u32
Default: 1024
LimitList
Type: u32
Default: 0
Type: u32
Default: 8
JitterHistogram Read-Only Attributes

joinedSources (overloaded)
joinedSources (pim) - Object definition for the following paths:
StreamBlock.Pimv4JoinPrune.groupRecords.JoinPrunev4GroupRecord.joinedSources
joinedSources (pim) - Object definition for the following paths:
StreamBlock.Pimv6JoinPrune.groupRecords.JoinPrunev6GroupRecord.joinedSources
joinedSources Object (pim PDU library)

Description:
Parents: JoinPrunev4GroupRecord (StreamBlock.Pimv4JoinPrune.groupRecords.JoinPrunev4GroupRecord)

Children: EncodedSourceIpv4Address
1416
JoinPrunev4GroupRecord
joinedSources Attributes
Attribute
Description
Name
information.
Type: string
joinedSources Object (pim PDU library)

Description:

joinedSources Attributes
Attribute
Description
Name
information.
Type: string
Description:
Parents: groupRecords
Children: groupAddr, joinedSources, prunedSources
JoinPrunev4GroupRecord Attributes
Attribute
Description
Name
Type: string
numJoin
Type: INTEGER
Default: 1
numPrune
Type: INTEGER
Default: 1
1417
Description:
Parents: groupRecords
Children: groupAddr, joinedSources, prunedSources
JoinPrunev6GroupRecord Attributes
Attribute
Description
Name
Type: string
numJoin
Type: INTEGER
Default: 1
numPrune
Type: INTEGER
Default: 1
jumbo
Description:
Parents: Ipv6HopByHopOption
Children: None
jumbo Attributes
Attribute
Description
data
Type: INTEGER
Default: 0
length
Type: INTEGER
Default: 4
Name
more information.
Type: string
pad
Type: ALIGNMENTPAD
Default: 0
type
Type: INTEGER
Default: 194
jumboMax
Description:
Parents: fs
Children: theReservedDataSelect
1418
keys
jumboMax Attributes
Attribute
Description
jumbo
Type: OCTETSTRING
Name
information.
Type: string
keys
Description:
Parents: Gre
Children: GreKey
keys Attributes
Attribute
Description
Name
information.
Type: string
L2LearningConfig
Description:
The definition of the Layer 2 learning configuration. Layer 2 Learning teaches the DUT the source MAC address of streams configured on the test port. This
object holds the definition of the Layer 2 learning configuration. One project can contain exactly one L2LearningConfig.
Tcl example: stc::get [stc::get project1 -children-l2learningconfig]

L2LearningConfig Writable Attributes

Writable Attribute
Description
Active, Name
EncapOption
Which encapsulation to use for layer 2 Rx learning frames.

Type: enum
Default: USE_TX_ENCAP
Possible Values:
Value
Description
USE_TX_ENCAP Use the same encapsulation as Tx frames.
NONE
Use no encapsulation.
1419
L2LearningStartCommand
Writable Attribute
Description
L2FrameSize
Specifies whether the Layer 2 learning frame size is to match the new stream or is created at a fixed size.
Tcl example: stc::config [stc::get project1 -children-l2learningconfig] -L2FrameSize FIXED
Type: enum
Possible Values:
Value
Description
SAME_AS_STREAM Use the same frame size as stream.
FIXED
Uses a fixed frame size.
L2FrameSizeFixed
The frame size in bytes of a new Layer 2 learning frame when EnumL2FrameSizeType is FIXED.
Tcl example: stc::config [stc::get project1 -children-l2learningconfig] -L2FrameSizeFixed 128
Type: u32
Default: 128
LearningStartDelay
Delay time in seconds before starting a Layer 2 learning frame.

Tcl example: stc::config [stc::get project1 -children-l2learningconfig] -LearningStartDelay 5
Type: u32
Default: 1
Rate
Rate of Layer 2 learning frames in frames per second.

Tcl example: stc::config [stc::get project1 -children-l2learningconfig] -Rate 500
Type: u32
Default: 1000
RepeatCount
Repeat count of Layer 2 learning frames in seconds.

Tcl example: stc::config [stc::get project1 -children-l2learningconfig] -RepeatCount 5
Type: u32
Default: 3
L2LearningConfig Read-Only Attributes

L2LearningStartCommand
Description:
Teach the DUT the MAC address of the transmitted/received port.

L2LearningStartCommand Writable Attributes

Writable Attribute
Description
HandleList

Type: handle
Default: 0
1420
L2LearningStopCommand
Writable Attribute
Description
L2LearningOption
Specifies whether the L2LearningOption takes place on Tx, or Rx, or both Tx and Rx.
Type: enum
Default: TX_RX
Possible Values:
Value
Description
TX_ONLY Transmit side.
RX_ONLY Receive side.
TX_RX
Both transmit and receive side.
L2LearningStartCommand Read-Only Attributes

Read-Only Attribute
Description

L2LearningState
The state of the current layer 2 learning command.

Type: enum
Default: IDLE
Possible Values:
Value
Description
IDLE
Idle state.
CONFIGURING Configuring state.

INPROGRESS
In Progress state.
SUCCESSFUL Successful state.

FAILURE
Failure state.
L2LearningStopCommand
Description:
Stop the transmitted Layer 2 frame from the Tx/Rx port.
The StopL2Learning command will do the following:
- StopL2TxLearning if needed.
- StopL2RxLearning if needed.

L2LearningStopCommand Writable Attributes

Writable Attribute
Description
HandleList

Type: handle
Default: 0
1421
L2TestBreakLinkCommand
L2LearningStopCommand Read-Only Attributes

Read-Only Attribute
Description

L2TestBreakLinkCommand
Description:
Brings down a link. After successful completion of the command, the link status changes to DOWN.

L2TestBreakLinkCommand Writable Attributes

Writable Attribute
Description
Port

Type: handle
Default: 0
L2TestBreakLinkCommand Read-Only Attributes

Read-Only Attribute
Description

L2TestLoadTemplateCommand
Description:
Saves the MII or MDIO configuration to an xml file. -LoadDefault is optional. It is FALSE by default.

L2TestLoadTemplateCommand Writable Attributes

Writable Attribute
Description
FileName
Name of template file.

Type: inputFilePath
1422
L2TestReloadRegistersCommand
Writable Attribute
Description
LoadDefault
-LoadDefault is optional. It is FALSE by default.

Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
Load the default template "ieee802_3ae45.xml".
FALSE Load the -FileName requested.

Port
Port handle.
Type: handle
Default: 0
L2TestLoadTemplateCommand Read-Only Attributes

Read-Only Attribute
Description

L2TestReloadRegistersCommand
Description:
Reloads the MII or MDIO configuration from the hardware.

L2TestReloadRegistersCommand Writable Attributes

Writable Attribute
Description
PortList
List of ports to reload registers.

Type: handle
Default: 0
L2TestReloadRegistersCommand Read-Only Attributes

Read-Only Attribute
Description

L2TestRestoreLinkCommand
Description:
Brings up a link previously brought down using BreakLink command. After successful completion of command, the link status changes to UP.

1423
L2TestSaveTemplateCommand

L2TestRestoreLinkCommand Writable Attributes

Writable Attribute
Description
Port

Type: handle
Default: 0
L2TestRestoreLinkCommand Read-Only Attributes

Read-Only Attribute
Description

L2TestSaveTemplateCommand
Description:
Saves the MII or MDIO configuration to an xml file.

L2TestSaveTemplateCommand Writable Attributes

Writable Attribute
Description
FileName
Required: Name of template file.

Port
Required: port handle.

Type: handle
Default: 0
L2TestSaveTemplateCommand Read-Only Attributes

Read-Only Attribute
Description

L2TestStartLinkFaultSignallingCommand
Description:
1424
L2TestStopLinkFaultSignallingCommand
Starts LinkFault signaling on an Ethernet 10Gig fiber port.

L2TestStartLinkFaultSignallingCommand Writable Attributes

Writable Attribute
Description
FaultDuration
Fault duration in case of timed fault.

Type: u32
Default: 0
FaultMode
Fault mode.
Type: enum
Default: LOCAL
Possible Values:
Value
Description
RESET
Stop forcing a local or remote fault. Reset will remove all forced faults from the tx data path.
LOCAL
Local fault.
REMOTE Remote fault.

FaultType
Type of fault to be generated.

Type: enum
Default: CONTINUOUS
Possible Values:
Value
Description
CONTINUOUS Continuous fault. Requires manual stop.
TIMED
Port
Timed fault. Occurs for specified duration.

Type: handle
Default: 0
L2TestStartLinkFaultSignallingCommand Read-Only Attributes

Read-Only Attribute
Description

L2TestStopLinkFaultSignallingCommand
Description:
Stops the LinkFault signalling started on Ethernet 10gig fiber Phy.

L2TestStopLinkFaultSignallingCommand Writable Attributes

Writable Attribute
Description
1425
L2tpAbortCommand
Writable Attribute
Description
Port

Type: handle
Default: 0
L2TestStopLinkFaultSignallingCommand Read-Only Attributes

Read-Only Attribute
Description

L2tpAbortCommand
Description:
Abort the L2TP emulation.

L2tpAbortCommand Writable Attributes

Writable Attribute
Description
BlockList
List of L2TP block configuration objects on which to abort L2TP emulation.

Type: handle
Default: 0
ControlType

Type: enum
Default: UNDEFINED
Possible Values:
Value
Description
UNDEFINED
Undefined.
CONNECT
Connect.
DISCONNECT Disconnect.
TERMINATE
Terminate.
NodeStartStepCountList
Currently unavailable.
Type: u16
Default: 0
TunnelStartStepCountList
Type: u16
Default: 0
L2tpAbortCommand Read-Only Attributes

Read-Only Attribute
Description

1426
L2tpClearStatsCommand
L2tpClearStatsCommand
Description:
Clear the L2TP port and block level statistics.

L2tpClearStatsCommand Writable Attributes

Writable Attribute
Description
BlockList
List of blocks to clear statistics on.

Type: handle
Default: 0
L2tpClearStatsCommand Read-Only Attributes

Read-Only Attribute
Description

L2tpConnectCommand
Description:
Start connection of the L2TP tunnels.

L2tpConnectCommand Writable Attributes

Writable Attribute
Description
BlockList
List of L2TP block config objects on which to start tunnels connecting.

Type: handle
Default: 0
ControlType

Type: enum
Default: UNDEFINED
Possible Values:
Value
Description
UNDEFINED
Undefined.
CONNECT
Connect.
TERMINATE
Terminate.
1427
L2tpConnectWaitCommand
Writable Attribute
Description
Type: u16
Default: 0
SeqType
not use it.
Instead of this attribute, use the SeqType attribute on the L2tpPortConfig object.
The way in which to bring up the tunnels.
Type: enum
Default: SEQUENTIAL
Possible Values:
Value
Description
SEQUENTIAL
Connect the tunnels in a sequential manner.
ROUND_ROBIN Connect the tunnels in a round-robin manner.

Type: u16
Default: 0
L2tpConnectCommand Read-Only Attributes

Read-Only Attribute
Description

L2tpConnectWaitCommand
Description:
Wait for tunnels to go into established state after the L2TP Connect command.

Parents: Sequencer
L2tpConnectWaitCommand Writable Attributes

Writable Attribute
Description
ErrorOnFailure
BlockConnectedState
Block state to wait for.

Type: enum
Default: CONNECTED
Possible Values:
Value
Description
NONE
None state.
IDLE
Idle state.
CONNECTING
Connecting state.
CONNECTED
Connected state.
DISCONNECTING Disconnecting state.

TERMINATING
ObjectList
Terminating state.
List of objects (ie Project, Port, or EmulatedDevice) to wait for connected state on.
Type: handle
Default: 0
1428
L2tpDisconnectCommand
Writable Attribute
Description
WaitTime
Maximum amount of time to wait for tunnels to go into established state.

Type: double
Default: 30.0
Range: 0.005 - 2147483647.0
L2tpConnectWaitCommand Read-Only Attributes

Read-Only Attribute
Description
L2tpDisconnectCommand
Description:
Start the L2TP tunnels disconnecting.

L2tpDisconnectCommand Writable Attributes

Writable Attribute
Description
BlockList
List of L2TP block configuration objects on which to start tunnels disconnecting.

Type: handle
Default: 0
ControlType

Type: enum
Default: UNDEFINED
Possible Values:
Value
Description
UNDEFINED
Undefined.
CONNECT
Connect.
TERMINATE
Terminate.
Type: u16
Default: 0
SeqType
not use it.
Instead of this attribute, use the SeqType attribute on the L2tpPortConfig object.
Order in which to bring down the tunnels.
Type: enum
Default: SEQUENTIAL
Possible Values:
Value
Description
SEQUENTIAL
Bring the tunnels down in a sequential manner.
ROUND_ROBIN Bring the tunnels down in a round-robin manner.
1429
L2tpDisconnectWaitCommand
Writable Attribute
Description
Type: u16
Default: 0
L2tpDisconnectCommand Read-Only Attributes

Read-Only Attribute
Description

L2tpDisconnectWaitCommand
Description:
Wait for tunnels to go into idle state after the L2TP Disconnect command.

Parents: Sequencer
L2tpDisconnectWaitCommand Writable Attributes

Writable Attribute
Description
ErrorOnFailure
BlockDisconnectState

Type: enum
Default: IDLE
Possible Values:
Value
Description
NONE
None state.
IDLE
Idle state.
CONNECTING
Connecting state.
CONNECTED
Connected state.

TERMINATING
Terminating state.
ObjectList
List of objects (ie Project, Port, or EmulatedDevice) to wait for idle state on.
Type: handle
Default: 0
WaitTime
Maximum amount of time to wait for tunnels to go into idle state.

Type: double
Default: 30.0
Range: 0.005 - 2147483647.0
L2tpDisconnectWaitCommand Read-Only Attributes

Read-Only Attribute
Description
1430
L2tpNodeInfoCommand
L2tpNodeInfoCommand
Description:
Get the L2TP node information.

L2tpNodeInfoCommand Writable Attributes

Writable Attribute
Description
BlockList
List of L2TP block configuration objects on which to get L2TP node information.
Type: handle
Default: 0
FileName
Name of the file in which to save the L2TP node information.

Default: l2tpnodeinfo.csv
SaveToFile
Enable saving of the L2TP node information to a file.

Type: bool
Default: TRUE
Possible Values:
Value Description
TRUE
Save the L2TP node information to a file.
FALSE Do not save the L2TP node information to a file.

TimestampFilename
Whether to include a timestamp as part of the filename.

Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
L2tpNodeInfoCommand Read-Only Attributes

Read-Only Attribute
Description

L2tpPortConfig
Description:
L2TP port configuration settings.

Result children (automatically created): L2tpPortResults
Relations:
1431
L2tpPortResults
Side name
(Type)
Relative
Description
ResultChild
(ResultChild)
L2tpPortResults
L2tpPortConfig Writable Attributes

Writable Attribute
Description
Active, Name
L2tpNodeType
L2TP node emulation type.

Type: enum
Default: LAC
Possible Values:
Value Description
SeqType
LAC
All L2TP nodes on this port will run the LAC emulation.
LNS
All L2TP nodes on this port will run the LNS emulation.
Port-level sequence type that determines in what order tunnels are attempted.
Type: enum
Default: SEQUENTIAL
Possible Values:
Value
Description
SEQUENTIAL Attempt tunnels sequentially across host blocks under the port.
PARALLEL
TunnelConnectRate
Attempt tunnels in parallel across host blocks under the port.
Tunnel connection rate in tunnels per second.

Type: u16
Default: 100
Range: 1 - 1000
L2tpPortConfig Read-Only Attributes

Read-Only Attribute
Description
PortState
State of the tunnels on the port.

Type: enum
Default: NONE
Possible Values:
Value
Description
NONE
Emulation is not running on this port.
IDLE
Tunnels are not connecting or disconnecting.
CONNECTING
Tunnels on this port are being connected.
CONNECTED
At least one tunnel on this port is in the established state.
DISCONNECTING
Tunnels on this port are being disconnected.
TERMINATING
All of the tunnels on the nodes are being terminated/aborted.
CONNECTING_DISCONNECTING Tunnels on this port are connecting on some host blocks and disconnecting others.
L2tpPortResults
Description:
L2TP port results.
1432
L2tpPortResults
Parents: L2tpPortConfig
Relations:
Side name
(Type)
Relative
Description
ResultParent
(ResultChild)
L2tpPortConfig
L2tpPortResults Writable Attributes

L2tpPortResults Read-Only Attributes

Read-Only Attribute
Description
AvgSessionSetupTime
Average session setup time (msec).

Type: u32
Default: 0
AvgTunnelSetupTime
Average tunnel setup time (msec).

Type: u32
Default: 0
LacCount
Number of LAC nodes under this port.

Type: u32
Default: 0
LnsCount
Number of LNS nodes under this port.

Type: u32
Default: 0
MaxSessionSetupTime
Maximum session setup time (msec).

Type: u32
Default: 0
MaxTunnelSetupTime
Maximum tunnel setup time (msec).

Type: u32
Default: 0
MinSessionSetupTime
Minimum session setup time (msec).

Type: u32
Default: 0
MinTunnelSetupTime
Minimum tunnel setup time (msec).

Type: u32
Default: 0
SessionDownCount
Number of sessions down.

Type: u32
Default: 0
SessionPendingDownCount
Number of sessions in the disconnecting state.

Type: u32
Default: 0
SessionPendingUpCount
Number of sessions in the connecting state.

Type: u32
Default: 0
SessionSetupRate
Session setup rate in sessions per second.

Type: u32
Default: 0
SessionUpCount
Number of sessions up.

Type: u32
Default: 0
1433
L2tpSessionInfoCommand
Read-Only Attribute
Description
TunnelDownCount
Number of tunnels on this port that are in the idle state.

Type: u32
Default: 0
TunnelPendingDownCount
Number of tunnels in the disconnecting state.

Type: u32
Default: 0
TunnelPendingUpCount
Number of tunnels in the connecting state.

Type: u32
Default: 0
TunnelSetupRate
Tunnel setup rate for the tunnels under this port (tunnels per second).
Type: u32
Default: 0
TunnelUpCount
Number of tunnels on this port that are in the established state.

Type: u32
Default: 0
L2tpSessionInfoCommand
Description:
Get the L2TP session information.

L2tpSessionInfoCommand Writable Attributes

Writable Attribute
Description
BlockList
List of L2TP block configuration objects on which to get session information.

Type: handle
Default: 0
FileName
Name of the file in which to save the L2TP session information.

SaveToFile
Enable saving of the L2TP session information to a file.

Type: bool
Default: TRUE
Possible Values:
Value Description
TRUE
Save the L2TP session information into a file.
FALSE Do not save the L2TP session information into a file.

TimestampFilename

Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
1434
L2tpShowNodeInfoCommand
L2tpSessionInfoCommand Read-Only Attributes

Read-Only Attribute
Description

L2tpShowNodeInfoCommand
Description:
Show the L2TP node info (GUI only).

Parents: Sequencer
L2tpShowNodeInfoCommand Writable Attributes

Writable Attribute
Description
BlockList
List of L2TP block config objects on which to show node info.

Type: handle
Default: 0
L2tpShowNodeInfoCommand Read-Only Attributes

L2tpShowSessionInfoCommand
Description:
Show the L2TP session info (GUI only).

Parents: Sequencer
L2tpShowSessionInfoCommand Writable Attributes

Writable Attribute
Description
BlockList
List of L2TP block config objects on which to show session info.

Type: handle
Default: 0
L2tpShowSessionInfoCommand Read-Only Attributes

1435
L2tpShowTunnelInfoCommand
L2tpShowTunnelInfoCommand
Description:
Show the L2TP tunnel info (GUI only).

Parents: Sequencer
L2tpShowTunnelInfoCommand Writable Attributes

Writable Attribute
Description
BlockList
List of L2TP block config objects on which to show tunnel info.

Type: handle
Default: 0
L2tpShowTunnelInfoCommand Read-Only Attributes

L2tpTunnelInfoCommand
Description:
Get the L2TP tunnel information.

L2tpTunnelInfoCommand Writable Attributes

Writable Attribute
Description
BlockList
List of L2TP block configuration objects on which to get L2TP tunnel information.
Type: handle
Default: 0
FileName
Name of the file in which to save the L2TP tunnel information.

SaveToFile
Enable saving of the L2TP tunnel information into a file.

Type: bool
Default: TRUE
Possible Values:
Value Description
TRUE
Save the L2TP tunnel information into a file.
FALSE Do not save the L2TP tunnel information into a file.
1436
L2TPv2
Writable Attribute
Description
TimestampFilename

Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
L2tpTunnelInfoCommand Read-Only Attributes

Read-Only Attribute
Description

L2TPv2 (l2tpv2:L2TPv2)
Description:
Children: lengths, nrList, nsList, offset, padding
Next headers: ppp:PPP, custom:Custom
L2TPv2 Attributes
Attribute
Description
Name
Type: string
reserved1
Type: BITSTRING
Default: 00
reserved2
Type: BITSTRING
Default: 0
reserved3
Type: BITSTRING
Default: 0000
sessionId
Type: INTEGER
Default: 0
tunnelId
Type: INTEGER
Default: 0
type
Type: BITSTRING
Default: 0
useLength
Type: BITSTRING
Default: 0
useOffset
Type: BITSTRING
Default: 0
usePriority
Type: BITSTRING
Default: 1
1437
L2tpv2BlockConfig
Attribute
Description
useSequence
Type: BITSTRING
Default: 0
version
Type: INTEGER
Default: 2
L2tpv2BlockConfig
Description:
L2TPv2 block configuration settings (a group of L2TP nodes).

Automatically-created children: Ipv4NetworkBlock, L2tpv2BlockResults
Result children (automatically created): L2tpv2BlockResults, L2tpv2NodeResults, L2tpv2SessionResults, L2tpv2TunnelResults
Relations:
Side name
(Type)
Relative
Description
ResultChild
(ResultChild)
L2tpv2BlockResults
UsesIf
(UsesIf)


L2tpv2BlockConfig Writable Attributes

Writable Attribute
Description
Active, Name
AutoRetryCount
Maximum number of times to retry failed tunnels.

Type: u8
Default: 1
Range: 1 - 255
BearerCapabilities
Specifies to the peer the bearer device types supported by the hardware interfaces of the sender for outgoing calls.
Type: enum
Default: ANALOG
Possible Values:
Value
Description
ANALOG Sender supports analog.
DIGITAL Sender supports digital.
BOTH
BearerType
Sender supports both.
Specifies the bearer capability of the call (ICRQ) or required for the call (OCRQ).
Type: enum
Default: ANALOG
Possible Values:
Value
Description
ANALOG Bearer type is analog.
DIGITAL Bearer type is digital.
1438
L2tpv2BlockConfig
Writable Attribute
Description
EnableAutoRetry
Enable auto retry of failed tunnels.

Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
Enable auto retry.

EnableDutAuthentication
Enable DUT authentication of the tunnels.

Type: bool
Default: TRUE
Possible Values:
Value Description
TRUE
Enable DUT authentication of the tunnels.
FALSE Disable DUT authentication of the tunnels.

EnableHello
Enable transmit of Hello messages.

Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
Enable transmission of Hello messages.
FALSE Disable transmission of Hello messages.

ForceLcpRenegotiation
Force LCP Renegotiation from the LNS/PPP Server even if the LAC has already negotiated LCP.
Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
Enable Force LCP Renegotiation.
FALSE Disable Force LCP Renegotiation.

FrameCapabilities
Specifies to the peer the types of framing that will be accepted or requested by the sender.
Type: enum
Default: SYNC
Possible Values:
Value Description
ASYNC Asynchronous framing is supported.
FrameType
SYNC
Synchronous framing is supported.
BOTH
Both synchronous and asynchronous framing types are supported.
Specifies the frame type of the sessions.

Type: enum
Default: SYNC
Possible Values:
Value Description
ASYNC Frame type is asynchronous.
SYNC
Frame type is synchronous.
HelloTimeout
Hello message timeout (seconds).

Type: u16
Default: 60
Range: 1 - 1024
HiddenAvps
A list AVPs that should be hidden.

Type: u8
Default: 0
1439
L2tpv2BlockConfig
Writable Attribute
Description
HostName
Host name.
Type: string
Default: server.spirent.com
LcpProxyMode
Specifies if the LAC will do LCP negotiation and PPP Authentication.

Type: enum
Default: NONE
Possible Values:
Value
Description
NONE
The LAC will not do LCP negotiation or PPP Authentication. The results of LCP and
authentication are forwarded to the LNS in the appropriate AVPs.
LCPONLY
The LAC will do LCP negotiation only.
AUTHENTICATION The LAC will do LCP negotiation and PPP Authentication.

RetryTimeout
Amount of time to wait for the retry (seconds).

Type: u8
Default: 1
Range: 1 - 255
RxTunnelPassword
Receive (inbound) tunnel password.

Type: string
Default: spirent
RxWindowSize
Rx window size (number of outstanding control plane packets).

Type: u16
Default: 4
Range: 1 - 65535
SessionsPerTunnelCount
Number of sessions per tunnel.

Type: u32
Default: 1
Range: 1 - 65535
SessionStartingId
Session starting ID.

Type: u16
Default: 1
Range: 1 - 65535
TunnelCount
Number of tunnels per L2TP node.

Type: u16
Default: 1
Range: 1 - 65535
TunnelStartingId
Tunnel starting ID.

Type: u16
Default: 1
Range: 1 - 65535
TxConnectRate
Transmit connect speed in bits per second (AVP 24).

Type: u64
Default: 56000
Range: 1 - 65535
TxTunnelPassword
Transmit (outbound) tunnel password.

Type: string
Default: spirent
UdpSrcPort
UDP source port number.

Type: u16
Default: 1701
Range: 1 - 65535
1440
L2tpv2BlockResults
Writable Attribute
Description
UseGatewayAsRemoteIpv4Addr
Use the Gateway IP address as the Remote IP address. Only applies to the LAC.
Type: bool
Default: TRUE
Possible Values:
Value Description
TRUE
Use the Gateway IP address as the Remote IP. Anything specified for the Remote IP will be ignored.
FALSE Don't use the Gateway IP address as the Remote IP.


Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
Enable use of partial block state.
FALSE Disable use of partial block state.
L2tpv2BlockConfig Read-Only Attributes

Read-Only Attribute
Description
BlockState
State of the tunnels on the L2TP nodes on this L2TP block.

Type: enum
Default: IDLE
Possible Values:
Value
Description
NONE
Emulation is not currently running on this block.
IDLE
Tunnels on this block are not connecting or disconnecting.
CONNECTING
Tunnels on this block are connecting.
CONNECTED
At least one tunnel on this block is in the established state.
DISCONNECTING Tunnels on this block are disconnecting.

TERMINATING
All tunnels on this block are being terminated/aborted.
L2tpv2BlockResults
Description:
L2TPv2 results.

Automatically created from: L2tpv2BlockConfig
Relations:
Side name
(Type)
Relative
Description
ResultParent
(ResultChild)
L2tpv2BlockConfig
L2tpv2BlockResults Writable Attributes

1441
L2tpv2BlockResults
L2tpv2BlockResults Read-Only Attributes

Read-Only Attribute
Description
AvgSessionSetupTime
Average session setup time (msec).

Type: u32
Default: 0
AvgTunnelSetupTime
Average tunnel setup time (msec).

Type: u32
Default: 0
MaxSessionSetupTime
Maximum session setup time (msec).

Type: u32
Default: 0
MaxTunnelSetupTime
Maximum tunnel setup time (msec).

Type: u32
Default: 0
MinSessionSetupTime
Minimum session setup time (msec).

Type: u32
Default: 0
MinTunnelSetupTime
Minimum tunnel setup time (msec).

Type: u32
Default: 0
RxAckCount
Number of ACK packets received.

Type: u32
Default: 0
RxCallDisconnectNotifyCount
Number of Call-Disconnect-Notify (CDN) packets received.

Type: u32
Default: 0
RxHelloCount
Number of Hello packets received.

Type: u32
Default: 0
RxIncomingCallConnectCount
Number of Incoming-Call-Connected (ICCN) packets received.

Type: u32
Default: 0
RxIncomingCallReplyCount
Number of Incoming-Call-Reply (ICRP) packets received.

Type: u32
Default: 0
RxIncomingCallRequestCount
Number of Incoming-Call-Request (ICRQ) packets received.

Type: u32
Default: 0
RxOutgoingCallConnectCount
Number of Outgoing-Call-Connected (OCCN) packets received.

Type: u32
Default: 0
RxOutgoingCallReplyCount
Number of Outgoing-Call-Reply (OCRP) packets received.

Type: u32
Default: 0
RxOutgoingCallRequestCount
Number of Outgoing-Call-Request (OCRQ) packets received.

Type: u32
Default: 0
RxPktCount
Number of packets received.

Type: u32
Default: 0
1442
L2tpv2BlockResults
Read-Only Attribute
Description
RxSetLinkInfoCount
Number of Set-Link-Info (SLI) packets received.

Type: u32
Default: 0
RxStartCcConnectCount
Number of Start-Control-Connection-Connected (SCCCN) packets received.

Type: u32
Default: 0
RxStartCcReplyCount
Number of Start-Control-Connection-Reply (SCCRP) packets received.

Type: u32
Default: 0
RxStartCcRequestCount
Number of Start-Control-Connection-Request (SCCRQ) packets received.

Type: u32
Default: 0
RxStopCcNotifyCount
Number of Stop-Control-Connection-Notification (StopCCN) packets received.

Type: u32
Default: 0
RxWanErrorNotifyCount
Number of WAN-Error-Notify (WEN) packets received.

Type: u32
Default: 0
SessionSetupRate
Session setup rate (sessions per second).

Type: u32
Default: 0
TunnelSetupRate
Tunnel setup rate in tunnels per second.

Type: u32
Default: 0
TxAckCount
Number of ACK packets transmitted.

Type: u32
Default: 0
TxCallDisconnectNotifyCount
Number of Call-Disconnect-Notify (CDN) packets transmitted.

Type: u32
Default: 0
TxHelloCount
Number of Hello packets transmitted.

Type: u32
Default: 0
TxIncomingCallConnectCount
Number of Incoming-Call-Connected (ICCN) packets transmitted.

Type: u32
Default: 0
TxIncomingCallReplyCount
Number of Incoming-Call-Reply (ICRP) packets transmitted.

Type: u32
Default: 0
TxIncomingCallRequestCount
Number of Incoming-Call-Request (ICRQ) packets transmitted.

Type: u32
Default: 0
TxOutgoingCallConnectCount
Number of Outgoing-Call-Connected (OCCN) packets transmitted.

Type: u32
Default: 0
TxOutgoingCallReplyCount
Number of Outgoing-Call-Reply (OCRP) packets transmitted.

Type: u32
Default: 0
TxOutgoingCallRequestCount
Number of Outgoing-Call-Request (OCRQ) packets transmitted.

Type: u32
Default: 0
1443
L2tpv2DeviceGenProtocolParams
Read-Only Attribute
Description
TxPktCount
Number of packets transmitted.

Type: u32
Default: 0
TxSetLinkInfoCount
Number of Set-Link-Info (SLI) packets transmitted.

Type: u32
Default: 0
TxStartCcConnectCount
Number of Start-Control-Connection-Connected (SCCCN) packets transmitted.

Type: u32
Default: 0
TxStartCcReplyCount
Number of Start-Control-Connection-Reply (SCCRP) packets transmitted.

Type: u32
Default: 0
TxStartCcRequestCount
Number of Start-Control-Connection-Request (SCCRQ) packets transmitted.

Type: u32
Default: 0
TxStopCcNotifyCount
Number of Stop-Control-Connection-Notification (StopCCN) packets transmitted.

Type: u32
Default: 0
TxWanErrorNotifyCount
Number of WAN-Error-Notify (WEN) packets transmitted.

Type: u32
Default: 0
L2tpv2DeviceGenProtocolParams
Description:
L2TP block configuration wizard parameters.

L2tpv2DeviceGenProtocolParams Writable Attributes

Writable Attribute
Description
Active, Name
EnableAuthentication
Enable authentication of tunnels.

Type: bool
Default: TRUE
Possible Values:
Value Description
TRUE
Enable DUT authentication of tunnels.
FALSE Disable DUT authentication of tunnels.

HostName
Host name.
Type: string
1444
L2tpv2If
Writable Attribute
Description
L2tpNodeType
Type of emulation the L2TP node will run.

Type: enum
Default: LAC
Possible Values:
Value Description
LAC
The L2TP node will function as an LAC.
LNS
The L2TP node will function as an LNS.
RemoteIpv4Addr
Remote IPv4 address.

Type: ip
Default: 0.0.0.0
RemoteIpv4AddrStepPerL2tpNode
Remote IPv4 address step per L2TP node.

Type: ip
Default: 0.0.0.0
TunnelPassword
Tunnel password (outbound and inbound).

Type: string
Default: spirent
TunnelsPerL2tpNode
Tunnels per L2TP node.

Type: u32
Default: 1
Range: 1 - 65535
Use the Gateway IP address as the Remote IP address. Only applies to the LAC.
Type: bool
Default: TRUE
Possible Values:
Value Description
TRUE
Use the Gateway IP address as the Remote IP. Anything specified for the Remote IP will be
ignored.
FALSE Don't use the Gateway IP address as the Remote IP.
L2tpv2DeviceGenProtocolParams Read-Only Attributes

L2tpv2If
Description:
Layer 2 Tunneling Protocol interface.

Relations:
Side name
(Type)
Relative
Description
DstBoundTo
(DstBinding)

StreamBlock.
EncapsulationSource
(Encapsulation)
PathDescriptor
1445
L2tpv2If
Side name
(Type)
Relative
Description
NetworkLink
(LinkSrc)

MemberOfVpn
(MemberOfVpn)

VpnSiteInfoVplsLdp
Port

relation.

WimaxIf

PrimaryIfSource
(PrimaryIf)

SUT

the DUT.
RelayBlockConfig
(RelayIf)
(ResolvesInterface)

RsvpRouterConfig

SrcBoundTo
(SrcBinding)

StreamBlock.
StackedOn
(StackedOnEndpoint)

WimaxIf
TopLevelIfSource
(TopLevelIf)

SUT

interface stack.
Port

relation.
1446
L2tpv2If
Side name
(Type)
Relative
Description
UsesIfSource
(UsesIf)


L2tpv2If Writable Attributes

Writable Attribute
Description
Active, Name
IfCountPerLowerIf

Type: u32
Default: 1
IfRecycleCount
How many times to increment the item before returning to the starting value. The item to increment can be
LocalSessionId, LocalTunnelId, RemoteIpv4Addr, and UdpSrcPort.
Example: LocalSessionId = 1, LocalSessionIdRepeatCount = 0, LocalSessionIdStep = 1, IfRecycleCount = 3. The
generated values for LocalSessionId will be 1, 2, 3, 1, 2, 3, and so on. It works in a similar manner for other items.
Type: u32
Default: 0
IsLoopbackIf

Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE

IsRange
Whether to use a combination of attributes to generate a range of items, or to use an nList attribute to specify the
items. The items are LocalSessionId, LocalTunnelId, RemoteIpv4Addr, and UdpSrcPort.
Type: bool
Default: TRUE
Possible Values:
Value Description
TRUE
Set 1: LocalSessionId, LocalSessionIdRepeatCount, LocalSessionIdStep, IfRecycleCount.
Set 2: LocalTunnelId, LocalTunnelIdRepeatCount, LocalTunnelIdStep, IfRecycleCount.
Set 3: RemoteIpv4Addr, RemoteIpv4AddrRepeatCount, RemoteIpv4AddrStep, RemoteIpv4AddrStepMask,
IfRecycleCount.
Set 4: UdpSrcPort, UdpSrcPortRepeatCount, UdpSrcPortStep, IfRecycleCount.
FALSE Use one of the nList attributes to specify the items. The nList attributes are LocalSessionIdList,
LocalTunnelIdList, RemoteIpv4AddrList, and UdpSrcPortList.
LocalSessionId
L2TP local session ID. You can generate more than one local session ID by using combinations of LocalSessionId,
LocalSessionIdRepeatCount, LocalSessionIdStep, and IfRecycleCount. If you do that, then LocalSessionId is the
starting local session ID.
Type: u16
Default: 0
1447
L2tpv2If
Writable Attribute
Description
LocalSessionIdList
A Tcl list of L2TP local session IDs. To use this attribute, the IsRange attribute must be FALSE.
Type: u16
Default: 0
LocalSessionIdRepeatCount
How many times to repeat the same L2TP local session ID before incrementing it. See IsRange for more information.
Type: u32
Default: 0
LocalSessionIdStep
Step value for the L2TP local session ID (LocalSessionId). See IsRange for more information.
Type: s16
Default: 1
LocalTunnelId
L2TP local tunnel ID. You can generate more than one local tunnel ID by using combinations of LocalTunnelId,
LocalTunnelIdRepeatCount, LocalTunnelIdStep, and IfRecycleCount. If you do that, then LocalTunnelId is the starting
local tunnel ID.
Type: u16
Default: 0
LocalTunnelIdList
A Tcl list of L2TP local tunnel IDs. To use this attribute, the IsRange attribute must be FALSE.
Type: u16
Default: 0
LocalTunnelIdRepeatCount
How many times to repeat the same L2TP local tunnel ID before incrementing it. See IsRange for more information.
Type: u32
Default: 0
LocalTunnelIdStep
L2TP local tunnel ID step value. See IsRange for more information.
Type: s16
Default: 1
RemoteIpv4Addr
IPv4 address of the L2TP remote system. You can generate more than one remote IPv4 address by using combinations
of RemoteIpv4Addr, RemoteIpv4AddrRepeatCount, RemoteIpv4AddrStep, RemoteIpv4AddrStepMask, and
IfRecycleCount. If you do that, then RemoteIpv4Addr is the starting remote IPv4 address.
Type: ip
Default: 192.85.1.3
RemoteIpv4AddrList
A Tcl list of IPv4 addresses of L2TP remote systems. To use this attribute, the IsRange attribute must be FALSE.
Type: ip
Default: 0
RemoteIpv4AddrRepeatCount
How many times to repeat the same L2TP remote IPv4 address before incrementing it. See IsRange for more
information.
Type: u32
Default: 0
RemoteIpv4AddrStep
L2TP remote IPv4 address step value. See IsRange for more information.
Type: ip
Default: 0.0.0.1
RemoteIpv4AddrStepMask
L2TP remote IPv4 address step mask. This indicates which parts of the IPv4 address will change when incremented.
See IsRange for more information.
Type: ip
Default: 0.0.0.255
RemoteSessionIdList
A Tcl list of L2TP remote session IDs.

Type: u16
Default: 0
RemoteTunnelIdList
A Tcl list of L2TP remote tunnel IDs.

Type: u16
Default: 0
TunnelSessionResolver
Protocol that resolves L2tpv2 tunnel parameters. Spirent TestCenter sets this automatically when L2tpv2 testing is
configured.
Type: string
Default: default
1448
L2tpv2If
Writable Attribute
Description
UdpChecksumEnabled
Whether to use a checksum on UDP packets.

Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
Use a checksum.
FALSE Do not use a checksum.

UdpDstPortList
A Tcl list of L2TP UDP destination ports.

Type: u16
Default: 1701
UdpSrcPort
UDP source port used in L2TP. You can generate more than one UDP source port by using combinations of UdpSrcPort,
UdpSrcPortRepeatCount, UdpSrcPortStep, and IfRecycleCount. If you do that, then UdpSrcPort is the starting UDP
source port.
Type: u16
Default: 1701
UdpSrcPortList
A Tcl list of L2TP UDP source ports. To use this attribute, the IsRange attribute must be FALSE.
Type: u16
Default: 1701
UdpSrcPortRepeatCount
How many times to repeat the same L2TP UDP source port before incrementing it. See IsRange for more information.
Type: u32
Default: 0
UdpSrcPortStep
L2TP UDP source port step value. See IsRange for more information.
Type: s16
Default: 1
UseLength

Type: bool
Default: TRUE
Possible Values:
Value Description
TRUE
Do not use.
FALSE Do not use.

UseOffset

Type: bool
Default: TRUE
Possible Values:
Value Description
TRUE
Do not use.
FALSE Do not use.

UsePriority

Type: bool
Default: TRUE
Possible Values:
Value Description
TRUE
Do not use.
FALSE Do not use.

UseSeq

Type: bool
Default: TRUE
Possible Values:
Value Description
TRUE
Do not use.
FALSE Do not use.
1449
L2tpv2NodeResults
L2tpv2If Read-Only Attributes

Read-Only Attribute
Description
EffectiveBlockCount

Type: u32
Default: 1
IfState

Type: enum
Default: DISABLED
Possible Values:
Value
Description
READY
Ready.
DISABLED
Disabled.
DELETING
Deleting.

TunnelSessionResolveState
Tunnel session resolve state.

Type: enum
Possible Values:
Value
Description
RESOLVE_DONE
Resolve is done.
RESOLVE_NEEDED
Resolve is needed.
RESOLVE_FAILED
Resolve failed.
RESOLVE_IN_PROGRESS
L2tpv2NodeResults
Description:
L2TPv2 node results object.

Parents: L2tpv2BlockConfig
L2tpv2NodeResults Writable Attributes

L2tpv2NodeResults Read-Only Attributes

Read-Only Attribute
Description
IncomingTunnelDownCount
Number of incoming tunnels down.

Type: u32
Default: 0
IncomingTunnelPendingDownCount

Type: u32
Default: 0
IncomingTunnelPendingUpCount

Type: u32
Default: 0
1450
L2tpv2NodeResults
Read-Only Attribute
Description
IncomingTunnelUpCount
Number of incoming tunnels up.

Type: u32
Default: 0
InnerVlanId
Inner VLAN ID.

Type: u16
Default: 1
LocalIp
Local IPv4 address.

Type: ip
Default: 0.0.0.0
MacAddr
MAC address.
Type: mac
Default: 00-00-00-00-00-00
NodeIndex
L2TP node index.

Type: u16
Default: 0
OutgoingTunnelDownCount
Number of outgoing tunnels down.

Type: u32
Default: 0
OutgoingTunnelPendingDownCount
Number of outgoing tunnels in the disconnecting state.

Type: u32
Default: 0
OutgoingTunnelPendingUpCount
Number of outgoing tunnels in the connecting state.

Type: u32
Default: 0
OutgoingTunnelUpCount
Number of outgoing tunnels up.

Type: u32
Default: 0
RemoteIp

Type: ip
Default: 0.0.0.0
RemotePort
UDP remote port.

Type: u16
Default: 0
SrcPort
UDP source port.

Type: u16
Default: 1701
TunnelDownCount
Number of tunnels down.

Type: u32
Default: 0
TunnelPendingDownCount

Type: u32
Default: 0
TunnelPendingUpCount

Type: u32
Default: 0
TunnelUpCount
Number of tunnels up.

Type: u32
Default: 0
Vci
VCI
Type: u16
Default: 32
1451
L2tpv2SessionResults
Read-Only Attribute
Description
VlanId
VLAN ID.
Type: u16
Default: 1
Vpi
VPI
Type: u16
Default: 0
Description:
L2TPv2 session results object.

L2tpv2SessionResults Writable Attributes

L2tpv2SessionResults Read-Only Attributes

Read-Only Attribute
Description
ErrorCode
Error code.
Type: u32
Default: 0
ErrorMsg
Error message.
Type: string
Default: 0
IncomingProxyAuthCount
Incoming proxy authentication count.

Type: u32
Default: 0
IncomingProxyLcpCount
Incoming proxy LCP count.

Type: u32
Default: 0
InnerVlanId
Inner VLAN ID.

Type: u16
Default: 1
LocalIp
Local IPv4 address.

Type: ip
Default: 0.0.0.0
MacAddr
MAC address.
Type: mac
Default: 00-00-00-00-00-00
NodeIndex
Index of the node this session is under.

Type: u16
Default: 0
RemoteIp

Type: ip
Default: 0.0.0.0
1452
Read-Only Attribute
Description
RemotePort
UDP remote port.

Type: u16
Default: 0
RemoteSessionId
Remote session ID.

Type: u16
Default: 0
RemoteTunnelId
Remote tunnel ID.

Type: u16
Default: 0
ResultCode
Result code.
Type: u32
Default: 0
RxCallDisconnectNotifyCount
Number of Call-Disconnect-Notify (CDN) packets received.

Type: u32
Default: 0
RxIncomingCallConnectCount
Number of Incoming-Call-Connected (ICCN) packets received.

Type: u32
Default: 0
RxIncomingCallReplyCount
Number of Incoming-Call-Reply (ICRP) packets received.

Type: u32
Default: 0
RxIncomingCallRequestCount
Number of Incoming-Call-Request (ICRQ) packets received.

Type: u32
Default: 0
RxOutgoingCallConnectCount
Number of Outgoing-Call-Connected (OCCN) packets received.

Type: u32
Default: 0
RxOutgoingCallReplyCount
Number of Outgoing-Call-Reply (OCRP) packets received.

Type: u32
Default: 0
RxOutgoingCallRequestCount
Number of Outgoing-Call-Request (OCRQ) packets received.

Type: u32
Default: 0
SessionId
Session ID.
Type: u16
Default: 0
SessionIndex
Session index.
Type: u16
Default: 0
SessionState
State of the session.

Type: enum
Default: IDLE
Possible Values:
Value
Description
IDLE
Session is down.
WAIT_TUNNEL
Idle state for the LNS.
WAIT_REPLY
Waiting for the OCRP.
WAIT_CONNECT Waiting for the OCCN.

ESTABLISHED
Session is up.
1453
L2tpv2TunnelResults
Read-Only Attribute
Description
SrcPort
UDP source port.

Type: u16
Default: 1701
TunnelId
ID of the tunnel this session is under.

Type: u16
Default: 0
TunnelIndex
Index of the tunnel this session is under.

Type: u16
Default: 0
TxCallDisconnectNotifyCount
Number of Call-Disconnect-Notify (CDN) packets transmitted.

Type: u32
Default: 0
TxIncomingCallConnectCount
Number of Incoming-Call-Connected (ICCN) packets transmitted.

Type: u32
Default: 0
TxIncomingCallReplyCount
Number of Incoming-Call-Reply (ICRP) packets transmitted.

Type: u32
Default: 0
TxIncomingCallRequestCount
Number of Incoming-Call-Request (ICRQ) packets transmitted.

Type: u32
Default: 0
TxOutgoingCallConnectCount
Number of Outgoing-Call-Connected (OCCN) packets transmitted.

Type: u32
Default: 0
TxOutgoingCallReplyCount
Number of Outgoing-Call-Reply (OCRP) packets transmitted.

Type: u32
Default: 0
TxOutgoingCallRequestCount
Number of Outgoing-Call-Request (OCRQ) packets transmitted.

Type: u32
Default: 0
Vci
VCI
Type: u16
Default: 32
VlanId
VLAN ID.
Type: u16
Default: 1
Vpi
VPI
Type: u16
Default: 0
L2tpv2TunnelResults
Description:
L2TPv2 tunnel results object.

1454
L2tpv2TunnelResults
L2tpv2TunnelResults Writable Attributes

L2tpv2TunnelResults Read-Only Attributes

Read-Only Attribute
Description
IncomingSessionDownCount
Number of incoming sessions that are down.

Type: u32
Default: 0
IncomingSessionPendingDownCount
Number of incoming sessions in the "Pending Down" state.

Type: u32
Default: 0
IncomingSessionPendingUpCount
Number of incoming sessions in the "Pending Up" state.

Type: u32
Default: 0
IncomingSessionUpCount
Number of incoming sessions that are up.

Type: u32
Default: 0
InnerVlanId
Inner VLAN ID.

Type: u16
Default: 1
LocalIp
Local IPv4 address.

Type: ip
Default: 0.0.0.0
MacAddr
MAC address.
Type: mac
Default: 00-00-00-00-00-00
NodeIndex
Index of the node this tunnel is under.

Type: u16
Default: 0
OutgoingSessionDownCount
Number of outbound sessions that are down.

Type: u32
Default: 0
OutgoingSessionPendingDownCount
Number of outgoing sessions in the "Pending Down" state.

Type: u32
Default: 0
OutgoingSessionPendingUpCount
Number of outgoing sessions in the "Pending Up" state.

Type: u32
Default: 0
OutgoingSessionUpCount
Number of outbound sessions.

Type: u32
Default: 0
RemoteIp

Type: ip
Default: 0.0.0.0
RemotePort
UDP remote port.

Type: u16
Default: 0
RemoteTunnelId
Remote tunnel ID.

Type: u16
Default: 0
1455
L2tpv2TunnelResults
Read-Only Attribute
Description
RxAckCount
Number of ACK packets received.

Type: u32
Default: 0
RxHelloCount
Number of Hello packets received.

Type: u32
Default: 0
RxPktCount

Type: u32
Default: 0
RxSetLinkInfoCount
Number of Set-Link-Info (SLI) packets received.

Type: u32
Default: 0
RxStartCcConnectCount
Number of Start-Control-Connection-Connected (SCCCN) packets received.

Type: u32
Default: 0
RxStartCcReplyCount
Number of Start-Control-Connection-Reply (SCCRP) packets received.

Type: u32
Default: 0
RxStartCcRequestCount
Number of Start-Control-Connection-Request (SCCRQ) packets received.

Type: u32
Default: 0
RxStopCcNotifyCount
Number of Stop-Control-Connection-Notification (StopCCN) packets received.

Type: u32
Default: 0
RxWanErrorNotifyCount
Number of WAN-Error-Notify (WEN) packets received.

Type: u32
Default: 0
SessionDownCount
Number of sessions that are down.

Type: u32
Default: 0
SessionUpCount
Number of sessions in this tunnel that are up.

Type: u32
Default: 0
SrcPort
UDP source port.

Type: u16
Default: 1701
TunnelId
Tunnel ID.
Type: u16
Default: 0
TunnelIndex
Tunnel index.
Type: u16
Default: 0
1456
L2tpv2TunnelResults
Read-Only Attribute
Description
TunnelState
State of the tunnel.

Type: enum
Default: IDLE
Possible Values:
Value
Description
IDLE
Tunnel is down.
WAIT_CTL_REP
Waiting for the SCCRP.
WAIT_CTL_CONN Waiting for the SCCCN.

ESTABLISHED
Tunnel is up.
BACKOFF_DELAY Tunnel is still up after the session has gone down.

TxAckCount
Number of ACK packets transmitted.

Type: u32
Default: 0
TxHelloCount
Number of Hello packets transmitted.

Type: u32
Default: 0
TxPktCount
Number of packets transmitted.

Type: u32
Default: 0
TxSetLinkInfoCount
Number of Set-Link-Info (SLI) packets transmitted.

Type: u32
Default: 0
TxStartCcConnectCount
Number of Start-Control-Connection-Connected (SCCCN) packets transmitted.

Type: u32
Default: 0
TxStartCcReplyCount
Number of Start-Control-Connection-Reply (SCCRP) packets transmitted.

Type: u32
Default: 0
TxStartCcRequestCount
Number of Start-Control-Connection-Request (SCCRQ) packets transmitted.

Type: u32
Default: 0
TxStopCcNotifyCount
Number of Stop-Control-Connection-Notification (StopCCN) packets transmitted.

Type: u32
Default: 0
TxWanErrorNotifyCount
Number of WAN-Error-Notify (WEN) packets transmitted.

Type: u32
Default: 0
Vci
VCI
Type: u16
Default: 32
VlanId
VLAN ID.
Type: u16
Default: 1
Vpi
VPI
Type: u16
Default: 0
1457
l2VpnEndpointSubTlv
l2VpnEndpointSubTlv
Description:
Children: None
l2VpnEndpointSubTlv Attributes
Attribute
Description
encapsulationType
Type: INTEGER
Default: 4
length
Type: INTEGER
Default: 14
Name
Type: string
receiverVeId
Type: INTEGER
Default: 2
reserved
Type: ALIGNMENTPAD
Default: 0
routeDistinguisher
Type: OCTETSTRING
Default: 0000000000000001
senderVeId
Type: INTEGER
Default: 1
type
Type: INTEGER
Default: 8
L3ForwardingLink
Description:
Link between layer 3 forwarding capable device (that is, an IP and MPLS enabled device).

Relations:
Side name
(Type)
Relative
Description
ContainedLink
(ContainedLink)
AncpCpeToDslamLink, CustomLink, Dhcpv4RelayAgentLink, EoamLink, EthernetBridgeLink,

IpForwardingLink, ItagServiceLink, L3ForwardingLink, MplsForwardingLink,
MplsHierarchicalLink, MplsIpv4VpnCeToPeLink, MplsIpv6VpnCeToPeLink,
MplsL2VpnPeToPLink, MplsL3VpnPeToPLink, MVpnGreCeToPeLink, MVpnGrePeToPLink,
VifToVicLink, VlanSwitchLink, VplsBgpCeToPeLink, VplsLdpCeToPeLink, VrfCustomerLink,
VrfProviderLink
Container
(ContainedLink)
EmulatedDevice
LinkDstDevice
(LinkDstDevice)
EmulatedDevice
1458
L4L7GenerateTrafficConfigCommand
L3ForwardingLink Writable Attributes

Writable Attribute
Description
Active, Name
L3ForwardingLink Read-Only Attributes

Read-Only Attribute
Description
LinkType
Name of Link Type.

Type: string
L4L7GenerateTrafficConfigCommand
Description:
Can be used to generate multiple clients and servers.

L4L7GenerateTrafficConfigCommand Writable Attributes

Writable Attribute
Description
GenParams
Handle of L4L7GenerateTrafficConfigParams
Type: handle
Default: 0
OverwriteExistingConfig
Overwrite Existing Config

Type: bool
Default: TRUE
Possible Values:
Value Description
TRUE
Overwrite existing config
FALSE Don't overwrite existing config
L4L7GenerateTrafficConfigCommand Read-Only Attributes

Read-Only Attribute
Description

DstProtocolList
Destination protocol handle list returned by the command.

Type: handle
Default: 0
SrcProtocolList
Source protocol handle list returned by the command.

Type: handle
Default: 0
1459
L4L7GenerateTrafficConfigParams
L4L7GenerateTrafficConfigParams
Description:
Configure endpoint and protocol parameters in the ALP Traffic Wizard.

Parents: Project
Automatically-created children: FtpProtocolParams, HttpProtocolParams, RawTcpProtocolParams, SipCalleeProtocolParams, SipCallerProtocolParams,
VideoProtocolParams
L4L7GenerateTrafficConfigParams Writable Attributes

Writable Attribute
Description
Active, Name
BidirectionalTraffic
Bidirectional traffic.
Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
Create bidirectional traffic.
FALSE Create unidirectional traffic.

DstDeviceList
Destination device list.

Type: handle
Default: 0
EnableFtp
Whether to enable FTP.

Type: bool
Default: TRUE
Possible Values:
Value Description
TRUE
Enable FTP.
FALSE Disable FTP.

EnableHttp
Enable HTTP.
Type: bool
Default: TRUE
Possible Values:
Value Description
TRUE
Enable HTTP.
FALSE Disable HTTP.

EnableRawTcp
Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
FALSE
EnableSip
Whether to enable SIP.

Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
Enable SIP.
FALSE Disable SIP.
1460
LabelBindingGlobalConfig
Writable Attribute
Description
EnableVideo
Whether to enable video.

Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
Enable video.
FALSE Disable video.

EncapsulationType
Encapsulation type.
Type: enum
Default: IPV4
Possible Values:
Value Description
IPV4
IPv4
IPV6
IPv6
VLAN VLAN
SrcDeviceList
Source device list.

Type: handle
Default: 0
L4L7GenerateTrafficConfigParams Read-Only Attributes

LabelBindingGlobalConfig
Description:
Global system configuration for MPLS traffic label binding.

LabelBindingGlobalConfig Writable Attributes

Writable Attribute
Description
Active, Name
EnableTransmitUnresolvedStream
Type: bool
Default: TRUE
Possible Values:
Value Description
TRUE
FALSE
LabelResolutionMode
MPLS Label Resolution Mode.

Type: enum
Default: PER_SESSION_LABEL_RESOLUTION
Possible Values:
Value
Description
PER_SESSION_LABEL_RESOLUTION Label Storage is done in per protocol session base for the same
protocol.
PER_PORT_LABEL_RESOLUTION
1461
Label Storage is done in per port base for the same protocol.
LACP
Writable Attribute
Description
SelectDeactivedTunnelForData
MPLS traffic binding auto selection mode.

Type: bool
Default: TRUE
Possible Values:
Value Description
TRUE
Deactived tunnels are included as part of auto selection.
FALSE Only active tunnel are included as part of auto slection.

SubscriptionInterval
Update Interval from the Chassis to Spirent Test Center Application Application for the label resolution
summary update.
Type: u16
Default: 5
Range: 1 - 3600
LabelBindingGlobalConfig Read-Only Attributes

LACP (lacp:LACP)
Description:
Link Aggregation Control Protocol Data Unit. See IEEE 802.3, clause 43.
Children: None
LACP Attributes
Attribute
Description
actorInformation
Type: TLVType
Default: 01
Possible Values:
Value Description
01
Actor Information
02
Partner Information
03
Collector Information
00
Terminator
actorInformationLength
Type: INTEGER
Default: 20
actorKey
Type: INTEGER
Default: 0001
actorPort
Type: INTEGER
Default: 0001
actorPortPriority
Type: INTEGER
Default: 0001
actorReserved
Type: INTEGER
Default: 000000
actorState
Type: INTEGER
Default: 00
1462
LACP
Attribute
Description
actorSystemId
Type: MACADDR
Default: 00:00:00:00:00:01
actorSystemPriority
Type: INTEGER
Default: 0001
collectorInformation
Type: TLVType
Default: 03
Possible Values:
Value Description
01
Actor Information
02
Partner Information
03
00
Terminator
collectorInformationLength
Type: INTEGER
Default: 16
collectorMaxDelay
Type: INTEGER
Default: 32768
collectorReserved
Type: OCTETSTRING
Name
Type: string
partnerInformation
Type: TLVType
Default: 02
Possible Values:
Value Description
01
Actor Information
02
Partner Information
03
00
Terminator
partnerInformationLength
Type: INTEGER
Default: 20
partnerKey
Type: INTEGER
Default: 0001
partnerPort
Type: INTEGER
Default: 0001
partnerPortPriority
Type: INTEGER
Default: 0001
partnerReserved
Type: INTEGER
Default: 000000
partnerState
Type: INTEGER
Default: 00
partnerSystemId
Type: MACADDR
Default: 00:00:00:00:00:01
partnerSystemPriority
Type: INTEGER
Default: 0001
1463
LacpCreateLagCommand
Attribute
Description
subtype
Type: Subtype
Default: 01
Possible Values:
Value Description
terminatorInformation
01
LACP
02
Marker
Type: TLVType
Default: 0
Possible Values:
Value Description
01
Actor Information
02
Partner Information
03
00
Terminator
terminatorInformationLength
Type: INTEGER
Default: 00
terminatorReserved
Type: OCTETSTRING
version
Type: INTEGER
Default: 01
LacpCreateLagCommand
Description:

Parents: EmulatedDeviceGenParams, HostGenParams, RouterGenParams, Sequencer, StcSystem
LacpCreateLagCommand Writable Attributes

Writable Attribute
Description
ActorKey
Type: u16
Default: 1
ActorKeyStep
Type: u16
Default: 0
ActorPort
Type: u16
Default: 1
ActorPortPriority
Type: u16
Default: 1
ActorPortPriorityStep
Type: u16
Default: 0
ActorPortStep
Type: u16
Default: 1
Range: 1 - 65535
1464
LacpGroupConfig
Writable Attribute
Description
ActorSystemId
Type: mac
Default: 00:00:00:00:00:01
ActorSystemIdStep
Type: mac
Default: 00:00:00:00:00:01
ActorSystemPriority
Type: u16
Default: 1
ActorSystemPriorityStep
Type: u16
Default: 0
LacpActivity
Type: enum
Default: ACTIVE
Possible Values:
Value
Description
PASSIVE
ACTIVE
LacpTimeout
Type: enum
Default: LONG
Possible Values:
Value Description
LONG
SHORT
NumLags
Type: u16
Default: 1
PortList
Type: handle
Default: 0
LacpCreateLagCommand Read-Only Attributes

Read-Only Attribute
Description

LacpGroupConfig
Description:
LACP aggregation group configuration

Parents: Project
Automatically-created children: MacBlock
Relations:
Side name
(Type)
Relative
Description
MembersOfLag
(MemberOfLag)
LacpPortConfig
Identifies the LACP group that contains this port
1465
LacpPortConfig
LacpGroupConfig Writable Attributes

Writable Attribute
Description
Active, Name
ActorSystemId
MAC address of the group. This value is configured in the LACP groups editor.
Type: mac
Default: 00:00:00:00:00:01
ActorSystemPriority
Priority of the group. This value is configured in the LACP groups editor.
Type: u16
Default: 1
LacpGroupConfig Read-Only Attributes

LacpPortConfig
Description:
LACP port configuration

Parents: Port
Result children (automatically created): LacpPortResults
Relations:
Side name
(Type)
Relative
Description
LinkAggregationGroup
(MemberOfLag)
LacpGroupConfig
Identifies the LACP group that contains this port
ResultChild
(ResultChild)
LacpPortResults
UsesIf
(UsesIf)

WimaxIf

LacpPortConfig Writable Attributes

Writable Attribute
Description
Active, Name
ActorKey
The operational key value assigned to the port by the actor

Type: u16
Default: 1
ActorPort
The port number assigned to the port by the actor

Type: u16
Default: 1
ActorPortPriority
The priority assigned to this port by the actor

Type: u16
Default: 1
1466
LacpPortConfig
Writable Attribute
Description
LacpActivity
The activity control value with regard to this link

Type: enum
Default: ACTIVE
Possible Values:
Value
Description
PASSIVE Passive activity - sends LACP PDUs only after receipt of LACP PDUs from partner
ACTIVE
LacpTimeout
Active activity - initiates LACP PDUs
The timeout value with regard to this link

Type: enum
Default: LONG
Possible Values:
Value Description
LONG
Long timeout (90 seconds) sort
SHORT Short timeout (3 seconds)

Use partial block state

Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
Use partial block state
FALSE Do not use partial block state
LacpPortConfig Read-Only Attributes

Read-Only
Attribute
Description
ActorState
The actor state variables for the port, encoded as individual bits
The state bits are encoded as follows:
Bit 0: LACP Activity - this flag indicates the activity control value with regard to this link.
Bit 1: LACP Timeout - this flag indicates the timeout control value with regard to this link.
Bit 2: Aggregation - If true, this flag indicates that the system considers this link to be "aggregatable" (i.e., a potential candidate for aggregation).
If false, this link is considered to be "individual" (i.e., this link can be operated only as an individual link).
Bit 3: Synchronization - If true, the system considers this link to be "in sync" [i.e., it has been allocated to the correct Link Aggregation Group
(LAG), the group has been associated with a compatible aggregator, and the identity of the LAG is consistent with the system ID and operation
key information transmitted]. If false, then this link is currently "out of sync" (i.e., it is not in the right aggregation).
Bit 4: Collecting - If true, it means collection of incoming frames on this link is enabled (i.e., collection is currently enabled and is not expected
to be disabled in the absence of administrative changes or changes in received protocol information). If false, collection of frames is not
enabled.
Bit 5: Distributing - If false, it means the distribution of outgoing frames on this link is disabled (i.e., distribution is currently disabled and is
not expected to be enabled in the absence of administrative changes or changes in received protocol information). If true, distribution of
frames is enabled.
Bit 6: Defaulted - If true, this flag indicates that the actor receive machine is using defaulted operational partner information, administratively
configured for the partner. If false, the operational partner information in use has been received in a LACPDU.
Bit 7: Expired - If true, this flag indicates that the actor receive machine is in the expired state. If false, this flag indicates that the actor receive
machine is not in the expired state.
Type: u8
Default: 0x00
LacpState
Summary information about the LACP peering state

Type: enum
Default: NO_STATE
Possible Values:
Value
Description
NO_STATE The state when the user configuration has not been applied
DOWN
The state when the actor or partner states are defaulted or do not have the collecting and distributing state bits set
EXCHG
The state when LACP sessions are either coming up or negotiating.
UP
The state when the actor and partner states indicate a true value for the collecting and distributing state bits
1467
LacpPortResults
Read-Only
Attribute
Description
PartnerState
The partner state variables for the port, encoded as individual bits.
The state bits are encoded as follows:
Bit 0: LACP Activity - this flag indicates the activity control value with regard to this link.
Bit 1: LACP Timeout - this flag indicates the timeout control value with regard to this link.
Bit 2: Aggregation - If true, this flag indicates that the system considers this link to be "aggregatable" (i.e., a potential candidate for aggregation).
If false, this link is considered to be "individual" (i.e., this link can be operated only as an individual link).
Bit 3: Synchronization - If true, the system considers this link to be "in sync" [i.e., it has been allocated to the correct Link Aggregation Group
(LAG), the group has been associated with a compatible aggregator, and the identity of the LAG is consistent with the system ID and operation
key information transmitted]. If false, then this link is currently "out of sync" (i.e., it is not in the right aggregation).
Bit 4: Collecting - If true, it means collection of incoming frames on this link is enabled (i.e., collection is currently enabled and is not expected
to be disabled in the absence of administrative changes or changes in received protocol information). If false, collection of frames is not
enabled.
Bit 5: Distributing - If false, it means the distribution of outgoing frames on this link is disabled (i.e., distribution is currently disabled and is
not expected to be enabled in the absence of administrative changes or changes in received protocol information). If true, distribution of
frames is enabled.
Bit 6: Defaulted - If true, this flag indicates that the actor receive machine is using defaulted operational partner information, administratively
configured for the partner. If false, the operational partner information in use has been received in a LACPDU.
Bit 7: Expired - If true, this flag indicates that the actor receive machine is in the expired state; if false, this flag indicates that the actor receive
machine is not in the expired state.
Type: u8
Default: 0x00
LacpPortResults
Description:
LACP port result object

Parents: LacpPortConfig
Relations:
Side name
(Type)
Relative
Description
ResultParent
(ResultChild)
LacpPortConfig
LacpPortResults Writable Attributes

LacpPortResults Read-Only Attributes

Read-Only Attribute
Description
ActorOperationalKey
The operational key value assigned to the port by the actor

Type: u16
Default: 0
ActorPort
The port number assigned to the port by the actor

Type: u16
Default: 0
ActorSystemId
The actor system ID, encoded as a MAC address

Type: mac
Default: 00-00-00-00-00-00
1468
LacpResumePdusCommand
Read-Only Attribute
Description
PartnerCollectorMaxDelay
The value of the collector max delay of the partner transmitting the LACPDU
Type: u16
Default: 0
PartnerOperationalKey
The operational key value assigned to the port associated with this link by the partner
Type: u16
Default: 0
PartnerPort
The port number associated with this link assigned to the port by the partner
Type: u16
Default: 0
PartnerPortPriority
The priority assigned to this port by the partner

Type: u16
Default: 0
PartnerSystemId
The partner system ID, encoded as a MAC address

Type: mac
Default: 00-00-00-00-00-00
PartnerSystemPriority
The priority assigned to the partner system

Type: u16
Default: 0
RxLacpPduCount
Number of LACP PDUs received

Type: u64
Default: 0
RxMarkerPduCount
Number of marker PDUs received

Type: u64
Default: 0
RxMarkerResponsePduCount
Number of marker response PDUs received

Type: u64
Default: 0
TxLacpPduCount
Number of LACP PDUs transmitted

Type: u64
Default: 0
TxMarkerPduCount
Number of marker PDUs transmitted

Type: u64
Default: 0
TxMarkerResponsePduCount
Number of marker response PDUs transmitted

Type: u64
Default: 0
LacpResumePdusCommand
Description:
Resume sending LACP PDUs from the selected ports.

1469
LacpStateSummary
LacpResumePdusCommand Writable Attributes

Writable Attribute
Description
LacpList

Type: handle
Default: 0
LacpResumePdusCommand Read-Only Attributes

Read-Only Attribute
Description

LacpStateSummary
Description:
LACP states summarized at port and project level

Relations:
Side name
(Type)
Relative
Description
ResultParent
(ResultChild)
Port, Project
LacpStateSummary Writable Attributes

LacpStateSummary Read-Only Attributes

Read-Only Attribute
Description
DownCount
Number of LACP ports in down state

Type: u32
Default: 0
ExchgCount
Number of LACP ports in exchg state

Type: u32
Default: 0
NotStartedCount
Number of LACP ports in not started state

Type: u32
Default: 0
RouterDownCount
Number of LACP ports in states other than UP

Type: u32
Default: 0
RouterUpCount
Number of LACP ports in up state

Type: u32
Default: 0
1470
LacpStopPdusCommand
Read-Only Attribute
Description
UpCount
Number of LACP ports in up state

Type: u32
Default: 0
LacpStopPdusCommand
Description:
Stop sending LACP PDUs from the selected ports.

LacpStopPdusCommand Writable Attributes

Writable Attribute
Description
LacpList

Type: handle
Default: 0
LacpStopPdusCommand Read-Only Attributes

Read-Only Attribute
Description

lanPruneDelay
Description:
The LAN Prune Delay option in the PIM Hello message. See RFC 3973.
Children: None
lanPruneDelay Attributes
Attribute
Description
length
Type: INTEGER
Default: 4
Name
Type: string
overrideIntervalValue
Type: INTEGER
Default: 0
1471
LastEgressIdent
Attribute
Description
pruneDelayValue
Type: INTEGER
Default: 0
tBit
Type: BITSTRING
Default: 0
type
Type: INTEGER
Default: 2
LastEgressIdent (overloaded)
LastEgressIdent (EOAMTLV)
LastEgressIdent (serviceoam)
LastEgressIdent Object (EOAMTLV PDU library)

Description:
Parents: LTREgrID (StreamBlock.LTREgrID)

Children: None
LastEgressIdent Attributes
Attribute
Description
Index
Type: OCTETSTRING
Default: 0000
MacAddr
Type: MACADDR
Default: 00:00:00:00:00:00
Name
more information.
Type: string
LastEgressIdent Object (serviceoam PDU library)

Description:

Children: None
1472
LatencyHistogram
LastEgressIdent Attributes
Attribute
Description
Index
Type: OCTETSTRING
Default: 0000
MacAddr
Type: MACADDR
Default: 00:00:00:00:00:00
Name
more information.
Type: string
LatencyHistogram
Description:
Latency histogram configuration. Total, minimum, maximum, and average latency, and 16 histogram bin counters can be retrieved from the results.

Relations:
Side name
(Type)
Relative
Description
ActiveParent
(ActiveHistogram)
AnalyzerConfig

object.
LatencyHistogram Writable Attributes

Writable Attribute
Description
Active, Name
BucketSizeList
Type: s64
Default: 0
ConfigMode

Type: enum
Possible Values:
Value
Description
Description

Type: string
Default: (ns)
1473
LBM
Writable Attribute
Description
DistributionMode
mode.
Type: enum
Possible Values:
Value
Description
LEFT_MODE
RIGHT_MODE

CUSTOM_MODE
Type: u32
Default: 1024
LimitList
Type: s64
Default: 0
Type: u32
Default: 8
LatencyHistogram Read-Only Attributes

LBM (EOAM:LBM)
Description:
Children: cfmHeader, MACPreamble, theLBMTLVs
LBM Attributes
Attribute
Description
FirstTLVOffset
Type: OCTETSTRING
Default: 04
Flags
Type: INTEGER
Default: 00000000
LBtID
Type: INTEGER
Default: 0
Name
Type: string
OpCode
Type: OCTETSTRING
Default: 3
1474
LBM
LBM (serviceoam:LBM)
Description:
Children: cfmHeader, theLBMTLVs
LBM Attributes
Attribute
Description
FirstTLVOffset
Type: OCTETSTRING
Default: 04
Flags
Type: INTEGER
Default: 00000000
LBtID
Type: INTEGER
Default: 0
Name
Type: string
OpCode
Type: OCTETSTRING
Default: 3
LBMTLVList
Description:
Parents: theLBMTLVs
Children: DataTLV, EndTLV, OrgSpecTLV, SenderIDTLV
LBMTLVList Attributes
Attribute
Description
Name
information.
Type: string
LBMTLVList
Description:
Parents: theLBMTLVs, theLBRTLVs
Children: DataTLV, EndTLV, OrgSpecTLV, PbbTeMipTLV, SenderIDTLV, TestTLV
1475
LBR
LBMTLVList Attributes
Attribute
Description
Name
information.
Type: string
LBR (EOAM:LBR)
Description:
LBR Attributes
Attribute
Description
FirstTLVOffset
Type: OCTETSTRING
Default: 04
Flags
Type: INTEGER
Default: 00000000
LBtID
Type: INTEGER
Default: 0
Name
Type: string
OpCode
Type: OCTETSTRING
Default: 2
LBR (serviceoam:LBR)
Description:
Children: cfmHeader, theLBRTLVs
LBR Attributes
Attribute
Description
FirstTLVOffset
Type: OCTETSTRING
Default: 04
Flags
Type: INTEGER
Default: 00000000
LBtID
Type: INTEGER
Default: 0
1476
LBRTLVList
Attribute
Description
Name
Type: string
OpCode
Type: OCTETSTRING
Default: 2
LBRTLVList
Description:
Parents:
Children: DataTLV, EndTLV, OrgSpecTLV, SenderIDTLV, TestTLV
LBRTLVList Attributes
Attribute
Description
Name
information.
Type: string
LdpAbortRequestCommand
Description:

LdpAbortRequestCommand Writable Attributes

Writable Attribute
Description
LspList
Type: handle
Default: 0
LdpAbortRequestCommand Read-Only Attributes

Read-Only Attribute
Description

1477
LdpAuthenticationParams
LdpAuthenticationParams
Description:
Specifies all LDP authentication parameters.

Automatically created from: LdpDeviceGenProtocolParams, LdpRouterConfig, LdpSharedSessionParams, VpnMplsLdpSessionParams
LdpAuthenticationParams Writable Attributes

Writable Attribute
Description
Authentication
Specify authentication type.

Type: enum
Default: NONE
Possible Values:
Value
Description
NONE
SIMPLE SIMPLE authentication is used (Not supported for LDP).

MD5
MD5 authentication is used.
Md5KeyId
MD5 Key ID (Not supported for LDP).

Type: u8
Default: 1
Password
Specify the authentication password.

Type: string
Default: Spirent
LdpAuthenticationParams Read-Only Attributes

LdpDeviceGenProtocolParams
Description:
Defines a LDP session parameter object for device generation.

Automatically-created children: LdpAuthenticationParams
LdpDeviceGenProtocolParams Writable Attributes

Writable Attribute
Description
Active, Name
DutIp
DUT IP.
Type: ip
Default: 10.1.1.2
DutIpStep
DUT IP step.
Type: ip
Default: 0.0.0.0
1478
LdpDeviceGenProtocolParams
Writable Attribute
Description
EgressLabel
Specifies the egress label advertised by the emulated peer.

Type: enum
Default: LDP_EGRESS_NEXTAVAILABLE
Possible Values:
Value
Description
LDP_EGRESS_NEXTAVAILABLE Next available.
For each FEC, the LSR advertises the next available label from the min label to
max label pool.
EnableBfd
LDP_EGRESS_IMPLICIT_NULL
Implicit null.
This label value is used in an LDP or RSVP packet to enable penultimate hop
label popping.
LDP_EGRESS_EXPLICIT_NULL
Explicit null.
Explicit null instructions are signaled to the penultimate router by the egress
router.

Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
Enable BFD.
FALSE Disable BFD.

Enables/disables graceful restart (Select to enable.) If enabled, the timer parameters must be set and the
LDPRestartRouterCommand is available in the sequencer.
Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
Enables LDP graceful restart.
FALSE Disables LDP graceful restart.

HelloType
Hello type.
Type: enum
Default: LDP_DIRECTED_HELLO
Possible Values:
Value
Description
LDP_DIRECTED_HELLO
Directed hello.
LDP_TARGETED_HELLO
Targeted hello.
LDP_DIRECTED_AND_TARGETED_HELLO
LabelAdvertisementMode
Type: enum
Default: DOWNSTREAM_UNSOLICITED
Possible Values:
Value
Description
DOWNSTREAM_UNSOLICITED
DOWNSTREAM_ON_DEMAND
LabelMin
Minimum label sent by the emulated router.

Minimum label sent by the emulated router (To optimize test module performance, use label range settings that are
suitable for the test.)
Type: u32
Default: 16
Range: 0 - 1048575
1479
ldpIpv4PrefixSubTlv
Writable Attribute
Description

Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
Enable
FALSE Disable
LdpDeviceGenProtocolParams Read-Only Attributes

ldpIpv4PrefixSubTlv
Description:
Children: None
ldpIpv4PrefixSubTlv Attributes
Attribute
Description
ipv4Prefix
Type: IPV4ADDR
Default: 192.168.1.1
length
Type: INTEGER
Default: 5
Name
Type: string
prefixLength
Type: INTEGER
Default: 24
reserved
Type: ALIGNMENTPAD
Default: 0
type
Type: INTEGER
Default: 1
ldpIpv6PrefixSubTlv
Description:
Children: None
1480
LdpLspResults
ldpIpv6PrefixSubTlv Attributes
Attribute
Description
ipv6Prefix
Type: IPV6ADDR
Default: 2000::1
length
Type: INTEGER
Default: 17
Name
Type: string
prefixLength
Type: INTEGER
Default: 64
reserved
Type: ALIGNMENTPAD
Default: 0
type
Type: INTEGER
Default: 2
LdpLspResults
Description:
LDP LSP results.

Relations:
Side name
(Type)
Relative
Description
ResultParent
(ResultChild)
LdpRouterConfig
LdpLspResults Writable Attributes

LdpLspResults Read-Only Attributes

Read-Only Attribute
Description
Cbit
Type: enum
Default: NA
Possible Values:
Value
Description
NOT_SET
SET
NA
1481
LdpLspResults
Read-Only Attribute
Description
FlowLabelSubTlvFBit
Type: enum
Default: NA
Possible Values:
Value
Description
NOT_SET
SET
NA
LspFecInfo
If the LSP is prefix or host address, the information contains IPv4 address and prefix length. If the LSP is VC, the
information contains VC ID.
Type: string
Default: Fec Info
LspFecType
LSP FEC type.

Type: enum
Possible Values:
Value
Description
LDP_FEC_TYPE_PREFIX
Prefix.
LDP_FEC_TYPE_HOST_ADDR
Host address.
LDP_FEC_TYPE_VC
Virtual circuit.
LDP_FEC_TYPE_GENERALIZED_PWID Generalized PWid (FEC 129).

LspLabel
LSP label value.

Type: u32
Default: 0
LspMode
LSP mode.
Type: enum
Default: LSP_MODE_DU
Possible Values:
Value
Description
LSP_MODE_DU
Downstream unsolicited.
LSP_MODE_DOD Downstream on demand.

LspState
LSP state information (live results only).

Type: enum
Default: LDP_LSP_STATE_NO_STATE
Possible Values:
Value
Description
LDP_LSP_STATE_NO_STATE
No state
LDP_LSP_STATE_DOWN
Down
LDP_LSP_STATE_UP
Up
LDP_LSP_STATE_SIGNALING
Signaling
LDP_LSP_STATE_TEARDOWN Teardown
LspType
LSP type.
Type: enum
Default: LSP_TYPE_EGRESS
Possible Values:
Value
Description
LSP_TYPE_EGRESS Egress
LSP_TYPE_INGRESS Ingress
1482
LdpPseudowireGroupStatusNotificationCommand
Read-Only Attribute
Description
PreferentialForwardingStatusBit
Type: enum
Default: NA
Possible Values:
Value
Description
ACTIVE
STANDBY
NA
LdpPseudowireGroupStatusNotificationCommand
Description:

LdpPseudowireGroupStatusNotificationCommand Writable Attributes

Writable Attribute
Description
CustomStatusCode
Type: u32
Default: 0
GroupIdList
Type: u32
Default: 0
LspType
Type: enum
Default: LDP_LSP_TYPE_ALL
Possible Values:
Value
Description
LDP_LSP_TYPE_ALL
LDP_LSP_TYPE_VC
LDP_LSP_TYPE_GENERALIZED_PWID
RouterList
Type: handle
Default: 0
StatusCode
Type: enum
Default: 0
Possible Values:
Value
Description
NOT_FORWARDING
PSEUDOWIRE_RX_FAULT
PSEUDOWIRE_TX_FAULT
1483
LdpPseudowireStatusNotificationCommand
Writable Attribute
Description
UseCustomStatusCode
Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
FALSE
LdpPseudowireGroupStatusNotificationCommand Read-Only Attributes

Read-Only Attribute
Description

LdpPseudowireStatusNotificationCommand
Description:

LdpPseudowireStatusNotificationCommand Writable Attributes

Writable Attribute
Description
CustomStatusCode
Type: u32
Default: 0
LspList
Type: handle
Default: 0
StatusCode
Type: enum
Default: 0
Possible Values:
Value
Description
NOT_FORWARDING
PSEUDOWIRE_RX_FAULT
PSEUDOWIRE_TX_FAULT
UseCustomStatusCode
Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
FALSE
1484
LdpReadvertiseLspCommand
LdpPseudowireStatusNotificationCommand Read-Only Attributes

Read-Only Attribute
Description

LdpReadvertiseLspCommand
Description:

LdpReadvertiseLspCommand Writable Attributes

Writable Attribute
Description
LspList
Type: handle
Default: 0
LdpReadvertiseLspCommand Read-Only Attributes

Read-Only Attribute
Description

LdpReadvertisePseudowireGroupCommand
Description:
Readvertise LSPs associated with a Pseudowire group.

LdpReadvertisePseudowireGroupCommand Writable Attributes

Writable Attribute
Description
GroupIdList
List of Group ID associated with the selected LSP type to readvertise.

Type: u32
Default: 0
1485
LdpRequestLabelCommand
Writable Attribute
Description
LspType
LSP type associated with the specified Group IDs to readvertise.

Type: enum
Possible Values:
Value
Description
LDP_LSP_TYPE_ALL
Readvertise both VC and Generalized PWid LSPs.
LDP_LSP_TYPE_VC
Readvertise VC LSPs.
LDP_LSP_TYPE_GENERALIZED_PWID Readvertise Generalized PWid LSPs.

RouterList
List of routers to readvertise the LSPs.

Type: handle
Default: 0
LdpReadvertisePseudowireGroupCommand Read-Only Attributes

Read-Only Attribute
Description

LdpRequestLabelCommand
Description:

LdpRequestLabelCommand Writable Attributes

Writable Attribute
Description
LspList
Type: handle
Default: 0
LdpRequestLabelCommand Read-Only Attributes

Read-Only Attribute
Description

LdpRestartRouterCommand
Description:
Performs the LDP graceful restart from the list of routers.
1486
LdpResumeHellosCommand

LdpRestartRouterCommand Writable Attributes

Writable Attribute
Description
RouterList
List of LDP router that the command is executed on.

Type: handle
Default: 0
LdpRestartRouterCommand Read-Only Attributes

Read-Only Attribute
Description

LdpResumeHellosCommand
Description:
Resumes hellos on selected LDP router(s).

LdpResumeHellosCommand Writable Attributes

Writable Attribute
Description
RouterList

Type: handle
Default: 0
LdpResumeHellosCommand Read-Only Attributes

Read-Only Attribute
Description

LdpResumeKeepAlivesCommand
Description:
Resumes sending keepalives from the list of routers.

1487
LdpRouterConfig
LdpResumeKeepAlivesCommand Writable Attributes

Writable Attribute
Description
RouterList

Type: handle
Default: 0
LdpResumeKeepAlivesCommand Read-Only Attributes

Read-Only Attribute
Description

LdpRouterConfig
Description:
Defines an LDP emulated router object.

Children: GeneralizedPwidLsp, Ipv4IngressPrefixLsp, Ipv4PrefixLsp, VcLsp
Result children (automatically created): LdpLspResults, LdpRouterResults
Relations:
Side name
(Type)
Relative
Description
(ResolvesInterface)


ResultChild
(ResultChild)
LdpLspResults, LdpRouterResults
LdpRouterConfig Writable Attributes

Writable Attribute
Description
DirectedHelloInterval
Type: u16
Default: 5
Range: 1 - 21845
DutIp
Session DUT IP address. Each LDP session must have a DUT IP address. This IPv4 address is used as the
peer address of the emulated LDP session.
DUT IP address is not the same as tester IP. This is used to set up the DUT IP. For a direct LDP session, it can
be either the DUT loopback address or its interface address directly connected to Spirent TestCenter. For a
target LDP session, it must be the DUT router ID (usually a loopback address).
Type: ip
Default: null
1488
LdpRouterConfig
Writable Attribute
Description
EgressLabel
Specifies the egress label advertised by the emulated peer.

Type: enum
Possible Values:
Value
Description
LDP_EGRESS_NEXTAVAILABLE Next available.
For each FEC, the LSR advertises the next available label from the min
label to max label pool.
EnableBfd
Implicit null.
This label value is used in an LDP or RSVP packet to enable penultimate
hop label popping.
Explicit null.
Explicit null instructions are signaled to the penultimate router by the egress
router.
Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
Enable BFD.
FALSE Disable BFD.

Enables/disables graceful restart. (Select to enable.) If enabled, the timer parameters must be set and the
LDPRestartRouterCommand is available in the sequencer.
Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
Enables LDP graceful restart.
FALSE Disables LDP graceful restart.

EnableLspResults
Enable LSP results.

Type: bool
Default: TRUE
Possible Values:
Value Description
TRUE
Enable LSP results.
FALSE Disable LSP results.

EnableStatefulPseudowireLspResults
Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
FALSE
GeneralizedPwidLspLabelBindingMode
Type: enum
Default: TX_AND_RX
Possible Values:
Value
Description
TX_AND_RX
TX_ONLY
RX_ONLY
NONE
1489
LdpRouterConfig
Writable Attribute
Description
HelloInterval
not use it.
Hello interval.
Type: u16
Default: 5
Range: 1 - 21845
HelloType
Type of hello packet transmitted by the emulated peer.

Type: enum
Possible Values:
Value
Description
LDP_DIRECTED_HELLO
Directed hello.
LDP_TARGETED_HELLO
Targeted hello.
LDP_DIRECTED_AND_TARGETED_HELLO
KeepAliveInterval
Keepalive time (in seconds) proposed in the initialization message sent by the peer.
Type: u16
Default: 60
Range: 1 - 21845
Specifies the Label Advertisement Mode for the LDP router.

Type: enum
Possible Values:
Value
Description
LabelMin
Minimum label sent by the emulated router (To optimize test module performance, use label range settings that
are suitable for the test.)
Type: u32
Default: 16
Range: 0 - 1048575
LabelRequestRetryCount
Specifies the number of times Label Request Message should be sent for the configured Ingress LSPs. Applicable
only when Label Advertisement Mode is Downstream-on-Demand.
Type: u16
Default: 10
LabelRequestRetryInterval
Specifies the interval in seconds between consecutive Label Request Messages sent for the configured Ingress
LSPs. Applicable only when Label Advertisement Mode is Downstream-on-Demand.
Type: u16
Default: 30
LivenessTime
Type: u16
Default: 360
Range: 120 - 600
PrefixLspLabelBindingMode
Label binding mode for Prefix FEC type.

Type: enum
Default: TX_AND_RX
Possible Values:
Value
Description
TX_AND_RX Labels received by Spirent TestCenter and advertised by it are used for traffic binding.
TX_ONLY
Only labels advertised by Spirent TestCenter are used for traffic binding.
RX_ONLY
Only labels received by Spirent TestCenter are used for traffic binding.
NONE
No labels are used for traffic binding.
1490
LdpRouterConfig
Writable Attribute
Description
PseudowireRedundancyMode
Type: enum
Default: PSEUDOWIRE_REDUNDANCY_MODE_NONE
Possible Values:
Value
Description
PSEUDOWIRE_REDUNDANCY_MODE_NONE
PSEUDOWIRE_REDUNDANCY_MODE_INDEPENDENT
PSEUDOWIRE_REDUNDANCY_MODE_MASTER
PSEUDOWIRE_REDUNDANCY_MODE_SLAVE
ReconnectTime
Reconnect time. Applicable only when graceful restart is enabled.

Type: u32
Default: 60
Range: 0 - 4294967
RecoveryTime
Recovery time. Applicable only when graceful restart is enabled.

Type: u32
Default: 140
Range: 0 - 4294967
TargetedHelloInterval
Type: u16
Default: 5
Range: 1 - 21845
TransportTlvMode
Transport TLV mode.

Type: enum
Default: TRANSPORT_TLV_MODE_TESTER_IP
Possible Values:
Value
Description
TRANSPORT_TLV_MODE_NONE
None.
TRANSPORT_TLV_MODE_TESTER_IP Emulated router interface address.

TRANSPORT_TLV_MODE_ROUTER_ID Emulated router ID.
UseStaticFlowLabel
Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
FALSE
VcLspLabelBindingMode
Label Binding Mode for VC FEC type.

Type: enum
Default: TX_AND_RX
Possible Values:
Value
Description
TX_AND_RX Labels received by Spirent TestCenter and advertised by it are used for traffic binding.
TX_ONLY
Only labels advertised by Spirent TestCenter are used for traffic binding.
RX_ONLY
Only labels received by Spirent TestCenter are used for traffic binding.
NONE
No labels are used for traffic binding.
LdpRouterConfig Read-Only Attributes

Read-Only Attribute
Description
LabelSpaceId
Platform-wide label space ID (read only) Only a platform label space of 0 is supported.
Type: u16
Default: 0
LearnedLabelCount
Number of learned labels.

Type: u32
Default: 0
1491
LdpRouterResults
Read-Only Attribute
Description
ResolvedLabelCount
Number of resolved labels.

Type: u32
Default: 0
RouterState
LDP router state.

Type: enum
Default: LDP_SESSION_STATE_NO_STATE
Possible Values:
Value
Description
LDP_SESSION_STATE_NO_STATE No state
LDP_SESSION_STATE_DOWN
Down
LDP_SESSION_STATE_UP
Up
LDP_SESSION_STATE_FAILED
Failed
LDP_SESSION_STATE_OPEN
Open
LDP_SESSION_STATE_CONNECT
Connect
LDP_SESSION_STATE_RESTART
Restart
LDP_SESSION_STATE_HELPER
Helper
Number of unresolved labels.

Type: u32
Default: 0
LdpRouterResults
Description:
LDP router results.

Relations:
Side name
(Type)
Relative
Description
ResultParent
(ResultChild)
LdpRouterConfig
LdpRouterResults Writable Attributes

LdpRouterResults Read-Only Attributes

Read-Only Attribute
Description
LspUpCount
Number of LSPs in the up state.

Type: u64
Default: 0
NumLspDownCount
Number of LSPs in the down state.

Type: u64
Default: 0
RxAddrWithdrawCount
Number of Address Withdraw messages received.

Type: u64
Default: 0
1492
LdpRouterResults
Read-Only Attribute
Description
RxDirectHellosCount
Number of direct hellos received.

Type: u64
Default: 0
RxKeepAliveCount
Number of keepalives received.

Type: u64
Default: 0
RxLabelAbortCount
Number of label abort requests received.

Type: u64
Default: 0
RxLabelMappingCount
Number of label mapping messages received.

Type: u64
Default: 0
RxLabelReleaseCount
Number of label release messages received.

Type: u64
Default: 0
RxLabelRequestsCount
Number of label requests received.

Type: u64
Default: 0
RxLabelWithdrawCount
Number of label withdraw messages received.

Type: u64
Default: 0
RxNotificationCount
Number of notification messages received.

Type: u64
Default: 0
1493
LdpRouterResults
Read-Only Attribute
Description
RxNotifyCode
Notification code received in string format (This is the last notification code that the emulated router received from the
DUT.)
Type: enum
Default: LDP_NOTIFY_CODE_SUCCESS
Possible Values:
Value
Description
LDP_NOTIFY_CODE_SUCCESS
Success.
LDP_NOTIFY_CODE_BAD_LDP_IDENTIFIER
Bad LDP identifier.
LDP_NOTIFY_CODE_BAD_PROTOCOL_VERSION
Bad protocol version.
LDP_NOTIFY_CODE_BAD_PDU_LENGTH
Bad PDU length.
LDP_NOTIFY_CODE_UNKNOWN_MSG_TYPE
Unknown message type.
LDP_NOTIFY_CODE_BAD_MESSAGE_LENGTH
Bad message length.
LDP_NOTIFY_CODE_UNKNOWN_TLV
Unknown TLV.
LDP_NOTIFY_CODE_BAD_TLV_LENGTH
Bad TLV length.
LDP_NOTIFY_CODE_MALFORMED_TLV_VALUE
Malformed TLV value.
LDP_NOTIFY_CODE_HOLD_TIMER_EXPIRED
Hold timer expired.
LDP_NOTIFY_CODE_SHUTDOWN
Shutdown.
LDP_NOTIFY_CODE_LOOP_DETECTED
Loop detected.
LDP_NOTIFY_CODE_UNKNOWN_FEC
Unknown FEC.
LDP_NOTIFY_CODE_NO_ROUTE
No route.
LDP_NOTIFY_CODE_NO_LABEL_RESOURCES
No label resources.
LDP_NOTIFY_CODE_LABEL_RESOURCE_AVAILABLE Label resources available.

LDP_NOTIFY_CODE_REJECTED_16
Session rejected or no hello.
Session rejected or parameters advertisement mode.
Session rejected or parameters max PDU length.
Session rejected or parameters label range.
LDP_NOTIFY_CODE_KEEPAILVE_TIMER_EXPIRED
Keepalive timer expired.
LDP_NOTIFY_CODE_LABEL_REQUEST_ABORTED
Label request aborted.
LDP_NOTIFY_CODE_MISSING_MSG_PARAM
Missing message parameters.
LDP_NOTIFY_CODE_UNKNOWN_ADDR_FAMILY
Unsupported address family.
Session rejected or bad keepalive time.
LDP_NOTIFY_CODE_INTERNAL_ERROR
Internal error.
RxTargetedHellosCount
Number of targeted hellos received.

Type: u64
Default: 0
TxAddrWithdrawCount
Number of Address Withdraw messages sent.

Type: u64
Default: 0
TxDirectHellosCount
Number of direct hellos sent.

Type: u64
Default: 0
TxKeepAliveCount
Number of keepalives sent.

Type: u64
Default: 0
TxLabelAbortCount
Number of label abort requests sent.

Type: u64
Default: 0
TxLabelMappingCount
Number of label mapping messages sent.

Type: u64
Default: 0
1494
LdpRouterResults
Read-Only Attribute
Description
TxLabelReleaseCount
Number of label release messages sent.

Type: u64
Default: 0
TxLabelRequestsCount
Number of label requests sent.

Type: u64
Default: 0
TxLabelWithdrawCount
Number of label withdraw messages sent.

Type: u64
Default: 0
TxNotificationCount
Number of notification messages sent.

Type: u64
Default: 0
TxNotifyCode
Notification code sent in string format (This is the last notification code that the emulated router sent to the DUT.)
Type: enum
Default: LDP_NOTIFY_CODE_SUCCESS
Possible Values:
Value
Description
LDP_NOTIFY_CODE_SUCCESS
Success.
LDP_NOTIFY_CODE_BAD_LDP_IDENTIFIER
Bad LDP identifier.
LDP_NOTIFY_CODE_BAD_PROTOCOL_VERSION
Bad protocol version.
LDP_NOTIFY_CODE_BAD_PDU_LENGTH
Bad PDU length.
LDP_NOTIFY_CODE_UNKNOWN_MSG_TYPE
Unknown message type.
LDP_NOTIFY_CODE_BAD_MESSAGE_LENGTH
Bad message length.
LDP_NOTIFY_CODE_UNKNOWN_TLV
Unknown TLV.
LDP_NOTIFY_CODE_BAD_TLV_LENGTH
Bad TLV length.
LDP_NOTIFY_CODE_MALFORMED_TLV_VALUE
Malformed TLV value.
LDP_NOTIFY_CODE_HOLD_TIMER_EXPIRED
Hold timer expired.
LDP_NOTIFY_CODE_SHUTDOWN
Shutdown.
LDP_NOTIFY_CODE_LOOP_DETECTED
Loop detected.
LDP_NOTIFY_CODE_UNKNOWN_FEC
Unknown FEC.
LDP_NOTIFY_CODE_NO_ROUTE
No route.
LDP_NOTIFY_CODE_NO_LABEL_RESOURCES
No label resources.
LDP_NOTIFY_CODE_LABEL_RESOURCE_AVAILABLE Label resources available.
TxTargetedHellosCount
Session rejected or no hello.
Session rejected or parameters advertisement mode.
Session rejected or parameters max PDU length.
Session rejected or parameters label range.
LDP_NOTIFY_CODE_KEEPAILVE_TIMER_EXPIRED
Keepalive timer expired.
LDP_NOTIFY_CODE_LABEL_REQUEST_ABORTED
Label request aborted.
LDP_NOTIFY_CODE_MISSING_MSG_PARAM
Missing message parameters.
LDP_NOTIFY_CODE_UNKNOWN_ADDR_FAMILY
Unsupported address family.
Session rejected or bad keepalive time.
LDP_NOTIFY_CODE_INTERNAL_ERROR
Internal error.
Number of targeted hellos sent.

Type: u64
Default: 0
1495
LdpSharedSessionParams
LdpSharedSessionParams
Description:
LDP shared session parameters used by routing wizards.

LdpSharedSessionParams Writable Attributes

Writable Attribute
Description
Active, Name
EgressLabel
Egress label advertised by the emulated peer.

Type: enum
Possible Values:
Value
Description
LDP_EGRESS_NEXTAVAILABLE For each FEC, the LSR advertises the next available label starting from Min Label.
EnableBfd
This label value (3) is used in an LDP or RSVP packet to enable penultimate hop
label popping. The egress LSR signals a request to its upstream neighbor to pop
the top label in the stack and forward the rest of the packet. This value does not
appear in the encapsulation.
A zero (IPv4 datagram) or 2 (IPv6 datagram) MPLS label value indicates to the
penultimate router that it is to pop the label upon receipt and forward the IP packet
to the egress router for Layer 3 forwarding. Explicit null instructions are signaled to
the penultimate router by the egress router.
Enable BFD on this router. Creates a session with IP addressing matching this router.
Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
Enable
FALSE Disable
Select to enable Graceful Restart. If enabled, the timer parameters must be set and the LdpRestartRouterCommand is
available in the Command Sequencer.
Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
Enable
FALSE Disable
HelloInterval
Hello Interval (seconds).

Type: u16
Default: 5
Range: 1 - 21845
HelloType
Type of Hello packet transmitted by the emulated peer.

Type: enum
Possible Values:
Value
Description
LDP_DIRECTED_HELLO A Basic Discovery mechanism. Used to locate directly-connected neighbors. Peer IP address
is DUT interface address.
LDP_TARGETED_HELLO An Extended Discovery mechanism. Used to locate neighbors not directly connected. Peer
IP address is DUT loopback address.
KeepAliveInterval
Time interval used by the peer for Hello packet transmission.

Type: u16
Default: 60
Range: 1 - 21845
1496
LdpStateSummary
Writable Attribute
Description
Type: enum
Possible Values:
Value
Description
LabelMin
Minimum label sent by the emulated router.

Type: u32
Default: 16
Range: 0 - 1048575
ReconnectTime
Reconnect Time. Applicable only when Graceful Restart is enabled.

Type: u32
Default: 60
Range: 0 - 4294967
RecoveryTime
Recovery Time. Applicable only when Graceful Restart is enabled.

Type: u32
Default: 140
Range: 0 - 4294967
TransportTlvMode
Transport TLV mode.

Type: enum
Default: TRANSPORT_TLV_MODE_TESTER_IP
Possible Values:
Value
Description
TRANSPORT_TLV_MODE_NONE
Transport address TLV will not be included in LDP Hellos.
TRANSPORT_TLV_MODE_TESTER_IP Emulated router interface address.

TRANSPORT_TLV_MODE_ROUTER_ID Emulated router ID.
LdpSharedSessionParams Read-Only Attributes

LdpStateSummary
Description:
Summary of all router states per port and per project.

Relations:
Side name
(Type)
Relative
Description
ResultParent
(ResultChild)
Port, Project
LdpStateSummary Writable Attributes

1497
LdpStopHellosCommand
LdpStateSummary Read-Only Attributes

Read-Only Attribute
Description
NotStartedCount
Number of routers in not started state.

Type: u32
Default: 0
RouterDownCount
Number of routers in any state other than SessionUp.

Type: u32
Default: 0
RouterUpCount
Number of routers in the Up state. SessionUp state is considered the UP state.

Type: u32
Default: 0
SessionConnectCount
Number of routers in SessionConnect state.

Type: u32
Default: 0
SessionDownCount
Number of routers in SessionDown state.

Type: u32
Default: 0
SessionFailedCount
Number of routers in SessionFailed state.

Type: u32
Default: 0
SessionHelperCount
Number of routers in SessionHelper state.

Type: u32
Default: 0
SessionOpenCount
Number of routers in SessionOpen state.

Type: u32
Default: 0
SessionRestartCount
Number of routers in SessionRestart state.

Type: u32
Default: 0
SessionUpCount

Type: u32
Default: 0
LdpStopHellosCommand
Description:
Stops hellos on selected LDP router(s).

LdpStopHellosCommand Writable Attributes

Writable Attribute
Description
1498
LdpStopKeepAlivesCommand
Writable Attribute
Description
RouterList

Type: handle
Default: 0
LdpStopHellosCommand Read-Only Attributes

Read-Only Attribute
Description

LdpStopKeepAlivesCommand
Description:
Stops sending keepalives from the list of routers.

LdpStopKeepAlivesCommand Writable Attributes

Writable Attribute
Description
RouterList

Type: handle
Default: 0
LdpStopKeepAlivesCommand Read-Only Attributes

Read-Only Attribute
Description

LdpWithdrawLspCommand
Description:

LdpWithdrawLspCommand Writable Attributes

Writable Attribute
Description
1499
LdpWithdrawMacAddrCommand
Writable Attribute
Description
LspList
Type: handle
Default: 0
LdpWithdrawLspCommand Read-Only Attributes

Read-Only Attribute
Description

Description:
Withdraw MAC addresses associated with LDP signalled VPLSs.

LdpWithdrawMacAddrCommand Writable Attributes

Writable Attribute
Description
AttachmentGroupId
Start value for Attachment Group Identifier (AGI) for Custom Generalized PWid LSPs.
Type: string
Default: 100:1
Attachment Group Identifier (AGI) increment for Custom Generalized PWid LSPs.
Type: string
Default: 0:1
CustomEncap
Custom encapsulation value.

Type: u16
Default: 4
Range: 0 - 32767
1500
Writable Attribute
Description
Encap
Encapsulation type.
Type: enum
Default: LDP_LSP_ENCAP_ETHERNET_VLAN
Possible Values:
Value
Description
LDP_LSP_ENCAP_FRAME_RELAY_DLCI
Frame relay DLCI.
LDP_LSP_ENCAP_ATM_AAL5_VCC
ATM AAL5 SDU VCC transport.
LDP_LSP_ENCAP_ATM_TRANSPARENT_CELL
ATM transparent cell transport.
LDP_LSP_ENCAP_ETHERNET_VLAN
Ethernet VLAN.
LDP_LSP_ENCAP_ETHERNET
Ethernet.
LDP_LSP_ENCAP_HDLC
HDLC.
LDP_LSP_ENCAP_PPP
PPP.
LDP_LSP_ENCAP_CEM
SONET/SDH Circuit Emulation Service

Over MPLS.
LDP_LSP_ENCAP_ATM_VCC
ATM n-to-one VCC cell transport.
LDP_LSP_ENCAP_ATM_VPC
ATM n-to-one VPC cell transport.
LDP_LSP_ENCAP_ETHERNET_VPLS
ETHERNET VPLS.
LDP_LSP_ENCAP_ATM_VCC_ONE_TO_ONE
ATM one-to-one VCC Cell Mode.
LDP_LSP_ENCAP_ATM_VPC_ONE_TO_ONE
ATM one-to-one VPC Cell Mode.
LDP_LSP_ENCAP_ATM_AAL5_PDU_VCC
ATM AAL5 PDU VCC transport.
LDP_LSP_ENCAP_FRAME_RELAY_PORT
Frame-Relay Port mode.
LDP_LSP_ENCAP_SONET_SDH_OVER_PKT
SONET/SDH Circuit Emulation over

Packet.
LDP_LSP_ENCAP_CES_OVER_PSN_BASIC
CESoPSN basic mode.
TDMoIP AAL1 Mode .
LDP_LSP_ENCAP_CES_OVER_PSN_TDM_CAS
CESoPSN TDM with CAS.
TDMoIP AAL2 Mode.
LDP_LSP_ENCAP_FRAME_RELAY_DLCI_NEW_BIT_ORDERING Frame Relay DLCI.

LDP_LSP_ENCAP_ROHC_HEADER_COMPRESSED_PKT
ROHC Transport Header-compressed

Packets.
LDP_LSP_ENCAP_ECRTP_HEADER_COMPRESSED_PKT
ECRTP Transport Header-compressed

Packet.
LDP_LSP_ENCAP_IPHC_HEADER_COMPRESSED_PKT
IPHC Transport Header-compressed

Packets.
LDP_LSP_ENCAP_CRTP_HEADER_COMPRESSED_PKT
cRTP Transport Header-compressed

Packets.
LDP_LSP_ENCAP_ATM_VP_VIRTUAL_TRUNK
ATM VP Virtual Trunk.
LDP_LSP_ENCAP_RESERVED
Reserved.
LDP_LSP_ENCAP_WILDCARD
Wildcard.
GroupId
Group ID for Custom VC LSPs.

Type: u32
Default: 0
LspCount
Number of Custom LSPs on which MAC addresses are to be withdrawn.

Type: u32
Default: 1
Range: 1 - 4294967295
1501
Writable Attribute
Description
LspType
Mode for specifying LSPs for which MAC addresses are withdrawn.
Type: enum
Default: LDP_LSP_TYPE_CONFIGURED_LSPS
Possible Values:
Value
Description
LDP_LSP_TYPE_CONFIGURED_LSPS
Send a MAC withdraw message for selected LSPs.
LDP_LSP_TYPE_CUSTOM_VC
Send a user-configured FEC 128 MAC withdraw

message for selected devices.
LDP_LSP_TYPE_CUSTOM_GENERALIZED_PWID Send a user-configured FEC 129 MAC withdraw

message for selected devices.
MacAddrCount
Number of addresses to withdraw using the MAC address range values.

Type: u32
Default: 1
Range: 1 - 5000
MacAddrInputFormat
Input format for MAC addresses to be withdrawn.

Type: enum
Default: MAC_ADDR_ALL
Possible Values:
Value
Description
MAC_ADDR_ALL
Withdraw all MAC addresses associated with the LSPs. This option would
use an empty MAC TLV.
MAC_ADDR_CUSTOM_RANGE Specify a Custom Range of MAC addresses.

MAC_ADDR_CUSTOM_TABLE
Specify a list of MAC addresses.
MacAddrStep
Step value for the MAC addresses in the custom MAC range.
Type: mac
Default: 00:00:00:00:00:01
MacList
List of MAC addresses to withdraw.

Type: mac
Default: 00-00-00-00-00-01
ObjectList
ObjectList specifies list of LSPs for LspType of configured LSPs. ObjectList specifies list of routers for LspType
of Custom VC or Custom Generalized PWid LSPs.
Type: handle
Default: 0
Start value for Source Attachment Individual Identifier (SAII) for Custom Generalized PWid LSPs.
Type: string
Default: 192.0.0.1
Source Attachment Individual Identifier (SAII) increment for Custom Generalized PWid LSPs.
Type: string
Default: 0.0.0.1
StartMacAddr
Start value for the MAC addresses in the custom MAC range.
Type: mac
Default: 00:10:94:00:00:02
StartVcId
Start VC ID for Custom VC LSPs.

Type: u32
Default: 1
Start value for Target Attachment Individual Identifier (TAII) for Custom Generalized PWid LSPs.
Type: string
Default: 192.0.0.1
Target Attachment Individual Identifier (TAII) increment for Custom Generalized PWid LSPs.
Type: string
Default: 0.0.0.1
1502
LdpWithdrawPseudowireGroupCommand
Writable Attribute
Description
UseCustomEncap
Use or do not use custom encapsulation for the custom LSPs.

Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
Use custom encapsulation for the custom LSPs.
FALSE Do not use custom encapsulation for the custom LSPs.

VcIdIncrement
VC ID increment for Custom VC LSPs.

Type: u32
Default: 1
LdpWithdrawMacAddrCommand Read-Only Attributes

Read-Only Attribute
Description

LdpWithdrawPseudowireGroupCommand
Description:
Perform a pseudowire group withdraw for specified pseudowire Group IDs and LSP type(s).

LdpWithdrawPseudowireGroupCommand Writable Attributes

Writable Attribute
Description
GroupIdList
List of Group IDs to withdraw for the selected LSP types.

Type: u32
Default: 0
LspType
LSP type for the pseudowire group withdraw.

Type: enum
Possible Values:
Value
Description
LDP_LSP_TYPE_ALL
Withdraw pseudowire group for both VC and Generalized PWid LSP.
LDP_LSP_TYPE_VC
Withdraw pseudowire group for VC LSP.
LDP_LSP_TYPE_GENERALIZED_PWID Withdraw pseudowire group for Generalized PWid LSP.

RouterList
List of LDP routers to perform the pseudowire group withdraw on.

Type: handle
Default: 0
1503
LE
LdpWithdrawPseudowireGroupCommand Read-Only Attributes

Read-Only Attribute
Description

LE
Description:
Parents: EventOAMPDUTLVList
Children: None
LE Attributes
Attribute
Description
ErrorRT
Type: OCTETSTRING
Default: 0000000000000000
Errors
Type: OCTETSTRING
Default: 0000000000000000
EventLength
Type: OCTETSTRING
Default: 00
EventRT
Type: OCTETSTRING
Default: 00000000
EventTimeStamp
Type: INTEGER
Default: 0
EventType
Type: LEEventType
Default: 00
Possible Values:
Value Description
00
End of TLV Marker
01
Errored Symbol Period Event
02
Errored Frame Event
03
Errored Frame Period Event
04
Errored Frame Seconds Summary Event
05
Reserved
FE
Organization Specific Event
FF
Reserved
Name
Type: string
Threshold
Type: OCTETSTRING
Default: 0000000000000000
Window
Type: OCTETSTRING
Default: 0000000000000000
1504
leaseTime
leaseTime
Description:
DHCP IP address lease time
Parents: DHCPOption
Children: None
leaseTime Attributes
Attribute
Description
leaseTime
Type: INTEGER
Default: 0
length
Type: OCTETSTRING
Default: 04
Name
Type: string
type
Type: OCTETSTRING
Default: 33
Length
Description:
Parents: lengths
Children: None
Length Attributes
Attribute
Description
Name
more information.
Type: string
value
Type: INTEGER
Default: 0
lengths
Description:
Parents: L2TPv2
Children: Length
1505
LI
lengths Attributes
Attribute
Description
Name
information.
Type: string
LI
Description:
Parents: InfoOAMPDUTLVList
Children: Configuration, OAMPDUConfiguration, State
LI Attributes
Attribute
Description
InfoLength
Type: OCTETSTRING
Default: 10
InfoRevision
Type: OCTETSTRING
Default: 0000
InfoType
Type: OCTETSTRING
Default: 01
InfoVersion
Type: OCTETSTRING
Default: 01
Name
Type: string
OUI
Type: OCTETSTRING
Default: 000000
VSI
Type: OCTETSTRING
Default: 00000000
LicenseCheckCommand
Description:
Command to check if one or more chassis contains a valid license for a specified feature.

1506
LicenseDeleteFileCommand
LicenseCheckCommand Writable Attributes

Writable Attribute
Description
ChassisList
List of one or more chassis objects to check out a feature license for.
Type: handle
Default: 0
EquipmentList
List of one or more chassis or test module objects to check out a feature license for.
Type: handle
Default: 0
FeatureName
Feature to check out a license for(for example, "0001_PACKET_GEN_ANALYZER_BPK_A").

Type: string
ModuleType
Module type to check for in the feature license(for example, "2000").

Type: string
PerformanceLevel
Performance level to check for in the feature license(for example, "C").

Type: string
LicenseCheckCommand Read-Only Attributes

Read-Only Attribute
Description

IsLicensedList
Status indicating if the license check passed/failed for each chassis or test module specified.
Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
A valid license exists for the specified feature and is currently checked out.
FALSE A valid license exists for the specified feature and is currently checked out.
LicenseDeleteFileCommand
Description:
Delete the current license file on one or more chassis.

LicenseDeleteFileCommand Writable Attributes

Writable Attribute
Description
ChassisList
List of one or more chassis to delete the current license file from.
Type: handle
Default: 0
1507
LicenseDownloadFileCommand
LicenseDeleteFileCommand Read-Only Attributes

Read-Only Attribute
Description

LicenseDownloadFileCommand
Description:
Command to install a license on a chassis.

LicenseDownloadFileCommand Writable Attributes

Writable Attribute
Description
ChassisList
Chassis to install the license on.

Type: handle
Default: 0
FileName
License file to install.

Type: inputFilePath
LicenseDownloadFileCommand Read-Only Attributes

Read-Only Attribute
Description

LicenseSetAPIVersionCommand
Description:
Currently not supported.

LicenseSetAPIVersionCommand Writable Attributes

Writable Attribute
Description
1508
LicenseShowCommand
Writable Attribute
Description
Version
Version.
Type: string
LicenseSetAPIVersionCommand Read-Only Attributes

Read-Only Attribute
Description

LicenseShowCommand
Description:
Command to query a chassis for licensing information.

LicenseShowCommand Writable Attributes

Writable Attribute
Description
ChassisList
Chassis to query licensing information for.

Type: handle
Default: 0
LicenseShowCommand Read-Only Attributes

Read-Only Attribute
Description

LicenseCheckDate
License date based version(DBV) required by the application.

Type: string
LicenseEntryList
Information about each feature in the chassis license file.

Type: string
LicenseUploadFileCommand
Description:
Upload license file(s) from one or more chassis.
1509
LinkAggregationTlv

LicenseUploadFileCommand Writable Attributes

Writable Attribute
Description
ChassisList
List of one or more chassis to upload a license file from.

Type: handle
Default: 0
DstDir
Destination directory to uploaded the license file(s) to. The chassis IP address/hostname will be included
in the license filename(for example, "10_0_0_1.lic").
LicenseUploadFileCommand Read-Only Attributes

Read-Only Attribute
Description

LinkAggregationTlv (lldp:LinkAggregationTlv)
Description:
Children: aggregationStatus
lldp:NivSupportTlv
LinkAggregationTlv Attributes
Attribute
Description
aggregatedPortid
Type: OCTETSTRING
Default: 0000000E
length
Type: INTEGER
Default: 0
Name
Type: string
oui
Type: OCTETSTRING
Default: 00120F
subtype
Type: OCTETSTRING
Default: 03
type
Type: INTEGER
Default: 127
1510
LinkCreateCommand
LinkCreateCommand
Description:

LinkCreateCommand Writable Attributes

Writable Attribute
Description
DstDev
Type: handle
Default: 0
DstIf
Type: handle
Default: 0
LinkType
Type: string
SrcDev
Type: handle
Default: 0
SrcIf
Type: handle
Default: 0
LinkCreateCommand Read-Only Attributes

Read-Only Attribute
Description

Link
Type: handle
Default: 0
LinkDeleteCommand
Description:

LinkDeleteCommand Writable Attributes

Writable Attribute
Description
Link
Type: handle
Default: 0
1511
LinkDescriptor
LinkDeleteCommand Read-Only Attributes

Read-Only Attribute
Description

LinkDescriptor
Description:
Parents: linkDescriptors
Children: None
LinkDescriptor Attributes
Attribute
Description
linkCost
Type: INTEGER
Default: 1000
linkID
Type: OCTETSTRING
Default: 00000000
linkType
Type: OCTETSTRING
Default: 01
Name
Type: string
neighborPortIndex
Type: INTEGER
Default: 0
outputPortIndex
Type: INTEGER
Default: 0
reserved1
Type: OCTETSTRING
Default: 00
reserved2
Type: OCTETSTRING
Default: 00
reserved3
Type: OCTETSTRING
Default: 00
LinkDescriptor
Description:
Parents: linkDescriptors
Children: None
1512
linkDescriptors
LinkDescriptor Attributes
Attribute
Description
linkCost
Type: INTEGER
Default: 1000
linkID
Type: OCTETSTRING
Default: 00000000
linkType
Type: OCTETSTRING
Default: 01
Name
Type: string
neighborPortIndex
Type: INTEGER
Default: 0
outputPortIndex
Type: INTEGER
Default: 0
reserved1
Type: OCTETSTRING
Default: 00
reserved2
Type: OCTETSTRING
Default: 00
reserved3
Type: OCTETSTRING
Default: 00
linkDescriptors (overloaded)
linkDescriptors (fc)
linkDescriptors (fcsw)
linkDescriptors Object (fc PDU library)

Description:
Parents: LinkStateRecord (StreamBlock.FCoE.fc.fcPayloads.FCPayload-Choice.lsuRequest.lsrs.LinkStateRecord)

Children: LinkDescriptor
linkDescriptors Attributes
Attribute
Description
Name
information.
Type: string
1513
LinkLayerAddress
linkDescriptors Object (fcsw PDU library)

Description:
Parents: LinkStateRecord (StreamBlock.LsuReq.lsrs.LinkStateRecord)

Children: LinkDescriptor
linkDescriptors Attributes
Attribute
Description
Name
information.
Type: string
LinkLayerAddress
Description:
Link layer address used with ICMPv6
Parents: linkLayerOption
Children: None
LinkLayerAddress Attributes
Attribute
Description
length
Type: INTEGER
Default: 1
Name
information.
Type: string
type
Type: NdOptionType
Default: 1
Possible Values:
Value Description
value
Source Link-Layer Address
Target Link-Layer Address
Prefix Information
Redirected Header
MTU
Type: OCTETSTRING
Default: 000000000000
linkLayerOption
Description:
1514
LinkOamCounterResults
Used in ICMPv6 as a parent object for LinkLayerAddress object children

Parents: RouterSolicitation, RouterAdvertisement, NeighborSolicitation, NeighborAdvertisement, Redirect
Children: LinkLayerAddress
linkLayerOption Attributes
Attribute
Description
Name
information.
Type: string
LinkOamCounterResults
Description:
Link OAM counter results.

Parents: LinkOamRouterConfig
Relations:
Side name
(Type)
Relative
Description
ResultParent
(ResultChild)
LinkOamRouterConfig
LinkOamCounterResults Writable Attributes

LinkOamCounterResults Read-Only Attributes

Read-Only Attribute
Description
EventPduRxCount
Number of event PDUs received.

Type: u32
Default: 0
EventPduTxCount
Number of event PDUs transmitted.

Type: u32
Default: 0
InfoPduRxCount
Number of information PDUs received.

Type: u32
Default: 0
InfoPduTimeouts
Number of information PDU timeouts.

Type: u32
Default: 0
InfoPduTxCount
Number of information PDUs transmitted.

Type: u32
Default: 0
LoopbackPduRxCount
Number of loopback PDUs received.

Type: u32
Default: 0
1515
LinkOamEventCounterResults
Read-Only Attribute
Description
LoopbackPduTimeouts
Number of loopback PDU timeouts.

Type: u32
Default: 0
LoopbackPduTxCount
Number of loopback PDUs transmitted.

Type: u32
Default: 0
OrgSpecificPduRxCount
Number of organization specific PDUs received.

Type: u32
Default: 0
OrgSpecificPduTxCount
Number of organization specific PDUs transmitted.

Type: u32
Default: 0
VariableRequestPduRxCount
Number of variable request PDUs received.

Type: u32
Default: 0
VariableRequestPduTimeouts
Number of variable request PDU timeouts.

Type: u32
Default: 0
VariableRequestPduTxCount
Number of variable request PDUs transmitted.

Type: u32
Default: 0
VariableResponsePduRxCount
Number of variable response PDUs received.

Type: u32
Default: 0
VariableResponsePduTxCount
Number of variable response PDUs transmitted.

Type: u32
Default: 0
LinkOamEventCounterResults
Description:
Link OAM event counter results.

Relations:
Side name
(Type)
Relative
Description
ResultParent
(ResultChild)
LinkOamRouterConfig
LinkOamEventCounterResults Writable Attributes

1516
LinkOamEventLogCommand
LinkOamEventCounterResults Read-Only Attributes

Read-Only Attribute
Description
ErroredFramePeriodRxCount
Number of errored frame period events received.

Type: u32
Default: 0
ErroredFramePeriodTxCount
Number of errored frame period events transmitted.

Type: u32
Default: 0
ErroredFrameRxCount
Number of errored frame events received.

Type: u32
Default: 0
ErroredFrameSecondsSummaryRxCount
Number of errored frame seconds summary events received.

Type: u32
Default: 0
ErroredFrameSecondsSummaryTxCount
Number of errored frame seconds summary events transmitted.

Type: u32
Default: 0
ErroredFrameTxCount
Number of errored frame events transmitted.

Type: u32
Default: 0
ErroredSymbolPeriodRxCount
Number of errored symbol period events received.

Type: u32
Default: 0
ErroredSymbolPeriodTxCount
Number of errored symbol period events transmitted.

Type: u32
Default: 0
OrgSpecificRxCount
Number of organization specific events received.

Type: u32
Default: 0
OrgSpecificTxCount
Number of organization specific events transmitted.

Type: u32
Default: 0
LinkOamEventLogCommand
Description:
Link OAM Event Log Command.

LinkOamEventLogCommand Writable Attributes

Writable Attribute
Description
1517
LinkOamEventNotificationConfig
Writable Attribute
Description
LinkOamRouter
Specifies a handle to a Link OAM router configuration.

Type: handle
Default: 0
Subscribe
Specifies the subscription value for the event log.

Type: bool
Default: TRUE
Possible Values:
Value Description
TRUE
Subscribe to the event log.
FALSE Unsubscribe to the event log.
LinkOamEventLogCommand Read-Only Attributes

Read-Only Attribute
Description

LinkOamEventNotificationConfig
Description:
Link OAM event notification configuration.

Automatically created from: LinkOamRouterConfig
LinkOamEventNotificationConfig Writable Attributes

Writable Attribute
Description
Active, Name
DataValue
Specifies the data value.

Type: string
Default: 00
ErroredFramePeriodThreshold
Specifies the number of errored frames required to generate the event.

Type: u32
Default: 1
Range: 0 - 65535
ErroredFramePeriodWindowSize
Specifies the duration of the period in terms of frames.

Type: u32
Default: 10
Range: 1 - 65535
ErroredFrameSecondsSummaryThreshold
Specifies the number of errored frame seconds required to generate the event.
Type: u16
Default: 1
Range: 0 - 65535
ErroredFrameSecondsSummaryWindowSize
Specifies the period in 100 ms intervals.

Type: u16
Default: 600
Range: 100 - 9000
1518
LinkOamEventNotificationResults
Writable Attribute
Description
ErroredFrameThreshold
Specifies the number of errored frames required to generate the event.

Type: u32
Default: 1
Range: 0 - 65535
ErroredFrameWindowSize
Specifies the period in 100 ms intervals.

Type: u16
Default: 10
Range: 10 - 600
ErroredSymbolPeriodThreshold
Specifies the number of errored symbols required to generate the event.

Type: u64
Default: 1
Range: 0 - 65535
ErroredSymbolPeriodWindowSize
Specifies the number of symbols in the period.

Type: u64
Default: 10
Range: 1 - 65535
FrameErrors
Specifies the number of detected errored frames in the period.

Type: u32
Default: 1
FramePeriodErrors
Specifies the number of detected frame errors in the period.

Type: u32
Default: 1
FrameSecondsSummaryErrors
Specifies the number of detected errored frame seconds in the period.

Type: u16
Default: 1
InitialTimeBase
Specifies the initial time base in 100 ms intervals.

Type: u16
Default: 0
MsgRepeatCount
Specifies the number of times to transmit an event.

Type: u8
Default: 2
Range: 1 - 10
Oui
Specifies the OUI.

Type: string
Default: 00-10-94
SymbolPeriodErrors
Specifies the number of detected symbol errors in the period.

Type: u64
Default: 1
LinkOamEventNotificationConfig Read-Only Attributes

LinkOamEventNotificationResults
Description:
Link OAM event notification results.

Relations:
1519
LinkOamGenerateVariableRequestsCommand
Side name
(Type)
Relative
Description
ResultParent
(ResultChild)
LinkOamRouterConfig
LinkOamEventNotificationResults Writable Attributes

LinkOamEventNotificationResults Read-Only Attributes

Read-Only Attribute
Description
DataValue
The data value of the organization specific event.

Type: string
Default: 00
ErrorCount
Error count of the event.

Type: u64
Default: 0
ErrorRunningTotal
Error running total of the event.

Type: u64
Default: 0
EventRunningTotal
Event running total.

Type: u32
Default: 0
EventType
Displays the event type.

Type: enum
Default: ERRORED_SYMBOL_PERIOD
Possible Values:
Value
Description
ERRORED_SYMBOL_PERIOD
Errored symbol period event.
ERRORED_FRAME
Errored frame event.
ERRORED_FRAME_PERIOD
Errored frame period event.
ERRORED_FRAME_SECONDS_SUMMARY Errored frame seconds summary event.

ORG_SPECIFIC
Organization specific event.
Oui
OUI of the organization specific event.

Type: string
Default: 00-10-94
Threshold
Threshold of the event.

Type: u64
Default: 0
Timestamp
Timestamp of the event in 100 ms intervals.

Type: u16
Default: 0
WindowSize
The window size of the event.

Type: u64
Default: 0
LinkOamGenerateVariableRequestsCommand
Description:
1520
LinkOamGenerateVariableResponsesCommand
Link OAM Generate Variable Requests Command

LinkOamGenerateVariableRequestsCommand Writable Attributes

Writable Attribute
Description
BranchStart
Specifies the starting branch value.

Type: string
Default: 01
BranchStep
Specifies the branch step.

Type: string
Default: 01
LeafStart
Specifies the starting leaf value.

Type: string
Default: 0001
LeafStep
Specifies the leaf step.

Type: string
Default: 0001
LinkOamRouterList
List of handles to Link OAM router configurations.

Type: handle
Default: 0
NumOfRequests
Specifies the number of variable request configurations to create.

Type: u8
Default: 1
Range: 1 - 100
LinkOamGenerateVariableRequestsCommand Read-Only Attributes

Read-Only Attribute
Description

LinkOamGenerateVariableResponsesCommand
Description:
Link OAM Generate Variable Responses Command.

LinkOamGenerateVariableResponsesCommand Writable Attributes

Writable Attribute
Description
1521
LinkOamLoadVariableResponsesCommand
Writable Attribute
Description
BranchStart
Specifies the starting branch value.

Type: string
Default: 00
BranchStep
Specifies the branch step.

Type: string
Default: 01
DataValueStart
Specifies the starting data value.

Type: string
Default: 00
DataValueStep
Specifies the data value step.

Type: string
Default: 01
DataValueStepOffset
Specifies the offset into the data value on which to perform the step.
Type: u8
Default: 1
Range: 0 - 127
LeafStart
Specifies the starting leaf value.

Type: string
Default: 0000
LeafStep
Specifies the leaf step.

Type: string
Default: 0001
LinkOamRouterList

Type: handle
Default: 0
NumOfResponses
Specifies the number of variable response configurations to create.

Type: u8
Default: 1
Range: 1 - 100
WidthStart
Specifies the starting width value.

Type: string
Default: 00
WidthStep
Specifies the width step.

Type: string
Default: 01
LinkOamGenerateVariableResponsesCommand Read-Only Attributes

Read-Only Attribute
Description

LinkOamLoadVariableResponsesCommand
Description:
Link OAM Load Variable Responses Command.

1522
LinkOamOrgSpecificConfig
LinkOamLoadVariableResponsesCommand Writable Attributes

Writable Attribute
Description
Filename
Specifies the name of the CSV file to load.

Type: inputFilePath
Default: varResponse.csv
LinkOamRouter

Type: handle
Default: 0
LinkOamLoadVariableResponsesCommand Read-Only Attributes

Read-Only Attribute
Description

LinkOamOrgSpecificConfig
Description:
Link OAM organization specific configuration.

LinkOamOrgSpecificConfig Writable Attributes

Writable Attribute
Description
Active, Name
DataValue

Type: string
Default: 00
Oui
Specifies the OUI.

Type: string
Default: 00-10-94
LinkOamOrgSpecificConfig Read-Only Attributes

LinkOamOrgSpecificInfoConfig
Description:
Link OAM organization specific information configuration.

1523
LinkOamRemoteInfoResults
LinkOamOrgSpecificInfoConfig Writable Attributes

Writable Attribute
Description
Active, Name
DataValue

Type: string
Default: 00
Oui
Specifies the OUI.

Type: string
Default: 00-10-94
LinkOamOrgSpecificInfoConfig Read-Only Attributes

LinkOamRemoteInfoResults
Description:
Link OAM remote info results.

Relations:
Side name
(Type)
Relative
Description
ResultParent
(ResultChild)
LinkOamRouterConfig
LinkOamRemoteInfoResults Writable Attributes

LinkOamRemoteInfoResults Read-Only Attributes

Read-Only Attribute
Description
RemoteInterpretsLinkEvents
Interprets link events flag.

Type: enum
Default: TRUE
Possible Values:
Value Description
FALSE Interprets link events is not supported on the remote OAM client.
TRUE
Interprets link events is supported on the remote OAM client.
RemoteMaxPduSize
Maximum PDU size supported on the remote OAM client.

Type: u16
Default: 0
RemoteOamVersion
Version of the remote OAM client.

Type: u8
Default: 0
1524
LinkOamResumeCommand
Read-Only Attribute
Description
RemoteOperationMode
Operation mode of the remote OAM client.

Type: enum
Default: PASSIVE
Possible Values:
Value
Description
PASSIVE Passive OAM mode.
ACTIVE
Active OAM mode.
RemoteRevision
Revision number of the remote OAM client.

Type: u16
Default: 0
RemoteSupportsLoopback
Loopback support flag.

Type: enum
Default: TRUE
Possible Values:
Value Description
FALSE Loopback is not supported on the remote OAM client.
TRUE
RemoteSupportsUnidirectionalMode
Loopback is supported on the remote OAM client.
Unidirectional mode support flag.

Type: enum
Default: TRUE
Possible Values:
Value Description
FALSE Unidirectional mode is not supported on the remote OAM client.
TRUE
RemoteSupportsVariableRetrieval
Unidirectional mode is supported on the remote OAM client.
Variable retrieval support flag.

Type: enum
Default: TRUE
Possible Values:
Value Description
FALSE Variable retrieval is not supported on the remote OAM client.
TRUE
RemoteVendorSpecificInfo
Variable retrieval is supported on the remote OAM client.
Vendor specific information on the remote OAM client.

Type: string
Default: 0000 0000
LinkOamResumeCommand
Description:
Resume sending Link OAM commands.

LinkOamResumeCommand Writable Attributes

Writable Attribute
Description
1525
LinkOamRouterConfig
Writable Attribute
Description
LinkOamRouterList

Type: handle
Default: 0
PauseAtState
The state the Link OAM router will remain in until a resume command is issued.
Type: enum
Default: NONE
Possible Values:
Value
Description
FAULT
FAULT state.
ACTIVE_PASSIVE
ACTIVE_SEND_LOCAL or PASSIVE_WAIT state, depending on OAM mode.
SEND_LOCAL_REMOTE
SEND_LOCAL_REMOTE state.
SEND_LOCAL_REMOTE_OK SEND_LOCAL_REMOTE_OK state.

SEND_ANY
SEND_ANY state.
NONE
NONE.
LinkOamResumeCommand Read-Only Attributes

Read-Only Attribute
Description

LinkOamRouterConfig
Description:
Link OAM router configuration.

Children: LinkOamOrgSpecificInfoConfig, LinkOamVariableRequestConfig, LinkOamVariableResponseConfig
Automatically-created children: LinkOamEventNotificationConfig, LinkOamOrgSpecificConfig, LinkOamTimersConfig
Result children (automatically created): LinkOamCounterResults, LinkOamEventCounterResults, LinkOamEventNotificationResults, LinkOamRemoteInfoResults,
LinkOamStateResults
Relations:
Side name
(Type)
Relative
Description
ResultChild
(ResultChild)
LinkOamCounterResults, LinkOamEventCounterResults,
LinkOamEventNotificationResults,
LinkOamRemoteInfoResults, LinkOamStateResults
UsesIf
(UsesIf)


LinkOamRouterConfig Writable Attributes

Writable Attribute
Description
Active, Name
1526
LinkOamRouterConfig
Writable Attribute
Description
EnableCriticalEvent
Enables the critical event flag.

Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
Enable critical event.
FALSE Do not enable critical event.

EnableDyingGasp
Enables the dying gasp flag.

Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
Enable dying gasp.
FALSE Do not enable dying gasp.

EnableLinkFault
Enables the link fault flag.

Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
Enable link fault.
FALSE Do not enable link fault.

EnableLoopbackResponseTx
Enables transmission of loopback responses.

Type: bool
Default: TRUE
Possible Values:
Value Description
TRUE
Enable loopback response Tx.
FALSE Do not enable loopback response Tx.

EnablePduTx
Enables transmission of PDUs.

Type: bool
Default: TRUE
Possible Values:
Value Description
TRUE
Enable PDU Tx.
FALSE Do not enable PDU Tx.

EnableVariableResponseTx
Enables transmission of variable responses.

Type: bool
Default: TRUE
Possible Values:
Value Description
TRUE
Enable variable response Tx.
FALSE Do not enable variable response Tx.

InterpretsLinkEvents
Enables support for interpreting link events.

Type: bool
Default: TRUE
Possible Values:
Value Description
TRUE
Enable interpreting of link events.
FALSE Do not enable interpreting of link event.

MaxPduSize
Specifies the maximum PDU size supported.

Type: u16
Default: 1500
Range: 64 - 2047
1527
LinkOamRouterConfig
Writable Attribute
Description
OamVersion
Specifies the OAM version.

Type: u8
Default: 1
OperationMode
Specifies the operation mode of the OAM client.

Type: enum
Default: ACTIVE
Possible Values:
Value
Description
PASSIVE Passive OAM mode.
ACTIVE
Active OAM mode.
Oui
Specifies the OUI.

Type: string
Default: 00-10-94
OverrideLocalSatisfied
Specifies if the local satisfied flag is to be overridden.

Type: enum
Default: DEFAULT
Possible Values:
Value
Description
FALSE
Set local satisfied to false.
TRUE
Set local statisfied to true.
DEFAULT Use the default handling of the local satified flag.

OverrideRemoteStable
Specifies if the remote stable flag is to be overridden.

Type: enum
Default: DEFAULT
Possible Values:
Value
Description
FALSE
Set remote stable to false.
TRUE
Set remote stable to true.
DEFAULT Use the default handling of the remote stable flag.

OverrideRevision
Enables overriding of the revision number.

Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
Enable revision override.
FALSE Do not enable revision override.

Revision
Specifies the current revision number.

Type: u16
Default: 0
SupportsLoopback
Enables remote loopback mode capability.

Type: bool
Default: TRUE
Possible Values:
Value Description
TRUE
Enable loopback capability.
FALSE Do not enable loopback capability.

SupportsUnidirectionalMode
Enables unidirectional support.

Type: bool
Default: TRUE
Possible Values:
Value Description
TRUE
Enable unidirectional mode.
FALSE Do not enable unidirectional mode.
1528
LinkOamSaveVariableResponsesCommand
Writable Attribute
Description
SupportsVariableRetrieval
Enables support for sending variable response OAMPDUs.

Type: bool
Default: TRUE
Possible Values:
Value Description
TRUE
Enable variable retrieval.
FALSE Do not enable variable retrieval.


Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE

VendorSpecificInfo
Specifies the vendor specific information.

Type: string
Default: 0000 0000
LinkOamRouterConfig Read-Only Attributes

Read-Only Attribute
Description
LocalState
Displays the local DTE state.

Type: enum
Default: NONE
Possible Values:
Value
Description
UNSATISFIED
Discovery can not complete.
NOT_COMPLETED Discovery has not completed.

COMPLETED
Discovery has completed.
RESERVED
Reserved flag should not be received.
NONE
No current state exists.
LinkOamSaveVariableResponsesCommand
Description:
Link OAM Save Variable Responses Command.

LinkOamSaveVariableResponsesCommand Writable Attributes

Writable Attribute
Description
Filename
Specifies the name of the CSV file to save to.

Default: varResponse.csv
1529
LinkOamStartCommand
Writable Attribute
Description
LinkOamRouter

Type: handle
Default: 0
LinkOamSaveVariableResponsesCommand Read-Only Attributes

Read-Only Attribute
Description

LinkOamStartCommand
Description:
Start sending Link OAM PDUs.

LinkOamStartCommand Writable Attributes

Writable Attribute
Description
LinkOamRouterList

Type: handle
Default: 0
PauseAtState
The state the Link OAM router will remain in until a resume command is issued.
Type: enum
Default: NONE
Possible Values:
Value
Description
FAULT
FAULT state.
ACTIVE_PASSIVE
ACTIVE_SEND_LOCAL or PASSIVE_WAIT state, depending on OAM mode.
SEND_LOCAL_REMOTE
SEND_LOCAL_REMOTE state.
SEND_LOCAL_REMOTE_OK SEND_LOCAL_REMOTE_OK state.

SEND_ANY
SEND_ANY state.
NONE
NONE.
LinkOamStartCommand Read-Only Attributes

Read-Only Attribute
Description

1530
LinkOamStartEventNotificationCommand
LinkOamStartEventNotificationCommand
Description:
Start sending Event Notification PDUs.

LinkOamStartEventNotificationCommand Writable Attributes

Writable Attribute
Description
LinkOamRouterList

Type: handle
Default: 0
PduPackingOption
Specifies how the TLVs are packed into the PDU.

Type: enum
Default: BATCH_TLVS
Possible Values:
Value
Description
SINGLE_TLV
Send a single TLV per PDU.
BATCH_TLVS Batch TLVs into a minimum number of PDUs.

Period
Specifies the transmission period.

Type: u8
Default: 1
Range: 1 - 10
SendErroredFrameEvent
Enables the sending of an errored frame event.

Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
Send an errored frame event.
FALSE Do not send an errored frame event.

SendErroredFramePeriodEvent
Enables the sending of an errored frame period event.

Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
Send an errored frame period event.
FALSE Do not send an errored frame period event.

SendErroredFrameSecondsSummaryEvent
Enables the sending of an errored frame seconds summary event.

Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
Send an errored frame seconds summary event.
FALSE Do not send an errored frame seconds summary event.

SendErroredSymbolPeriodEvent
Enables the sending of an errored symbol period event.

Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
Send an errored symbol period event.
FALSE Do not send an errored symbol period event.
1531
LinkOamStartLoopbackRequestCommand
Writable Attribute
Description
SendOrgSpecificEvent
Enables the sending of an organization specific event.

Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
Send an organization specific event.
FALSE Do not send an organization specific event.

TxType
Specifies the message transmit type.

Type: enum
Default: SINGLE_MSG
Possible Values:
Value
Description
SINGLE_MSG Send a single message.
PERIODIC
Send continuous messages.
LinkOamStartEventNotificationCommand Read-Only Attributes

Read-Only Attribute
Description

LinkOamStartLoopbackRequestCommand
Description:
Send a Loopback Control OAMPDU to enable remote loopback.

LinkOamStartLoopbackRequestCommand Writable Attributes

Writable Attribute
Description
LinkOamRouterList

Type: handle
Default: 0
LinkOamStartLoopbackRequestCommand Read-Only Attributes

Read-Only Attribute
Description

1532
LinkOamStartOrgSpecificCommand
LinkOamStartOrgSpecificCommand
Description:
Start sending Organization Specific PDUs.

LinkOamStartOrgSpecificCommand Writable Attributes

Writable Attribute
Description
LinkOamRouterList

Type: handle
Default: 0
Period

Type: u8
Default: 1
Range: 1 - 10
TxType

Type: enum
Default: SINGLE_MSG
Possible Values:
Value
Description
PERIODIC
LinkOamStartOrgSpecificCommand Read-Only Attributes

Read-Only Attribute
Description

LinkOamStartVariableRequestCommand
Description:
Start sending Start Variable Request PDUs.

LinkOamStartVariableRequestCommand Writable Attributes

Writable Attribute
Description
LinkOamRouterList

Type: handle
Default: 0
1533
LinkOamStateResults
Writable Attribute
Description
PduPackingOption
Specifies how the TLVs are packed into the PDU.

Type: enum
Default: BATCH_TLVS
Possible Values:
Value
Description
SINGLE_TLV
Send a single TLV per PDU.
BATCH_TLVS Batch TLVs into a minimum number of PDUs.

Period

Type: u8
Default: 1
Range: 1 - 10
TxType

Type: enum
Default: SINGLE_MSG
Possible Values:
Value
Description
PERIODIC
LinkOamStartVariableRequestCommand Read-Only Attributes

Read-Only Attribute
Description

LinkOamStateResults
Description:
Link OAM state results.

Relations:
Side name
(Type)
Relative
Description
ResultParent
(ResultChild)
LinkOamRouterConfig
LinkOamStateResults Writable Attributes

1534
LinkOamStateResults
LinkOamStateResults Read-Only Attributes

Read-Only Attribute
Description
CriticalEvent
Displays the critical event flag.

Type: enum
Default: OFF
Possible Values:
Value Description
OFF
Critical event is not enabled.
ON
Critical event is enabled.
CriticalEventRxCount
Number of critical events received.

Type: u32
Default: 0
CriticalEventTxCount
Number of critical events transmitted.

Type: u32
Default: 0
DyingGasp
Displays the dying gasp flag.

Type: enum
Default: OFF
Possible Values:
Value Description
OFF
Dying gasp is not enabled.
ON
Dying gasp is enabled.
DyingGaspRxCount
Number of dying gasp received.

Type: u32
Default: 0
DyingGaspTxCount
Number of dying gasps transmitted.

Type: u32
Default: 0
LinkFault
Displays the link fault flag.

Type: enum
Default: OFF
Possible Values:
Value Description
OFF
Link fault is not enabled.
ON
Link fault is enabled.
LinkFaultRxCount
Number of link faults received.

Type: u32
Default: 0
LinkFaultTxCount
Number of link faults transmitted.

Type: u32
Default: 0
LocalState
Displays the local DTE state.

Type: enum
Default: NONE
Possible Values:
Value
Description
UNSATISFIED

COMPLETED
RESERVED
NONE
1535
LinkOamStateResults
Read-Only Attribute
Description
MultiplexerAction
Displays the local multiplexer action.

Type: enum
Default: FWD
Possible Values:
Value
Description
FWD
Forwarding non-OAMPDUs.
DISCARD Discarding non-OAMPDUs.

ParserAction
Displays the parser action.

Type: enum
Default: FWD
Possible Values:
Value
Description
FWD
LB
Looping back non-OAMPDUs.
DISCARD
Discarding non-OAMPDUs.
RESERVED Reserved flag should not be set.

RemoteCriticalEvent
RemoteDyingGasp
RemoteLinkFault
RemoteMultiplexerAction
Displays the remote critical event flag.

Type: enum
Default: OFF
Possible Values:
Value Description
OFF
Remote critical event is not enabled.
ON
Remote critical event ist enabled.
Displays the remote dying gasp flag.

Type: enum
Default: OFF
Possible Values:
Value Description
OFF
Remote dying gasp is not enabled.
ON
Remote dying gasp is enabled.
Displays the remote link fault flag.

Type: enum
Default: OFF
Possible Values:
Value Description
OFF
Remote link fault is not enabled.
ON
Remote link fault is enabled.
Displays the remote multiplexer action.

Type: enum
Default: FWD
Possible Values:
Value
Description
FWD
DISCARD Discarding non-OAMPDUs.

RemoteParserAction
Displays the remote parser action.

Type: enum
Default: FWD
Possible Values:
Value
Description
FWD
LB
Looping back non-OAMPDUs.
DISCARD
Discarding non-OAMPDUs.
RESERVED Reserved flag should not be set.
1536
LinkOamStopCommand
Read-Only Attribute
Description
RemoteState
Displays the remote DTE state.

Type: enum
Default: NONE
Possible Values:
Value
Description
UNSATISFIED

COMPLETED
RESERVED
NONE
LinkOamStopCommand
Description:
Stop sending Link OAM PDUs.

LinkOamStopCommand Writable Attributes

Writable Attribute
Description
LinkOamRouterList

Type: handle
Default: 0
LinkOamStopCommand Read-Only Attributes

Read-Only Attribute
Description

LinkOamStopEventNotificationCommand
Description:
Stop sending event notification PDUs.

1537
LinkOamStopLoopbackRequestCommand
LinkOamStopEventNotificationCommand Writable Attributes

Writable Attribute
Description
LinkOamRouterList

Type: handle
Default: 0
LinkOamStopEventNotificationCommand Read-Only Attributes

Read-Only Attribute
Description

LinkOamStopLoopbackRequestCommand
Description:
Send a Loopback Control OAMPDU to disable remote loopback.

LinkOamStopLoopbackRequestCommand Writable Attributes

Writable Attribute
Description
LinkOamRouterList

Type: handle
Default: 0
LinkOamStopLoopbackRequestCommand Read-Only Attributes

Read-Only Attribute
Description

LinkOamStopOrgSpecificCommand
Description:
Stop sending organization specific PDUs.

1538
LinkOamStopVariableRequestCommand
LinkOamStopOrgSpecificCommand Writable Attributes

Writable Attribute
Description
LinkOamRouterList

Type: handle
Default: 0
LinkOamStopOrgSpecificCommand Read-Only Attributes

Read-Only Attribute
Description

LinkOamStopVariableRequestCommand
Description:
Stop sending variable request PDUs.

LinkOamStopVariableRequestCommand Writable Attributes

Writable Attribute
Description
LinkOamRouterList

Type: handle
Default: 0
LinkOamStopVariableRequestCommand Read-Only Attributes

Read-Only Attribute
Description

LinkOamTimersConfig
Description:
Link OAM timers configuration.

1539
LinkOamVariableRequestConfig
LinkOamTimersConfig Writable Attributes

Writable Attribute
Description
Active, Name
LoopbackResponseTimeout
Specifies the loopback response timeout.

Type: u8
Default: 1
Range: 1 - 10
LostLinkTimer
Specifies the lost link timer used to reset the discovery state machine.
Type: u8
Default: 5
Range: 2 - 90
PduTimer
Specifies the PDU timer used to ensure the OAM sublayr adheres to the max and min PDUs per
second.
Type: u8
Default: 1
Range: 1 - 10
VariableResponseTimeout
Specifies the variable response timeout.

Type: u8
Default: 1
Range: 1 - 10
LinkOamTimersConfig Read-Only Attributes

LinkOamVariableRequestConfig
Description:
Link OAM variable request configuration.

LinkOamVariableRequestConfig Writable Attributes

Writable Attribute
Description
Active, Name
Branch
Specifies the branch.

Type: string
Default: 00
Leaf
Specifies the leaf.

Type: string
Default: 0000
LinkOamVariableRequestConfig Read-Only Attributes

1540
LinkOamVariableResponseConfig
LinkOamVariableResponseConfig
Description:
Link OAM variable response configuration.

LinkOamVariableResponseConfig Writable Attributes

Writable Attribute
Description
Active, Name
Branch
Specifies the branch.

Type: string
Default: 00
DataValue

Type: string
Default: 00
Indication
Enables the indication bit of the variable width.

Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
Enable the indication flag.
FALSE Do not enable the indication flag.

Leaf
Specifies the leaf.

Type: string
Default: 0000
Width
Specifies the width or indication if enabled.

Type: string
Default: 00
LinkOamVariableResponseConfig Read-Only Attributes

LinkOamWaitOnDiscoveryCompleteCommand
Description:
Wait until discovery is complete.

Parents: Sequencer
LinkOamWaitOnDiscoveryCompleteCommand Writable Attributes

Writable Attribute
Description
ErrorOnFailure
1541
LinkReconnectCommand
Writable Attribute
Description
ObjectList

Type: handle
Default: 0
WaitTime
The time to wait if the state is not reached.

Type: double
Default: 30.0
Range: 0.005 - 2147483647.0
LinkOamWaitOnDiscoveryCompleteCommand Read-Only Attributes

Read-Only Attribute
Description
LocalState
Specifies the state to wait for.

Type: enum
Default: COMPLETED
Possible Values:
Value
Description
UNSATISFIED

COMPLETED
RESERVED
Reserved flag should not be reached.
NONE
LinkReconnectCommand
Description:

LinkReconnectCommand Writable Attributes

Writable Attribute
Description
Link
Type: handle
Default: 0
LinkReconnectCommand Read-Only Attributes

Read-Only Attribute
Description

1542
LinkRegistry
LinkRegistry
Description:

Parents: StcSystem
LinkRegistry Writable Attributes

Writable Attribute
Description
Active, Name
LinkRegistry Read-Only Attributes

Read-Only Attribute
Description
LinkTypes
Type: string
LinksReconnectAllCommand
Description:

LinksReconnectAllCommand Writable Attributes

Writable Attribute
Description
IgnoreOfflinePorts
Type: bool
Default: TRUE
Possible Values:
Value Description
TRUE
FALSE
LinksReconnectAllCommand Read-Only Attributes

Read-Only Attribute
Description

LinkStateHeader
Description:
Parents: lsrs
1543
LinkStateHeader
Children: None
LinkStateHeader Attributes
Attribute
Description
advDomainID
Type: OCTETSTRING
Default: 00000000
checkSum
Type: OCTETSTRING
Default: 0000
linkStateID
Type: OCTETSTRING
Default: 00000001
lsIncarnationNumber
Type: INTEGER
Default: 0
lsrAge
Type: INTEGER
Default: 1
lsrLength
Type: INTEGER
Default: 44
lsrType
Type: OCTETSTRING
Default: 01
Name
Type: string
reserved1
Type: OCTETSTRING
Default: 00
reserved2
Type: OCTETSTRING
Default: 00000000
LinkStateHeader
Description:
Parents: lsrs
Children: None
LinkStateHeader Attributes
Attribute
Description
advDomainID
Type: OCTETSTRING
Default: 00000000
checkSum
Type: OCTETSTRING
Default: 0000
linkStateID
Type: OCTETSTRING
Default: 00000001
lsIncarnationNumber
Type: INTEGER
Default: 0
lsrAge
Type: INTEGER
Default: 1
1544
LinkStateRecord
Attribute
Description
lsrLength
Type: INTEGER
Default: 44
lsrType
Type: OCTETSTRING
Default: 01
Name
Type: string
reserved1
Type: OCTETSTRING
Default: 00
reserved2
Type: OCTETSTRING
Default: 00000000
LinkStateRecord
Description:
Parents: lsrs
Children: linkDescriptors
LinkStateRecord Attributes
Attribute
Description
advDomainID
Type: OCTETSTRING
Default: 00000000
checkSum
Type: OCTETSTRING
Default: 0000
linkStateID
Type: OCTETSTRING
Default: 00000001
lsIncarnationNumber
Type: INTEGER
Default: 0
lsrAge
Type: INTEGER
Default: 2
lsrLength
Type: INTEGER
Default: 44
lsrType
Type: OCTETSTRING
Default: 01
Name
Type: string
numLinks
Type: INTEGER
Default: 0
reserved
Type: OCTETSTRING
Default: 0000
reserved1
Type: OCTETSTRING
Default: 00
1545
LinkStateRecord
Attribute
Description
reserved2
Type: OCTETSTRING
Default: 00000000
LinkStateRecord
Description:
Parents: lsrs
Children: linkDescriptors
LinkStateRecord Attributes
Attribute
Description
advDomainID
Type: OCTETSTRING
Default: 00000000
checkSum
Type: OCTETSTRING
Default: 0000
linkStateID
Type: OCTETSTRING
Default: 00000001
lsIncarnationNumber
Type: INTEGER
Default: 0
lsrAge
Type: INTEGER
Default: 2
lsrLength
Type: INTEGER
Default: 44
lsrType
Type: OCTETSTRING
Default: 01
Name
Type: string
numLinks
Type: INTEGER
Default: 0
reserved
Type: OCTETSTRING
Default: 0000
reserved1
Type: OCTETSTRING
Default: 00
reserved2
Type: OCTETSTRING
Default: 00000000
LinkTlv
Description:
Link Type-Length value (TLV).
1546
llc

Parents: TeLsa
Automatically-created children: TeParams
LinkTlv Writable Attributes

Writable Attribute
Description
Active, Name
LinkId
A four-octet parameter, identical to the Link ID of the Router LSA. Point-to-Point link: Link ID is the Router ID of the
neighbor. Multiaccess link: Link ID is the interface address of the Designated Router.
Type: ip
Default: 0.0.0.0
LinkType
Link type (P2P or Multiaccess). This mandatory Link TLV parameter defines the type of the link.
Type: enum
Default: POINT_TO_POINT
Possible Values:
Value
Description
POINT_TO_POINT Point-to-point link.
MULTIACCESS
TeMetric
Multi-access link.
This optional Link TLV parameter is a four-octet metric that may be different than the standard OSPF metric for the
link.
Type: u32
Default: 1
Range: 0 - 2147483647
LinkTlv Read-Only Attributes

llc
Description:
Parents: LlcRoutedSnap, LlcRoutedNlpid, LlcBridgedEth8023, LlcSnapIana, Ethernet8022, EthernetSnap, Ethernet8022, EthernetSnap, EncapEthernet8022,
EncapEthernetSnap
Children: None
llc Attributes
Attribute
Description
control
Type: OCTETSTRING
Default: 03
dsap
Type: LLCSapNumbers
Default: AA
Possible Values:
Value Description
04
IBM SNA
06
IP
80
3Com
AA
Snap
BC
Banyan
E0
Novell
FE
ISO Network Layer Protocol
1547
LlcBridgedEth8023
Attribute
Description
Name
information.
Type: string
ssap
Type: LLCSapNumbers
Default: AA
Possible Values:
Value Description
04
IBM SNA
06
IP
80
3Com
AA
Snap
BC
Banyan
E0
Novell
FE
LlcBridgedEth8023 (aal5:LlcBridgedEth8023)
Description:
Children: llc
Next headers: ethernet:EthernetII, ethernet:EthernetSnap , ethernet:Ethernet8022 , ethernet:Ethernet8023Raw, MAC-in-MAC:MAC-in-MAC, custom:Custom
LlcBridgedEth8023 Attributes
Attribute
Description
Name
information.
Type: string
oui
Type: OCTETSTRING
Default: 0080C2
pad
Type: OCTETSTRING
Default: 0000
pid
Type: LlcBridgedEth8023PidNumbers
Default: 0007
Possible Values:
Value Description
0001
with preserved FCS
0007
w/o preserved FCS
llcheader
Description:
Parents: LlcRoutedSnap, LlcRoutedNlpid, LlcBridgedEth8023, LlcSnapIana, Ethernet8022, EthernetSnap, Ethernet8022, EthernetSnap, EncapEthernet8022,
EncapEthernetSnap
1548
LlcRoutedNlpid
Children: None
llcheader Attributes
Attribute
Description
control
Type: OCTETSTRING
Default: 03
dsap
Type: LLCSapNumbers
Default: AA
Possible Values:
Value Description
04
IBM SNA
06
IP
80
3Com
AA
Snap
BC
Banyan
E0
Novell
FE
Name
information.
Type: string
ssap
Type: LLCSapNumbers
Default: AA
Possible Values:
Value Description
04
IBM SNA
06
IP
80
3Com
AA
Snap
BC
Banyan
E0
Novell
FE
LlcRoutedNlpid (aal5:LlcRoutedNlpid)
Description:
Children: llc
LlcRoutedNlpid Attributes
Attribute
Description
Name
information.
Type: string
1549
LlcRoutedSnap
Attribute
Description
nlpid
Type: NLPIDNumbers
Default: 80
Possible Values:
Value Description
00
NULL
80
SNAP
81
ISO CLNP
82
ISO ESIS
83
ISO ISIS
8E
IPv6
CC
IPv4
CF
PPP
LlcRoutedSnap (aal5:LlcRoutedSnap)
Description:
Children: llc, snap
Next headers: ipv4:IPv4, ipv6:IPv6, custom:Custom
LlcRoutedSnap Attributes
Attribute
Description
Name
information.
Type: string
LlcSnapIana (aal5:LlcSnapIana)
Description:
Children: llc
Next headers: l2tpv2:L2TPv2
LlcSnapIana Attributes
Attribute
Description
Name
information.
Type: string
oui
Type: OCTETSTRING
Default: 00005E
pid
Type: OCTETSTRING
Default: 0007
1550
LldpDcbxFeatureResult
Description:
DCBX feature result.

Relations:
Side name
(Type)
Relative
Description
ResultParent
(ResultChild)
LldpNodeConfig
LldpDcbxFeatureResult Writable Attributes

LldpDcbxFeatureResult Read-Only Attributes

Read-Only Attribute
Description
Advertise
Whether the DCB feature is advertised by the system.

Type: enum
Default: FALSE
Possible Values:
Value Description
FALSE FALSE
TRUE
Enable
Error
TRUE
Whether the DCB feature is enabled nor not.

Type: enum
Default: OFF
Possible Values:
Value Description
OFF
OFF
ON
ON
Whether an error has occurred during the configuration exchange.

Type: enum
Default: FALSE
Possible Values:
Value Description
FALSE FALSE
TRUE
TRUE
FeatureSeqNumber
The value that Sequence Number must equal to before Syncd can become true.
Type: u32
Default: 0
MaxVersion
Highest feature version supported by the system.

Type: u8
Default: 0
OperatingMode
Operational state of the feature.

Type: enum
Default: OFF
Possible Values:
Value Description
OFF
OFF
ON
ON
1551
Read-Only Attribute
Description
OperatingVersion
Operating version of the feature.

Type: u8
Default: 0
PeerAdvertise
Whether the DCB feature is advertised by the peer.

Type: enum
Default: FALSE
Possible Values:
Value Description
FALSE FALSE
TRUE
PeerEnable
PeerError
TRUE
The Enable bit in the received Feature TLV.

Type: enum
Default: OFF
Possible Values:
Value Description
OFF
OFF
ON
ON
The Error bit in the received Feature TLV.

Type: enum
Default: FALSE
Possible Values:
Value Description
FALSE FALSE
TRUE
TRUE
PeerMaxVersion
Highest feature version supported by the peer.

Type: u8
Default: 0
PeerWilling
The Willing state of the peer.

Type: enum
Default: FALSE
Possible Values:
Value Description
FALSE FALSE
TRUE
TRUE
Subtype
Subtype defined for the DCB feature.

Type: u8
Default: 0
Syncd
Whether the current DesiredCfg has been received by the peer.

Type: enum
Default: FALSE
Possible Values:
Value Description
FALSE FALSE
TRUE
Type
TRUE
Type code of the DCB feature.

Type: string
1552
LldpDcbxResult
Read-Only Attribute
Description
Willing
Whether this feature accepts its configuration from the peer or not.
Type: enum
Default: FALSE
Possible Values:
Value Description
FALSE FALSE
TRUE
TRUE
LldpDcbxResult
Description:
DCBX Result.

Relations:
Side name
(Type)
Relative
Description
ResultParent
(ResultChild)
LldpNodeConfig
LldpDcbxResult Writable Attributes

LldpDcbxResult Read-Only Attributes

Read-Only Attribute
Description
AckNumber
Acknowledge Number in the DCBX control TLV.

Type: u32
Default: 0
MaxVersion
Highest DCBX version supported by the system.

Type: u8
Default: 1
OperatingVersion
Operating version of the DCBX protocol.

Type: u8
Default: 1
PeerAckNumber
Acknowledge Number in the received DCBX control TLV.

Type: u32
Default: 0
PeerMaxVersion
Highest DCBX version supported by the peer.

Type: u8
Default: 1
PeerSeqNumber
Sequence Number in the received DCBX control TLV.

Type: u32
Default: 0
SeqNumber
Sequence Number in the DCBX control TLV.

Type: u32
Default: 0
1553
LldpDeviceGenProtocolParams
LldpDeviceGenProtocolParams
Description:

Automatically-created children: LldpTlvConfig
LldpDeviceGenProtocolParams Writable Attributes

Writable Attribute
Description
Active, Name
MsgTxHoldMultiplier
Type: u8
Default: 4
Range: 2 - 10
MsgTxInterval
Type: u16
Default: 30
Range: 5 - 32768
ReinitializeDelay
Type: u8
Default: 2
Range: 1 - 10
TxDelay
Type: u16
Default: 2
Range: 1 - 8192
LldpDeviceGenProtocolParams Read-Only Attributes

LldpNeighborResults
Description:
LLDP node neighbor results.

Relations:
Side name
(Type)
Relative
Description
ResultParent
(ResultChild)
LldpNodeConfig
LldpNeighborResults Writable Attributes

1554
LldpNodeConfig
LldpNeighborResults Read-Only Attributes

Read-Only Attribute
Description
ChassisId
Chassis ID.
Type: string
Default: 0
ChassisIdSubtype
Chassis ID subtype.
Type: u8
Default: 0
PortId
Port ID.
Type: string
Default: 0
PortIdSubtype
Port ID subtype.
Type: u8
Default: 0
TimeToLive
Time To Live (in seconds).

Type: u16
Default: 0
LldpNodeConfig
Description:
Defines an LLDP emulated node object.

Automatically-created children: LldpTlvConfig
Result children (automatically created): DcbxBandwidthAllocationResult, DcbxBcnModeResult, DcbxBcnParameterResult, DcbxFcoePriorityResult,
DcbxLogicalLinkResult, DcbxNivResult, DcbxPriorityAllocationResult, DcbxPriorityFlowControlResult, LldpDcbxFeatureResult, LldpDcbxResult,
LldpNeighborResults, LldpNodeResults
Relations:
Side name
(Type)
Relative
Description
ResultChild
(ResultChild)
DcbxBandwidthAllocationResult, DcbxBcnModeResult,
DcbxBcnParameterResult, DcbxFcoePriorityResult,
DcbxLogicalLinkResult, DcbxNivResult, DcbxPriorityAllocationResult,
DcbxPriorityFlowControlResult, LldpDcbxFeatureResult,
LldpDcbxResult, LldpNeighborResults, LldpNodeResults

object.
UsesIf
(UsesIf)

LldpNodeConfig Writable Attributes

Writable Attribute
Description
Active, Name
DstMacAddr
Type: mac
Default: 01:80:c2:00:00:0e
1555
LldpNodeResults
Writable Attribute
Description
MsgTxHoldMultiplier
A multiplier used to compute the TTL value.

Type: u8
Default: 4
Range: 2 - 10
MsgTxInterval
Interval in seconds between successive transmit cycles.

Type: u16
Default: 30
Range: 5 - 32768
ReinitializeDelay
Delay (in seconds) after adminStatus becomes disable before re-initialization is attempted.
Type: u8
Default: 2
Range: 1 - 10
TxDelay

Type: u16
Default: 2
Range: 1 - 8192

Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
FALSE Don't use partial block state.
LldpNodeConfig Read-Only Attributes

Read-Only Attribute
Description
DeviceState
LLDP device state.

Type: enum
Default: LLDP_SESSION_STATE_NONE
Possible Values:
Value
Description
LLDP_SESSION_STATE_NONE
No state.
LLDP_SESSION_STATE_DOWN Session down.

LLDP_SESSION_STATE_UP
Session up.
LLDP_SESSION_STATE_PAUSE Session pause.
LldpNodeResults
Description:
LLDP Node statistics results.

Relations:
Side name
(Type)
Relative
Description
ResultParent
(ResultChild)
LldpNodeConfig
1556
LldpPauseCommand
LldpNodeResults Writable Attributes

LldpNodeResults Read-Only Attributes

Read-Only Attribute
Description
RxPortAgeOutsCount
Number of neighbors aged out.

Type: u64
Default: 0
RxPortErrorFrameCount
Number of LLDP error frames received.

Type: u64
Default: 0
RxPortFrameCount
Number of LLDP frames received.

Type: u64
Default: 0
RxPortFrameDiscardedCount
Number of LLDP frames discarded.

Type: u64
Default: 0
RxPortTlvsDiscardedCount
Number of LLDP TLVs discarded.

Type: u64
Default: 0
RxPortTlvsUnrecognizedCount
Number of unrecognized LLDP TLVs received.

Type: u64
Default: 0
TxPortFrameCount
Number of LLDP frames sent.

Type: u64
Default: 0
LldpPauseCommand
Description:
Stops sending LLDP message from the list of LLDP nodes.

LldpPauseCommand Writable Attributes

Writable Attribute
Description
NodeList
List of LLDP node that the command is executed on.

Type: handle
Default: 0
1557
LldpResumeCommand
LldpPauseCommand Read-Only Attributes

Read-Only Attribute
Description

LldpResumeCommand
Description:
Resumes sending LLDP message from the list of LLDP nodes.

LldpResumeCommand Writable Attributes

Writable Attribute
Description
NodeList

Type: handle
Default: 0
LldpResumeCommand Read-Only Attributes

Read-Only Attribute
Description

LldpShowNeighborsInfoCommand
Description:
View all the TLVs received from the Neighbors.

LldpShowNeighborsInfoCommand Writable Attributes

Writable Attribute
Description
FileName
Name of the file which saves all received TLVs from the neighbors.
Default: neighbors.txt
1558
LldpStateSummary
Writable Attribute
Description
NodeList

Type: handle
Default: 0
LldpShowNeighborsInfoCommand Read-Only Attributes

Read-Only Attribute
Description

LldpStateSummary
Description:
Summary of all router states per port and per project.

Relations:
Side name
(Type)
Relative
Description
ResultParent
(ResultChild)
Port, Project
LldpStateSummary Writable Attributes

LldpStateSummary Read-Only Attributes

Read-Only Attribute
Description
NotStartedCount
Number of routers in Not Started state.

Type: u32
Default: 0
RouterDownCount
Number of routers in any state other than SessionUp state.

Type: u32
Default: 0
RouterUpCount
Number of routers in Up state. SessionUp state is considered as UP state.

Type: u32
Default: 0
SessionsDownCount

Type: u64
Default: 0
SessionsPauseCount
Number of routers in SessionPause state.

Type: u64
Default: 0
SessionsUpCount
Number of routers in SessionUp state.

Type: u64
Default: 0
1559
LldpTlvConfig
LldpTlvConfig
Description:
This object holds the definition of the TLVs list carried in the LLDP message.

Automatically created from: LldpDeviceGenProtocolParams, LldpNodeConfig
LldpTlvConfig Writable Attributes

Writable Attribute
Description
Active, Name
AllowInvalidHeaders
Used to allow FrameConfig to contain an invalid TLV.

Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
FrameConfig can contain invalid TLVs.
FALSE FrameConfig cannot contain invalid TLVs.

FrameConfig
PDU (XML) configuration for the LLDP TLV lists.

Type: string
LldpTlvConfig Read-Only Attributes

Read-Only Attribute
Description
PduInfo
Type: string
LMM (EOAM:LMM)
Description:
LMM Attributes
Attribute
Description
FirstTLVOffset
Type: OCTETSTRING
Default: 0C
Flags
Type: INTEGER
Default: 00000000
Name
Type: string
OpCode
Type: OCTETSTRING
Default: 2B
1560
LMM
Attribute
Description
RxFCf
Type: OCTETSTRING
Default: 00000000
TxFCb
Type: OCTETSTRING
Default: 00000000
TxFCf
Type: OCTETSTRING
Default: 00000000
LMM (serviceoam:LMM)
Description:
LMM Attributes
Attribute
Description
FirstTLVOffset
Type: OCTETSTRING
Default: 0C
Flags
Type: INTEGER
Default: 00000000
Name
Type: string
OpCode
Type: OCTETSTRING
Default: 2B
RxFCf
Type: OCTETSTRING
Default: 00000000
TxFCb
Type: OCTETSTRING
Default: 00000000
TxFCf
Type: OCTETSTRING
Default: 00000000
LMR (EOAM:LMR)
Description:
1561
LMR
LMR Attributes
Attribute
Description
FirstTLVOffset
Type: OCTETSTRING
Default: 0C
Flags
Type: INTEGER
Default: 00000000
Name
Type: string
OpCode
Type: OCTETSTRING
Default: 2A
RxFCf
Type: OCTETSTRING
Default: 00000000
TxFCb
Type: OCTETSTRING
Default: 00000000
TxFCf
Type: OCTETSTRING
Default: 00000000
LMR (serviceoam:LMR)
Description:
LMR Attributes
Attribute
Description
FirstTLVOffset
Type: OCTETSTRING
Default: 0C
Flags
Type: INTEGER
Default: 00000000
Name
Type: string
OpCode
Type: OCTETSTRING
Default: 2A
RxFCf
Type: OCTETSTRING
Default: 00000000
TxFCb
Type: OCTETSTRING
Default: 00000000
TxFCf
Type: OCTETSTRING
Default: 00000000
1562
LoadFilterFromLibraryCommand
LoadFilterFromLibraryCommand
Description:
Load a capture pattern matching template.

LoadFilterFromLibraryCommand Writable Attributes

Writable Attribute
Description
CaptureProxyId

Type: handle
Default: 0
FileName
Name of the pattern matching template file to load.

Type: string
LoadFilterFromLibraryCommand Read-Only Attributes

Read-Only Attribute
Description

LoadFromDatabaseCommand
Description:
Loads a configuration database file into memory. The configuration database file must be in TestCenter Configuration (.tcc) format. You can create this type
of file with the SaveToTccCommand object, or with the Spirent TestCenter GUI. In the GUI, choose File / Save As, and then set Save as type to TestCenter
Configuration (*.tcc).

LoadFromDatabaseCommand Writable Attributes

Writable Attribute
Description
File name of the configuration database file to load.

Type: inputFilePath
Default: result.db
DataSetId
If the saved configuration database contains multiple configurations (that is, multiple save points), each
configuration has a dataset ID associated with it. The IDs start at zero (0) and automatically increment
with each save.
Type: u32
Default: 0
1563
LoadFromTemplateCommand
LoadFromDatabaseCommand Read-Only Attributes

Read-Only Attribute
Description

LoadFromTemplateCommand
Description:
Loads data from a template to an object.

LoadFromTemplateCommand Writable Attributes

Writable Attribute
Description
Config
Destination object for the load.

Type: handle
Default: 0
TemplateUri
The URI of the template to load from.

Type: string
UseSystemDefaultTemplate
Whether to use only the system default templates.

Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
Uses only the system default templates when resolving the URI.
FALSE Uses both user and system templates when resolving the URI.
LoadFromTemplateCommand Read-Only Attributes

Read-Only Attribute
Description

LoadFromXmlCommand
Description:
Loads an XML configuration file into memory. This XML configuration file might create objects in memory. Call stc::apply to send the configuration to the
connected chassis.
You can create an XML configuration file with the SaveAsXmlCommand object, or with the Spirent TestCenter GUI. In the GUI, choose File / Save As, and
then set Save as type to Xml files (*.xml).

1564
locallyAssigned

LoadFromXmlCommand Writable Attributes

Writable Attribute
Description
FileName
File name of the XML configuration file to load. You can include a path. If you use the InputConfigString attribute, make
this attribute empty.
Type: inputFilePath
Default: config.xml
InputConfigString
If the FileName attribute is empty, you can use an XML configuration as a string in this attribute.
Type: string
Default: 0
ParentConfig
Handle of the object under which to load the objects in the XML configuration. Do not use this if you want to replace
the entire configuration. If you want to replace a single object, use the TargetConfig attribute and leave this at the
default.
Type: handle
Default: 0
TargetConfig
Handle of the object to replace with the object that is in the XML configuration. Do not use this if you want to replace
the entire configuration. If you want to replace the objects under a parent object, use the ParentConfig attribute and
leave this at the default.
Type: handle
Default: 0
UseDefaultName
Whether to use the system-assigned names for each object that is loaded.
Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
Use the system-assigned names for each object loaded.
FALSE Use the names from the XML configuration, which may conflict with the already-assigned names.
LoadFromXmlCommand Read-Only Attributes

Read-Only Attribute
Description

Config
Handle of the parent object of all the objects loaded.

Type: handle
Default: 0
locallyAssigned
Description:
Parents: chassisid
Children: None
1565
locallyAssigned
locallyAssigned Attributes
Attribute
Description
id
Type: INTEGER
Default: 0
Name
information.
Type: string
subtype
Default: 07
Possible Values:
Value Description
01
Chassis Component
02
Interface Alias
03
Port Component
04
MAC Address
05
Network Address
06
Interface Name
07
Locally Assigned
locallyAssigned
Description:
Children: None
locallyAssigned Attributes
Attribute
Description
ChassisID
Type: ASCII
Default: SPIRENT
ChassisIDSubtype
Default: 07
Possible Values:
Value Description
Name
01
Chassis Component
02
Interface Alias
03
Port Component
04
MAC Address
05
Network Address
06
Interface Name
07
Locally Assigned
more information.
Type: string
1566
LogFileQuerySet
LogFileQuerySet
Description:
Configures system to write event messages to bll.log.

Parents: Project
Result children (automatically created): Result, ResultViewData
Relations:
Side name
(Type)
Relative
Description
ResultChild
(ResultChild)
Result, ResultViewData
LogFileQuerySet Writable Attributes

Writable Attribute
Description
Active, Name
Description
Not used with this object.

Type: string
DisablePaging
Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
FALSE
Identifier

Type: string
InternalXmlFormatString

Type: string
NotifyInterval

Type: u16
Default: 1000
Range: 1000 - 60000
PageNumber

Type: u16
Default: 1
Path

Type: string
PrimaryClass

Type: string
RecordsPerPage

Type: u16
Default: 100
1567
logicLinkDownTlv
Writable Attribute
Description
ResultViewOwner

Type: enum
Default: SYSTEM
Possible Values:
Value
Description
SYSTEM
USER
LogFileQuerySet Read-Only Attributes

Read-Only Attribute
Description
ResultState
ResultHandleList
Contains the handles of objects attached to this dataset.

Type: handle
Default: 0
TotalPageCount

Type: u16
Default: 1
logicLinkDownTlv
Description:
Parents: DcbxSubTlvt1
Children: header
logicLinkDownTlv Attributes
Attribute
Description
Name
more information.
Type: string
reserved
Type: BITSTRING
Default: 0000000
status
Type: INTEGER
Default: 1
logo
Description:
Parents: fabricLogoRequest
Children: fc
1568
logoAcc
logo Attributes
Attribute
Description
command
Type: OCTETSTRING
Default: 05
Name
Type: string
nPortId
Type: OCTETSTRING
Default: 00000A
portName
Type: WWN
Default: 20:00:10:94:00:00:00:01
reserved1
Type: OCTETSTRING
Default: 00000000
logoAcc
Description:
Parents: fabricLogoAccept
Children: fc
logoAcc Attributes
Attribute
Description
command
Type: OCTETSTRING
Default: 02
Name
Type: string
reserved1
Type: OCTETSTRING
Default: 000000
logoAccept
Description:
Children: None
logoAccept Attributes
Attribute
Description
command
Type: OCTETSTRING
Default: 02
1569
logoReject
Attribute
Description
Name
Type: string
reserved1
Type: OCTETSTRING
Default: 000000
logoReject
Description:
Children: None
logoReject Attributes
Attribute
Description
command
Type: OCTETSTRING
Default: 01
Name
Type: string
reasonCode
Type: OCTETSTRING
Default: 3
reasonExplanation
Type: OCTETSTRING
Default: 0F
reserved1
Type: OCTETSTRING
Default: 00000000
vendorUnique
Type: OCTETSTRING
Default: 0
logoRequest
Description:
Children: None
logoRequest Attributes
Attribute
Description
command
Type: OCTETSTRING
Default: 05
1570
logoRjt
Attribute
Description
Name
Type: string
nPortId
Type: OCTETSTRING
Default: 000000
portName
Type: WWN
Default: 20:00:10:94:00:00:00:01
reserved1
Type: OCTETSTRING
Default: 00000000
logoRjt
Description:
Children: fc
logoRjt Attributes
Attribute
Description
commandCode
Type: OCTETSTRING
Default: 01
explanationCode
Type: OCTETSTRING
Default: 0F
Name
Type: string
reasonCode
Type: OCTETSTRING
Default: 03
reserved1
Type: OCTETSTRING
Default: 000000
reserved2
Type: OCTETSTRING
Default: 00
vendorUnique
Type: OCTETSTRING
Default: 00
LoopbackControlOAMPDU (LinkOAM:LoopbackControlOAMPDU)
Description:
Children: OAMBH
1571
looseSrcRoute
LoopbackControlOAMPDU Attributes
Attribute
Description
Code
Type: OCTETSTRING
Default: 04
data
Type: rlbc
Default: 01
Possible Values:
Value Description
00
Reserved
01
Enable OAM Remote Loopback
02
Disable OAM Remote Loopback
03
Reserved
Name
information.
Type: string
Pad
Type: OCTETSTRING
looseSrcRoute
Description:
Children: addrList
looseSrcRoute Attributes
Attribute
Description
length
Type: INTEGER
Default: 0
Name
Type: string
pointer
Type: INTEGER
Default: 0
1572
lsaHdrOptions
Attribute
Description
type
Default: 131
Possible Values:
Value Description
0
End of Options List
NOP
130
Security
131
Loose Source Route
68
Time Stamp
133
Extended Security
Record Route
136
Stream Identifier
137
Strict Source Route
11
MTU Probe
12
MTU Reply
82
Traceroute
147
Address Extension
148
Router Alert
149
lsaHdrOptions
Description:
Children: None
lsaHdrOptions Attributes
Attribute
Description
dcBit
Type: BITSTRING
Default: 0
eaBit
Type: BITSTRING
Default: 0
eBit
Type: BITSTRING
Default: 0
mcBit
Type: BITSTRING
Default: 0
Name
Type: string
npBit
Type: BITSTRING
Default: 0
reserved0
Type: BITSTRING
Default: 0
reserved6
Type: BITSTRING
Default: 0
1573
lsaHeaders
Attribute
Description
reserved7
Type: BITSTRING
Default: 0
lsaHeaders
Description:
Parents: Ospfv2DatabaseDescription, Ospfv2LinkStateAcknowledge
Children: Ospfv2LsaHeader
lsaHeaders Attributes
Attribute
Description
Name
information.
Type: string
LsaReq (fcsw:LsaReq)
Description:
Children: fspfHeader, lsrs
LsaReq Attributes
Attribute
Description
flags
Type: BITSTRING
Default: 00000000
Name
Type: string
numLSRs
Type: INTEGER
Default: 0
reserved
Type: OCTETSTRING
Default: 000000
lsaRequest
Description:
1574
LspPing
lsaRequest Attributes
Attribute
Description
flags
Type: BITSTRING
Default: 00000000
Name
Type: string
numLSRs
Type: INTEGER
Default: 0
reserved
Type: OCTETSTRING
Default: 000000
LspPing (lspping:LspPing)
Description:
Children: header, tlvs
LspPing Attributes
Attribute
Description
Name
information.
Type: string
LspPingImportFecInfoFromStreamBlockCommand
Description:

LspPingImportFecInfoFromStreamBlockCommand Writable Attributes

Writable Attribute
Description
ClearEchoRequestConfig
Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
FALSE
1575
LspPingPausePingCommand
Writable Attribute
Description
FecTypes
Type: enum
Default: IPV4_PREFIX | IPV6_PREFIX | LDP_VC_FEC_128 | LDP_VC_FEC_129 | BGP_VPLS |
VPN_IPV4 | VPN_IPV6 | RSVP
Possible Values:
Value
Description
IPV4_PREFIX
IPV6_PREFIX
LDP_VC_FEC_128
LDP_VC_FEC_129
BGP_VPLS
VPN_IPV4
VPN_IPV6
RSVP
LspPingList
Type: handle
Default: 0
StreamBlockList
Type: handle
Default: 0
LspPingImportFecInfoFromStreamBlockCommand Read-Only Attributes

Read-Only Attribute
Description

ReturnList
Type: handle
Default: 0
LspPingPausePingCommand
Description:

LspPingPausePingCommand Writable Attributes

Writable Attribute
Description
EchoRequestList
Type: handle
Default: 0
LspPingPausePingCommand Read-Only Attributes

Read-Only Attribute
Description

1576
LspPingPauseTraceRouteCommand
LspPingPauseTraceRouteCommand
Description:

LspPingPauseTraceRouteCommand Writable Attributes

Writable Attribute
Description
EchoRequestList
Type: handle
Default: 0
LspPingPauseTraceRouteCommand Read-Only Attributes

Read-Only Attribute
Description

LspPingPingResults
Description:
LSP-Pring echo request results.

Relations:
Side name
(Type)
Relative
Description
ResultParent
(ResultChild)
LspPingProtocolConfig
LspPingPingResults Writable Attributes

LspPingPingResults Read-Only Attributes

Read-Only Attribute
Description
AvgPingLatency
Type: u64
Default: 0
FailCount
Type: u64
Default: 0
LspFecInfo
Type: string
Default: Fec Info
LspPathDown
Type: u8
Default: 0
1577
Read-Only Attribute
Description
LspPathUp
Type: u8
Default: 0
MaxPingLatency
Type: u64
Default: 0
MinPingLatency
Type: u64
Default: 0
RxReturnCode
Type: enum
Default: NO_RETURN_CODE
Possible Values:
Value
Description
NO_RETURN_CODE
MALFORMED_ECHO_REQUEST
TLV_NOT_UNDERSTOOD
REPLYING_ROUTER_IS_AN_EGRESS
NO_FEC_MAPPING
DOWNSTREAM_MAPPING_MISMATCH
UNKNOWN_UPSTREAM_IF_INDEX
LABEL_SWITCHED
LABEL_SWITCHED_BUT_NO_MPLS_FORWARDING
FEC_AND_LABEL_MISMATCH
NO_LABEL_ENTRY
PROTOCOL_NOT_ASSOCIATED_WITH_IF
PREMATURE_TERMINATION_OF_PING
State
Type: enum
Default: STOPPED
Possible Values:
Value
Description
STOPPED
RESOLVING_LSP_PATH
STARTED
SuccessCount
Type: u64
Default: 0
Description:

Children: EchoReplyErrorGeneration, Ipv4EchoRequestConfig
Result children (automatically created): LspPingPingResults, LspPingProtocolResults, LspPingTraceRouteResults
Relations:
Side name
(Type)
Relative
Description
ResultChild
(ResultChild)
LspPingPingResults, LspPingProtocolResults,
LspPingTraceRouteResults
1578
LspPingProtocolResults
Side name
(Type)
Relative
Description
UsesIf
(UsesIf)


LspPingProtocolConfig Writable Attributes

Writable Attribute
Description
Active, Name
Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
FALSE
LspPingProtocolConfig Read-Only Attributes

Read-Only Attribute
Description
ProtocolState
Type: enum
Default: LSP_PING_STATE_NO_STATE
Possible Values:
Value
Description
LSP_PING_STATE_NO_STATE
LSP_PING_STATE_DOWN
LSP_PING_STATE_UP
LspPingProtocolResults
Description:
LSP-Ping results.

Relations:
Side name
(Type)
Relative
Description
ResultParent
(ResultChild)
LspPingProtocolResults Writable Attributes

LspPingProtocolResults Read-Only Attributes

Read-Only Attribute
Description
LspPingDownCount
Type: u64
Default: 0
1579
LspPingResumePingCommand
Read-Only Attribute
Description
LspPingUpCount
Type: u64
Default: 0
RxEchoReplyCount
Type: u64
Default: 0
RxEchoRequestCount
Type: u64
Default: 0
TxEchoReplyCount
Type: u64
Default: 0
TxEchoRequestCount
Type: u64
Default: 0
LspPingResumePingCommand
Description:

LspPingResumePingCommand Writable Attributes

Writable Attribute
Description
EchoRequestList
Type: handle
Default: 0
LspPingResumePingCommand Read-Only Attributes

Read-Only Attribute
Description

LspPingResumeTraceRouteCommand
Description:

LspPingResumeTraceRouteCommand Writable Attributes

Writable Attribute
Description
1580
LspPingStateSummary
Writable Attribute
Description
EchoRequestList
Type: handle
Default: 0
LspPingResumeTraceRouteCommand Read-Only Attributes

Read-Only Attribute
Description

LspPingStateSummary
Description:

Relations:
Side name
(Type)
Relative
Description
ResultParent
(ResultChild)
Port, Project
LspPingStateSummary Writable Attributes

LspPingStateSummary Read-Only Attributes

Read-Only Attribute
Description
NotStartedCount
Type: u32
Default: 0
RouterDownCount
Type: u32
Default: 0
RouterUpCount
Type: u32
Default: 0
LspPingTlvs
Description:
Parents: tlvs
Children: CustomTlvType, downstreamMappingTlv, erroredTlv, interfaceAndLabelStackTlv, padTlv, replyTOSByteTlv, targetFecTlv, vendorEnterpriseNumberTlv
1581
LspPingTlvs Attributes
Attribute
Description
Name
information.
Type: string
Description:
LSP-Ping trace route results.

Relations:
Side name
(Type)
Relative
Description
ResultParent
(ResultChild)
LspPingTraceRouteResults Writable Attributes

LspPingTraceRouteResults Read-Only Attributes

Read-Only Attribute
Description
FailCount
Type: u64
Default: 0
LspFecInfo
Type: string
Default: Fec Info
LspHopCount
Type: u8
Default: 0
LspPathDown
Type: u8
Default: 0
LspPathUp
Type: u8
Default: 0
1582
lsrs
Read-Only Attribute
Description
RxReturnCode
Type: enum
Default: NO_RETURN_CODE
Possible Values:
Value
Description
NO_RETURN_CODE
MALFORMED_ECHO_REQUEST
TLV_NOT_UNDERSTOOD
REPLYING_ROUTER_IS_AN_EGRESS
NO_FEC_MAPPING
DOWNSTREAM_MAPPING_MISMATCH
UNKNOWN_UPSTREAM_IF_INDEX
LABEL_SWITCHED
LABEL_SWITCHED_BUT_NO_MPLS_FORWARDING
FEC_AND_LABEL_MISMATCH
NO_LABEL_ENTRY
PROTOCOL_NOT_ASSOCIATED_WITH_IF
PREMATURE_TERMINATION_OF_PING
State
State of the LSP Ping session.

Type: enum
Default: STOPPED
Possible Values:
Value
Description
STOPPED
Ping messages are not being transmitted.
RESOLVING_LSP_PATH
STARTED
SuccessCount
Type: u64
Default: 0
lsrs (overloaded)
lsrs (fc) - Object definition for the following paths:
StreamBlock.FCoE.fc.fcPayloads.FCPayload-Choice.lsuRequest.lsrs
lsrs (fc) - Object definition for the following paths:
StreamBlock.FCoE.fc.fcPayloads.FCPayload-Choice.lsaRequest.lsrs
lsrs (fcsw) - Object definition for the following paths:
StreamBlock.LsaReq.lsrs
lsrs (fcsw) - Object definition for the following paths:
StreamBlock.LsuReq.lsrs
lsrs Object (fc PDU library)

Description:
Parents: lsuRequest (StreamBlock.FCoE.fc.fcPayloads.FCPayload-Choice.lsuRequest)

Children: LinkStateRecord
1583
lsrs
lsrs Attributes
Attribute
Description
Name
information.
Type: string
lsrs Object (fc PDU library)

Description:
Parents: lsaRequest (StreamBlock.FCoE.fc.fcPayloads.FCPayload-Choice.lsaRequest)

Children: LinkStateHeader
lsrs Attributes
Attribute
Description
Name
information.
Type: string
lsrs Object (fcsw PDU library)

Description:
Parents: lsaRequest (StreamBlock.LsaReq)

Children: LinkStateHeader
lsrs Attributes
Attribute
Description
Name
information.
Type: string
lsrs Object (fcsw PDU library)
1584
LsuReq
Description:
Parents: lsuRequest (StreamBlock.LsuReq)

Children: LinkStateRecord
lsrs Attributes
Attribute
Description
Name
information.
Type: string
LsuReq (fcsw:LsuReq)
Description:
LsuReq Attributes
Attribute
Description
flags
Type: BITSTRING
Default: 00000000
Name
Type: string
numLSRs
Type: INTEGER
Default: 0
reserved
Type: OCTETSTRING
Default: 000000
lsuRequest
Description:
lsuRequest Attributes
Attribute
Description
flags
Type: BITSTRING
Default: 00000000
1585
LTM
Attribute
Description
Name
Type: string
numLSRs
Type: INTEGER
Default: 0
reserved
Type: OCTETSTRING
Default: 000000
LTM (EOAM:LTM)
Description:
Children: cfmHeader, MACPreamble, theLTMTLVs
LTM Attributes
Attribute
Description
FirstTLVOffset
Type: OCTETSTRING
Default: 11
Flags
Type: LTMFF
Default: 80
Possible Values:
Value Description
80
UseFDBonly (on)
00
UseFDBonly (off)
LTMTransID
Type: OCTETSTRING
Default: 00000000
LTMTTL
Type: OCTETSTRING
Default: 00
Name
Type: string
OpCode
Type: OCTETSTRING
Default: 5
OrigMAC
Type: MACADDR
Default: 00:00:00:00:00:00
TargetMAC
Type: MACADDR
Default: 00:00:00:00:00:01
LTM (serviceoam:LTM)
Description:
1586
LTMEgressIdentTLV
Children: cfmHeader, theLTMTLVs
LTM Attributes
Attribute
Description
FirstTLVOffset
Type: OCTETSTRING
Default: 11
Flags
Type: LTMFF
Default: 80
Possible Values:
Value Description
80
UseFDBonly (on)
00
UseFDBonly (off)
LTMTransID
Type: OCTETSTRING
Default: 00000000
LTMTTL
Type: OCTETSTRING
Default: 00
Name
Type: string
OpCode
Type: OCTETSTRING
Default: 5
OrigMAC
Type: MACADDR
Default: 00:00:00:00:00:00
TargetMAC
Type: MACADDR
Default: 00:00:00:00:00:01
LTMEgressIdentTLV (overloaded)
LTMEgressIdentTLV (EOAM)
LTMEgressIdentTLV (serviceoam)
LTMEgressIdentTLV Object (EOAM PDU library)

Description:
Parents: LTMTLVList (StreamBlock.LTM.theLTMTLVs.LTMTLVList)

Children: None
1587
LTMEgrID
LTMEgressIdentTLV Attributes
Attribute
Description
EgressIdent
Type: OCTETSTRING
Default: 0102030405060708
Length
Type: OCTETSTRING
Default: 0000
Name
Type: string
Type
Type: OCTETSTRING
Default: 07
LTMEgressIdentTLV Object (serviceoam PDU library)

Description:
Parents: LTMTLVList (StreamBlock.LTM.theLTMTLVs.LTMTLVList)

Children: EgressIdent
LTMEgressIdentTLV Attributes
Attribute
Description
Length
Type: OCTETSTRING
Default: 0000
Name
more information.
Type: string
Type
Type: OCTETSTRING
Default: 07
LTMEgrID (EOAMTLV:LTMEgrID)
Description:
Children: EgressIdent
1588
LTMTLVList
LTMEgrID Attributes
Attribute
Description
Length
Type: OCTETSTRING
Default: 0000
Name
more information.
Type: string
Type
Type: OCTETSTRING
Default: 07
LTMTLVList
Description:
Parents: theLTMTLVs
Children: EndTLV, LTMEgressIdentTLV, OrgSpecTLV, SenderIDTLV
LTMTLVList Attributes
Attribute
Description
Name
information.
Type: string
LTMTLVList
Description:
Parents: theLTMTLVs
Children: EndTLV, LTMEgressIdentTLV, OrgSpecTLV, PbbTeMipTLV, SenderIDTLV
LTMTLVList Attributes
Attribute
Description
Name
information.
Type: string
LTR (EOAM:LTR)
Description:
1589
LTR
Children: cfmHeader, MACPreamble, theLTRTLVs
LTR Attributes
Attribute
Description
FirstTLVOffset
Type: OCTETSTRING
Default: 06
FwdYes
Type: LTRfwd
Default: 1
Possible Values:
Value Description
LTRRelayAction
LTM was NOT Forwarded
LTM was Forwarded
Type: LTRRelayActionField
Default: 01
Possible Values:
Value Description
01
RlyHit
02
RlyFDB
03
RlyMPDB
LTRTransID
Type: OCTETSTRING
Default: 00000000
Name
Type: string
OpCode
Type: OCTETSTRING
Default: 4
ReplyTTL
Type: OCTETSTRING
Default: 00
Reserved
Type: BITSTRING
Default: 00000
TermMEP
Type: LTRTermMep
Default: 1
Possible Values:
Value Description
UseFDBonly
MP reported in TLV is NOT a MEP
MP reported in TLV is a MEP
Type: BITSTRING
Default: 0
LTR (serviceoam:LTR)
Description:
Children: cfmHeader, theLTRTLVs
1590
LTREgressIdentTLV
LTR Attributes
Attribute
Description
FirstTLVOffset
Type: OCTETSTRING
Default: 06
FwdYes
Type: LTRfwd
Default: 1
Possible Values:
Value Description
LTRRelayAction
LTM was NOT Forwarded
LTM was Forwarded
Type: LTRRelayActionField
Default: 01
Possible Values:
Value Description
01
RlyHit
02
RlyFDB
03
RlyMPDB
LTRTransID
Type: OCTETSTRING
Default: 00000000
Name
Type: string
OpCode
Type: OCTETSTRING
Default: 4
ReplyTTL
Type: OCTETSTRING
Default: 00
Reserved
Type: BITSTRING
Default: 00000
TermMEP
Type: LTRTermMep
Default: 1
Possible Values:
Value Description
UseFDBonly
MP reported in TLV is NOT a MEP
MP reported in TLV is a MEP
Type: BITSTRING
Default: 0
LTREgressIdentTLV (overloaded)
LTREgressIdentTLV (EOAM)
LTREgressIdentTLV (serviceoam)
1591
LTREgrID
LTREgressIdentTLV Object (EOAM PDU library)

Description:
Parents: LTRTLVList (StreamBlock.LTR.theLTRTLVs.LTRTLVList)

Children: None
LTREgressIdentTLV Attributes
Attribute
Description
LastEgressIdent
Type: OCTETSTRING
Default: 0102030405060708
Length
Type: OCTETSTRING
Default: 0000
Name
Type: string
NextEgressIdent
Type: OCTETSTRING
Default: 0102030405060708
Type
Type: OCTETSTRING
Default: 08
LTREgressIdentTLV Object (serviceoam PDU library)

Description:

Children: LastEgressIdent, NextEgressIdent
LTREgressIdentTLV Attributes
Attribute
Description
Length
Type: OCTETSTRING
Default: 0000
Name
more information.
Type: string
Type
Type: OCTETSTRING
Default: 08
LTREgrID (EOAMTLV:LTREgrID)
1592
LTRTLVList
Description:
Children: LastEgressIdent, NextEgressIdent
LTREgrID Attributes
Attribute
Description
Length
Type: OCTETSTRING
Default: 0000
Name
more information.
Type: string
Type
Type: OCTETSTRING
Default: 08
LTRTLVList
Description:
Parents: theLTRTLVs
Children: EndTLV, LTREgressIdentTLV, OrgSpecTLV, ReplyEgressTLVFormatTLV, ReplyIngressTLVFormatTLV, SenderIDTLV
LTRTLVList Attributes
Attribute
Description
Name
information.
Type: string
LTRTLVList
Description:
Parents: theLTRTLVs
Children: EndTLV, LTREgressIdentTLV, OrgSpecTLV, ReplyEgressTLVFormatTLV, ReplyIngressTLVFormatTLV, SenderIDTLV
LTRTLVList Attributes
Attribute
Description
Name
information.
Type: string
1593
macAddr
macAddr
Description:
Parents: DL-Choice
Children: None
macAddr Attributes
Attribute
Description
length
Type: INTEGER
Default: 2
macAddr
Type: MACADDR
Default: 00:10:94:00:00:01
Name
more information.
Type: string
type
Type: INTEGER
Default: 2
macAddress
Description:
Parents: chassisid
Children: None
macAddress Attributes
Attribute
Description
id
Type: MACADDR
Default: 00:00:00:00:00:00
Name
Type: string
subtype
Default: 04
Possible Values:
Value Description
01
Chassis Component
02
Interface Alias
03
Port Component
04
MAC Address
05
Network Address
06
Interface Name
07
Locally Assigned
1594
macAddress
macAddress
Description:
Children: None
macAddress Attributes
Attribute
Description
ChassisID
Type: MACADDR
ChassisIDSubtype
Default: 04
Possible Values:
Value Description
Name
01
Chassis Component
02
Interface Alias
03
Port Component
04
MAC Address
05
Network Address
06
Interface Name
07
Locally Assigned
more information.
Type: string
MacBlock
Description:
MAC address block.

Automatically created from: LacpGroupConfig, MacGroup, VcLsp
Relations:
Side name
(Type)
Relative
Description
DstBoundTo
(DstBinding)

StreamBlock.
EncapsulationSource
(Encapsulation)
PathDescriptor
MemberOfVpn
(MemberOfVpn)

Port

1595
MacControl
Side name
(Type)
Relative
Description

VlanIf, WimaxIf

SrcBoundTo
(SrcBinding)

StreamBlock.
StackedOn
(StackedOnEndpoint)

VlanIf, WimaxIf
Port

MacBlock Writable Attributes

Writable Attribute
Description
Active, Name
AddrIncrement
MAC address increment.

Type: u32
Default: 1
NetworkCount
Type: u32
Default: 1
Offset
Type: u8
Default: 0
Range: 0 - 5
StartMacList

Type: mac
Default: 00-00-00-00-00-01
MacBlock Read-Only Attributes

MacControl (ethernetpause:MacControl)
Description:
Children: None
Next headers: custom:Custom, ethernetpause:PauseMacControl, ethernetpause:PFC
1596
MacGroup
MacControl Attributes
Attribute
Description
dstMac
Type: MACADDR
Default: 00:00:01:00:00:01
lengthType
Type: OCTETSTRING
Default: 8808
Name
Type: string
preamble
Type: OCTETSTRING
Default: 55555555555555d5
srcMac
Type: MACADDR
Default: 00:10:94:00:00:02
MacGroup
Description:
MAC address group.

Parents: Project
Automatically-created children: MacBlock
MacGroup Writable Attributes

Writable Attribute
Description
Active, Name
MacGroup Read-Only Attributes

MAC-in-MAC (MAC-in-MAC:MAC-in-MAC)
Description:
Children: bVlanTag
Next headers: MAC-in-MAC:iTag, mpls:Mpls, lacp:LACP, lacp:Marker, serviceoam:CCM, serviceoam:LBM, serviceoam:LBR, serviceoam:LTM, serviceoam:LTR,
serviceoam:LMM, serviceoam:LMR, serviceoam:DMM, serviceoam:DMR
MAC-in-MAC Attributes
Attribute
Description
bDstMac
Type: MACADDR
Default: 00:00:01:00:00:01
1597
MacPhyConfigStatusTlv
Attribute
Description
bSrcMac
Type: MACADDR
Default: 00:10:94:00:00:02
etherType
Type: EtherTypes
Default: 88B5
Possible Values:
Value Description
0200
XEROX PUP
0201
PUP Addr Trans
0400
Nixdorf
0600
XEROX NS IDP
0660
DLOG
0661
DLOG2
0800
Internet IP
0801
X.75 Internet
0802
NBS Internet
0803
ECMA Internet
0804
Chaosnet
0805
X.25 Level 3
0806
ARP
0807
XNS Compatibility
0808
Frame Relay ARP
8035
RARP
86DD IPv6
880B PPP
8809
Slow Protocol
8847
MPLS Unicast
8848
MPLS Multicast
8863
PPPoE Discovery
8864
PPPoE Session
8906
FCoE
8914
FIP
Name
information.
Type: string
preamble
Type: OCTETSTRING
Default: 55555555555555d5
MacPhyConfigStatusTlv (lldp:MacPhyConfigStatusTlv)
Description:
Children: autoNegotiationAdvertisedCapability, autoNegotiationSupportAndStatus
lldp:NivSupportTlv
1598
MacPhyConfigStatusTlv
MacPhyConfigStatusTlv Attributes
Attribute
Description
length
Type: INTEGER
Default: 0
Name
Type: string
operationalMauType
Type: EnumMauType
Default: 0000
Possible Values:
Value Description
0000
Other
0001
AUI
0002
10Base5
0003
FOIRL
0004
10Base2
0005
10BaseT
0006
10BaseFP
0007
10BaseFB
0008
10BaseFL
0009
10Broad36
000A 10BaseTHD
000B 10BaseTFD
000C 10BaseFLHD
000D 10BaseFLFD
000E 10BaseT4
000F 100BaseTXHD
0010
100BaseTXFD
0011
100BaseFXFD
0012
100BaseFXFD
0013
100BaseT2HD
0014
100BaseT2FD
0015
1000BaseTXHD
0016
1000BaseTXFD
0017
1000BaseLXHD
0018
1000BaseLXFD
0019
1000BaseSXHD
001A 1000BaseSXFD
001B 1000BaseCXHD
001C 1000BaseCXFD
001D 1000BaseTHD
001E 1000BaseTFD
001F 10GigBaseX
0020
10GigBaseLX4
0021
10GigBaseR
0022
10GigBaseER
0023
10GigBaseLR
0024
10GigBaseSR
0025
10GigBaseW
0026
10GigBaseEW
0027
10GigBaseLW
0028
10GigBaseSW
1599
MACPreamble
Attribute
Description
oui
Type: OCTETSTRING
Default: 00120F
subtype
Type: OCTETSTRING
Default: 01
type
Type: INTEGER
Default: 127
MACPreamble
Description:
Parents: CCM, LBM, LBR, LTM, LTR, LMM, LMR, DMM, DMR
Children: theTags
MACPreamble Attributes
Attribute
Description
dstMac
Type: MACADDR
Default: 01:80:c2:00:00:00
etherType
Type: EtherTypes
Default: 8902
Possible Values:
Value Description
0200
XEROX PUP
0201
PUP Addr Trans
0400
Nixdorf
0600
XEROX NS IDP
0660
DLOG
0661
DLOG2
0800
Internet IP
0801
X.75 Internet
0802
NBS Internet
0803
ECMA Internet
0804
Chaosnet
0805
X.25 Level 3
0806
ARP
0807
XNS Compatibility
0808
Frame Relay ARP
8035
RARP
86DD IPv6
880B PPP
8809
Slow Protocol
8847
MPLS Unicast
8848
MPLS Multicast
8863
PPPoE Discovery
8864
PPPoE Session
8906
FCoE
8914
FIP
1600
MADCustom
Attribute
Description
Name
Type: string
srcMac
Type: MACADDR
Default: 00:00:01:00:00:02
MADCustom
Description:
Parents: MADList
Children: None
MADCustom Attributes
Attribute
Description
MAD
Type: OCTETSTRING
Default: 00
MADL
Type: OCTETSTRING
Default: 00
MAL
Type: OCTETSTRING
Default: 00
ManAdd
Type: OCTETSTRING
Default: 00
Name
more information.
Type: string
MADList
Description:
Parents: theManagementAddressDomain
Children: MADCustom, MADsI802, MADtDL, MADtDS4, MADtDS4z, MADtDS6, MADtDS6z, MADtDT4, MADtDT4z, MADtDT6, MADtDT6z, MADtDU, MADtDU4,
MADtDU4z, MADtDU6, MADtDU6z, MADtSU, MADtTU
MADList Attributes
Attribute
Description
Name
information.
Type: string
1601
MADsI802
MADsI802
Description:
Parents: MADList
Children: None
MADsI802 Attributes
Attribute
Description
MAD
Type: OCTETSTRING
Default: 2b0601060106
MADL
Type: OCTETSTRING
Default: 06
MAL
Type: OCTETSTRING
Default: 00
ManAdd
Type: MACADDR
Name
more information.
Type: string
MADtDL
Description:
Parents: MADList
Children: ManAdd
MADtDL Attributes
Attribute
Description
MAD
Type: OCTETSTRING
Default: 2b0601020164010D
MADL
Type: OCTETSTRING
Default: 08
MAL
Type: OCTETSTRING
Default: 00
Name
more information.
Type: string
MADtDS4
Description:
Parents: MADList
1602
MADtDS4z
Children: ManAdd
MADtDS4 Attributes
Attribute
Description
MAD
Type: OCTETSTRING
Default: 2b06010201640109
MADL
Type: OCTETSTRING
Default: 08
MAL
Type: OCTETSTRING
Default: 06
Name
more information.
Type: string
MADtDS4z
Description:
Parents: MADList
Children: ManAdd
MADtDS4z Attributes
Attribute
Description
MAD
Type: OCTETSTRING
Default: 2b0601020164010B
MADL
Type: OCTETSTRING
Default: 08
MAL
Type: OCTETSTRING
Default: 0A
Name
more information.
Type: string
MADtDS6
Description:
Parents: MADList
Children: ManAdd
1603
MADtDS6z
MADtDS6 Attributes
Attribute
Description
MAD
Type: OCTETSTRING
Default: 2b0601020164010A
MADL
Type: OCTETSTRING
Default: 08
MAL
Type: OCTETSTRING
Default: 12
Name
more information.
Type: string
MADtDS6z
Description:
Parents: MADList
Children: ManAdd
MADtDS6z Attributes
Attribute
Description
MAD
Type: OCTETSTRING
Default: 2b0601020164010C
MADL
Type: OCTETSTRING
Default: 08
MAL
Type: OCTETSTRING
Default: 16
Name
more information.
Type: string
MADtDT4
Description:
Parents: MADList
Children: ManAdd
MADtDT4 Attributes
Attribute
Description
MAD
Type: OCTETSTRING
Default: 2b06010201640105
1604
MADtDT4z
Attribute
Description
MADL
Type: OCTETSTRING
Default: 08
MAL
Type: OCTETSTRING
Default: 06
Name
more information.
Type: string
MADtDT4z
Description:
Parents: MADList
Children: ManAdd
MADtDT4z Attributes
Attribute
Description
MAD
Type: OCTETSTRING
Default: 2b06010201640107
MADL
Type: OCTETSTRING
Default: 08
MAL
Type: OCTETSTRING
Default: 0A
Name
more information.
Type: string
MADtDT6
Description:
Parents: MADList
Children: ManAdd
MADtDT6 Attributes
Attribute
Description
MAD
Type: OCTETSTRING
Default: 2b06010201640106
MADL
Type: OCTETSTRING
Default: 08
MAL
Type: OCTETSTRING
Default: 12
1605
MADtDT6z
Attribute
Description
Name
more information.
Type: string
MADtDT6z
Description:
Parents: MADList
Children: ManAdd
MADtDT6z Attributes
Attribute
Description
MAD
Type: OCTETSTRING
Default: 2b06010201640108
MADL
Type: OCTETSTRING
Default: 08
MAL
Type: OCTETSTRING
Default: 16
Name
more information.
Type: string
MADtDU
Description:
Parents: MADList
Children: ManAdd
MADtDU Attributes
Attribute
Description
MAD
Type: OCTETSTRING
Default: 2b0601020164010E
MADL
Type: OCTETSTRING
Default: 08
MAL
Type: OCTETSTRING
Default: 00
Name
more information.
Type: string
1606
MADtDU4
MADtDU4
Description:
Parents: MADList
Children: ManAdd
MADtDU4 Attributes
Attribute
Description
MAD
Type: OCTETSTRING
Default: 2b06010201640101
MADL
Type: OCTETSTRING
Default: 08
MAL
Type: OCTETSTRING
Default: 06
Name
more information.
Type: string
MADtDU4z
Description:
Parents: MADList
Children: ManAdd
MADtDU4z Attributes
Attribute
Description
MAD
Type: OCTETSTRING
Default: 2b06010201640103
MADL
Type: OCTETSTRING
Default: 08
MAL
Type: OCTETSTRING
Default: 0A
Name
more information.
Type: string
MADtDU6
Description:
Parents: MADList
Children: ManAdd
1607
MADtDU6z
MADtDU6 Attributes
Attribute
Description
MAD
Type: OCTETSTRING
Default: 2b06010201640102
MADL
Type: OCTETSTRING
Default: 08
MAL
Type: OCTETSTRING
Default: 12
Name
more information.
Type: string
MADtDU6z
Description:
Parents: MADList
Children: ManAdd
MADtDU6z Attributes
Attribute
Description
MAD
Type: OCTETSTRING
Default: 2b06010201640104
MADL
Type: OCTETSTRING
Default: 08
MAL
Type: OCTETSTRING
Default: 16
Name
more information.
Type: string
MADtSU
Description:
Parents: MADList
Children: ManAdd
MADtSU Attributes
Attribute
Description
MAD
Type: OCTETSTRING
Default: 2b06010201640110
1608
MADtTU
Attribute
Description
MADL
Type: OCTETSTRING
Default: 08
MAL
Type: OCTETSTRING
Default: 00
Name
more information.
Type: string
MADtTU
Description:
Parents: MADList
Children: ManAdd
MADtTU Attributes
Attribute
Description
MAD
Type: OCTETSTRING
Default: 2b0601020164010F
MADL
Type: OCTETSTRING
Default: 08
MAL
Type: OCTETSTRING
Default: 00
Name
more information.
Type: string
MAID (overloaded)
MAID (EOAM)
MAID (serviceoam)
MAID Object (EOAM PDU library)

Description:

Children: theMDN, theMDNL, thePad
1609
MAID
MAID Attributes
Attribute
Description
MDNF
Type: MDNFF
Default: 01
Possible Values:
Value Description
00
Reserved for IEEE 802.1 (00)
01
No Maintenance Domain Name Present
02
Domain Name Based String
03
MAC address + 2-octet Integer
04
Character String
05
20
Defined by ITU-T Y.1731
40
Name
Type: string
SMAF
Type: SMANF
Default: 01
Possible Values:
Value Description
00
01
Primary VID
02
Characer String
03
2-octet Integer
04
RFC 2685 VPN ID
05
20
40
SMAL
Type: OCTETSTRING
Default: 01
SMAN
Type: OCTETSTRING
MAID Object (serviceoam PDU library)

Description:

Children: theMDN, theMDNL, thePad
1610
MaintenanceDomainName
MAID Attributes
Attribute
Description
MDNF
Type: MDNFF
Default: 01
Possible Values:
Value Description
00
01
No Maintenance Domain Name Present
02
Domain Name Based String
03
MAC address + 2-octet Integer
04
Character String
05
20
40
Name
Type: string
SMAF
Type: SMANF
Default: 01
Possible Values:
Value Description
00
01
Primary VID
02
Characer String
03
2-octet Integer
04
RFC 2685 VPN ID
05
20
40
SMAL
Type: OCTETSTRING
Default: 01
SMAN
Type: OCTETSTRING
Description:
Parents: theMDN
Children: None
MaintenanceDomainName Attributes
Attribute
Description
MDN
Type: OCTETSTRING
Default: 00
1611
Attribute
Description
Name
information.
Type: string
Description:
Parents: theMDN
Children: None
MaintenanceDomainName Attributes
Attribute
Description
MDN
Type: OCTETSTRING
Default: 00
Name
information.
Type: string
ManAdd (overloaded)
ManAdd (serviceoam) - Object definition for the following paths:
StreamBlock.SndrID.theManagementAddressDomain.MADList.MADtDU4.ManAdd
StreamBlock.SndrID.theManagementAddressDomain.MADList.MADtDT4.ManAdd
StreamBlock.SndrID.theManagementAddressDomain.MADList.MADtDS4.ManAdd
StreamBlock.CCM.theCCMTLVS.CCMTLVList.SenderIDTLV.theManagementAddressDomain.MADList.MADtDU4.ManAdd
StreamBlock.CCM.theCCMTLVS.CCMTLVList.SenderIDTLV.theManagementAddressDomain.MADList.MADtDT4.ManAdd
StreamBlock.CCM.theCCMTLVS.CCMTLVList.SenderIDTLV.theManagementAddressDomain.MADList.MADtDS4.ManAdd
StreamBlock.LBM.theLBMTLVs.LBMTLVList.SenderIDTLV.theManagementAddressDomain.MADList.MADtDU4.ManAdd
StreamBlock.LBM.theLBMTLVs.LBMTLVList.SenderIDTLV.theManagementAddressDomain.MADList.MADtDT4.ManAdd
StreamBlock.LBM.theLBMTLVs.LBMTLVList.SenderIDTLV.theManagementAddressDomain.MADList.MADtDS4.ManAdd
StreamBlock.LBR.theLBRTLVs.LBMTLVList.SenderIDTLV.theManagementAddressDomain.MADList.MADtDU4.ManAdd
StreamBlock.LBR.theLBRTLVs.LBMTLVList.SenderIDTLV.theManagementAddressDomain.MADList.MADtDT4.ManAdd
StreamBlock.LBR.theLBRTLVs.LBMTLVList.SenderIDTLV.theManagementAddressDomain.MADList.MADtDS4.ManAdd
StreamBlock.LTM.theLTMTLVs.LTMTLVList.SenderIDTLV.theManagementAddressDomain.MADList.MADtDU4.ManAdd
StreamBlock.LTM.theLTMTLVs.LTMTLVList.SenderIDTLV.theManagementAddressDomain.MADList.MADtDT4.ManAdd
StreamBlock.LTM.theLTMTLVs.LTMTLVList.SenderIDTLV.theManagementAddressDomain.MADList.MADtDS4.ManAdd
StreamBlock.LTR.theLTRTLVs.LTRTLVList.SenderIDTLV.theManagementAddressDomain.MADList.MADtDU4.ManAdd
StreamBlock.LTR.theLTRTLVs.LTRTLVList.SenderIDTLV.theManagementAddressDomain.MADList.MADtDT4.ManAdd
StreamBlock.LTR.theLTRTLVs.LTRTLVList.SenderIDTLV.theManagementAddressDomain.MADList.MADtDS4.ManAdd
StreamBlock.SndrID.theManagementAddressDomain.MADList.MADtDU6.ManAdd
StreamBlock.SndrID.theManagementAddressDomain.MADList.MADtDT6.ManAdd
StreamBlock.SndrID.theManagementAddressDomain.MADList.MADtDS6.ManAdd
StreamBlock.CCM.theCCMTLVS.CCMTLVList.SenderIDTLV.theManagementAddressDomain.MADList.MADtDU6.ManAdd
StreamBlock.CCM.theCCMTLVS.CCMTLVList.SenderIDTLV.theManagementAddressDomain.MADList.MADtDT6.ManAdd
StreamBlock.CCM.theCCMTLVS.CCMTLVList.SenderIDTLV.theManagementAddressDomain.MADList.MADtDS6.ManAdd
StreamBlock.LBM.theLBMTLVs.LBMTLVList.SenderIDTLV.theManagementAddressDomain.MADList.MADtDU6.ManAdd
StreamBlock.LBM.theLBMTLVs.LBMTLVList.SenderIDTLV.theManagementAddressDomain.MADList.MADtDT6.ManAdd
StreamBlock.LBM.theLBMTLVs.LBMTLVList.SenderIDTLV.theManagementAddressDomain.MADList.MADtDS6.ManAdd
StreamBlock.LBR.theLBRTLVs.LBMTLVList.SenderIDTLV.theManagementAddressDomain.MADList.MADtDU6.ManAdd
StreamBlock.LBR.theLBRTLVs.LBMTLVList.SenderIDTLV.theManagementAddressDomain.MADList.MADtDT6.ManAdd
StreamBlock.LBR.theLBRTLVs.LBMTLVList.SenderIDTLV.theManagementAddressDomain.MADList.MADtDS6.ManAdd
StreamBlock.LTM.theLTMTLVs.LTMTLVList.SenderIDTLV.theManagementAddressDomain.MADList.MADtDU6.ManAdd
1612
ManAdd
StreamBlock.LTM.theLTMTLVs.LTMTLVList.SenderIDTLV.theManagementAddressDomain.MADList.MADtDT6.ManAdd
StreamBlock.LTM.theLTMTLVs.LTMTLVList.SenderIDTLV.theManagementAddressDomain.MADList.MADtDS6.ManAdd
StreamBlock.LTR.theLTRTLVs.LTRTLVList.SenderIDTLV.theManagementAddressDomain.MADList.MADtDU6.ManAdd
StreamBlock.LTR.theLTRTLVs.LTRTLVList.SenderIDTLV.theManagementAddressDomain.MADList.MADtDT6.ManAdd
StreamBlock.LTR.theLTRTLVs.LTRTLVList.SenderIDTLV.theManagementAddressDomain.MADList.MADtDS6.ManAdd
StreamBlock.SndrID.theManagementAddressDomain.MADList.MADtDU4z.ManAdd
StreamBlock.SndrID.theManagementAddressDomain.MADList.MADtDT4z.ManAdd
StreamBlock.SndrID.theManagementAddressDomain.MADList.MADtDS4z.ManAdd
StreamBlock.CCM.theCCMTLVS.CCMTLVList.SenderIDTLV.theManagementAddressDomain.MADList.MADtDU4z.ManAdd
StreamBlock.CCM.theCCMTLVS.CCMTLVList.SenderIDTLV.theManagementAddressDomain.MADList.MADtDT4z.ManAdd
StreamBlock.CCM.theCCMTLVS.CCMTLVList.SenderIDTLV.theManagementAddressDomain.MADList.MADtDS4z.ManAdd
StreamBlock.LBM.theLBMTLVs.LBMTLVList.SenderIDTLV.theManagementAddressDomain.MADList.MADtDU4z.ManAdd
StreamBlock.LBM.theLBMTLVs.LBMTLVList.SenderIDTLV.theManagementAddressDomain.MADList.MADtDT4z.ManAdd
StreamBlock.LBM.theLBMTLVs.LBMTLVList.SenderIDTLV.theManagementAddressDomain.MADList.MADtDS4z.ManAdd
StreamBlock.LBR.theLBRTLVs.LBMTLVList.SenderIDTLV.theManagementAddressDomain.MADList.MADtDU4z.ManAdd
StreamBlock.LBR.theLBRTLVs.LBMTLVList.SenderIDTLV.theManagementAddressDomain.MADList.MADtDT4z.ManAdd
StreamBlock.LBR.theLBRTLVs.LBMTLVList.SenderIDTLV.theManagementAddressDomain.MADList.MADtDS4z.ManAdd
StreamBlock.LTM.theLTMTLVs.LTMTLVList.SenderIDTLV.theManagementAddressDomain.MADList.MADtDU4z.ManAdd
StreamBlock.LTM.theLTMTLVs.LTMTLVList.SenderIDTLV.theManagementAddressDomain.MADList.MADtDT4z.ManAdd
StreamBlock.LTM.theLTMTLVs.LTMTLVList.SenderIDTLV.theManagementAddressDomain.MADList.MADtDS4z.ManAdd
StreamBlock.LTR.theLTRTLVs.LTRTLVList.SenderIDTLV.theManagementAddressDomain.MADList.MADtDU4z.ManAdd
StreamBlock.LTR.theLTRTLVs.LTRTLVList.SenderIDTLV.theManagementAddressDomain.MADList.MADtDT4z.ManAdd
StreamBlock.LTR.theLTRTLVs.LTRTLVList.SenderIDTLV.theManagementAddressDomain.MADList.MADtDS4z.ManAdd
StreamBlock.SndrID.theManagementAddressDomain.MADList.MADtDU6z.ManAdd
StreamBlock.SndrID.theManagementAddressDomain.MADList.MADtDT6z.ManAdd
StreamBlock.SndrID.theManagementAddressDomain.MADList.MADtDS6z.ManAdd
StreamBlock.CCM.theCCMTLVS.CCMTLVList.SenderIDTLV.theManagementAddressDomain.MADList.MADtDU6z.ManAdd
StreamBlock.CCM.theCCMTLVS.CCMTLVList.SenderIDTLV.theManagementAddressDomain.MADList.MADtDT6z.ManAdd
StreamBlock.CCM.theCCMTLVS.CCMTLVList.SenderIDTLV.theManagementAddressDomain.MADList.MADtDS6z.ManAdd
StreamBlock.LBM.theLBMTLVs.LBMTLVList.SenderIDTLV.theManagementAddressDomain.MADList.MADtDU6z.ManAdd
StreamBlock.LBM.theLBMTLVs.LBMTLVList.SenderIDTLV.theManagementAddressDomain.MADList.MADtDT6z.ManAdd
StreamBlock.LBM.theLBMTLVs.LBMTLVList.SenderIDTLV.theManagementAddressDomain.MADList.MADtDS6z.ManAdd
StreamBlock.LBR.theLBRTLVs.LBMTLVList.SenderIDTLV.theManagementAddressDomain.MADList.MADtDU6z.ManAdd
StreamBlock.LBR.theLBRTLVs.LBMTLVList.SenderIDTLV.theManagementAddressDomain.MADList.MADtDT6z.ManAdd
StreamBlock.LBR.theLBRTLVs.LBMTLVList.SenderIDTLV.theManagementAddressDomain.MADList.MADtDS6z.ManAdd
StreamBlock.LTM.theLTMTLVs.LTMTLVList.SenderIDTLV.theManagementAddressDomain.MADList.MADtDU6z.ManAdd
StreamBlock.LTM.theLTMTLVs.LTMTLVList.SenderIDTLV.theManagementAddressDomain.MADList.MADtDT6z.ManAdd
StreamBlock.LTM.theLTMTLVs.LTMTLVList.SenderIDTLV.theManagementAddressDomain.MADList.MADtDS6z.ManAdd
StreamBlock.LTR.theLTRTLVs.LTRTLVList.SenderIDTLV.theManagementAddressDomain.MADList.MADtDU6z.ManAdd
StreamBlock.LTR.theLTRTLVs.LTRTLVList.SenderIDTLV.theManagementAddressDomain.MADList.MADtDT6z.ManAdd
StreamBlock.LTR.theLTRTLVs.LTRTLVList.SenderIDTLV.theManagementAddressDomain.MADList.MADtDS6z.ManAdd
StreamBlock.SndrID.theManagementAddressDomain.MADList.MADtDL.ManAdd
StreamBlock.SndrID.theManagementAddressDomain.MADList.MADtDU.ManAdd
StreamBlock.SndrID.theManagementAddressDomain.MADList.MADtTU.ManAdd
StreamBlock.SndrID.theManagementAddressDomain.MADList.MADtSU.ManAdd
StreamBlock.CCM.theCCMTLVS.CCMTLVList.SenderIDTLV.theManagementAddressDomain.MADList.MADtDL.ManAdd
StreamBlock.CCM.theCCMTLVS.CCMTLVList.SenderIDTLV.theManagementAddressDomain.MADList.MADtDU.ManAdd
StreamBlock.CCM.theCCMTLVS.CCMTLVList.SenderIDTLV.theManagementAddressDomain.MADList.MADtTU.ManAdd
StreamBlock.CCM.theCCMTLVS.CCMTLVList.SenderIDTLV.theManagementAddressDomain.MADList.MADtSU.ManAdd
StreamBlock.LBM.theLBMTLVs.LBMTLVList.SenderIDTLV.theManagementAddressDomain.MADList.MADtDL.ManAdd
StreamBlock.LBM.theLBMTLVs.LBMTLVList.SenderIDTLV.theManagementAddressDomain.MADList.MADtDU.ManAdd
StreamBlock.LBM.theLBMTLVs.LBMTLVList.SenderIDTLV.theManagementAddressDomain.MADList.MADtTU.ManAdd
StreamBlock.LBM.theLBMTLVs.LBMTLVList.SenderIDTLV.theManagementAddressDomain.MADList.MADtSU.ManAdd
StreamBlock.LBR.theLBRTLVs.LBMTLVList.SenderIDTLV.theManagementAddressDomain.MADList.MADtDL.ManAdd
StreamBlock.LBR.theLBRTLVs.LBMTLVList.SenderIDTLV.theManagementAddressDomain.MADList.MADtDU.ManAdd
StreamBlock.LBR.theLBRTLVs.LBMTLVList.SenderIDTLV.theManagementAddressDomain.MADList.MADtTU.ManAdd
StreamBlock.LBR.theLBRTLVs.LBMTLVList.SenderIDTLV.theManagementAddressDomain.MADList.MADtSU.ManAdd
StreamBlock.LTM.theLTMTLVs.LTMTLVList.SenderIDTLV.theManagementAddressDomain.MADList.MADtDL.ManAdd
StreamBlock.LTM.theLTMTLVs.LTMTLVList.SenderIDTLV.theManagementAddressDomain.MADList.MADtDU.ManAdd
StreamBlock.LTM.theLTMTLVs.LTMTLVList.SenderIDTLV.theManagementAddressDomain.MADList.MADtTU.ManAdd
StreamBlock.LTM.theLTMTLVs.LTMTLVList.SenderIDTLV.theManagementAddressDomain.MADList.MADtSU.ManAdd
StreamBlock.LTR.theLTRTLVs.LTRTLVList.SenderIDTLV.theManagementAddressDomain.MADList.MADtDL.ManAdd
StreamBlock.LTR.theLTRTLVs.LTRTLVList.SenderIDTLV.theManagementAddressDomain.MADList.MADtDU.ManAdd
StreamBlock.LTR.theLTRTLVs.LTRTLVList.SenderIDTLV.theManagementAddressDomain.MADList.MADtTU.ManAdd
StreamBlock.LTR.theLTRTLVs.LTRTLVList.SenderIDTLV.theManagementAddressDomain.MADList.MADtSU.ManAdd
1613
ManAdd
ManAdd Object (serviceoam PDU library)

Description:
Parents: MADtDU4 (StreamBlock.SndrID.theManagementAddressDomain.MADList.MADtDU4)

MADtDT4 (StreamBlock.SndrID.theManagementAddressDomain.MADList.MADtDT4)
MADtDS4 (StreamBlock.SndrID.theManagementAddressDomain.MADList.MADtDS4)
MADtDU4 (StreamBlock.CCM.theCCMTLVS.CCMTLVList.SenderIDTLV.theManagementAddressDomain.MADList.MADtDU4)
MADtDT4 (StreamBlock.CCM.theCCMTLVS.CCMTLVList.SenderIDTLV.theManagementAddressDomain.MADList.MADtDT4)
MADtDS4 (StreamBlock.CCM.theCCMTLVS.CCMTLVList.SenderIDTLV.theManagementAddressDomain.MADList.MADtDS4)
MADtDU4 (StreamBlock.LBM.theLBMTLVs.LBMTLVList.SenderIDTLV.theManagementAddressDomain.MADList.MADtDU4)
MADtDT4 (StreamBlock.LBM.theLBMTLVs.LBMTLVList.SenderIDTLV.theManagementAddressDomain.MADList.MADtDT4)
MADtDS4 (StreamBlock.LBM.theLBMTLVs.LBMTLVList.SenderIDTLV.theManagementAddressDomain.MADList.MADtDS4)
MADtDU4 (StreamBlock.LBR.theLBRTLVs.LBMTLVList.SenderIDTLV.theManagementAddressDomain.MADList.MADtDU4)
MADtDT4 (StreamBlock.LBR.theLBRTLVs.LBMTLVList.SenderIDTLV.theManagementAddressDomain.MADList.MADtDT4)
MADtDS4 (StreamBlock.LBR.theLBRTLVs.LBMTLVList.SenderIDTLV.theManagementAddressDomain.MADList.MADtDS4)
MADtDU4 (StreamBlock.LTM.theLTMTLVs.LTMTLVList.SenderIDTLV.theManagementAddressDomain.MADList.MADtDU4)
MADtDT4 (StreamBlock.LTM.theLTMTLVs.LTMTLVList.SenderIDTLV.theManagementAddressDomain.MADList.MADtDT4)
MADtDS4 (StreamBlock.LTM.theLTMTLVs.LTMTLVList.SenderIDTLV.theManagementAddressDomain.MADList.MADtDS4)
MADtDU4 (StreamBlock.LTR.theLTRTLVs.LTRTLVList.SenderIDTLV.theManagementAddressDomain.MADList.MADtDU4)
MADtDT4 (StreamBlock.LTR.theLTRTLVs.LTRTLVList.SenderIDTLV.theManagementAddressDomain.MADList.MADtDT4)
MADtDS4 (StreamBlock.LTR.theLTRTLVs.LTRTLVList.SenderIDTLV.theManagementAddressDomain.MADList.MADtDS4)
Children: None
ManAdd Attributes
Attribute
Description
IPv4
Type: IPV4ADDR
Name
information.
Type: string
Port
Type: OCTETSTRING
Default: 0000

Description:
Parents: MADtDU6 (StreamBlock.SndrID.theManagementAddressDomain.MADList.MADtDU6)

MADtDT6 (StreamBlock.SndrID.theManagementAddressDomain.MADList.MADtDT6)
MADtDS6 (StreamBlock.SndrID.theManagementAddressDomain.MADList.MADtDS6)
MADtDU6 (StreamBlock.CCM.theCCMTLVS.CCMTLVList.SenderIDTLV.theManagementAddressDomain.MADList.MADtDU6)
MADtDT6 (StreamBlock.CCM.theCCMTLVS.CCMTLVList.SenderIDTLV.theManagementAddressDomain.MADList.MADtDT6)
MADtDS6 (StreamBlock.CCM.theCCMTLVS.CCMTLVList.SenderIDTLV.theManagementAddressDomain.MADList.MADtDS6)
MADtDU6 (StreamBlock.LBM.theLBMTLVs.LBMTLVList.SenderIDTLV.theManagementAddressDomain.MADList.MADtDU6)
MADtDT6 (StreamBlock.LBM.theLBMTLVs.LBMTLVList.SenderIDTLV.theManagementAddressDomain.MADList.MADtDT6)
MADtDS6 (StreamBlock.LBM.theLBMTLVs.LBMTLVList.SenderIDTLV.theManagementAddressDomain.MADList.MADtDS6)
MADtDU6 (StreamBlock.LBR.theLBRTLVs.LBMTLVList.SenderIDTLV.theManagementAddressDomain.MADList.MADtDU6)
MADtDT6 (StreamBlock.LBR.theLBRTLVs.LBMTLVList.SenderIDTLV.theManagementAddressDomain.MADList.MADtDT6)
MADtDS6 (StreamBlock.LBR.theLBRTLVs.LBMTLVList.SenderIDTLV.theManagementAddressDomain.MADList.MADtDS6)
MADtDU6 (StreamBlock.LTM.theLTMTLVs.LTMTLVList.SenderIDTLV.theManagementAddressDomain.MADList.MADtDU6)
MADtDT6 (StreamBlock.LTM.theLTMTLVs.LTMTLVList.SenderIDTLV.theManagementAddressDomain.MADList.MADtDT6)
MADtDS6 (StreamBlock.LTM.theLTMTLVs.LTMTLVList.SenderIDTLV.theManagementAddressDomain.MADList.MADtDS6)
MADtDU6 (StreamBlock.LTR.theLTRTLVs.LTRTLVList.SenderIDTLV.theManagementAddressDomain.MADList.MADtDU6)
MADtDT6 (StreamBlock.LTR.theLTRTLVs.LTRTLVList.SenderIDTLV.theManagementAddressDomain.MADList.MADtDT6)
MADtDS6 (StreamBlock.LTR.theLTRTLVs.LTRTLVList.SenderIDTLV.theManagementAddressDomain.MADList.MADtDS6)
Children: None
1614
ManAdd
ManAdd Attributes
Attribute
Description
IPv6
Type: IPV6ADDR
Name
information.
Type: string
Port
Type: OCTETSTRING
Default: 0000

Description:
Parents: MADtDU4z (StreamBlock.SndrID.theManagementAddressDomain.MADList.MADtDU4z)

MADtDT4z (StreamBlock.SndrID.theManagementAddressDomain.MADList.MADtDT4z)
MADtDS4z (StreamBlock.SndrID.theManagementAddressDomain.MADList.MADtDS4z)
MADtDU4z (StreamBlock.CCM.theCCMTLVS.CCMTLVList.SenderIDTLV.theManagementAddressDomain.MADList.MADtDU4z)
MADtDT4z (StreamBlock.CCM.theCCMTLVS.CCMTLVList.SenderIDTLV.theManagementAddressDomain.MADList.MADtDT4z)
MADtDS4z (StreamBlock.CCM.theCCMTLVS.CCMTLVList.SenderIDTLV.theManagementAddressDomain.MADList.MADtDS4z)
MADtDU4z (StreamBlock.LBM.theLBMTLVs.LBMTLVList.SenderIDTLV.theManagementAddressDomain.MADList.MADtDU4z)
MADtDT4z (StreamBlock.LBM.theLBMTLVs.LBMTLVList.SenderIDTLV.theManagementAddressDomain.MADList.MADtDT4z)
MADtDS4z (StreamBlock.LBM.theLBMTLVs.LBMTLVList.SenderIDTLV.theManagementAddressDomain.MADList.MADtDS4z)
MADtDU4z (StreamBlock.LBR.theLBRTLVs.LBMTLVList.SenderIDTLV.theManagementAddressDomain.MADList.MADtDU4z)
MADtDT4z (StreamBlock.LBR.theLBRTLVs.LBMTLVList.SenderIDTLV.theManagementAddressDomain.MADList.MADtDT4z)
MADtDS4z (StreamBlock.LBR.theLBRTLVs.LBMTLVList.SenderIDTLV.theManagementAddressDomain.MADList.MADtDS4z)
MADtDU4z (StreamBlock.LTM.theLTMTLVs.LTMTLVList.SenderIDTLV.theManagementAddressDomain.MADList.MADtDU4z)
MADtDT4z (StreamBlock.LTM.theLTMTLVs.LTMTLVList.SenderIDTLV.theManagementAddressDomain.MADList.MADtDT4z)
MADtDS4z (StreamBlock.LTM.theLTMTLVs.LTMTLVList.SenderIDTLV.theManagementAddressDomain.MADList.MADtDS4z)
MADtDU4z (StreamBlock.LTR.theLTRTLVs.LTRTLVList.SenderIDTLV.theManagementAddressDomain.MADList.MADtDU4z)
MADtDT4z (StreamBlock.LTR.theLTRTLVs.LTRTLVList.SenderIDTLV.theManagementAddressDomain.MADList.MADtDT4z)
MADtDS4z (StreamBlock.LTR.theLTRTLVs.LTRTLVList.SenderIDTLV.theManagementAddressDomain.MADList.MADtDS4z)
Children: None
ManAdd Attributes
Attribute
Description
IPv4
Type: IPV4ADDR
Name
more information.
Type: string
Port
Type: OCTETSTRING
Default: 0000
Zone
Type: OCTETSTRING
Default: 00000000
1615
ManAdd

Description:
Parents: MADtDU6z (StreamBlock.SndrID.theManagementAddressDomain.MADList.MADtDU6z)

MADtDT6z (StreamBlock.SndrID.theManagementAddressDomain.MADList.MADtDT6z)
MADtDS6z (StreamBlock.SndrID.theManagementAddressDomain.MADList.MADtDS6z)
MADtDU6z (StreamBlock.CCM.theCCMTLVS.CCMTLVList.SenderIDTLV.theManagementAddressDomain.MADList.MADtDU6z)
MADtDT6z (StreamBlock.CCM.theCCMTLVS.CCMTLVList.SenderIDTLV.theManagementAddressDomain.MADList.MADtDT6z)
MADtDS6z (StreamBlock.CCM.theCCMTLVS.CCMTLVList.SenderIDTLV.theManagementAddressDomain.MADList.MADtDS6z)
MADtDU6z (StreamBlock.LBM.theLBMTLVs.LBMTLVList.SenderIDTLV.theManagementAddressDomain.MADList.MADtDU6z)
MADtDT6z (StreamBlock.LBM.theLBMTLVs.LBMTLVList.SenderIDTLV.theManagementAddressDomain.MADList.MADtDT6z)
MADtDS6z (StreamBlock.LBM.theLBMTLVs.LBMTLVList.SenderIDTLV.theManagementAddressDomain.MADList.MADtDS6z)
MADtDU6z (StreamBlock.LBR.theLBRTLVs.LBMTLVList.SenderIDTLV.theManagementAddressDomain.MADList.MADtDU6z)
MADtDT6z (StreamBlock.LBR.theLBRTLVs.LBMTLVList.SenderIDTLV.theManagementAddressDomain.MADList.MADtDT6z)
MADtDS6z (StreamBlock.LBR.theLBRTLVs.LBMTLVList.SenderIDTLV.theManagementAddressDomain.MADList.MADtDS6z)
MADtDU6z (StreamBlock.LTM.theLTMTLVs.LTMTLVList.SenderIDTLV.theManagementAddressDomain.MADList.MADtDU6z)
MADtDT6z (StreamBlock.LTM.theLTMTLVs.LTMTLVList.SenderIDTLV.theManagementAddressDomain.MADList.MADtDT6z)
MADtDS6z (StreamBlock.LTM.theLTMTLVs.LTMTLVList.SenderIDTLV.theManagementAddressDomain.MADList.MADtDS6z)
MADtDU6z (StreamBlock.LTR.theLTRTLVs.LTRTLVList.SenderIDTLV.theManagementAddressDomain.MADList.MADtDU6z)
MADtDT6z (StreamBlock.LTR.theLTRTLVs.LTRTLVList.SenderIDTLV.theManagementAddressDomain.MADList.MADtDT6z)
MADtDS6z (StreamBlock.LTR.theLTRTLVs.LTRTLVList.SenderIDTLV.theManagementAddressDomain.MADList.MADtDS6z)
Children: None
ManAdd Attributes
Attribute
Description
IPv6
Type: IPV6ADDR
Name
more information.
Type: string
Port
Type: OCTETSTRING
Default: 0000
Zone
Type: OCTETSTRING
Default: 00000000

Description:
Parents: MADtDL (StreamBlock.SndrID.theManagementAddressDomain.MADList.MADtDL)

MADtDU (StreamBlock.SndrID.theManagementAddressDomain.MADList.MADtDU)
MADtTU (StreamBlock.SndrID.theManagementAddressDomain.MADList.MADtTU)
MADtSU (StreamBlock.SndrID.theManagementAddressDomain.MADList.MADtSU)
MADtDL (StreamBlock.CCM.theCCMTLVS.CCMTLVList.SenderIDTLV.theManagementAddressDomain.MADList.MADtDL)
MADtDU (StreamBlock.CCM.theCCMTLVS.CCMTLVList.SenderIDTLV.theManagementAddressDomain.MADList.MADtDU)
MADtTU (StreamBlock.CCM.theCCMTLVS.CCMTLVList.SenderIDTLV.theManagementAddressDomain.MADList.MADtTU)
MADtSU (StreamBlock.CCM.theCCMTLVS.CCMTLVList.SenderIDTLV.theManagementAddressDomain.MADList.MADtSU)
MADtDL (StreamBlock.LBM.theLBMTLVs.LBMTLVList.SenderIDTLV.theManagementAddressDomain.MADList.MADtDL)
MADtDU (StreamBlock.LBM.theLBMTLVs.LBMTLVList.SenderIDTLV.theManagementAddressDomain.MADList.MADtDU)
MADtTU (StreamBlock.LBM.theLBMTLVs.LBMTLVList.SenderIDTLV.theManagementAddressDomain.MADList.MADtTU)
MADtSU (StreamBlock.LBM.theLBMTLVs.LBMTLVList.SenderIDTLV.theManagementAddressDomain.MADList.MADtSU)
MADtDL (StreamBlock.LBR.theLBRTLVs.LBMTLVList.SenderIDTLV.theManagementAddressDomain.MADList.MADtDL)
MADtDU (StreamBlock.LBR.theLBRTLVs.LBMTLVList.SenderIDTLV.theManagementAddressDomain.MADList.MADtDU)
MADtTU (StreamBlock.LBR.theLBRTLVs.LBMTLVList.SenderIDTLV.theManagementAddressDomain.MADList.MADtTU)
MADtSU (StreamBlock.LBR.theLBRTLVs.LBMTLVList.SenderIDTLV.theManagementAddressDomain.MADList.MADtSU)
MADtDL (StreamBlock.LTM.theLTMTLVs.LTMTLVList.SenderIDTLV.theManagementAddressDomain.MADList.MADtDL)
MADtDU (StreamBlock.LTM.theLTMTLVs.LTMTLVList.SenderIDTLV.theManagementAddressDomain.MADList.MADtDU)
1616
managementAddr
MADtTU (StreamBlock.LTM.theLTMTLVs.LTMTLVList.SenderIDTLV.theManagementAddressDomain.MADList.MADtTU)
MADtSU (StreamBlock.LTM.theLTMTLVs.LTMTLVList.SenderIDTLV.theManagementAddressDomain.MADList.MADtSU)
MADtDL (StreamBlock.LTR.theLTRTLVs.LTRTLVList.SenderIDTLV.theManagementAddressDomain.MADList.MADtDL)
MADtDU (StreamBlock.LTR.theLTRTLVs.LTRTLVList.SenderIDTLV.theManagementAddressDomain.MADList.MADtDU)
MADtTU (StreamBlock.LTR.theLTRTLVs.LTRTLVList.SenderIDTLV.theManagementAddressDomain.MADList.MADtTU)
MADtSU (StreamBlock.LTR.theLTRTLVs.LTRTLVList.SenderIDTLV.theManagementAddressDomain.MADList.MADtSU)
Children: None
ManAdd Attributes
Attribute
Description
Name
Type: string
Name
Type: ASCII
Default: SPIRENT
Port
Type: OCTETSTRING
Default: 0000
managementAddr
Description:
Parents: ManagementAddrTlv
Children: customAddr, ipv4Addr, ipv6Addr
managementAddr Attributes
Attribute
Description
Name
information.
Type: string
managementAddressEntries (overloaded)
managementAddressEntries (fc)
managementAddressEntries (fcgs)
managementAddressEntries Object (fc PDU library)

Description:
1617
ManagementAddressEntry
Parents: gmalAccept (StreamBlock.FCoE.fc.fcPayloads.FCPayload-Choice.gmalAccept)

gplmlAccept (StreamBlock.FCoE.fc.fcPayloads.FCPayload-Choice.gplmlAccept)
Children: ManagementAddressEntry
managementAddressEntries Attributes
Attribute
Description
Name
information.
Type: string
managementAddressEntries Object (fcgs PDU library)

Description:
Parents: gmalAccept (StreamBlock.GmalAccept)

gplmlAccept (StreamBlock.GplmlAccept)
Children: ManagementAddressEntry
managementAddressEntries Attributes
Attribute
Description
Name
information.
Type: string
Description:
Parents: managementAddressEntries
Children: None
ManagementAddressEntry Attributes
Attribute
Description
managementAddressLength
Type: INTEGER
Default: 0
managementAddressValue
Type: ASCII
1618
Attribute
Description
Name
Type: string
reserved1
Description:
Parents: managementAddressEntries
Children: None
ManagementAddressEntry Attributes
Attribute
Description
managementAddressLength
Type: INTEGER
Default: 0
managementAddressValue
Type: ASCII
Name
Type: string
reserved1
ManagementAddrTlv (lldp:ManagementAddrTlv)
Description:
Children: managementAddr
lldp:NivSupportTlv
ManagementAddrTlv Attributes
Attribute
Description
ifNumber
Type: INTEGER
Default: 0
1619
ManagementDevice
Attribute
Description
ifNumberingSubtype
Type: EnumIfNumberingSubtype
Default: 01
Possible Values:
Value Description
01
Unknown
02
IfIndex
03
SystemPortNumber
length
Type: INTEGER
Default: 0
managementAddrLength
Type: INTEGER
Default: 0
Name
Type: string
oid
Type: OCTETSTRING
oidLength
Type: INTEGER
Default: 0
type
Type: INTEGER
Default: 8
ManagementDevice
Description:
MDIO device.
Tcl example: stc::config managementdevice1 -Address 30 -Name "Vendor 1"

Parents: MdioPort
Children: MdioRegister
ManagementDevice Writable Attributes

Writable Attribute
Description
Active, Name
Address
8-bit address to reference which device to access.

Type: u8
Default: 0
ManagementDevice Read-Only Attributes

1620
ManagementRegister
ManagementRegister
Description:
This is an abstract class for MiiRegister and MdioRegister.
ManagementRegister Writable Attributes

Writable Attribute
Description
Active, Name
Address
16-bit address to reference which register to access.

Type: u16
Default: 0
RegValue
16-bit value to be configured by the user.

Type: u16
Default: 0
WritableMask
Bit mask specifying which bits are to be written to the hardware.

Type: u16
Default: 65535
ManagementRegister Read-Only Attributes

Read-Only Attribute
Description
HwRegValue
Read-only hardware register value read from the hardware.

Type: u16
Default: 0
ManualSchedule
Description:
A container to hold manual schedule entries.

Parents: GeneratorConfig
Children: ManualScheduleEntry
ManualSchedule Writable Attributes

Writable Attribute
Description
Active, Name
ManualSchedule Read-Only Attributes

Read-Only Attribute
Description
TablePercentUtilization
Show the percent utilization of the manual schedule table based on the hardware capability.
Type: double
Default: 0
1621
ManualScheduleEntry
ManualScheduleEntry
Description:
Specify the burst information (size, gap, looping, etc.) of a schedule entry.

Parents: ManualSchedule
Relations:
Side name
(Type)
Relative
StreamBlock
(AffiliationManualScheduleEntryStreamBlock)
StreamBlock
GeneratorScheduleTableEntry
(LoopBackToEntry)
ManualScheduleEntry
ManualScheduleEntry Writable Attributes

Writable Attribute
Description
Active, Name
BurstCount
Specify the number of bursts to be transmitted by the entry.

Type: u16
Default: 1
BurstSize
Specify the number of frames in a burst.

Type: u16
Default: 1
InterBurstGap
Specify the unit for inter-burst gap.

Type: double
Default: 1344
InterBurstGapUnit
Specify the unit for inter-burst gap.

Type: enum
Default: BYTES
Possible Values:
Value
Description
PERCENT_LINE_RATE
Gap in percentage of line rate.
FRAMES_PER_SECOND
Gap as the number of frames per second.
BYTES
Gap in bytes.
MILLISECONDS
Gap in nanoseconds.
NANOSECONDS
Gap in nanoseconds.
BITS_PER_SECOND
Gap as the number of bits per second.
KILOBITS_PER_SECOND
Gap in number of kilobits per second.
MEGABITS_PER_SECOND Gap in number of megabits per second.

InterEntryGap
Gap between stream entries.

Type: double
Default: 2000
1622
Description
ManualScheduleLoadFromTemplateCommand
Writable Attribute
Description
InterEntryGapUnit
Specify the unit for inter-entry gap.

Type: enum
Default: BYTES
Possible Values:
Value
Description
PERCENT_LINE_RATE
FRAMES_PER_SECOND
BYTES
Gap in bytes.
MILLISECONDS
Gap in milliseconds.
NANOSECONDS
Gap in nanoseconds.
BITS_PER_SECOND
KILOBITS_PER_SECOND

InterFrameGap
Gap between frames within a burst.

Type: double
Default: 12
InterFrameGapUnit
Specify the unit for inter-frame gap.

Type: enum
Default: BYTES
Possible Values:
Value
Description
PERCENT_LINE_RATE
FRAMES_PER_SECOND
BYTES
Gap in bytes.
MILLISECONDS
Gap in nanoseconds.
NANOSECONDS
Gap in nanoseconds.
BITS_PER_SECOND
KILOBITS_PER_SECOND

LoopCount
Specify how many times the sequence of entries will be repeated.

Type: u32
Default: 1
ManualScheduleEntry Read-Only Attributes

ManualScheduleLoadFromTemplateCommand
Description:
Load a Manual Schedule from the template.

ManualScheduleLoadFromTemplateCommand Writable Attributes

Writable Attribute
Description
1623
ManualScheduleSaveAsTemplateCommand
Writable Attribute
Description
FileName
Name of the template file from which the manual schedule will be loaded.
Type: inputFilePath
Generator
Handle of the Generator to which the manual schedule will be applied.

Type: handle
Default: 0
ManualScheduleLoadFromTemplateCommand Read-Only Attributes

Read-Only Attribute
Description

ManualSchedule
Handle of the manual schedule that has been loaded.

Type: handle
Default: 0
ManualScheduleSaveAsTemplateCommand
Description:
Save manual schedule object to a template file.

ManualScheduleSaveAsTemplateCommand Writable Attributes

Writable Attribute
Description
FileName
Name of the template file to which the schedule will be saved.

ManualSchedule
Handle of the manual schedule object to be saved to the template.

Type: handle
Default: 0
ManualScheduleSaveAsTemplateCommand Read-Only Attributes

Read-Only Attribute
Description

MapPortCommand
Description:
1624
Marker
Map a list of "logical" ports to a list of physical ports.

MapPortCommand Writable Attributes

Writable Attribute
Description
LogicalPortLis
NOTE: This is deprecated. It will be removed in subsequent releases, so it is recommended

that you do not use it.
Use the LogicalPortList attribute instead.
Type: handle
Default: 0
LogicalPortList
A list of one or more logical ports.

Type: handle
Default: 0
PhysicalPortList
A list of one or more physical ports.

Type: handle
Default: 0
MapPortCommand Read-Only Attributes

Read-Only Attribute
Description

Marker (lacp:Marker)
Description:
LACP Marker PDU. See IEEE 802.3, clause 43.
Children: None
Marker Attributes
Attribute
Description
markerInformation
Type: MarkerTLVType
Default: 01
Possible Values:
Value Description
01
Marker Information
02
Marker Response
00
Terminator
markerInformationLength
Type: INTEGER
Default: 16
markerPad
Type: INTEGER
Default: 0000
1625
MaxFrameSizeTlv
Attribute
Description
Name
Type: string
requesterPort
Type: INTEGER
Default: 0001
requesterSystemId
Type: MACADDR
Default: 00:00:00:00:00:01
requesterTransactionId
Type: INTEGER
Default: 00000001
subtype
Type: Subtype
Default: 02
Possible Values:
Value Description
terminatorInformation
01
LACP
02
Marker
Type: MarkerTLVType
Default: 00
Possible Values:
Value Description
01
Marker Information
02
Marker Response
00
Terminator
terminatorInformationLength
Type: INTEGER
Default: 0
terminatorReserved
Type: OCTETSTRING
version
Type: INTEGER
Default: 01
MaxFrameSizeTlv (lldp:MaxFrameSizeTlv)
Description:
Children: None
lldp:NivSupportTlv
MaxFrameSizeTlv Attributes
Attribute
Description
frameSize
Type: INTEGER
Default: 1518
length
Type: INTEGER
Default: 0
1626
MaximumInterleavingDelayDownstreamTlv
Attribute
Description
Name
Type: string
oui
Type: OCTETSTRING
Default: 00120F
subtype
Type: OCTETSTRING
Default: 04
type
Type: INTEGER
Default: 127
(ancp_draft0:MaximumInterleavingDelayDownstreamTlv)
Description:
Children: None
MaximumInterleavingDelayDownstreamTlv Attributes
Attribute
Description
Length
Type: INTEGER
Default: 4
MessageSelect
Default: 3
Possible Values:
Value Description
1
Port Up
Port Down
Port Up, Port Down
Name
Type: string
Time
Type: INTEGER
Default: 0
Type
Type: OCTETSTRING
Default: 008D
1627
(ancp_draft2:MaximumInterleavingDelayDownstreamTlv)
Description:
Children: None
MaximumInterleavingDelayDownstreamTlv Attributes
Attribute
Description
Length
Type: INTEGER
Default: 4
MessageSelect
Default: 3
Possible Values:
Value Description
1
Port Up
Port Down
Port Up, Port Down
Name
Type: string
Time
Type: INTEGER
Default: 0
Type
Type: OCTETSTRING
Default: 008D
MaximumInterleavingDelayUpstreamTlv
(ancp_draft0:MaximumInterleavingDelayUpstreamTlv)
Description:
Children: None
MaximumInterleavingDelayUpstreamTlv Attributes
Attribute
Description
Length
Type: INTEGER
Default: 4
1628
Attribute
Description
MessageSelect
Default: 3
Possible Values:
Value Description
1
Port Up
Port Down
Port Up, Port Down
Name
Type: string
Time
Type: INTEGER
Default: 0
Type
Type: OCTETSTRING
Default: 008B
(ancp_draft2:MaximumInterleavingDelayUpstreamTlv)
Description:
Children: None
MaximumInterleavingDelayUpstreamTlv Attributes
Attribute
Description
Length
Type: INTEGER
Default: 4
MessageSelect
Default: 3
Possible Values:
Value Description
1
Port Up
Port Down
Port Up, Port Down
Name
Type: string
Time
Type: INTEGER
Default: 0
Type
Type: OCTETSTRING
Default: 008B
1629
MaximumNetDataRateDownstreamTlv
(ancp_draft0:MaximumNetDataRateDownstreamTlv)
Description:
Children: None
MaximumNetDataRateDownstreamTlv Attributes
Attribute
Description
Length
Type: INTEGER
Default: 4
MessageSelect
Default: 3
Possible Values:
Value Description
1
Port Up
Port Down
Port Up, Port Down
Name
Type: string
Rate
Type: INTEGER
Default: 0
Type
Type: OCTETSTRING
Default: 0088
(ancp_draft2:MaximumNetDataRateDownstreamTlv)
Description:
Children: None
MaximumNetDataRateDownstreamTlv Attributes
Attribute
Description
Length
Type: INTEGER
Default: 4
1630
MaximumNetDataRateUpstreamTlv
Attribute
Description
MessageSelect
Default: 3
Possible Values:
Value Description
1
Port Up
Port Down
Port Up, Port Down
Name
Type: string
Rate
Type: INTEGER
Default: 0
Type
Type: OCTETSTRING
Default: 0088
(ancp_draft0:MaximumNetDataRateUpstreamTlv)
Description:
Children: None
MaximumNetDataRateUpstreamTlv Attributes
Attribute
Description
Length
Type: INTEGER
Default: 4
MessageSelect
Default: 3
Possible Values:
Value Description
1
Port Up
Port Down
Port Up, Port Down
Name
Type: string
Rate
Type: INTEGER
Default: 0
Type
Type: OCTETSTRING
Default: 0087
1631
(ancp_draft2:MaximumNetDataRateUpstreamTlv)
Description:
Children: None
MaximumNetDataRateUpstreamTlv Attributes
Attribute
Description
Length
Type: INTEGER
Default: 4
MessageSelect
Default: 3
Possible Values:
Value Description
1
Port Up
Port Down
Port Up, Port Down
Name
Type: string
Rate
Type: INTEGER
Default: 0
Type
Type: OCTETSTRING
Default: 0087
maxRcvSize
Description:
Parents: DL-Choice
Children: None
maxRcvSize Attributes
Attribute
Description
length
Type: INTEGER
Default: 1
maxReceiveSize
Type: OCTETSTRING
Default: 0840
Name
Type: string
1632
Mdio
Attribute
Description
type
Type: INTEGER
Default: 6
Mdio
Description:
Mdio is created automatically. There are 32 MdioPort objects under Mdio.

Parents: Ethernet100GigFiber, Ethernet10GigCopper, Ethernet10GigFiber, Ethernet40GigFiber, EthernetCopper, EthernetFiber
Children: MdioPort
Mdio Writable Attributes

Writable Attribute
Description
Active, Name
Mdio Read-Only Attributes

MdioPort
Description:
MDIO port address.
Tcl example: stc::config mdioport1 -Address "1" -Clause CLAUSE_45

Parents: Mdio
Children: ManagementDevice
MdioPort Writable Attributes

Writable Attribute
Description
Active, Name
Address
8-bit address to reference which port to access.

Type: u8
Default: 0
Clause
Specify which IEEE 802.3ae standard to use. Clause 22 is the older standard.
Type: enum
Default: CLAUSE_45
Possible Values:
Value
Description
CLAUSE_22 IEEE 802.3ae standard that is older than Clause 45.
CLAUSE_45 IEEE 802.3ae standard that supersedes Clause 22.
1633
MdioRegister
MdioPort Read-Only Attributes

MdioRegister
Description:
MDIO register.
Tcl example: stc::config mdioregister1 -Address 0 -RegValue 0x2041

Parents: ManagementDevice
MdioRegister Writable Attributes

Writable Attribute
Description
Active, Name
Address

Type: u16
Default: 0
RegValue

Type: u16
Default: 0
WritableMask

Type: u16
Default: 65535
MdioRegister Read-Only Attributes

Read-Only Attribute
Description
HwRegValue

Type: u16
Default: 0
mdiPowerSupport
Description:
Parents: PowerViaMdiTlv
Children: None
mdiPowerSupport Attributes
Attribute
Description
Name
Type: string
1634
MDN_Length
Attribute
Description
portClass
Type: BITSTRING
Default: 0
pseMdiPowerState
Type: BITSTRING
Default: 0
pseMdiPowerSupport
Type: BITSTRING
Default: 0
psePairsControlAbility
Type: BITSTRING
Default: 0
reserved
Type: BITSTRING
Default: 0000
MDN_Length
Description:
Parents: theMDNL
Children: None
MDN_Length Attributes
Attribute
Description
MDNL
Type: OCTETSTRING
Default: 00
Name
more information.
Type: string
MDN_Length
Description:
Parents: theMDNL
Children: None
MDN_Length Attributes
Attribute
Description
MDNL
Type: OCTETSTRING
Default: 00
Name
more information.
Type: string
1635
mergeRequest
mergeRequest
Description:
Children: payload
mergeRequest Attributes
Attribute
Description
command
Type: OCTETSTRING
Default: 22
Name
Type: string
protocolVersion
Type: OCTETSTRING
Default: 00
mergeRequestAcc
Description:
Children: None
mergeRequestAcc Attributes
Attribute
Description
command
Type: OCTETSTRING
Default: 02000000
Name
Type: string
obsolete1
Type: OCTETSTRING
Default: 00
obsolete2
Type: OCTETSTRING
Default: 00
obsolete3
Type: OCTETSTRING
Default: 00
reserved
Type: OCTETSTRING
Default: 00
message
Description:
DHCP message option
1636
messageSize
Parents: DHCPOption
Children: None
message Attributes
Attribute
Description
length
Type: OCTETSTRING
Default: 01
Name
more information.
Type: string
type
Type: OCTETSTRING
Default: 38
value
Type: OCTETSTRING
Default: 00
messageSize
Description:
DHCP maximum message size option
Parents: DHCPOption
Children: None
messageSize Attributes
Attribute
Description
length
Type: OCTETSTRING
Default: 02
Name
more information.
Type: string
type
Type: OCTETSTRING
Default: 39
value
Type: OCTETSTRING
Default: 0240
messageType
Description:
DHCP message type option
Parents: DHCPOption
Children: None
1637
Mii
messageType Attributes
Attribute
Description
code
Type: DHCPmessageType
Default: 1
Possible Values:
Value Description
1
Discover
Offer
Request
Decline
Ack
Nak
Release
Inform
length
Type: OCTETSTRING
Default: 01
Name
information.
Type: string
type
Type: OCTETSTRING
Default: 35
Mii
Description:
Medium Independent Interface object. When you create an EthernetCopper PHY object under a Port object, an Mii object is created automatically that has 32
MiiRegister objects under it.
It is recommended that you only configure these objects, do not remove or manually create them.
Tcl example: stc::config mii1 -name "My Mii"

Parents: Ethernet100GigFiber, Ethernet10GigCopper, Ethernet10GigFiber, Ethernet40GigFiber, EthernetCopper, EthernetFiber
Automatically-created children: MiiRegister
Mii Writable Attributes

Writable Attribute
Description
Active, Name
Mii Read-Only Attributes

MiiRegister
Description:
1638
MinimumNetDataRateDownstreamTlv
Mii register.
Tcl example: stc::config miiregister1 -Address 0 -RegValue 0x1040

Automatically created from: Mii
MiiRegister Writable Attributes

Writable Attribute
Description
Active, Name
Address

Type: u16
Default: 0
RegValue

Type: u16
Default: 0
WritableMask

Type: u16
Default: 65535
MiiRegister Read-Only Attributes

Read-Only Attribute
Description
HwRegValue

Type: u16
Default: 0
(ancp_draft0:MinimumNetDataRateDownstreamTlv)
Description:
Children: None
MinimumNetDataRateDownstreamTlv Attributes
Attribute
Description
Length
Type: INTEGER
Default: 4
1639
Attribute
Description
MessageSelect
Default: 3
Possible Values:
Value Description
1
Port Up
Port Down
Port Up, Port Down
Name
Type: string
Rate
Type: INTEGER
Default: 0
Type
Type: OCTETSTRING
Default: 0084
(ancp_draft2:MinimumNetDataRateDownstreamTlv)
Description:
Children: None
MinimumNetDataRateDownstreamTlv Attributes
Attribute
Description
Length
Type: INTEGER
Default: 4
MessageSelect
Default: 3
Possible Values:
Value Description
1
Port Up
Port Down
Port Up, Port Down
Name
Type: string
Rate
Type: INTEGER
Default: 0
Type
Type: OCTETSTRING
Default: 0084
1640
MinimumNetDataRateUpstreamTlv
(ancp_draft0:MinimumNetDataRateUpstreamTlv)
Description:
Children: None
MinimumNetDataRateUpstreamTlv Attributes
Attribute
Description
Length
Type: INTEGER
Default: 4
MessageSelect
Default: 3
Possible Values:
Value Description
1
Port Up
Port Down
Port Up, Port Down
Name
Type: string
Rate
Type: INTEGER
Default: 0
Type
Type: OCTETSTRING
Default: 0083
(ancp_draft2:MinimumNetDataRateUpstreamTlv)
Description:
Children: None
MinimumNetDataRateUpstreamTlv Attributes
Attribute
Description
Length
Type: INTEGER
Default: 4
1641
MinimumNetLowPowerDataRateDownstreamTlv
Attribute
Description
MessageSelect
Default: 3
Possible Values:
Value Description
1
Port Up
Port Down
Port Up, Port Down
Name
Type: string
Rate
Type: INTEGER
Default: 0
Type
Type: OCTETSTRING
Default: 0083
(ancp_draft0:MinimumNetLowPowerDataRateDownstreamTlv)
Description:
Children: None
MinimumNetLowPowerDataRateDownstreamTlv Attributes
Attribute
Description
Length
Type: INTEGER
Default: 4
MessageSelect
Default: 3
Possible Values:
Value Description
1
Port Up
Port Down
Port Up, Port Down
Name
Type: string
Rate
Type: INTEGER
Default: 0
Type
Type: OCTETSTRING
Default: 008A
1642
(ancp_draft2:MinimumNetLowPowerDataRateDownstreamTlv)
Description:
Children: None
MinimumNetLowPowerDataRateDownstreamTlv Attributes
Attribute
Description
Length
Type: INTEGER
Default: 4
MessageSelect
Default: 3
Possible Values:
Value Description
1
Port Up
Port Down
Port Up, Port Down
Name
Type: string
Rate
Type: INTEGER
Default: 0
Type
Type: OCTETSTRING
Default: 008A
MinimumNetLowPowerDataRateUpstreamTlv
(ancp_draft0:MinimumNetLowPowerDataRateUpstreamTlv)
Description:
Children: None
MinimumNetLowPowerDataRateUpstreamTlv Attributes
Attribute
Description
Length
Type: INTEGER
Default: 4
1643
Attribute
Description
MessageSelect
Default: 3
Possible Values:
Value Description
1
Port Up
Port Down
Port Up, Port Down
Name
Type: string
Rate
Type: INTEGER
Default: 0
Type
Type: OCTETSTRING
Default: 0089
(ancp_draft2:MinimumNetLowPowerDataRateUpstreamTlv)
Description:
Children: None
MinimumNetLowPowerDataRateUpstreamTlv Attributes
Attribute
Description
Length
Type: INTEGER
Default: 4
MessageSelect
Default: 3
Possible Values:
Value Description
1
Port Up
Port Down
Port Up, Port Down
Name
Type: string
Rate
Type: INTEGER
Default: 0
Type
Type: OCTETSTRING
Default: 0089
1644
MismatchInfo
MismatchInfo (oncrpcv2:MismatchInfo)
Description:
Children: None
MismatchInfo Attributes
Attribute
Description
high
Type: INTEGER
Default: 0
low
Type: INTEGER
Default: 0
Name
more information.
Type: string
MldEotHostResults
Description:
End of test state and statistics of the MLD host object.

Automatically created from: MldHostConfig
MldEotHostResults Writable Attributes

MldEotHostResults Read-Only Attributes

Read-Only Attribute
Description
AvgJoinLatency
Average join latency, in milliseconds, of all hosts within the block.

Type: double
Default: 0
AvgLeaveLatency
Average leave latency, in milliseconds, of all hosts within the block.

Type: double
Default: 0
DuplicateJoinCount
Number of duplicate joins of all hosts within the block.

Type: u32
Default: 0
HostName
Name of the host block.

Type: string
Default: 0
JoinFailCount
Number of join failures of all hosts within the block.

Type: u32
Default: 0
MaxJoinLatency
Maximum join latency, in milliseconds, of all hosts within the block.

Type: double
Default: 0
1645
MldGroupMembership
Read-Only Attribute
Description
MaxLeaveLatency
Maximum leave latency, in milliseconds, of all hosts within the block.

Type: double
Default: 0
MinJoinLatency
Minimum join latency, in milliseconds, of all hosts within the block.

Type: double
Default: 0
MinLeaveLatency
Minimum leave latency, in milliseconds, of all hosts within the block.

Type: double
Default: 0
MldGroupMembership
Description:
Creates blocks of MLD host group memberships.

Parents: IgmpHostConfig, MldHostConfig
Result children (automatically created): MldGroupMembershipResults
Relations:
Side name
(Type)
Relative
Description
ResultChild
(ResultChild)
MldGroupMembershipResults
MulticastGroup
(SubscribedGroups)
Relationship between the MLD group membership object and an

IPv6 multicast group object.
MulticastSource
(SubscribedSources)
EmulatedDevice
Relationship between the MLD group membership object and a host

object emulating a multicast source.
MldGroupMembership Writable Attributes

Writable Attribute
Description
Active, Name
CalculateLatency
Specifies whether or not to interactively calculate join/leave latency for the group associated to this membership.
Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
Enables join/leave latency to be calculated interactively. Refer to CalculateLatencyDelay property on the

PortConfig to configure the delay to calculate latency.
FALSE Disables join/leave latency from being calculated interactively.

DeviceGroupMapping
Type: enum
Possible Values:
Value
Description
ONE_TO_ONE
Assigns one device to each group. The mapping stops when it reaches the end of either devices or
groups. The extra devices or groups are not mapped.
1646
Writable Attribute
Description
FilterMode
Specifies the filter mode for the associated multicast groups and sources.
Type: enum
Default: EXCLUDE
Possible Values:
Value
Description
INCLUDE Select INCLUDE to enable the host to receive multicast data only from the sources specified in the Source
Filters field.
EXCLUDE Select EXCLUDE to reject multicast data from the sources specified in the Source Filters field.
IsSourceList
Specifies whether sources are defined as a list or range of addresses.

Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
Enables the use of a discrete list of user-defined sources.
FALSE Enables the use of a range of user-defined sources.

UserDefinedSources
Controls the use of user-defined multicast sources.

Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
Enables the use of user-defined multicast sources.
FALSE Disables the use of user-defined multicast sources.
MldGroupMembership Read-Only Attributes

Description:
MLD device-group results.

Parents: MldGroupMembership
Relations:
Side name
(Type)
Relative
Description
ResultParent
(ResultChild)
MldGroupMembership
MldGroupMembershipResults Writable Attributes

1647
MldGroupMembershipResults Read-Only Attributes

Read-Only Attribute
Description
DuplicateJoin
Indicates whether or not the DUT was already forwarding multicast prior to a join being sent.
Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
DUT was forwarding multicast traffic for this group prior to the join being sent.
FALSE No duplicate join report detected.

GroupAddr
Group's IP multicast address.

Type: ipv6
Default: ::
GroupHandle
IL group handle.
Type: u32
Default: 0
HostAddr
Host's IP address.
Type: ipv6
Default: ::
JoinFail
Indicates whether or not multicast traffic was received.

Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
Multicast traffic was not received.
FALSE Multicast traffic was received.

JoinLatency
Time between sending an IGMP join message, and receiving multicast data from the group specified in the join message.
Type: double
Default: 0
JoinTimestamp
Transmit timestamp of the initial MLD join message.

Type: string
Default: 0
LeaveLatency
Time between sending an IGMP leave message to a multicast group, and when the multicast data stopped traffic.
Type: double
Default: 0
LeaveTimestamp
Transmit timestamp of the MLD leave message.

Type: string
Default: 0
ResultIf
Object handle returned from the call to create the MLDS group membership object.
Type: u32
Default: 0
1648
MldHostConfig
Read-Only Attribute
Description
State
Current state of the MLD group.

Type: enum
Default: UNDEFINED
Possible Values:
Value
Description
UNDEFINED
Host is in an undefined state.
NON_MEMBER
Host does not belong to the group on the interface. This state applies only to MLDv1 and is the
initial state for all memberships on all network interfaces.
DELAYING_MEMBER Host belongs to the group on the interface and has a report delay timer running for that
membership. This state applies to MLDv1 only.
IDLE_MEMBER
Host belongs to the group on the interface and does not have a report delay timer running for
that membership. This state applies to MLDv1 only.
RETRYING_MEMBER This state applies to MLDv1 hosts when ForceRobustJoin is True. The host is retransmitting its
initial join before transitioning from the NON_MEMBER state to the DELAYING_MEMBER or
IDLE_MEMBER state. This state applies to MLDv1 only.
StateChangeTimestamp
INCLUDE
Data from the specified sources are filtered and forwarded to the host by the multicast router.
This state applies to MLDv2 only.
EXCLUDE
Data from the specified sources are filtered and not forwarded to the host by the multicast router.
This state applies to MLDv2 only.
Timestamp of the MLD group membership state change.

Type: string
Default: 0
MldHostConfig
Description:
Configures one or more host blocks on the MLD port.

Children: IgmpGroupMembership, MldGroupMembership
Automatically-created children: MldEotHostResults
Result children (automatically created): MldEotHostResults, MldHostResults
Relations:
Side name
(Type)
Relative
Description
IptvParameter
(MulticastParam)
IptvStbBlockConfig
Relationship between the IPTV set-top box block configuration

object, and the MLD host configuration object.
ResultChild
(ResultChild)
MldHostResults
VqAnalyzerChannelMembership
(SubscribedHosts)
VqAnalyzerChannelMembershipGenParams
Relationship between an IGMP/MLD host and a Video Quality

channel membership. Used exclusively in the Video Quality
wizard.
UsesIf
(UsesIf)

WimaxIf

1649
MldHostConfig
MldHostConfig Writable Attributes

Writable Attribute
Description
Active, Name
ForceLeave
Affects all hosts except the last one, which is always required to send an MLDv1 leave report. MLDv1 hosts leaving a multicast
group may optionally send a leave report to the all-routers multicast group. The ForceLeave flag controls whether or not all
hosts are required to send leave reports when leaving the multicast group.
Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
Force the MLDv1 host(s) to send a Leave Group message when leaving a multicast group.
FALSE Do not force the MLDv1 host(s) to send a Leave Group message when leaving a multicast group.
ForceRobustJoin
When an MLDv1 host joins a multicast group, it immediately transmits an initial unsolicited membership report for that group,
in case it is the first member of that group on the network. In case the initial report gets damaged or lost, a second unsolicited
report is recommended be sent out. The ForceRobustJoin flag controls whether or not a second report is transmitted.
Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
Forces the host to send a second MLDv1 join report.
FALSE Does not force the host to send a second MLDv1 join report.
ForceSimpleJoin
Forces the MLD host(s) to send a single join report per group. Enabling this option effectively bypasses the RFC defined
behavior of sending (Robustness Variable - 1) reports. Otherwise, MLD host(s) will behave according to RFC specification.
Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
Force MLD host(s) to send a single join report per group.
FALSE Default behavior that is compliant to RFC specification. MLD host(s) will send (Robustness Variable - 1) reports.
InsertCheckSumErrors
Controls the insertion of checksum errors into MLD messages by the hardware.
Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
MLD checksum of the transmitted packet is flipped by the protocol stack.
FALSE MLD checksum of the transmitted packet is not modified.

InsertLengthErrors
Controls the insertion of message length errors into the MLD messages by the MLD stack.
Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
Every MLD packet transmitted by the host will be 2 bytes shorter than normal.
FALSE MLD packet lengths will not be modified.

Ipv6TrafficClass
Specifies the value of the Traffic Class field in the IPv6 header.
Type: u8
Default: 0
PackReports
Allows MLDv2 host(s) to send reports that contain multiple group records, to allow reporting of full current state using fewer
packets.
Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
Reports will contain multiple group records.
FALSE An individual report will be sent for each group record.
1650
MldHostResults
Writable Attribute
Description
RobustnessVariable
Type: u8
Default: 2
Range: 2 - 255
UnsolicitedReportInterval
Time between repetitions of a host's initial report of membership in a group.

Type: u32
Default: 10
Range: 0 - 604800

Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE

Version

Type: enum
Default: IGMP_V2
Possible Values:
Value
Description
IGMP_V2 IGMP version specified in RFC 2236. Improved IGMP version that adds leave messages, shortening the amount
of time required for a router to determine that no stations are in a particular group.
IGMP_V3 Specified in RFC 3376, this major revision of the IGMP protocol adds the ability to specify the source(s) that a
receiver is willing to listen to.
MLD_V1
MLD_V2
MldHostConfig Read-Only Attributes

Read-Only Attribute
Description
BlockState

Type: enum
Default: NON_MEMBER
Possible Values:
Value
Description
UNDEFINED
Undefined.
NON_MEMBER No device in the block is joined to a group, and there are no initial unsolicited reports to be sent.
JOINING
MEMBER
At least one device in the block is joined to a group, and there are no initial unsolicited reports to be sent.
LEAVING
One or more devices in the block have yet to send their initial unsolicited Leave reports, and no device in
the block is sending non-Leave reports.
MldHostResults
Description:
MLD results.

Parents: MldHostConfig
Relations:
1651
MldHostResults
Side name
(Type)
Relative
Description
ResultParent
(ResultChild)
MldHostConfig
MldHostResults Writable Attributes

MldHostResults Read-Only Attributes

Read-Only Attribute
Description
AvgJoinLatency
Average Join Latency for this host.

Type: double
Default: 0
AvgLeaveLatency
Average Leave Latency for this host.

Type: double
Default: 0
HostState

Type: enum
Default: NON_MEMBER
Possible Values:
Value
Description
UNDEFINED
Undefined.
sent.
JOINING
MEMBER
At least one device in the block is joined to a group, and there are no initial unsolicited
reports to be sent.
LEAVING
One or more devices in the block have yet to send their initial unsolicited Leave reports,
and no device in the block is sending non-Leave reports.
IfHandle
Type: u32
Default: 0
MaxJoinLatency
Maximum Join Latency for this host.

Type: double
Default: 0
MaxLeaveLatency
Maximum Leave Latency for this host.

Type: double
Default: 0
MLD version the host block is currently operating as.

Type: enum
Default: V1
Possible Values:
Value Description
V1
MLDv1
V2
MLDv2
MinJoinLatency
Minimum Join Latency for this host.

Type: double
Default: 0
MinLeaveLatency
Minimum Leave Latency for this host.

Type: double
Default: 0
1652
MldPortConfig
Read-Only Attribute
Description
RouterState

Type: enum
Possible Values:
Value
Description
UNDEFINED
Undefined.

UP
RxFrameCount
Total number of MLD frames received.

Type: u32
Default: 0
RxMldCheckSumErrorCount
Total number of MLD messages received with checksum errors.

Type: u32
Default: 0
RxMldLengthErrorCount
Total number of MLD messages received with length errors.

Type: u32
Default: 0
RxUnknownTypeCount

Type: u32
Default: 0
Timestamp

Type: double
Default: 0
TxFrameCount
Total number of MLD frames transmitted.

Type: u32
Default: 0
MldPortConfig
Description:
Creates/configures an MLD port.

Result children (automatically created): MldPortResults
Relations:
Side name
(Type)
Relative
Description
ResultChild
(ResultChild)
MldPortResults
MldPortConfig Writable Attributes

Writable Attribute
Description
Active, Name
1653
MldPortResults
Writable Attribute
Description
CalculateLatencyDelay
Specifies the delay (in seconds) before latency is calculated. The timer starts after reports are sent for each device.
Note: Applies to interactive latency tests only.
Type: u32
Default: 10
Range: 1 - 3600
MaxBurst
Short-term maximum burst size in packets. A value of 0 specifies the maximum possible burst size.
Type: u32
Default: 0
RatePps
Long-term, maximum packet rate (in packets per second). A value of 0 specifies the maximum possible output rate.
Type: u32
Default: 0
VlanSubFilter
Specifies whether to filter on the Outer or Inner VLAN tag when calculating latency for devices with a PPPoE and
stacked VLAN encapsulation.
Type: enum
Default: OUTER
Possible Values:
Value Description
OUTER Specifies that the analyzer filter will be programmed to use the Outer VLAN ID.
INNER Specifies that the analyzer filter will be programmed to use the Inner VLAN ID.
MldPortConfig Read-Only Attributes

MldPortResults
Description:
MLD port results.

Parents: MldPortConfig
Relations:
Side name
(Type)
Relative
Description
ResultParent
(ResultChild)
MldPortConfig
MldPortResults Writable Attributes

MldPortResults Read-Only Attributes

Read-Only Attribute
Description
RxFrameCount

Type: u32
Default: 0
RxGeneralQueryCount
Total number of multicast general queries received.

Type: u32
Default: 0
1654
MldPortResults
Read-Only Attribute
Description
RxGroupAndSourceSpecificQueryCount
Type: u32
Default: 0
RxGroupSpecificQueryCount
Group-Specific Query is used to learn if a particular group has any members on an attached network.
Type: u32
Default: 0

Type: u32
Default: 0

Type: u32
Default: 0
RxUnknownTypeCount
Total number of MLD frames of unknown type received.

Type: u32
Default: 0
RxV1QueryCount
Total number of MLDv1 queries received. Routers use Multicast Listener Query messages to query a subnet
Type: u32
Default: 0
RxV1ReportCount
MLDv1 reports are sent to multicast routers to indicate that hosts have listeners interested in joining multicast
Type: u32
Default: 0
RxV2QueryCount
Total number of MLDv2 queries received. Routers use Multicast Listener Query messages to query a subnet
Type: u32
Default: 0
RxV2ReportCount
MLDv1 are used to report interest in receiving multicast traffic for a specific multicast address or to respond
to a Multicast Listener Query message.
Type: u32
Default: 0
Timestamp

Type: double
Default: 0
TxFrameCount

Type: u32
Default: 0
TxGeneralQueryCount
General Queries are used to learn which multicast addresses have listeners on an attached link.
Type: u32
Default: 0
TxGroupAndSourceSpecificQueryCount
Type: u32
Default: 0
TxGroupSpecificQueryCount
Total number of MLD group specific queries transmitted. The Group-Specific Query is used to learn if a
particular group has any members on an attached network.
Type: u32
Default: 0
TxStopListenGroupCount
Stop listening events occur when the node stops listening to an address on the interface.
Type: u32
Default: 0
1655
MldRouterConfig
Read-Only Attribute
Description
TxV1QueryCount
MLDv1 Membership Queries are sent by IP multicast routers to query the multicast reception state of
neighboring interfaces.
Type: u32
Default: 0
TxV1ReportCount
Type: u32
Default: 0
TxV2AllowNewSourcesCount
A Source-List-Change Record (SLCR) indicating the group's associated sources have changed such that
data from a new set of sources are to be received.
Type: u32
Default: 0
TxV2BlockOldSourcesCount
A Source-List-Change Record (SLCR) indicating the group's associated sources have changed such that
data from an existing set of sources are not required.
Type: u32
Default: 0
TxV2ChangeToExcludeModeCount
A Filter-Mode-Change Record (FMCR) indicating the filter-mode of the reception state has changed to exclude
mode.
Type: u32
Default: 0
TxV2ChangeToIncludeModeCount
A Filter-Mode-Change Record (FMCR) indicating the filter-mode of the reception state has changed to include
mode.
Type: u32
Default: 0
TxV2ModeIsExcludeCount
A Current-State Record (CSR) indicating the current reception state with respect to 1 multicast group at a
given interface. The state contains the exclude filter mode.
Type: u32
Default: 0
TxV2ModeIsIncludeCount
A Current-State Record (CSR) indicating the current reception state with respect to 1 multicast group at a
given interface. The state contains the include filter mode.
Type: u32
Default: 0
TxV2QueryCount
MLDv2 Membership Queries are sent by IP multicast routers to query the multicast reception state of
neighboring interfaces.
Type: u32
Default: 0
TxV2ReportCount
Type: u32
Default: 0
MldRouterConfig
Description:
Configures an MLD querier on the port.

Result children (automatically created): MldRouterResults
Relations:
1656
MldRouterConfig
Side name
(Type)
Relative
Description
ResultChild
(ResultChild)
MldRouterResults
UsesIf
(UsesIf)


MldRouterConfig Writable Attributes

Writable Attribute
Description
Active, Name
Ipv6TrafficClass
Specifies the value of the Traffic Class field in the IPv6 header.
Type: u8
Default: 0
LastMemberQueryCount
Value for the Max Response Time field (in milliseconds) that is inserted into Group-Specific and
Group-and-Source-Specific Query messages in response to Leave Group messages. This value also specifies the
interval between transmissions of Group-Specific and Group-and-Source-Specific Query messages. This field does not
apply to IGMPv1.
Type: u8
Default: 2
LastMemberQueryInterval
Maximum amount of time between group-specific query messages, including those sent in response to leave-group
messages.
Type: u32
Default: 1000
QueryInterval
Duration (in seconds) between transmissions of General Query messages. General Query messages are used to learn
which multicast groups have members on a connected network.
Type: u32
Default: 125
QueryResponseInterval
Value for the Max Response Time field (in milliseconds) that is inserted into the General Query messages. This time is
the maximum amount allowed for a host to send a responding report to the General Query message. This interval must
be less than the Query Interval. This field does not apply for IGMPv1.
Type: u32
Default: 10000
RobustnessVariable
Type: u8
Default: 2
Range: 2 - 255
StartupQueryCount
Number of queries sent out on startup, separated by the Startup Query Interval.
Type: u8
Default: 2
Range: 1 - 255

Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
1657
MldRouterResults
Writable Attribute
Description
Version

Type: enum
Default: IGMP_V2
Possible Values:
Value
Description
IGMP_V2 IGMP version specified in RFC 2236. Improved IGMP version that ads leave messages, shortening the
IGMP_V3 Specified in RFC 3376, this major revision of the IGMP protocol adds the ability to specify the source(s)
that a receiver is willing to listen to.
MLD_V1
MLD_V2
Version of MLD, specified in RFC 3810, that adds the "include" and "exclude" filter functionality as in
IGMPv3.
MldRouterConfig Read-Only Attributes

Read-Only Attribute
Description
BlockState

Type: enum
Possible Values:
Value
Description
UNDEFINED
Undefined.

UP
MldRouterResults
Description:
MLD Querier results.

Parents: MldRouterConfig
Relations:
Side name
(Type)
Relative
Description
ResultParent
(ResultChild)
MldRouterConfig
MldRouterResults Writable Attributes

1658
MldRouterResults
MldRouterResults Read-Only Attributes

Read-Only Attribute
Description
HostState

Type: enum
Default: NON_MEMBER
Possible Values:
Value
Description
UNDEFINED
Undefined.
sent.
JOINING
MEMBER
At least one device in the block is joined to a group, and there are no initial unsolicited reports
to be sent.
LEAVING
One or more devices in the block have yet to send their initial unsolicited Leave reports, and
no device in the block is sending non-Leave reports.
IfHandle
Type: u32
Default: 0
MLD version the router block is currently operating as.

Type: enum
Default: V1
Possible Values:
Value Description
RouterState
V1
MLDv1
V2
MLDv2

Type: enum
Possible Values:
Value
Description
UNDEFINED
Undefined.

UP
RxFrameCount

Type: u32
Default: 0

Type: u32
Default: 0

Type: u32
Default: 0
RxUnknownTypeCount

Type: u32
Default: 0
Timestamp

Type: double
Default: 0
TxFrameCount

Type: u32
Default: 0
1659
MLDv1
MLDv1 (icmpv6:MLDv1)
Description:
MLDv1 message. See RFC 2710.
Children: None
MLDv1 Attributes
Attribute
Description
checksum
Type: INTEGER
Default: 0
code
Type: INTEGER
Default: 0
maxRespDelay
Type: INTEGER
Default: 0
mcastAddr
Type: IPV6ADDR
Default: FF1E::1
Name
more information.
Type: string
reserved
Type: INTEGER
Default: 0
type
Type: Icmpv6Type
Default: 130
Possible Values:
Value Description
1
Packet Too Big
Time Exceeded
Parameter Problem
128
Echo Request
129
Echo Reply
130
MLDv1 Query
131
132
MLDv1 Listener Done
133
Router Solicitation
134
135
136
137
Redirect
143
MLDv2GroupRecord
Description:
MLDv2 Multicast Address Record. See RFC 3810.
Parents: grpRecords
Children: addrList
1660
MLDv2Query
MLDv2GroupRecord Attributes
Attribute
Description
auxDataLen
Type: INTEGER
Default: 0
mcastAddr
Type: IPV6ADDR
Default: FF1E::1
Name
Type: string
numSource
Type: INTEGER
Default: 0
recordType
Type: MLDv2RecordType
Possible Values:
Value Description
1
MODE_IS_INCLUDE
MODE_IS_EXCLUDE
CHANGE_TO_INCLUDE_MODE
CHANGE_TO_EXCLUDE_MODE
ALLOW_NEW_SOURCES
BLOCK_OLD_SOURCES
MLDv2Query (icmpv6:MLDv2Query)
Description:
MLDv2 Multicast Listener Query message. See RFC 3810.
Children: addrList
MLDv2Query Attributes
Attribute
Description
checksum
Type: INTEGER
Default: 0
code
Type: INTEGER
Default: 0
groupAddress
Type: IPV6ADDR
Default: FF1E::1
maxRespCode
Type: INTEGER
Default: 0
Name
Type: string
numSource
Type: INTEGER
Default: 0
1661
MLDv2Report
Attribute
Description
qqic
Type: INTEGER
Default: 0
qrv
Type: BITSTRING
Default: 0
reserved
Type: INTEGER
Default: 0
resv
Type: INTEGER
Default: 0
sFlag
Type: BITSTRING
Default: 1
type
Type: Icmpv6Type
Default: 130
Possible Values:
Value Description
1
Packet Too Big
Time Exceeded
Parameter Problem
128
Echo Request
129
Echo Reply
130
MLDv1 Query
131
132
MLDv1 Listener Done
133
Router Solicitation
134
135
136
137
Redirect
143
MLDv2Report (icmpv6:MLDv2Report)
Description:
MLDv2 Multicast Listener Report message. See RFC 3810.
Children: grpRecords
MLDv2Report Attributes
Attribute
Description
checksum
Type: INTEGER
Default: 0
Name
more information.
Type: string
1662
modeSense10
Attribute
Description
numGrpRecords
Type: INTEGER
Default: 0
reserved2
Type: INTEGER
Default: 0
type
Type: Icmpv6Type
Default: 143
Possible Values:
Value Description
unused
Packet Too Big
Time Exceeded
Parameter Problem
128
Echo Request
129
Echo Reply
130
MLDv1 Query
131
132
MLDv1 Listener Done
133
Router Solicitation
134
135
136
137
Redirect
143
Type: INTEGER
Default: 0
modeSense10
Description:
Parents: fcpCdb
Children: None
modeSense10 Attributes
Attribute
Description
allocationLength
Type: OCTETSTRING
Default: 0000
control
Type: OCTETSTRING
Default: 00
dbd
Type: BITSTRING
Default: 0
llbaa
Type: BITSTRING
Default: 0
Name
Type: string
1663
ModeSense10
Attribute
Description
opCode
Type: OCTETSTRING
Default: 5A
pageCode
Type: INTEGER
Default: 0
pc
Type: BITSTRING
Default: 00
reserved1
Type: BITSTRING
Default: 000
reserved2
Type: BITSTRING
Default: 000
reserved3
Type: OCTETSTRING
Default: 000000
subpageCode
Type: OCTETSTRING
Default: 00
ModeSense10 (scsi:ModeSense10)
Description:
Children: None
ModeSense10 Attributes
Attribute
Description
allocationLength
Type: OCTETSTRING
Default: 0000
control
Type: OCTETSTRING
Default: 00
dbd
Type: BITSTRING
Default: 0
llbaa
Type: BITSTRING
Default: 0
Name
Type: string
opCode
Type: OCTETSTRING
Default: 5A
pageCode
Type: INTEGER
Default: 0
pc
Type: BITSTRING
Default: 00
reserved1
Type: BITSTRING
Default: 000
1664
modeSense6
Attribute
Description
reserved2
Type: BITSTRING
Default: 000
reserved3
Type: OCTETSTRING
Default: 000000
subpageCode
Type: OCTETSTRING
Default: 00
modeSense6
Description:
Parents: fcpCdb
Children: None
modeSense6 Attributes
Attribute
Description
allocationLength
Type: INTEGER
Default: 0
control
Type: OCTETSTRING
Default: 00
dbd
Type: BITSTRING
Default: 0
Name
Type: string
opCode
Type: OCTETSTRING
Default: 1A
pageCode
Type: INTEGER
Default: 0
pc
Type: BITSTRING
Default: 00
reserved1
Type: BITSTRING
Default: 0000
reserved2
Type: BITSTRING
Default: 000
subpageCode
Type: OCTETSTRING
Default: 00
ModeSense6 (scsi:ModeSense6)
Description:
1665
ModifyTrafficGroupCommand
Children: None
ModeSense6 Attributes
Attribute
Description
allocationLength
Type: INTEGER
Default: 0
control
Type: OCTETSTRING
Default: 00
dbd
Type: BITSTRING
Default: 0
Name
Type: string
opCode
Type: OCTETSTRING
Default: 1A
pageCode
Type: INTEGER
Default: 0
pc
Type: BITSTRING
Default: 00
reserved1
Type: BITSTRING
Default: 0000
reserved2
Type: BITSTRING
Default: 000
subpageCode
Type: OCTETSTRING
Default: 00
ModifyTrafficGroupCommand
Description:
Modify properties of stream blocks associated with specified traffic groups. Group and subgroup names are used to find stream blocks. If subgroup name is
not provided for a given group, then all stream blocks under the group will be modified.

ModifyTrafficGroupCommand Writable Attributes

Writable Attribute
Description
AdditionalStreamBlocks
Stream blocks to be modified in addition to those under the traffic groups specified.
Type: handle
Default: 0
TrafficGroups
Names of traffic groups under which stream blocks are to be modified.

Type: string
1666
Mpls
ModifyTrafficGroupCommand Read-Only Attributes

Read-Only Attribute
Description

ModifiedGroups
Handle list of group collection (group) modified.

Type: handle
Default: 0
ModifiedStreamBlocks
Handle list of stream blocks modified.

Type: handle
Default: 0
ModifiedSubgroups
Handle list of traffic group (subgroup) modified.

Type: handle
Default: 0
Mpls (mpls:Mpls)
Description:
Children: None
Next headers: ethernet:EthernetII, ipv4:IPv4, ipv6:IPv6, mpls:Mpls, mpls:EntropyLabel, mpls:ControlWord, custom:Custom
Mpls Attributes
Attribute
Description
dstMac
Type: MACADDR
Default: 00:00:01:00:00:01
exp
Type: BITSTRING
Default: 000
label
Type: MplsLabel
Default: 1
Possible Values:
Value Description
0
IPv4 Explicit NULL Label
Router Alert Label
IPv6 Explicit NULL Label
Implicit NULL Label
14
OAM Alert Label
15
Reserved
Name
information.
Type: string
sBit
Type: BITSTRING
Default: 0
ttl
Type: INTEGER
Default: 64
1667
MplsForwardingLink
MplsForwardingLink
Description:
Link between an IP device and an MPLS enabled device. The packet of IP device will be forward through the MPLS tunnel created by the MPLS device if
tunnel is available. In most cases, L3ForwardingLink should be used instead of MplsForwardingLink.

Relations:
Side name
(Type)
Relative
Description
Container
(ContainedLink)

(LinkDst)
LinkDstDevice
(LinkDstDevice)
EmulatedDevice
NetworkLinkSource
(LinkSrc)
MplsForwardingLink Writable Attributes

Writable Attribute
Description
Active, Name
MplsForwardingLink Read-Only Attributes

Read-Only Attribute
Description
LinkType
Name of Link Type.

Type: string
MplsGeneralizedPwBindIfCreateCommand
Description:
MPLS Generalized Pw BindIfCreateCommand

Parents: Sequencer
MplsGeneralizedPwBindIfCreateCommand Writable Attributes

Writable Attribute
Description
AttachmentGroupId
Attachment Group ID.

Type: string
Default: 100:1
AttachmentGroupIdCount
Attachment Group ID count.

Type: u32
Default: 1
1668
MplsGeneralizedPwBindIfCreateCommand
Writable Attribute
Description
Attachment Group ID step.

Type: string
Default: 0:1
ControlWordEnabled
Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
FALSE
CreateClassId
Create class ID.

Type: classId
Default: 0
CreateCount
Create count.
Type: u32
Default: 1
FlowLabelEnabled
Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
FALSE
LabelRepeatCount
Label repeat count.

Type: u16
Default: 0
ParentList
Parent handle list.

Type: handle
Default: 0
Protocol
Protocol router configuration handle.

Type: handle
Default: 0
Source Attachment individual ID.

Type: u32
Default: 0
Source Attachment individual ID step.

Type: u32
Default: 1
Target Attachment individual ID.

Type: u32
Default: 0
Target Attachment individual ID step.

Type: u32
Default: 1
MplsGeneralizedPwBindIfCreateCommand Read-Only Attributes

Read-Only Attribute
Description
ReturnList
Return handles.
Type: handle
Default: 0
1669
MplsGeneralizedPwBindInfo
MplsGeneralizedPwBindInfo
Description:
Binding information for FEC 129.

Parents: Aal5If, EthIIIf, FcIf, GreIf, HdlcIf, Ipv4If, Ipv6If, ItagIf, L2tpv2If, MplsIf, PppIf, PppoeIf, VlanIf, WimaxIf
MplsGeneralizedPwBindInfo Writable Attributes

Writable Attribute
Description
Active, Name
AttachmentGroupId
Attachment Group ID.

Type: string
Default: 100:1
AttachmentGroupIdCount
Attachment Group ID count.

Type: u32
Default: 1
Attachment Group ID step.

Type: string
Default: 0:1
ControlWordEnabled
Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
FALSE
FlowLabelEnabled
Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
FALSE
Source Attachment Individual ID.

Type: u32
Default: 0
Source Attachment Individual ID step.

Type: u32
Default: 0
Target Attachment Individual ID.

Type: u32
Default: 0
Target Attachment Individual ID step.

Type: u32
Default: 0
MplsGeneralizedPwBindInfo Read-Only Attributes

1670
MplsHierarchicalLink
MplsHierarchicalLink
Description:
Link between two MPLS enabled device. In most cases, L3ForwardingLink should be used instead of MplsHierarchicalLink.

Relations:
Side name
(Type)
Relative
Description
Container
(ContainedLink)

(LinkDst)
LinkDstDevice
(LinkDstDevice)
EmulatedDevice
NetworkLinkSource
(LinkSrc)
Name of Link Type.
MplsHierarchicalLink Writable Attributes

Writable Attribute
Description
Active, Name
MplsHierarchicalLink Read-Only Attributes

Read-Only Attribute
Description
LinkType
Name of Link Type.

Type: string
MplsIf
Description:
MPLS interface object.

Relations:
Side name
(Type)
Relative
Description
DstBoundTo
(DstBinding)

StreamBlock.
EncapsulationSource
(Encapsulation)
PathDescriptor
1671
MplsIf
Side name
(Type)
Relative
Description
NetworkLink
(LinkSrc)

MemberOfVpn
(MemberOfVpn)

VpnSiteInfoVplsLdp
Port

relation.

WimaxIf

PrimaryIfSource
(PrimaryIf)

SUT

the DUT.
RelayBlockConfig
(RelayIf)
(ResolvesInterface)

RsvpRouterConfig

SrcBoundTo
(SrcBinding)

StreamBlock.
StackedOn
(StackedOnEndpoint)

WimaxIf
TopLevelIfSource
(TopLevelIf)

SUT

interface stack.
Port

relation.
1672
MplsIf
Side name
(Type)
Relative
Description
UsesIfSource
(UsesIf)


MplsIf Writable Attributes

Writable Attribute
Description
Active, Name
DstMac
Resolved destination MAC.

Type: mac
Default: 00:00:01:00:00:01
ExperimentalBits
MPLS label experimental bits.

Type: u8
Default: 0
Range: 0 - 7
IfCountPerLowerIf

Type: u32
Default: 1
IfRecycleCount
How many to times to increment the MPLS label before returning to the starting value. See Label for more information.
Type: u32
Default: 0
IsLoopbackIf

Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE

IsRange
Whether to use a combination of attributes to generate a range of MPLS labels, or to use the LabelList attribute to
specify the MPLS labels.
Type: bool
Default: TRUE
Possible Values:
Value Description
TRUE
Use a combination of attributes to generate a range of MPLS labels. The attributes are Label, LabelStep,
LabelRepeatCount, and IfRecycleCount. See Label for more information.
FALSE Use the LabelList attribute to specify the MPLS labels.
1673
MplsIf
Writable Attribute
Description
Label
MPLS label. You can generate more than one MPLS label by using LabelRepeatCount, LabelStep, and IfRecycleCount.
If you do that, then the value of this attribute is the starting MPLS label.
Example: Label = 1, LabelStep = 1, IfRecycleCount = 2, LabelRepeatCount = 0. Generated values will be 1, 2, 1, 2,
1, 2, and so on.
Example: Label = 1, LabelStep = 1, IfRecycleCount = 2, LabelRepeatCount = 1. Generated values will be 1, 1, 2, 2,
1, 1, 2, 2, 1, 1, 2, 2, and so on.
Type: u32
Default: 1
Range: 0 - 1048575
LabelList
A Tcl list of MPLS labels. To use this attribute, the IsRange attribute must be FALSE.
Type: u32
Default: 0
LabelRepeatCount
How many times to repeat the same MPLS Label before incrementing it. See Label for more information.
Type: u16
Default: 0
LabelResolver
Label resolver identifier.

Type: string
Default: default
LabelStep
MPLS label step value. See Label for more information.

Type: s32
Default: 1
StackBit
MPLS end-of-stack bit.

Type: u8
Default: 0
Range: 0 - 1
TTL
MPLS TTL value.

Type: u8
Default: 0
Range: 0 - 255
MplsIf Read-Only Attributes

Read-Only Attribute
Description
EffectiveBlockCount

Type: u32
Default: 1
IfState

Type: enum
Default: DISABLED
Possible Values:
Value
Description
READY
Ready.
DISABLED
Disabled.
DELETING
Deleting.
1674
MplsIpv4PrefixBindIfCreateCommand
Read-Only Attribute
Description
LabelResolveState
MPLS label resolve state.

Type: enum
Possible Values:
Value
Description
RESOLVE_DONE
Resolve is done.
RESOLVE_NEEDED
Resolve is needed.
RESOLVE_FAILED
Resolve failed.
RESOLVE_IN_PROGRESS
Description:
Create an MPLS interface with IPv4 prefix MPLS Binding information.

Parents: Sequencer
MplsIpv4PrefixBindIfCreateCommand Writable Attributes

Writable Attribute
Description
AddrIncrement

Type: u32
Default: 1
CreateClassId
Not used.
Type: classId
Default: 0
CreateCount
Not used.
Type: u32
Default: 1
LabelRepeatCount
Label Repeat Count.

Type: u16
Default: 0
NetworkCount
Number of IPv4 address.

Type: u32
Default: 1
ParentList
Not used.
Type: handle
Default: 0
PrefixLength
Prefix length.
Type: u8
Default: 24
Range: 1 - 32
Protocol
Protocol which resolved the MPLS Labels.

Type: handle
Default: 0
1675
MplsIpv4PrefixBindInfo
Writable Attribute
Description
StartIpAddr
Starting IPv4 address.

Type: ip
Default: 192.0.1.0
MplsIpv4PrefixBindIfCreateCommand Read-Only Attributes

Read-Only Attribute
Description
ReturnList
Handle of created MPLS interface.

Type: handle
Default: 0
Description:
Specifiy IPv4 Prefix information that need to resovled for MPLS traffic binding.

MplsIpv4PrefixBindInfo Writable Attributes

Writable Attribute
Description
Active, Name
AddrIncrement
IPv4 increment.
Type: u32
Default: 1
NetworkCount
Number of IPv4 addresses.

Type: u32
Default: 1
PrefixLength
Prefix length.
Type: u8
Default: 24
Range: 1 - 32
StartIpAddr

Type: ip
Default: 192.0.1.0
MplsIpv4PrefixBindInfo Read-Only Attributes

MplsIpv4VpnBindIfCreateCommand
Description:
Create an MPLS interface with RFC2547 MPLS Binding information.

1676
MplsIpv4VpnBindInfo

Parents: Sequencer
MplsIpv4VpnBindIfCreateCommand Writable Attributes

Writable Attribute
Description
AddrIncrement

Type: u32
Default: 1
CreateClassId
Not used.
Type: classId
Default: 0
CreateCount
Not used.
Type: u32
Default: 1
LabelRepeatCount
Label Repeat Count.

Type: u16
Default: 0
NetworkCount

Type: u32
Default: 1
ParentList
Not used.
Type: handle
Default: 0
PrefixLength
Prefix length.
Type: u8
Default: 24
Range: 1 - 32
Protocol

Type: handle
Default: 0
RouteDistinguisher
Route Distinguisher.
Type: string
Default: 100:1
StartIpAddr

Type: ip
Default: 192.0.1.0
MplsIpv4VpnBindIfCreateCommand Read-Only Attributes

Read-Only Attribute
Description
ReturnList

Type: handle
Default: 0
MplsIpv4VpnBindInfo
Description:
Specifiy RFC2547 information that need to resovled for MPLS traffic binding.
1677
MplsIpv4VpnCeToPeLink
MplsIpv4VpnBindInfo Writable Attributes

Writable Attribute
Description
Active, Name
AddrIncrement

Type: u32
Default: 1
NetworkCount

Type: u32
Default: 1
PrefixLength
Prefix length.
Type: u8
Default: 24
Range: 1 - 32
RouteDistinguisher
Type: string
Default: 100:1
StartIpAddr

Type: ip
Default: 192.0.1.0
MplsIpv4VpnBindInfo Read-Only Attributes

Description:
Link between Customer Edge (CE) and Provider Edge (PE) device of MPLS IP VPN. In most cases, VrfCustomerLink should be used instead.

Relations:
Side name
(Type)
Relative
Description
Container
(ContainedLink)

(LinkDst)
LinkDstDevice
(LinkDstDevice)
EmulatedDevice
NetworkLinkSource
(LinkSrc)
MplsIpv4VpnCeToPeLink Writable Attributes

Writable Attribute
Description
Active, Name
1678
MplsIpv4VpnCeToPeLink Read-Only Attributes

Read-Only Attribute
Description
LinkType
Name of Link Type.

Type: string
Description:
Create an MPLS interface with IPv6 prefix MPLS Binding information.

Parents: Sequencer
MplsIpv6PrefixBindIfCreateCommand Writable Attributes

Writable Attribute
Description
AddrIncrement

Type: u32
Default: 1
CreateClassId
Not used.
Type: classId
Default: 0
CreateCount
Not used.
Type: u32
Default: 1
LabelRepeatCount
Label Repeat Count.

Type: u16
Default: 0
NetworkCount

Type: u32
Default: 1
ParentList
Not used.
Type: handle
Default: 0
PrefixLength
Prefix length.
Type: u8
Default: 64
Range: 1 - 128
Protocol

Type: handle
Default: 0
StartIpv6Addr

Type: ipv6
Default: 2000::1
1679
MplsIpv6PrefixBindIfCreateCommand Read-Only Attributes

Read-Only Attribute
Description
ReturnList

Type: handle
Default: 0
Description:
Specifiy IPv6 Prefix information that need to resovled for MPLS traffic binding.

MplsIpv6PrefixBindInfo Writable Attributes

Writable Attribute
Description
Active, Name
AddrIncrement
IPv6 increment.
Type: u32
Default: 1
NetworkCount

Type: u32
Default: 1
PrefixLength
Prefix length.
Type: u8
Default: 64
Range: 1 - 128
StartIpv6Addr

Type: ipv6
Default: 2000::1
MplsIpv6PrefixBindInfo Read-Only Attributes

MplsIpv6VpnBindIfCreateCommand
Description:
Create an MPLS interface with 6VPE MPLS Binding information.

Parents: Sequencer
1680
MplsIpv6VpnBindInfo
MplsIpv6VpnBindIfCreateCommand Writable Attributes

Writable Attribute
Description
AddrIncrement

Type: u32
Default: 1
CreateClassId
Not used.
Type: classId
Default: 0
CreateCount
Not used.
Type: u32
Default: 1
LabelRepeatCount
Label Repeat Count.

Type: u16
Default: 0
NetworkCount

Type: u32
Default: 1
ParentList
Not used.
Type: handle
Default: 0
PrefixLength
Prefix length.
Type: u8
Default: 64
Range: 1 - 128
Protocol

Type: handle
Default: 0
RouteDistinguisher
Type: string
Default: 100:1
StartIpv6Addr

Type: ipv6
Default: 2000::1
MplsIpv6VpnBindIfCreateCommand Read-Only Attributes

Read-Only Attribute
Description
ReturnList

Type: handle
Default: 0
MplsIpv6VpnBindInfo
Description:
Specifiy 6VPE information that need to resovled for MPLS traffic binding.

1681
MplsIpv6VpnBindInfo Writable Attributes

Writable Attribute
Description
Active, Name
AddrIncrement

Type: u32
Default: 1
NetworkCount

Type: u32
Default: 1
PrefixLength
Prefix length.
Type: u8
Default: 64
Range: 1 - 128
RouteDistinguisher
Type: string
Default: 100:1
StartIpv6Addr

Type: ipv6
Default: 2000::1
MplsIpv6VpnBindInfo Read-Only Attributes

Description:
Link between Customer Edge (CE) and Provider Edge (PE) device of 6PE/6VPE. In most cases, VrfCustomerLink should be used instead.

Relations:
Side name
(Type)
Relative
Description
Container
(ContainedLink)

(LinkDst)
LinkDstDevice
(LinkDstDevice)
EmulatedDevice
NetworkLinkSource
(LinkSrc)
MplsIpv6VpnCeToPeLink Writable Attributes

Writable Attribute
Description
Active, Name
1682
MplsL2VpnPeToPLink
MplsIpv6VpnCeToPeLink Read-Only Attributes

Read-Only Attribute
Description
LinkType
Name of Link Type.

Type: string
MplsL2VpnPeToPLink
Description:
Link between Provider Edge (PE) and Provider (P) device of L2VPN. In most of cases, VrfProviderLink should be used instead.

Relations:
Side name
(Type)
Relative
Description
Container
(ContainedLink)

(LinkDst)
LinkDstDevice
(LinkDstDevice)
EmulatedDevice
NetworkLinkSource
(LinkSrc)
MplsL2VpnPeToPLink Writable Attributes

Writable Attribute
Description
Active, Name
MplsL2VpnPeToPLink Read-Only Attributes

Read-Only Attribute
Description
LinkType
Name of Link Type.

Type: string
MplsL3VpnPeToPLink
Description:
Link between Provider Edge (PE) and Provider (P) device of L3VPN. In most of the case, VrfProviderLink should be used instead.

Relations:
1683
MplsRsvpLabelLookUpEntry
Side name
(Type)
Relative
Description
Container
(ContainedLink)

(LinkDst)
LinkDstDevice
(LinkDstDevice)
EmulatedDevice
NetworkLinkSource
(LinkSrc)
MplsL3VpnPeToPLink Writable Attributes

Writable Attribute
Description
Active, Name
MplsL3VpnPeToPLink Read-Only Attributes

Read-Only Attribute
Description
LinkType
Name of Link Type.

Type: string
MplsRsvpLabelLookUpEntry
Description:
Specifiy RSVP Look up entry information that will be used for control plane packet look up.

MplsRsvpLabelLookUpEntry Writable Attributes

Writable Attribute
Description
Active, Name
DstIpv4Addr
Destination IP address.
Type: ip
Default: 192.85.2.1
LspId
LSP ID of RSVP tunnel will be used if control packet match the given source and destination IP address
given in SrcIpv4Addr and DstIpv4Addr.
Type: u16
Default: 1
Range: 1 - 20
SrcIpv4Addr
Source IP address.
Type: ip
Default: 192.85.1.1
1684
MplsRsvpTunnelBindIfCreateCommand
Writable Attribute
Description
TunnelId
Tunnel ID of RSVP tunnel will be used if control packet match the given source and destination IP address
given in SrcIpv4Addr and DstIpv4Addr.
Type: u16
Default: 0
MplsRsvpLabelLookUpEntry Read-Only Attributes

MplsRsvpTunnelBindIfCreateCommand
Description:
Create an MPLS interface with RSVP MPLS Binding information.

Parents: Sequencer
MplsRsvpTunnelBindIfCreateCommand Writable Attributes

Writable Attribute
Description
CreateClassId
Not used.
Type: classId
Default: 0
CreateCount
Not used.
Type: u32
Default: 1
LabelRepeatCount
Label Repeat Count.

Type: u16
Default: 0
LspIdCount
Number of LSP ID Count.

Type: u16
Default: 1
Range: 1 - 20
LspIdIncrement
LSP ID increment size.

Type: u16
Default: 1
Range: 0 - 20
MakeBeforeBreak
Enable/Disable Make Before Break.

Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
Enable Make Before Break. Only tunnel ID will be used for MPLS binding. The first available
LSP will be picked internally.
FALSE Disable Make Before Break. Tunnel ID and LSP ID will be used for MPLS binding.
ParentList
Not used.
Type: handle
Default: 0
1685
MplsRsvpTunnelBindInfo
Writable Attribute
Description
Protocol

Type: handle
Default: 0
StartLspId
Start LSP ID.

Type: u16
Default: 1
Range: 1 - 20
TunnelId
RSVP Tunnel ID.

Type: u16
Default: 0
TunnelIdCount
Number of Tunnel ID.

Type: u16
Default: 1
Range: 1 - 65535
TunnelIdIncrement
Tunnel ID increment size.

Type: u16
Default: 1
MplsRsvpTunnelBindIfCreateCommand Read-Only Attributes

Read-Only Attribute
Description
ReturnList

Type: handle
Default: 0
MplsRsvpTunnelBindInfo
Description:
Specifiy RSVP Tunnel information that need to resovled for MPLS traffic binding.

MplsRsvpTunnelBindInfo Writable Attributes

Writable Attribute
Description
Active, Name
LspIdCount
Number of RSVP LSP.

Type: u16
Default: 1
Range: 1 - 20
LspIdIncrement
RSVP LSP ID increment.

Type: u16
Default: 1
Range: 0 - 20
1686
MplsStaticBindIfCreateCommand
Writable Attribute
Description
MakeBeforeBreak
Enable or disable Make Before Break.

Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
Enable Make Before Break. Only tunnel ID will be used for MPLS binding. The first avaible LSP
will be picked internally.
FALSE Disable Make Before Break. Tunnel ID and LSP ID will be used for MPLS binding.
StartLspId
Start RSVP LSP ID.

Type: u16
Default: 1
Range: 1 - 20
TunnelId
Start RSVP Tunnel ID.

Type: u16
Default: 0
TunnelIdCount
Number of RSVP tunnel.

Type: u16
Default: 1
Range: 1 - 65535
TunnelIdIncrement
RSVP Tunnel ID increment.

Type: u16
Default: 1
MplsRsvpTunnelBindInfo Read-Only Attributes

MplsStaticBindIfCreateCommand
Description:
Create an MPLS interface with static label information.

Parents: Sequencer
MplsStaticBindIfCreateCommand Writable Attributes

Writable Attribute
Description
CreateClassId
Not used.
Type: classId
Default: 0
CreateCount
Not used.
Type: u32
Default: 1
1687
MplsVcBindIfCreateCommand
Writable Attribute
Description
IsRange
Whether to use a combination of attributes to generate a range of labels (StartLabel, LabelStep, LabelCount),
or to use the LabelList attribute to specify the labels.
Type: bool
Default: TRUE
Possible Values:
Value Description
TRUE
Use a combination of attributes (StartLabel, LabelStep, LabelCount) to generate a range of labels.
FALSE Use the LabelList attribute to specify the labels.

LabelCount
Label count.
Type: u32
Default: 1
Range: 1 - 1048575
LabelList
A Tcl list of label value. To use this attribute, the IsRange attribute must be FALSE.
Type: u32
Default: 0
Range: 0 - 1048575
LabelRepeatCount
Static Label Repeat Count.

Type: u16
Default: 0
LabelStep
Label Step value.

Type: s32
Default: 1
ParentList
Not used.
Type: handle
Default: 0
Router
Specify the router that owns the MPLS interface.

Type: handle
Default: 0
StartLabel
Starting Label value.

Type: u32
Default: 16
Range: 0 - 1048575
MplsStaticBindIfCreateCommand Read-Only Attributes

Read-Only Attribute
Description
ReturnList

Type: handle
Default: 0
Description:
Create an MPLS interface with Martini/VPLS MPLS Binding information.

Parents: Sequencer
1688
MplsVcBindIfCreateCommand Writable Attributes

Writable Attribute
Description
ControlWordEnabled
Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
FALSE
CreateClassId
Not used.
Type: classId
Default: 0
CreateCount
Not used.
Type: u32
Default: 1
FlowLabelEnabled
Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
FALSE
LabelRepeatCount
Label Repeat Count.

Type: u16
Default: 0
ParentList
Not used.
Type: handle
Default: 0
Protocol

Type: handle
Default: 0
StartVcId
Start Virtual Circuit (VC) ID.

Type: u32
Default: 1
VcIdCount
Virtual Circuit (VC) Count.

Type: u32
Default: 1
Range: 1 - 65535
VcIdIncrement
Virtual Circuit (VC) ID increment.

Type: u32
Default: 1
MplsVcBindIfCreateCommand Read-Only Attributes

Read-Only Attribute
Description
ReturnList

Type: handle
Default: 0
1689
MplsVcBindInfo
MplsVcBindInfo
Description:
Specifiy Martini/VPLS VC information that need to resovled for MPLS traffic binding.

MplsVcBindInfo Writable Attributes

Writable Attribute
Description
Active, Name
ControlWordEnabled
Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
FALSE
FlowLabelEnabled
Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
FALSE
StartVcId
Starting Virtual Cirtuit (VC) ID.

Type: u32
Default: 1
VcIdCount
Virtual Cirtuit (VC) Count.

Type: u32
Default: 1
Range: 1 - 65535
VcIdIncrement
Virtual Cirtuit (VC) ID increment.

Type: u32
Default: 1
MplsVcBindInfo Read-Only Attributes

MplsVplsBindIfCreateCommand
Description:
Create an MPLS interface with BGP VPLS MPLS Binding information.

Parents: Sequencer
1690
MplsVplsBindIfCreateCommand
MplsVplsBindIfCreateCommand Writable Attributes

Writable Attribute
Description
CreateClassId
Not used.
Type: classId
Default: 0
CreateCount
Not used.
Type: u32
Default: 1
FarEndVeId
Far End VPLS Edge (VE) ID.

Type: u16
Default: 0
FarEndVeIdStep
Far End VPLS Edge (VE) ID step size.

Type: u16
Default: 1
LabelRepeatCount
Label Repeat Count.

Type: u16
Default: 0
NearEndVeId
Near End VPLS Edge (VE) ID.

Type: u16
Default: 0
NearEndVeIdStep
Near End VPLS Edge (VE) ID step size.

Type: u16
Default: 1
ParentList
Not used.
Type: handle
Default: 0
Protocol

Type: handle
Default: 0
RouteDistinguisher
Type: string
Default: 100:1
Route Distinguisher step size.

Type: string
Default: 0:1
RouteTarget

Route Target.
Type: string
Default: 100:1
VplsBlockCount
VPLS Block Size.

Type: u32
Default: 1
MplsVplsBindIfCreateCommand Read-Only Attributes

Read-Only Attribute
Description
ReturnList

Type: handle
Default: 0
1691
MplsVplsBindInfo
MplsVplsBindInfo
Description:
Specifiy BGP VPLS information that need to resovled for MPLS traffic binding.

MplsVplsBindInfo Writable Attributes

Writable Attribute
Description
Active, Name
FarEndVeId
Far End VPLS Edge (VE) ID.

Type: u16
Default: 0
FarEndVeIdStep
Far End VPLS Edge (VE) ID step.

Type: u16
Default: 1
NearEndVeId
Near End VPLS Edge (VE) ID.

Type: u16
Default: 0
NearEndVeIdStep
Near End VPLS Edge (VE) ID step.

Type: u16
Default: 0
RouteDistinguisher
Type: string
Default: 100:1
Route Distinguisher step.

Type: string
Default: 0:1
RouteTarget

Route Target.
Type: string
Default: 100:1
VplsBlockCount
VPLS VPN block count.

Type: u32
Default: 1
MplsVplsBindInfo Read-Only Attributes

MReq (fcsw:MReq)
Description:
Children: payload
1692
MReqAcc
MReq Attributes
Attribute
Description
command
Type: OCTETSTRING
Default: 22
Name
Type: string
protocolVersion
Type: OCTETSTRING
Default: 00
MReqAcc (fcsw:MReqAcc)
Description:
Children: None
MReqAcc Attributes
Attribute
Description
command
Type: OCTETSTRING
Default: 02000000
Name
Type: string
obsolete1
Type: OCTETSTRING
Default: 00
obsolete2
Type: OCTETSTRING
Default: 00
obsolete3
Type: OCTETSTRING
Default: 00
reserved
Type: OCTETSTRING
Default: 00
MRPayloadChoice
Description:
Parents: payload
Children: basicZoning, enhancedZoning
1693
MRPayloadChoice
MRPayloadChoice Attributes
Attribute
Description
Name
information.
Type: string
MRPayloadChoice
Description:
Parents: payload
Children: basicZoning, enhancedZoning
MRPayloadChoice Attributes
Attribute
Description
Name
information.
Type: string
Msg
Description:
Parents: Msgs
Children: None
Msg Attributes
Attribute
Description
Name
more information.
Type: string
Type
Type: INTEGER
Default: 0
Version
Type: OCTETSTRING
Default: 0
Msgs
Description:
Parents: MsgTypeArrayTLV
1694
MsgTypeArrayTLV
Children: Msg
Msgs Attributes
Attribute
Description
Name
information.
Type: string
MsgTypeArrayTLV (VICTLV:MsgTypeArrayTLV)
Description:
Children: Msgs
VICTLV:CustomTLV
MsgTypeArrayTLV Attributes
Attribute
Description
Length
Type: INTEGER
Default: 0
Name
more information.
Type: string
Type
Type: INTEGER
Default: 13
MstiConfig
Description:
MSTI configuration parameters.

Parents: BridgePortConfig, MstpBridgePortConfig
Automatically-created children: VlanBlock
Result children (automatically created): BridgePortResults, MstiResults
Relations:
Side name
(Type)
Relative
Description
ResultChild
(ResultChild)
BridgePortResults, MstiResults
1695
MstiConfig
MstiConfig Writable Attributes

Writable Attribute
Description
Active, Name
BridgePriority
Specifies the priority for the bridge. A low numerical value indicates a high bridge priority. The algorithm uses this
value during the root bridge election process. The bridge with the highest bridge priority value is elected as the
root bridge or the network.
Type: u16
Default: 32768
Range: 0 - 65535
CistInternalRootPathCost
CIST internal root path cost - only for MSTP. Specifies the cost to reach the root bridge. This value is used by the
DUT to determine which port is the primary path to the root bridge.
Type: u32
Default: 0
Range: 0 - 200000000
CistRegionalRootMacAddr
MAC address of the regional CIST root bridge - only for MSTP.
Type: mac
Default: 00-00-10-00-10-00
CistRegionalRootPriority
Bridge priority for the root bridge of the region - only for MSTP. The root priority value is used to determine which
bridge is elected as root.
Type: u16
Default: 32768
Range: 0 - 65535
PortPriority
Priority for the port on the bridge - first component of the port ID. Specifies the priority for the port. A low numerical
value indicates a high port priority. The algorithm uses this value to elect the root port. The port with the highest
port priority value is elected root port.
Type: u16
Default: 128
Range: 0 - 255
RegionRootBridge
Specifies the initial regional root bridge on the bridge port.

Type: enum
Default: 0
Possible Values:
Value
Description
SELF

RemainingHops
MSTP remaining hops.

Type: u8
Default: 16
Range: 1 - 255
MstiConfig Read-Only Attributes

Read-Only Attribute
Description
InstanceNum
MSTP instance number.

Type: u16
Default: 0
RegionElectedRoot
Region Elected Root Bridge.

Type: string
Default: NA
1696
MstiResults
MstiResults
Description:
MSTI results.

Parents: MstiConfig
Relations:
Side name
(Type)
Relative
Description
ResultParent
(ResultChild)
MstiConfig
MstiResults Writable Attributes

MstiResults Read-Only Attributes

Read-Only Attribute
Description
BridgeId

Type: string
Default: 80-00-00-00-10-00-10-00
DesignatedId

Type: string
Default: NA
InstanceNum

Type: u16
Default: 0
PortId

Type: string
Default: 0x8001
RegionalRootId

Type: string
Default: NA
RootId
Type: string
Default: NA
RxAgree
Type: u32
Default: 0
RxBpduFlag

Type: string
Default: 0x00
RxBpdus

Type: u32
Default: 0
RxPortRole
Receive port role. Reported states are disabled, alternate port, backup port, root port, and designated port.
Type: string
Default: NA
RxPortState
Receive port state. Reported states are listening, discarding, learning, and forwarding.
Type: string
Default: NA
1697
MstpBridgePortConfig
Read-Only Attribute
Description
RxProposals
state.
Type: u64
Default: 0
RxTcAck
Type: u32
Default: 0
RxTcBitSet

Type: u32
Default: 0
RxTcn

Type: u64
Default: 0
TxAgree
Type: u32
Default: 0
TxBpduFlag

Type: string
Default: 0x00
TxBpdus

Type: u32
Default: 0
TxPortRole
Transmit port role. Reported states are disabled, alternate port, backup port, root port, and designated port.
Type: string
Default: NA
TxPortState
Transmit port state. Reported states are listening, discarding, learning, and forwarding.
Type: string
Default: NA
TxProposals
Type: u64
Default: 0
TxTcAck
Type: u32
Default: 0
TxTcBitSet

Type: u32
Default: 0
TxTcn

Type: u64
Default: 0
VlanId

Type: string
Default: NA
MstpBridgePortConfig
Description:
Object containing MSTP-specific protocol parameters.
1698
MstpRegionConfig

Parents: BridgePortConfig
Children: MstiConfig
MstpBridgePortConfig Writable Attributes

Writable Attribute
Description
Active, Name
CIST internal root path cost - only for MSTP. Specifies the cost to reach the root bridge. This value is used
by the DUT to determine which port is the primary path to the root bridge.
Type: u32
Default: 0
Range: 0 - 200000000
MAC address of the regional CIST root bridge - only for MSTP. Specifies the MAC address of the root bridge
- the second component of the root bridge ID.
Type: mac
Default: 00-00-10-00-10-00
Bridge priority for the root bridge of the region - only for the MSTP. The root priority value is used to determine
which bridge is elected as root.
Type: u16
Default: 32768
Range: 0 - 65535
RegionRootBridge
Specifies the initial root bridge on the bridge port.

Type: enum
Default: 0
Possible Values:
Value
Description
SELF

RemainingHops
MSTP remaining hops.

Type: u8
Default: 16
Range: 1 - 255
MstpBridgePortConfig Read-Only Attributes

Read-Only Attribute
Description
InstanceNum
MSTP instance number.

Type: u16
Default: 0
RegionElectedRoot
Region Elected Root Bridge.

Type: string
Default: NA
MstpRegionConfig
Description:
MstpRegion configuration object.

Parents: Project
Relations:
1699
MTU
Side name
(Type)
Relative
Description
MemberPorts
(MemberOf)
StpPortConfig
Sets automatically when SetMstpRegionCommand is used to

configure region.
MstpRegionConfig Writable Attributes

Writable Attribute
Description
Active, Name
InstanceNumList
List of MSTI instance numbers.

Type: u16
Default: 0
InstanceVlanList
Comma-separated VLAN IDs. Use "-" to specify a range of IDs.

Example: 4,13,67,190-299
Type: string
Default: 0
MstInstanceCount
Number of MSTIs on each port in the region.

Type: u16
Default: 0
Range: 0 - 64
RegionName
Region name that the instance belongs to.

Type: string
Default: Region1
VersionNum
Version number.
Type: u16
Default: 1
Range: 0 - 65535
MstpRegionConfig Read-Only Attributes

MTU
Description:
ICMPv6 Maximum Transmission Unit
Parents: mtuOption
Children: None
MTU Attributes
Attribute
Description
length
Type: INTEGER
Default: 1
mtu
Type: INTEGER
Default: 1000
Name
more information.
Type: string
1700
mtuOption
Attribute
Description
reserved
Type: INTEGER
Default: 0
type
Type: NdOptionType
Default: 5
Possible Values:
Value Description
1
Prefix Information
Redirected Header
MTU
mtuOption
Description:
Used in ICMPv6 as a parent for MTU objects
Parents: RouterAdvertisement
Children: MTU
mtuOption Attributes
Attribute
Description
Name
information.
Type: string
mtuProbe
Description:
Children: None
mtuProbe Attributes
Attribute
Description
length
Type: INTEGER
Default: 4
mtu
Type: INTEGER
Default: 0
Name
Type: string
1701
MulticastDeviceGenProtocolParams
Attribute
Description
type
Default: 11
Possible Values:
Value Description
0
End of Options List
NOP
130
Security
131
Loose Source Route
68
Time Stamp
133
Extended Security
Record Route
136
Stream Identifier
137
Strict Source Route
11
MTU Probe
12
MTU Reply
82
Traceroute
147
Address Extension
148
Router Alert
149
Description:
Specifies multicast host/router generator parameters.
Note: When this object is used with the router generator, IGMP/MLD queriers are created and only the Version parameter is used.

Relations:
Side name
(Type)
Relative
Description
MulticastSource
(SubscribedSources)
EmulatedDevice
Sources to subscribe to for multicast traffic.
MulticastDeviceGenProtocolParams Writable Attributes

Writable Attribute
Description
Active, Name
DeviceGroupMapping
Type: enum
Possible Values:
Value
Description
ONE_TO_ONE
Assigns one device to each group. The mapping stops when it reaches the end of either devices
or groups. The extra devices or groups are not mapped.
1702
Writable Attribute
Description
FilteredSources
Mode for specifying filtered sources.

Type: enum
Default: NONE
Possible Values:
Value
Description
EXISTING Use existing sources (Hosts).
CUSTOM Specify sources by entering starting source IP, count, and step.
NONE
FilterMode
Specifies an empty source list.
Specifies an explicit set of sources from which the multicast group is interested in receiving data.
Type: enum
Default: EXCLUDE
Possible Values:
Value
Description
INCLUDE Data from the specified sources are filtered and forwarded to the hosts by the multicast router.
EXCLUDE Data from the specified sources are filtered and not forwarded to the hosts by the multicast router.
IgnoreMemberships
IGMP/MLD Host-only creation from wizard. Skip configuration of group memberships.

Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
Specifies that IGMP/MLD hosts will be created without memberships.
FALSE Specifies that IGMP/MLD hosts will be created with memberships.

McastGroupCount
Number of multicast groups to subscribe to.

Type: u32
Default: 1
Range: 1 - 32000
McastIpv4Addr
IPv4 multicast group address.

Type: ip
Default: 225.0.0.1
McastIpv4AddrPortStep
Step to apply to the IPv4 multicast group for each subsequent port.
Type: ip
Default: 0.0.0.0
McastIpv6Addr

Type: ipv6
Default: ff1e::1
Type: ipv6
Default: ::0
SrcCount
Number of multicast sources.

Type: u32
Default: 1
Range: 1 - 4294967295
SrcIpv4Addr
Multicast source IPv4 address.

Type: ip
Default: 1.0.0.2
SrcIpv4Prefix
Multicast source IPv4 prefix length.

Type: u8
Default: 24
Range: 1 - 32
SrcIpv6Addr

Type: ipv6
Default: 2001::2
1703
MulticastGroupCountCommand
Writable Attribute
Description
SrcIpv6Prefix

Type: u8
Default: 64
Range: 1 - 128
SrcStep
Step for the multicast source address.

Type: u32
Default: 1
Range: 0 - 4294967295
Version

Type: enum
Default: IGMP_V2
Possible Values:
Value
Description
MLD_V1
MLD_V2
IGMPv3.
MulticastDeviceGenProtocolParams Read-Only Attributes

MulticastGroupCountCommand
Description:
Base class for all multicast group count manipulating commands.

MulticastGroupCountCommand Writable Attributes

Writable Attribute
Description
DistributionType

Type: enum
Default: EVEN
Possible Values:
Value
Description
EVEN

MulticastGroupList
List of handles of multicast groups.

Type: handle
Default: 0
1704
MulticastHostGenProtocolParams
MulticastGroupCountCommand Read-Only Attributes

Read-Only Attribute
Description

TestStatus
Test status.
Type: string
Description:
Multicast Host generator parameters.

Relations:
Side name
(Type)
Relative
Description
MulticastSource
(SubscribedSources)
EmulatedDevice
Sources to subscribe to for multicast traffic.
MulticastHostGenProtocolParams Writable Attributes

Writable Attribute
Description
Active, Name
DeviceGroupMapping
Type: enum
Possible Values:
Value
Description
ONE_TO_ONE
FilteredSources
Assigns one device to each group. The mapping stops when it reaches the end of either devices
or groups. The extra devices or groups are not mapped.
Mode for specifying filtered sources.

Type: enum
Default: NONE
Possible Values:
Value
Description
EXISTING Use existing sources (Hosts).
CUSTOM Specify sources by entering starting source IP, count, and step.
NONE
FilterMode
Specifies an empty source list.
Specifies an explicit set of sources from which the multicast group is interested in receiving data.
Type: enum
Default: EXCLUDE
Possible Values:
Value
Description
INCLUDE Data from the specified sources are filtered and forwarded to the hosts by the multicast router.
EXCLUDE Data from the specified sources are filtered and not forwarded to the hosts by the multicast router.
1705
Writable Attribute
Description
IgnoreMemberships
IGMP/MLD Host-only creation from wizard. Skip configuration of group memberships.

Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
Specifies that IGMP/MLD hosts will be created without memberships.
FALSE Specifies that IGMP/MLD hosts will be created with memberships.

McastGroupCount
Number of multicast groups to subscribe to.

Type: u32
Default: 1
Range: 1 - 32000
McastIpv4Addr

Type: ip
Default: 225.0.0.1
Type: ip
Default: 0.0.0.0
McastIpv6Addr

Type: ipv6
Default: ff1e::1
Type: ipv6
Default: ::0
SrcCount
Number of multicast sources.

Type: u32
Default: 1
Range: 1 - 4294967295
SrcIpv4Addr

Type: ip
Default: 1.0.0.2
SrcIpv4Prefix

Type: u8
Default: 24
Range: 1 - 32
SrcIpv6Addr

Type: ipv6
Default: 2001::2
SrcIpv6Prefix

Type: u8
Default: 64
Range: 1 - 128
SrcStep
Step for the multicast source address.

Type: u32
Default: 1
Range: 0 - 4294967295
1706
multicastIDs
Writable Attribute
Description
Version

Type: enum
Default: IGMP_V2
Possible Values:
Value
Description
MLD_V1
MLD_V2
IGMPv3.
MulticastHostGenProtocolParams Read-Only Attributes

multicastIDs (overloaded)
multicastIDs (fc)
multicastIDs (fcsw)
multicastIDs Object (fc PDU library)

Description:
Parents: efpRequest (StreamBlock.FCoE.fc.fcPayloads.FCPayload-Choice.efpRequest)

Children: EfpMulticastIdRecord
multicastIDs Attributes
Attribute
Description
Name
information.
Type: string
multicastIDs Object (fcsw PDU library)

Description:
1707
MulticastRouterGenProtocolParams
Parents: efpRequest (StreamBlock.EfpReq)

Children: EfpMulticastIdRecord
multicastIDs Attributes
Attribute
Description
Name
information.
Type: string
MulticastRouterGenProtocolParams
Description:
Specifies multicast Querier generator parameters.

MulticastRouterGenProtocolParams Writable Attributes

Writable Attribute
Description
Active, Name
Version
Selects the multicast protocol used by the querier.

Type: enum
Default: IGMP_V2
Possible Values:
Value
Description
MLD_V1
MLD_V2
MulticastRouterGenProtocolParams Read-Only Attributes

MultiSegmentLeftSitePortParams
Description:
Port parameters used by left site ports of multisegment topology.
1708
MultiSegmentRightSitePortParams
Parents: VpnMartiniGenParams
Relations:
Side name
(Type)
Relative
Description
Port
(PortRelation)
Port
Port
MultiSegmentLeftSitePortParams Writable Attributes

MultiSegmentLeftSitePortParams Read-Only Attributes

MultiSegmentRightSitePortParams
Description:
Port parameters used by right site ports of multisegment topology.

Parents: VpnMartiniGenParams
Relations:
Side name
(Type)
Relative
Description
Port
(PortRelation)
Port
Port
MultiSegmentRightSitePortParams Writable Attributes

MultiSegmentRightSitePortParams Read-Only Attributes

MvpnGenCorePortParams
Description:
MVPN core port details.

Parents: MvpnGenParams
Relations:
Side name
(Type)
Relative
Description
Port
(PortRelation)
Port
MVPN core port.
1709
MvpnGenCustPortParams
MvpnGenCorePortParams Writable Attributes

MvpnGenCorePortParams Read-Only Attributes

MvpnGenCustPortParams
Description:
MVPN customer port details.

Parents: MvpnGenParams
Relations:
Side name
(Type)
Relative
Description
Port
(PortRelation)
Port
MVPN customer port details.
MvpnGenCustPortParams Writable Attributes

MvpnGenCustPortParams Read-Only Attributes

MvpnGenParams
Description:
Main wizard object for creating a VPN configuration.

Children: MvpnGenCorePortParams, MvpnGenCustPortParams, VpnLspPingGenIpv4CoreParams, VpnLspPingGenIpv4VpnParams
Automatically-created children: VpnIgpIsisSessionParams, VpnIgpOspfv2SessionParams, VpnMplsLdpSessionParams, VpnMplsRsvpSessionParams
MvpnGenParams Writable Attributes

Writable Attribute
Description
CoreCeBgp4ByteAs
Core CE BGP 4-byte AS.

Type: string
Default: 1:1
CoreCeBgp4ByteAsEnable
Core CE BGP 4-byte AS enable.

Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
Enable core CE BGP 4-byte AS.
FALSE Disable core CE BGP 4-byte AS.
1710
MvpnGenParams
Writable Attribute
Description
CoreCeBgp4ByteAsStepPerCe
Core CE BGP 4-byte AS step per CE.

Type: u32
Default: 1
Range: 0 - 65535
CoreCeBgp4ByteAsStepPerCeEnable
Enable core CE BGP 4-byte AS step per CE.

Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
Enable core CE BGP 4-byte AS step per CE.
FALSE Disable core CE BGP 4-byte AS step per CE when true.

CoreCeBgp4ByteAsStepPerVpn
Core CE BGP 4-byte AS step per VPN.

Type: u32
Default: 1
Range: 0 - 65535
CoreCeBgp4ByteAsStepPerVpnEnable
Enable core CE BGP 4-byte AS step per VPN.

Type: bool
Default: TRUE
Possible Values:
Value Description
TRUE
Enable core CE BGP 4-byte AS step per VPN.
FALSE Disable core CE BGP 4-byte AS step per VPN.

CoreCeBgpAs
Core CE BGP AS.

Type: u16
Default: 1
Range: 1 - 65535
CoreCeBgpAsEnable
Enable core CE BGP AS.

Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
Enable core CE BGP AS.
FALSE Disable core CE BGP AS.

CoreCeBgpAsStepPerCe
Core CE BGP AS step per CE.

Type: u16
Default: 1
Range: 0 - 65535
CoreCeBgpAsStepPerCeEnable
Enable core CE BGP AS step per CE.

Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
Enable core CE BGP AS step per CE.
FALSE Disable core CE BGP AS step per CE.

CoreCeBgpAsStepPerVpn
Core CE BGP AS step per VPN.

Type: u16
Default: 1
Range: 0 - 65535
1711
MvpnGenParams
Writable Attribute
Description
CoreCeBgpAsStepPerVpnEnable
Enable core CE BGP AS step per VPN.

Type: bool
Default: TRUE
Possible Values:
Value Description
TRUE
Enable core CE BGP AS step per VPN.
FALSE Disable core CE BGP AS step per VPN.

CoreEnableBfdForBgp
Enable BFD for BGP.

Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
Enable BFD for BGP.
FALSE Disable BFD for BGP.

CoreIgpProtocol
Core IGP protocol.

Type: enum
Default: OSPF
Possible Values:
Value Description
OSPF OSPF
CoreLdpHelloType
ISIS
ISIS
RIP
RIP
Core LDP Hello type.

Type: enum
Default: DIRECTED
Possible Values:
Value
Description
DIRECTED DIRECTED
TARGETED TARGETED
CoreMplsProtocol
Core MPLS protocol.

Type: enum
Default: LDP
Possible Values:
Value Description
NONE NONE
LDP
LDP
RSVP RSVP
CorePeLoopbackIpAddr
Core PE loopback IP address.

Type: ip
Default: 10.0.0.2
CorePeLoopbackIpAddrStep
Core PE loopback IP address step.

Type: ip
Default: 0.0.0.1
CorePEnable
Core P router enable.

Type: bool
Default: TRUE
Possible Values:
Value Description
TRUE
Enable core p router.
FALSE Disable core P router.
1712
MvpnGenParams
Writable Attribute
Description
CorePePerSubIf
Core PE routers per sub-interface.

Type: u16
Default: 1
Range: 1 - 65535
CorePeVpnAll
Core PE uses all VPNs.

Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
Core PE uses all VPNs.
FALSE Core PE uses does not use all VPNs.

CorePeVpnAssignment

Core PE VPN assignment.
Type: enum
Default: VPNS_PER_PE
Possible Values:
Value
Description
VPNS_PER_PE VPNS_PER_PE
PES_PER_VPN PES_PER_VPN
CorePeVpnCount

Core PEs per VPN or VPNs per PE count.
Type: u16
Default: 1
Range: 1 - 65535
CorePIfIpAddr
Core P loopback IP address step.

Type: ip
Default: 1.0.0.1
CorePIfPrefixLength
Prefix length.
Type: u8
Default: 24
Range: 1 - 30
CorePLoopbackIpAddr
Core P loopback IP address.

Type: ip
Default: 192.0.1.1
CorePLoopbackIpAddrStep
Core P loopback IP address step.

Type: ip
Default: 0.0.1.0
CorePPerSubIf
Core P routers per sub-interface.

Type: u16
Default: 1
Range: 1 - 65535
CorePRsvpBandwidthPerLink
Bandwidth per link (bytes per second).

Type: u32
Default: 100000
Range: 1 - 2147483647
CorePRsvpBandwidthPerTunnel
Bandwidth per tunnel (bytes per second).

Type: u32
Default: 0
Range: 0 - 2147483647
1713
MvpnGenParams
Writable Attribute
Description
CorePTopologyType
Core P router topology.

Type: enum
Default: TREE
Possible Values:
Value Description
TREE TREE
GRID GRID
CoreRouteDistinguisher
Core route distinguisher.

Type: string
Default: 1:0
CoreRouteDistinguisherStepPerCe
Core route distinguisher step per CE.

Type: string
Default: 0:0
CoreRouteDistinguisherStepPerCeEnable
Enable core route distinguisher step per CE.

Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
Enable core route distinguisher step per CE.
FALSE Disable core route distinguisher step per CE.

CoreRouteDistinguisherStepPerVpn
Core route distinguisher step per VPN.

Type: string
Default: 1:0
CoreRouteDistinguisherStepPerVpnEnable
Enable core route distinguisher step per VPN.

Type: bool
Default: TRUE
Possible Values:
Value Description
TRUE
Enable core route distinguisher step per VPN.
FALSE Disable core route distinguisher step per VPN.

CoreRouteReflectorClusterId
Core route reflector cluster ID.

Type: ip
Default: 0.0.0.0
CoreRouteReflectorClusterIdStep
Core route reflector cluster ID step.

Type: ip
Default: 0.0.0.1
CoreRouteReflectorEnable
Core route reflector enable.

Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
Enable core route reflector.
FALSE Disable core route reflector.

CoreRouteReflectorLoopbackIpAddr
Core route reflector loopback IP address.

Type: ip
Default: 7.7.7.7
CoreRouteReflectorLoopbackIpAddrStep
Core route reflector loopback IP address step.

Type: ip
Default: 0.0.0.1
1714
MvpnGenParams
Writable Attribute
Description
CoreRouteReflectorPerPe
Core route reflectors per PE.

Type: u16
Default: 1
Range: 1 - 65535
CoreRouteReflectorPerSubIf
Core route reflectors per sub-interface.

Type: u16
Default: 1
Range: 1 - 65535
CoreRoutesPerCe
Core routes per CE.

Type: u32
Default: 1
Range: 1 - 2147483647
CreateUnusedVpnHostsCorePorts
Whether to create hosts for unused core VPN sites.

Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
Create hosts for unused core VPN sites.
FALSE Do not create hosts for unused core VPN sites.

CustCeBgp4ByteAs
Customer CE BGP 4-byte AS.

Type: string
Default: 1:1
CustCeBgp4ByteAsEnable
Enable customer CE BGP 4-byte AS.

Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
Enable customer CE BGP 4-byte AS.
FALSE Disable customer CE BGP 4-byte AS.

CustCeBgp4ByteAsStepPerCe
Customer CE BGP 4-byte AS step per CE.

Type: u32
Default: 1
Range: 0 - 65535
CustCeBgp4ByteAsStepPerCeEnable
Enable customer CE BGP 4-byte AS step per CE.

Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
Enable customer CE BGP 4-byte AS step per CE.
FALSE Enable customer CE BGP 4-byte AS step per CE.

CustCeBgp4ByteAsStepPerVpn
Customer CE BGP 4-byte AS step per VPN.

Type: u32
Default: 1
Range: 0 - 65535
CustCeBgp4ByteAsStepPerVpnEnable
Enable customer CE BGP 4-byte AS step per VPN.

Type: bool
Default: TRUE
Possible Values:
Value Description
TRUE
Enable customer CE BGP 4-byte AS step per VPN.
FALSE Enable customer CE BGP 4-byte AS step per VPN.
1715
MvpnGenParams
Writable Attribute
Description
CustCeBgpAs
Customer CE BGP AS.

Type: u16
Default: 1
Range: 1 - 65535
CustCeBgpAsStep

Customer CE BGP AS step.
Type: u16
Default: 1
Range: 0 - 65535
CustCeBgpAsStepPerCe
Customer CE BGP AS step per CE.

Type: u16
Default: 1
Range: 0 - 65535
CustCeBgpAsStepPerCeEnable
Enable customer CE BGP AS step per CE.

Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
Enable customer CE BGP AS step per CE.
FALSE Disable customer CE BGP AS step per CE.

CustCeBgpAsStepPerVpn
Customer CE BGP AS step per VPN.

Type: u16
Default: 1
Range: 0 - 65535
CustCeBgpAsStepPerVpnEnable
Enable customer CE BGP AS step per VPN.

Type: bool
Default: TRUE
Possible Values:
Value Description
TRUE
Enable customer CE BGP AS step per VPN.
FALSE Disable customer CE BGP AS step per VPN.

CustCeBgpPercent
Customer CE BGP percent.

Type: double
Default: 0
Range: 0 - 100
CustCeIsisPercent
Customer CE IS-IS percent.

Type: double
Default: 0
Range: 0 - 100
CustCeOspfPercent
Customer CE OSPF percent.

Type: double
Default: 0
Range: 0 - 100
CustCeRipPercent
Customer CE RIP percent.

Type: double
Default: 0
Range: 0 - 100
CustCeRouteType
Customer CE route type.

Type: enum
Default: INTERNAL
Possible Values:
Value
Description
INTERNAL INTERNAL
EXTERNAL EXTERNAL
1716
MvpnGenParams
Writable Attribute
Description
CustCeRoutingProtocol
Customer CE routing protocol.

Type: enum
Default: 0
Possible Values:
Value
Description
BGP
BGP
RIP
RIP
OSPF
OSPF
ISIS
ISIS
STATIC_ROUTES STATIC_ROUTES
MIXED
MIXED
CustCeStaticRoutePercent
Customer CE static route percent.

Type: double
Default: 0
Range: 0 - 100
CustCeVpnAssignment
Customer CE VPN assignment.

Type: enum
Default: ROUND_ROBIN
Possible Values:
Value
Description
ROUND_ROBIN ROUND_ROBIN
SEQUENTIAL
CustomerPimProtocol
SEQUENTIAL
Customer PIM protocol.

Type: enum
Default: SM
Possible Values:
Value Description
SM
PIM-SM
SSM
PIM-SSM
CustomerRpAddress
Customer RP address.
Type: ip
Default: 192.0.2.0
CustomerRpIncrement
Customer RP increment.
Type: ip
Default: 0.0.0.1
CustRouteDistinguisher
Customer route distinguisher.

Type: string
Default: 1:0
CustRouteDistinguisherStepPerCe
Customer route distinguisher step per CE.

Type: string
Default: 0:0
CustRouteDistinguisherStepPerCeEnable
Enable customer route distinguisher step per CE.

Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
Enable customer route distinguisher step per CE.
FALSE Disable customer route distinguisher step per CE.

CustRouteDistinguisherStepPerVpn
Customer route distinguisher step per VPN.

Type: string
Default: 1:0
1717
MvpnGenParams
Writable Attribute
Description
CustRouteDistinguisherStepPerVpnEnable
Enable customer route distinguisher step per VPN.

Type: bool
Default: TRUE
Possible Values:
Value Description
TRUE
Enable customer route distinguisher step per VPN.
FALSE Disable customer route distinguisher step per VPN.

CustRoutesPerCe
Customer routes per CE.

Type: u32
Default: 1
Range: 1 - 2147483647
DataMdtAddress
Data MDT address.

Type: ip
Default: 230.1.1.2
DataMdtCount
Data MDT count.

Type: u16
Default: 1
Range: 1 - 65535
DataMdtIncrement
Data MDT increment.

Type: ip
Default: 0.0.0.1
DataMdtProtocol
Data MDT protocol.

Type: enum
Default: SM
Possible Values:
Value Description
SM
SM
SSM
SSM
DefaultMdtAddress
Default MDT address.

Type: ip
Default: 239.1.1.1
DefaultMdtIncrement
Default MDT increment.

Type: ip
Default: 0.0.0.1
DutAs
DUT AS number.
Type: u16
Default: 1
Range: 1 - 65535
DutAs4Byte
4-Byte DUT AS number.

Type: string
Default: 1:1
DutLoopbackIpAddr
DUT loopback IP address.

Type: ip
Default: 10.0.0.1
Enable4ByteDutAs
Enable 4-Byte DUT AS number.

Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
Enable 4-Byte DUT AS number.
FALSE Disable 4-Byte DUT AS number.
1718
MvpnGenParams
Writable Attribute
Description
EnableAllReceivers
Enable all receivers.

Type: bool
Default: TRUE
Possible Values:
Value Description
TRUE
Enable traffic to all receivers.
FALSE Disable traffic to all receivers.

EnableAllSources
Enable all sources.

Type: bool
Default: TRUE
Possible Values:
Value Description
TRUE
Enable traffic from all sources.
FALSE Disable traffic from all sources.

EnableCoreTunnelLspPing
Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
FALSE
EnableCustomerBsr
Enable customer BSR.

Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
Enable customer BSR when true.
FALSE Enable customer BSR when true.

EnableDataMdt
Enable data MDT.

Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
Enable data MDT when true.
FALSE Enable data MDT when true.

EnableMulticastTraffic
Enable or disable creation of multicast traffic stream blocks.

Type: bool
Default: TRUE
Possible Values:
Value Description
TRUE
Multicast traffic stream block is created.
FALSE No multicast traffic stream block is created.

EnableMultipleSenders
Enable traffic from multiple senders.

Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
Enable traffic from multiple senders.
FALSE Disable traffic from multiple senders.
1719
MvpnGenParams
Writable Attribute
Description
EnableProviderBsr
Enable provider BSR.

Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
Enable provider BSR when true.
FALSE Enable provider BSR when true.

EnableSwitchoverTraffic
Switch traffic from default to data MDT.

Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
Switch traffic from default to data MDT.
FALSE Do not switch traffic from default to data MDT.

EnableTrafficAnalyzer
Enable traffic analyzer.

Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
Enable traffic analyzer.
FALSE Disable traffic analyzer.

EnableUnicastTraffic
Enable unicast traffic.

Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
Enable unicast traffic.
FALSE Disable unicast traffic.

EnableVlanPerPortIncrement
Enable VLAN/port increment.

Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
Enable VLAN/port increment when true.
FALSE Enable VLAN/port increment when true.

EnableVpnToDutTunnelLspPing
Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
FALSE
EnableVpnTunnelLspPing
Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
FALSE
FrameSize
Frame size.
Type: u16
Default: 1280
Range: 12 - 16383
1720
MvpnGenParams
Writable Attribute
Description
GroupAddressIncrement
Group address increment.

Type: ip
Default: 0.0.0.1
GroupCount
Group count.
Type: u16
Default: 1
Range: 1 - 65535
GroupPortIncrement
Group port increment.

Type: ip
Default: 0.1.0.0
GroupVlanIncrement
Group VLAN increment.

Type: ip
Default: 0.0.1.0
MdtSwitchoverDelay
MDT switchover delay (seconds).

Type: u16
Default: 3
MdtSwitchoverInterval
MDT switchover interval (seconds).

Type: u16
Default: 60
MulticastSendersCount
Multicast senders count.

Type: u16
Default: 1
Range: 1 - 65535
MulticastTrafficFlow
Multicast traffic flow.

Type: enum
Default: CUSTOMER_TO_PROVIDER
Possible Values:
Value
Description
CUSTOMER_TO_PROVIDER
CUSTOMER_TO_PROVIDER
CUSTOMER_TO_CUSTOMER CUSTOMER_TO_CUSTOMER
CUSTOMER_TO_ALL_OTHER CUSTOMER_TO_ALL_OTHER
PROVIDER_TO_CUSTOMER
ProviderPeLspAssignment
PROVIDER_TO_CUSTOMER
Provider PE LSP assignment.

Type: enum
Default: LSPS_PER_PE
Possible Values:
Value
Description
LSPS_PER_PE LSPS_PER_PE
PES_PER_LSP PES_PER_LSP
ProviderPeLspCount
Provider PEs per LSP or LSPs per PE count.

Type: u16
Default: 1
Range: 1 - 65535
ProviderPeVpnAssignment
Provider VPN LSP assignment.

Type: enum
Default: VPNS_PER_PE
Possible Values:
Value
Description
VPNS_PER_PE VPNS_PER_PE
PES_PER_VPN PES_PER_VPN
1721
MvpnGenParams
Writable Attribute
Description
ProviderPimProtocol
Provider PIM protocol.

Type: enum
Default: SM
Possible Values:
Value Description
SM
PIM-SM
SSM
PIM-SSM
ProviderRpAddress
Provider RP address.
Type: ip
Default: 192.0.2.0
ReceiversCount
Receivers count.
Type: u16
Default: 1
Range: 1 - 65535
ReceiversHaveSameGroups
All receivers have same groups.

Type: bool
Default: TRUE
Possible Values:
Value Description
TRUE
All receivers have same groups.
FALSE All receivers do not have same groups.

SourcesCount
Sources count.
Type: u16
Default: 1
Range: 1 - 65535
SourcesHaveSameGroups
Option to map sources to multicast groups while configuring multicast traffic.

Type: bool
Default: TRUE
Possible Values:
Value Description
TRUE
When true, all sources have same multicast group as the traffic destination.
FALSE When false, each sources has a different multicast group as the traffic destination.
StartingGroupAddress
Starting group address.

Type: ip
Default: 225.0.0.1
Stream block group method.

Type: enum
Default: AGGREGATE
Possible Values:
Value
Description
AGGREGATE AGGREGATE
VPN
StreamBlockUseSingleStreamNumberPerEndpointPair
VPN
Use single stream number per endpoint pair.

Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
Use single stream number per endpoint pair.
FALSE Do not use single stream number per endpoint pair.
1722
MvpnGenParams
Writable Attribute
Description
TrafficFlow
Traffic flow.
Type: enum
Possible Values:
Value
Description
CUSTOMER_TO_CORE CUSTOMER_TO_CORE
CORE_TO_CUSTOMER CORE_TO_CUSTOMER
BIDIRECTIONAL
BIDIRECTIONAL
FULLY_MESHED
FULLY_MESHED
TrafficLoadPercentFromCorePorts
Traffic load percent from core ports.

Type: double
Default: 10.0
Range: 0 - 100
TrafficLoadPercentFromCustomerPorts
Traffic load percent from customer ports.

Type: double
Default: 10.0
Range: 0 - 100
UseCorePortsEnable
Use core ports.

Type: bool
Default: TRUE
Possible Values:
Value Description
TRUE
Use core ports when true.
FALSE Use core ports when true.

UseCustPortsEnable
Use customer ports.

Type: bool
Default: TRUE
Possible Values:
Value Description
TRUE
Use customer ports when true.
FALSE Use customer ports when true.

VpnCoreRouteOverlap
VPN core route overlap.

Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
Overlap VPN routes on the core side.
FALSE Do not overlap VPN routes on the core side.

VpnCoreRoutePrefixLength
VPN core route prefix length.

Type: u32
Default: 24
Range: 1 - 32
VpnCoreRouteStart
VPN core route start.

Type: ip
Default: 110.1.1.0
VpnCoreRouteStep
VPN core route step.

Type: u32
Default: 1
VpnCount
VPN count.
Type: u16
Default: 10
Range: 1 - 65535
1723
MvpnGenParams
Writable Attribute
Description
VpnCustRouteOverlap
VPN customer route overlap.

Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
Overlap VPN routes on the customer side.
FALSE Do not overlap VPN routes on the customer side.

VpnCustRoutePrefixLength
VPN customer route prefix length.

Type: u32
Default: 24
Range: 1 - 32
VpnCustRouteStart
VPN customer route start.

Type: ip
Default: 10.1.1.0
VpnCustRouteStep
VPN customer route step.

Type: u32
Default: 1
VpnRouteDistinguisher

VPN route distinguisher.
Type: string
Default: 1:0
VpnRouteDistinguisherAssignment
Route distinguisher assignment mode.

Type: enum
Default: USE_RT
Possible Values:
Value
Description
USE_RT USE_RT
MANUAL MANUAL
VpnRouteDistinguisherStep

VPN route distinguisher step.
Type: string
Default: 1:0
VpnRouteMplsLabelStart
VPN route MPLS label start.

Type: u32
Default: 16
Range: 0 - 1048575
VpnRouteMplsLabelType
VPN route MPLS label type.

Type: enum
Default: SITE
Possible Values:
Value Description
SITE
SITE
ROUTE ROUTE
VpnRouteOverlap

VPN route overlap.
Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
Overlap VPN routes.
FALSE Do not overlap VPN routes.
1724
MVpnGreCeToPeLink
Writable Attribute
Description
VpnRoutePrefixLength

VPN route prefix length.
Type: u32
Default: 24
Range: 1 - 32
VpnRouteStart

VPN route start.
Type: ip
Default: 10.1.1.0
VpnRouteStep

VPN route step.
Type: u32
Default: 1
VpnRouteTarget
VPN route target.

Type: string
Default: 1:0
VpnRouteTargetOverride

VPN route target override.
Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
Override VPN route target.
FALSE Do not override VPN route target.

VpnRouteTargetStep
VPN route target step.

Type: string
Default: 1:0
MvpnGenParams Read-Only Attributes

MVpnGreCeToPeLink
Description:
Link between Customer Edge (CE) and Provider Edge (PE) device of MVPN. In most cases, VrfCustomerLink should be used instead.

Relations:
Side name
(Type)
Relative
Description
Container
(ContainedLink)

(LinkDst)
LinkDstDevice
(LinkDstDevice)
EmulatedDevice
1725
MVpnGrePeToPLink
Side name
(Type)
Relative
Description
NetworkLinkSource
(LinkSrc)
MVpnGreCeToPeLink Writable Attributes

Writable Attribute
Description
Active, Name
MVpnGreCeToPeLink Read-Only Attributes

Read-Only Attribute
Description
LinkType
Name of Link Type.

Type: string
MVpnGrePeToPLink
Description:
Link between Provider Edge (PE) and Provider (P) device of MVPN. In most cases, VrfProviderLink should be used instead.

Relations:
Side name
(Type)
Relative
Description
Container
(ContainedLink)

(LinkDst)
LinkDstDevice
(LinkDstDevice)
EmulatedDevice
NetworkLinkSource
(LinkSrc)
MVpnGrePeToPLink Writable Attributes

Writable Attribute
Description
Active, Name
MVpnGrePeToPLink Read-Only Attributes

Read-Only Attribute
Description
LinkType
Name of Link Type.

Type: string
1726
nameId
nameId
Description:
Parents: DL-Choice
Children: None
nameId Attributes
Attribute
Description
length
Type: INTEGER
Default: 3
Name
Type: string
nameId
Type: WWN
Default: 10:00:10:94:00:00:00:01
reserved
Type: OCTETSTRING
Default: 0000
type
Type: INTEGER
Default: 4
NeighborAdvertisement (icmpv6:NeighborAdvertisement)
Description:
ICMPv6 Neighbor Advertisement
Children: linkLayerOption
NeighborAdvertisement Attributes
Attribute
Description
checksum
Type: INTEGER
Default: 0
code
Type: INTEGER
Default: 0
Name
more information.
Type: string
oFlag
Type: BITSTRING
Default: 0
reserved
Type: INTEGER
Default: 0
rFlag
Type: BITSTRING
Default: 0
sFlag
Type: BITSTRING
Default: 0
1727
neighbors
Attribute
Description
targetAddress
Type: IPV6ADDR
Default: 2000::1
type
Type: Icmpv6Type
Default: 136
Possible Values:
Value Description
1
Packet Too Big
Time Exceeded
Parameter Problem
128
Echo Request
129
Echo Reply
130
MLDv1 Query
131
132
MLDv1 Listener Done
133
Router Solicitation
134
135
136
137
Redirect
143
neighbors
Description:
Parents: Ospfv2Hello
Children: Ospfv2Neighbor
neighbors Attributes
Attribute
Description
Name
information.
Type: string
NeighborSolicitation (icmpv6:NeighborSolicitation)
Description:
ICMPv6 Neighbor Solicitation
1728
networkAddress4
NeighborSolicitation Attributes
Attribute
Description
checksum
Type: INTEGER
Default: 0
code
Type: INTEGER
Default: 0
Name
more information.
Type: string
reserved
Type: INTEGER
Default: 0
targetAddress
Type: IPV6ADDR
Default: 2000::1
type
Type: Icmpv6Type
Default: 135
Possible Values:
Value Description
1
Packet Too Big
Time Exceeded
Parameter Problem
128
Echo Request
129
Echo Reply
130
MLDv1 Query
131
132
MLDv1 Listener Done
133
Router Solicitation
134
135
136
137
Redirect
143
networkAddress4
Description:
Parents: chassisid
Children: None
networkAddress4 Attributes
Attribute
Description
ianaAddrNo
Type: INTEGER
Default: 1
id
Type: IPV4ADDR
Default: 192.168.1.1
1729
networkAddress4
Attribute
Description
Name
information.
Type: string
subtype
Default: 05
Possible Values:
Value Description
01
Chassis Component
02
Interface Alias
03
Port Component
04
MAC Address
05
Network Address
06
Interface Name
07
Locally Assigned
networkAddress4
Description:
Children: None
Attribute
Description
ChassisID
Type: IPV4ADDR
ChassisIDSubtype
Default: 05
Possible Values:
Value Description
IanaFamilyNumber
Name
01
Chassis Component
02
Interface Alias
03
Port Component
04
MAC Address
05
Network Address
06
Interface Name
07
Locally Assigned
Type: IanaFamilyValues
Default: 01
Possible Values:
Value Description
01
IPv4
02
IPv6
Type: string
1730
networkAddress6
networkAddress6
Description:
Parents: chassisid
Children: None
Attribute
Description
ianaAddrNo
Type: INTEGER
Default: 2
id
Type: IPV6ADDR
Default: 2000::
Name
more information.
Type: string
subtype
Default: 05
Possible Values:
Value Description
01
Chassis Component
02
Interface Alias
03
Port Component
04
MAC Address
05
Network Address
06
Interface Name
07
Locally Assigned
networkAddress6
Description:
Children: None
Attribute
Description
ChassisID
Type: IPV6ADDR
1731
NetworkLsa
Attribute
Description
ChassisIDSubtype
Default: 05
Possible Values:
Value Description
IanaFamilyNumber
01
Chassis Component
02
Interface Alias
03
Port Component
04
MAC Address
05
Network Address
06
Interface Name
07
Locally Assigned
Default: 02
Possible Values:
Value Description
Name
01
IPv4
02
IPv6
Type: string
NetworkLsa
Description:
Represents Network LSA attributes. Network LSAs, sent by network DRs, describe aggregated (network-wide) link-state and cost information for all routers
in the attached network.

Children: NetworkLsaLink
NetworkLsa Writable Attributes

Writable Attribute
Description
AdvertisingRouterId
Router ID of the emulated router that this NetworkLsa object is associated with. This will be the advertising router field in the
advertised LSAs.
Type: ip
Default: null
Age

Type: u16
Default: 0
Range: 0 - 3600
CheckSum
Specifies whether the LSA will be advertised with a good or bad checksum. A bad checksum indicates a corrupted LSA and
is used for negative testing.
Type: enum
Default: GOOD
Possible Values:
Value Description
BAD
1732
NetworkLsaLink
Writable Attribute
Description
LinkStateId
IP address of the router's interface.

Type: ip
Default: 0.0.0.0
Options
Network LSA Options.

Type: enum
Default: EBIT
Possible Values:
Value
Description
TBIT
EBIT
MCBIT
NPBIT
EABIT
DCBIT
OBIT
Opaque: Specifies the router's willingness to receive and forward Opaque LSAs as specified in RFC 2370
(O,6).

PrefixLength
Specifies the network portion of the DR IP address.

Type: u8
Default: 24
Range: 0 - 32
RouteCategory

Type: enum
Default: UNDEFINED
Possible Values:
Value
Description
UNDEFINED
PRIMARY
Primary route.
SeqNum
UNIQUE
Unique route.
ANY
Any route.

Type: u32
Default: 0x80000001
NetworkLsa Read-Only Attributes

NetworkLsaLink
Description:
Create one of these objects (NetworkLsaLink) for each router attached to the link. This object specifies whether this Network LSA link is active or not. A
NetworkLsa can have 0 or more Network LSA links.

Parents: NetworkLsa
1733
NextEgressIdent
NetworkLsaLink Writable Attributes

Writable Attribute
Description
Active, Name
LinkId
Specifies the router ID of the router attached to the link.

Type: ip
Default: 0.0.0.0
NetworkLsaLink Read-Only Attributes

NextEgressIdent (overloaded)
NextEgressIdent (EOAMTLV)
NextEgressIdent (serviceoam)
NextEgressIdent Object (EOAMTLV PDU library)

Description:
Parents: LTREgrID (StreamBlock.LTREgrID)

Children: None
NextEgressIdent Attributes
Attribute
Description
Index
Type: OCTETSTRING
Default: 0000
MacAddr
Type: MACADDR
Default: 00:00:00:00:00:00
Name
more information.
Type: string
NextEgressIdent Object (serviceoam PDU library)

Description:
1734
nilFecSubTlv
Children: None
NextEgressIdent Attributes
Attribute
Description
Index
Type: OCTETSTRING
Default: 0000
MacAddr
Type: MACADDR
Default: 00:00:00:00:00:00
Name
more information.
Type: string
nilFecSubTlv
Description:
Children: None
nilFecSubTlv Attributes
Attribute
Description
label
Type: INTEGER
Default: 16
length
Type: INTEGER
Default: 4
Name
Type: string
reserved
Type: ALIGNMENTPAD
Default: 0
type
Type: INTEGER
Default: 16
NivSupportTlv (lldp:NivSupportTlv)
Description:
Children: None
lldp:PriorityBasedFlowControlTlv, lldp:ApplicationPriorityTlv, lldp:ETSConfigurationTlv, lldp:ETSRecommendationTlv, lldp:CongestionNotificationTlv
1735
nivTlv
NivSupportTlv Attributes
Attribute
Description
length
Type: INTEGER
Default: 4
Name
more information.
Type: string
oui
Type: OCTETSTRING
Default: 000142
subtype
Type: OCTETSTRING
Default: 03
type
Type: INTEGER
Default: 127
nivTlv
Description:
Children: header
nivTlv Attributes
Attribute
Description
ctrlMacAddr
Type: MACADDR
Default: 00:00:00:00:00:00
ctrlVifId
Type: INTEGER
Default: 4095
Name
Type: string
vis
Type: INTEGER
Default: 0
vnTagVer
Type: INTEGER
Default: 1
nni (overloaded)
nni (aal5If)
nni (atm)
1736
NodeName
nni Object (aal5If PDU library)

Description:
Parents: vpi (StreamBlock.Aal5.vpi)

Children: None
nni Attributes
Attribute
Description
Name
information.
Type: string
vpi
Type: INTEGER
Default: 0
nni Object (atm PDU library)

Description:
Parents: vpi (StreamBlock.ATM.vpi)

Children: None
nni Attributes
Attribute
Description
Name
information.
Type: string
vpi
Type: INTEGER
Default: 0
NodeName
Description:
Parents: nodeNames
Children: None
NodeName Attributes
Attribute
Description
control
Type: BITSTRING
Default: 00000000
1737
NodeName
Attribute
Description
Name
Type: string
nodeName
Type: WWN
Default: 10:00:10:94:00:00:00:00
portIdentifier
Type: OCTETSTRING
Default: 000000
reserved
Type: OCTETSTRING
Default: 00000000
NodeName
Description:
Parents: nodeNames
Children: None
NodeName Attributes
Attribute
Description
control
Type: BITSTRING
Default: 00000000
Name
Type: string
nodeName
Type: WWN
Default: 10:00:10:94:00:00:00:00
portIdentifier
Type: OCTETSTRING
Default: 000000
reserved
Type: OCTETSTRING
Default: 00000000
nodeNames (overloaded)
nodeNames (fc)
nodeNames (fcgs)
1738
nodes
nodeNames Object (fc PDU library)

Description:
Parents: gnnFtAccept (StreamBlock.FCoE.fc.fcPayloads.FCPayload-Choice.gnnFtAccept)

Children: NodeName
nodeNames Attributes
Attribute
Description
Name
information.
Type: string
nodeNames Object (fcgs PDU library)

Description:
Parents: gnnFtAccept (StreamBlock.GnnFtAccept)

Children: NodeName
nodeNames Attributes
Attribute
Description
Name
information.
Type: string
nodes
Description:
Parents: Ipv6RoutingHeader
Children: Ipv6Addr
nodes Attributes
Attribute
Description
Name
information.
Type: string
1739
nop
nop
Description:
Children: None
nop Attributes
Attribute
Description
Name
Type: string
type
Default: 1
Possible Values:
Value Description
0
End of Options List
NOP
130
Security
131
Loose Source Route
68
Time Stamp
133
Extended Security
Record Route
136
Stream Identifier
137
Strict Source Route
11
MTU Probe
12
MTU Reply
82
Traceroute
147
Address Extension
148
Router Alert
149
npivFdiscAccept
Description:
Parents: DL-Choice
Children: fdiscAcc
npivFdiscAccept Attributes
Attribute
Description
length
Type: INTEGER
Default: 36
Name
more information.
Type: string
reserved
Type: OCTETSTRING
Default: 0000
1740
npivFdiscReject
Attribute
Description
type
Type: INTEGER
Default: 8
npivFdiscReject
Description:
Parents: DL-Choice
Children: fdiscRjt
npivFdiscReject Attributes
Attribute
Description
length
Type: INTEGER
Default: 9
Name
more information.
Type: string
reserved
Type: OCTETSTRING
Default: 0000
type
Type: INTEGER
Default: 8
npivFdiscRequest
Description:
Parents: DL-Choice
Children: fdisc
npivFdiscRequest Attributes
Attribute
Description
length
Type: INTEGER
Default: 36
Name
more information.
Type: string
reserved
Type: OCTETSTRING
Default: 0000
type
Type: INTEGER
Default: 8
1741
NPortClkSyncQos
NPortClkSyncQos (fc:NPortClkSyncQos)
Description:
Children: None
Next headers: fip:FipPadding, custom:Custom
NPortClkSyncQos Attributes
Attribute
Description
accuracy
Type: OCTETSTRING
Default: 00
implLsb
Type: OCTETSTRING
Default: 00
implMsb
Type: OCTETSTRING
Default: 00
Name
Type: string
qosRequest
Type: OCTETSTRING
Default: 00
updatePeriod
Type: INTEGER
Default: 0
Nr
Description:
Parents: nrList
Children: None
Nr Attributes
Attribute
Description
Name
more information.
Type: string
value
Type: INTEGER
Default: 0
nrList
Description:
Parents: L2TPv2
Children: Nr
1742
Ns
nrList Attributes
Attribute
Description
Name
information.
Type: string
Ns
Description:
Parents: nsList
Children: None
Ns Attributes
Attribute
Description
Name
more information.
Type: string
value
Type: INTEGER
Default: 0
nsList
Description:
Parents: L2TPv2
Children: Ns
nsList Attributes
Attribute
Description
Name
information.
Type: string
OAMBH
Description:
Parents: InfoOAMPDU, EventNoteOAMPDU, VariableRequestOAMPDU, VariableResponseOAMPDU, LoopbackControlOAMPDU, OrgSpecOAMPDU
Children: FLAGS
1743
OAMPDUConfiguration
OAMBH Attributes
Attribute
Description
dstMac
Type: MACADDR
Default: 01:80:c2:00:00:02
LengthType
Type: OCTETSTRING
Default: 8809
Name
Type: string
srcMac
Type: MACADDR
Default: 00:00:01:00:00:02
Subtype
Type: OCTETSTRING
Default: 03
OAMPDUConfiguration
Description:
Parents: LI, RI
Children: None
OAMPDUConfiguration Attributes
Attribute
Description
MaxOAMsize
Type: BITSTRING
Default: 00000000000
Name
Type: string
Reserved
Type: BITSTRING
Default: 00000
offset
Description:
Parents: L2TPv2
Children: OffsetSize
1744
OffsetPadding
offset Attributes
Attribute
Description
Name
information.
Type: string
OffsetPadding
Description:
Parents: padding
Children: None
OffsetPadding Attributes
Attribute
Description
Name
information.
Type: string
value
Type: OCTETSTRING
OffsetSize
Description:
Parents: offset
Children: None
OffsetSize Attributes
Attribute
Description
Name
more information.
Type: string
value
Type: INTEGER
Default: 0
optionOverload
Description:
The DHCP Option Overload option (code 52), as described in RFC 1533
1745
options
Parents: DHCPOption
Children: None
optionOverload Attributes
Attribute
Description
length
Type: OCTETSTRING
Default: 01
Name
more information.
Type: string
overload
Type: DHCPoptOverloadMode
Default: 3
Possible Values:
Value Description
type
file
sname
file+sname
Type: OCTETSTRING
Default: 34
options (overloaded)
options (dhcp)
options (ipv4)
options (ipv6) - Object definition for the following paths:
StreamBlock.Ipv6HopByHopHeader.options
options (ipv6) - Object definition for the following paths:
StreamBlock.Ipv6DestinationHeader.options
options (pim) - Object definition for the following paths:
StreamBlock.Pimv4Hello.options
options (pim) - Object definition for the following paths:
StreamBlock.Pimv6Hello.options
options Object (dhcp PDU library)

Description:
Parent of the DHCPOptions object.
Parents: Dhcpclientmsg (StreamBlock.Dhcpclientmsg)
Dhcpservermsg (StreamBlock.Dhcpservermsg)
Children: DHCPOption
1746
options
options Attributes
Attribute
Description
Name
information.
Type: string
options Object (ipv4 PDU library)

Description:
Parents: ipHdr (StreamBlock.IcmpDestUnreach.ipData.ipHdr)

ipHdr (StreamBlock.IcmpTimeExceeded.ipData.ipHdr)
ipHdr (StreamBlock.IcmpParameterProblem.ipData.ipHdr)
ipHdr (StreamBlock.IcmpSourceQuench.ipData.ipHdr)
ipHdr (StreamBlock.IcmpRedirect.ipData.ipHdr)
ipHdr (StreamBlock.IPv4)
Children: IPv4HeaderOption
options Attributes
Attribute
Description
Name
information.
Type: string

Description:
Parents: Ipv6HopByHopHeader (StreamBlock.Ipv6HopByHopHeader)

Children: Ipv6HopByHopOption
options Attributes
Attribute
Description
Name
information.
Type: string
1747
options

Description:
Parents: Ipv6DestinationHeader (StreamBlock.Ipv6DestinationHeader)

Children: Ipv6DestinationOption
options Attributes
Attribute
Description
Name
information.
Type: string
options Object (pim PDU library)

Description:

Children: Pimv4HelloOption
options Attributes
Attribute
Description
Name
information.
Type: string
options Object (pim PDU library)

Description:

Children: Pimv6HelloOption
options Attributes
Attribute
Description
Name
information.
Type: string
1748
OrganizationallySpecificTlv
OrganizationallySpecificTlv (lldp:OrganizationallySpecificTlv)
Description:
Children: None
lldp:NivSupportTlv
OrganizationallySpecificTlv Attributes
Attribute
Description
length
Type: INTEGER
Default: 0
Name
more information.
Type: string
oui
Type: OCTETSTRING
Default: 000000
subtype
Type: OCTETSTRING
Default: 00
type
Type: INTEGER
Default: 127
value
Type: OCTETSTRING
Default: 00
OrgSpec (EOAMTLV:OrgSpec)
Description:
Children: theValue
OrgSpec Attributes
Attribute
Description
Length
Type: OCTETSTRING
Default: 0000
Name
more information.
Type: string
OUI
Type: OCTETSTRING
Default: 000000
SubType
Type: OCTETSTRING
Default: 00
1749
OrgSpecOAMPDU
Attribute
Description
Type
Type: OCTETSTRING
Default: 1F
OrgSpecOAMPDU (LinkOAM:OrgSpecOAMPDU)
Description:
Children: DataPad, OAMBH
OrgSpecOAMPDU Attributes
Attribute
Description
Code
Type: OCTETSTRING
Default: FE
Name
information.
Type: string
OrgSpecTLV (overloaded)
OrgSpecTLV (EOAM)
OrgSpecTLV (serviceoam)
OrgSpecTLV Object (EOAM PDU library)

Description:

Children: theValue
OrgSpecTLV Attributes
Attribute
Description
Length
Type: OCTETSTRING
Default: 0000
1750
OS
Attribute
Description
Name
more information.
Type: string
OUI
Type: OCTETSTRING
Default: 000000
SubType
Type: OCTETSTRING
Default: 00
Type
Type: OCTETSTRING
Default: 1F
OrgSpecTLV Object (serviceoam PDU library)

Description:

Children: theValue
OrgSpecTLV Attributes
Attribute
Description
Length
Type: OCTETSTRING
Default: 0000
Name
more information.
Type: string
OUI
Type: OCTETSTRING
Default: 000000
SubType
Type: OCTETSTRING
Default: 00
Type
Type: OCTETSTRING
Default: 1F
OS
Description:
Children: None
1751
osLunMapEntries
OS Attributes
Attribute
Description
InfoLength
Type: OCTETSTRING
Default: 00
InfoType
Type: OCTETSTRING
Default: FE
Name
Type: string
OSI
Type: OCTETSTRING
OUI
Type: OCTETSTRING
Default: 000000
osLunMapEntries (overloaded)
osLunMapEntries (fc)
osLunMapEntries (fcgs)
osLunMapEntries Object (fc PDU library)

Description:
Parents: gpliAccept (StreamBlock.FCoE.fc.fcPayloads.FCPayload-Choice.gpliAccept)

rpli (StreamBlock.FCoE.fc.fcPayloads.FCPayload-Choice.rpli)
Children: OsLunMapEntry
osLunMapEntries Attributes
Attribute
Description
Name
information.
Type: string
osLunMapEntries Object (fcgs PDU library)

Description:
1752
OsLunMapEntry
Parents: gpliAccept (StreamBlock.GpliAccept)

rpli (StreamBlock.Rpli)
Children: OsLunMapEntry
osLunMapEntries Attributes
Attribute
Description
Name
information.
Type: string
OsLunMapEntry
Description:
Parents: osLunMapEntries
Children: None
OsLunMapEntry Attributes
Attribute
Description
fcpBindingType
Type: OCTETSTRING
Default: 00000000
fcpLuid
Type: OCTETSTRING
Default: 0000000000000000
fcpLuidLength
Type: INTEGER
Default: 0
fcpLun
Type: OCTETSTRING
Default: 0000000000000000
fcpNodeName
Type: WWN
Default: 10:00:10:94:00:00:00:00
fcpPortIdentifier
Type: OCTETSTRING
Default: 000000
fcpPortName
Type: WWN
Default: 20:00:10:94:00:00:00:00
hbaPortName
Type: WWN
Default: 20:00:10:94:00:00:00:00
Name
Type: string
osDeviceName
Type: ASCII
osDeviceNameLength
Type: INTEGER
Default: 0
1753
OsLunMapEntry
Attribute
Description
osScsiBusNumber
Type: OCTETSTRING
Default: 00000000
osScsiLun
Type: OCTETSTRING
Default: 00000000
osScsiTargetNumber
Type: OCTETSTRING
Default: 00000000
reserved1
Type: OCTETSTRING
Default: 0000
reserved2
reserved3
Type: OCTETSTRING
Default: 00
OsLunMapEntry
Description:
Parents: osLunMapEntries
Children: None
OsLunMapEntry Attributes
Attribute
Description
fcpBindingType
Type: OCTETSTRING
Default: 00000000
fcpLuid
Type: OCTETSTRING
Default: 0000000000000000
fcpLuidLength
Type: INTEGER
Default: 0
fcpLun
Type: OCTETSTRING
Default: 0000000000000000
fcpNodeName
Type: WWN
Default: 10:00:10:94:00:00:00:00
fcpPortIdentifier
Type: OCTETSTRING
Default: 000000
fcpPortName
Type: WWN
Default: 20:00:10:94:00:00:00:00
hbaPortName
Type: WWN
Default: 20:00:10:94:00:00:00:00
Name
Type: string
osDeviceName
Type: ASCII
1754
Ospfv2AgeAsbrLsaCommand
Attribute
Description
osDeviceNameLength
Type: INTEGER
Default: 0
osScsiBusNumber
Type: OCTETSTRING
Default: 00000000
osScsiLun
Type: OCTETSTRING
Default: 00000000
osScsiTargetNumber
Type: OCTETSTRING
Default: 00000000
reserved1
Type: OCTETSTRING
Default: 0000
reserved2
reserved3
Type: OCTETSTRING
Default: 00
Ospfv2AgeAsbrLsaCommand
Description:
Set MaxAge on selected ASBR-Summary LSAs in all or selected OSPF areas.

Ospfv2AgeAsbrLsaCommand Writable Attributes

Writable Attribute
Description
CategoryFilter

Type: enum
Default: ANY
Possible Values:
Value
Description
UNDEFINED
Undefined
PRIMARY
Primary
SECONDARY Secondary
UNIQUE
Unique
ANY
Any
LsaList
LSA handle list.

Type: handle
Default: 0
PercentFilter

Type: double
Default: 100.0
Range: 0 - 100
1755
Ospfv2AgeExternalLsaCommand
Writable Attribute
Description
PrefixFilter
Type: u8
Default: 0
Range: 0 - 128
RouteCategory
Specifies how the route is to be treated during command operation.

Type: enum
Default: ANY
Possible Values:
Value
Description
UNDEFINED
Default category assigned to a manually created block.
PRIMARY
A preferred route that has duplicates (secondary routes) advertised by other ports.
SECONDARY A less preferred backup route.

UNIQUE
Indicates that a single port in a test configuration advertises this route.
ANY
Can be any category type.
Ospfv2AgeAsbrLsaCommand Read-Only Attributes

Read-Only Attribute
Description

Description:
Set MaxAge on selected Ext LSAs on the selected router.

Ospfv2AgeExternalLsaCommand Writable Attributes

Writable Attribute
Description
CategoryFilter

Type: enum
Default: ANY
Possible Values:
Value
Description
UNDEFINED
Undefined
PRIMARY
Primary
SECONDARY Secondary
LsaList
UNIQUE
Unique
ANY
Any
LSA handle list.

Type: handle
Default: 0
1756
Ospfv2AgeNetworkLsaCommand
Writable Attribute
Description
PercentFilter

Type: double
Default: 100.0
Range: 0 - 100
PrefixFilter
Type: u8
Default: 0
Range: 0 - 128
RouteCategory

Type: enum
Default: ANY
Possible Values:
Value
Description
UNDEFINED
PRIMARY

UNIQUE
ANY
Ospfv2AgeExternalLsaCommand Read-Only Attributes

Read-Only Attribute
Description

Description:
Age Network LSA command. Set MaxAge on selected network LSAs. SUT will flush the LSAs from its database.

Ospfv2AgeNetworkLsaCommand Writable Attributes

Writable Attribute
Description
CategoryFilter

Type: enum
Default: ANY
Possible Values:
Value
Description
UNDEFINED
Undefined
PRIMARY
Primary
SECONDARY Secondary
UNIQUE
Unique
ANY
Any
1757
Ospfv2AgeRouterLsaCommand
Writable Attribute
Description
LsaList
LSA handle list.

Type: handle
Default: 0
PercentFilter

Type: double
Default: 100.0
Range: 0 - 100
PrefixFilter
Type: u8
Default: 0
Range: 0 - 128
Ospfv2AgeNetworkLsaCommand Read-Only Attributes

Read-Only Attribute
Description

Description:
Age Router LSA command. Set MaxAge on selected router LSAs. SUT will flush the LSAs from its database.

Ospfv2AgeRouterLsaCommand Writable Attributes

Writable Attribute
Description
CategoryFilter

Type: enum
Default: ANY
Possible Values:
Value
Description
UNDEFINED
Undefined
PRIMARY
Primary
SECONDARY Secondary
UNIQUE
Unique
ANY
Any
LsaList
LSA handle list.

Type: handle
Default: 0
PercentFilter

Type: double
Default: 100.0
Range: 0 - 100
1758
Ospfv2AgeSummaryLsaCommand
Writable Attribute
Description
PrefixFilter
Type: u8
Default: 0
Range: 0 - 128
Ospfv2AgeRouterLsaCommand Read-Only Attributes

Read-Only Attribute
Description

Ospfv2AgeSummaryLsaCommand
Description:
Set MaxAge on selected Summary LSAs on the selected router.

Ospfv2AgeSummaryLsaCommand Writable Attributes

Writable Attribute
Description
CategoryFilter

Type: enum
Default: ANY
Possible Values:
Value
Description
UNDEFINED
Undefined
PRIMARY
Primary
SECONDARY Secondary
UNIQUE
Unique
ANY
Any
LsaList
LSA handle list.

Type: handle
Default: 0
PercentFilter

Type: double
Default: 100.0
Range: 0 - 100
PrefixFilter
Type: u8
Default: 0
Range: 0 - 128
1759
Ospfv2AgeTeLsaCommand
Writable Attribute
Description
RouteCategory

Type: enum
Default: ANY
Possible Values:
Value
Description
UNDEFINED
PRIMARY

UNIQUE
ANY
Ospfv2AgeSummaryLsaCommand Read-Only Attributes

Read-Only Attribute
Description

Ospfv2AgeTeLsaCommand
Description:
Age TE LSA command. Set MaxAge on selected TE LSAs. SUT will flush the LSAs from its traffic engineering database.

Ospfv2AgeTeLsaCommand Writable Attributes

Writable Attribute
Description
CategoryFilter

Type: enum
Default: ANY
Possible Values:
Value
Description
UNDEFINED
Undefined
PRIMARY
Primary
SECONDARY Secondary
UNIQUE
Unique
ANY
Any
LsaList
LSA handle list.

Type: handle
Default: 0
PercentFilter

Type: double
Default: 100.0
Range: 0 - 100
1760
ospfv2AsExternalLsa
Writable Attribute
Description
PrefixFilter
Type: u8
Default: 0
Range: 0 - 128
Scope
Scope.
Type: enum
Default: AREA_LOCAL
Possible Values:
Value
Description
LINK_LOCAL
Link Local.
AREA_LOCAL
Area Local.
AREA_SYSTEM_WIDE Area System wide.
Ospfv2AgeTeLsaCommand Read-Only Attributes

Read-Only Attribute
Description

ospfv2AsExternalLsa
Description:
OSPFv2 AS-external-LSA. See RFC 2328.
Parents: Ospfv2Lsa
Children: externalAdditionalMetrics, externalLsaOptions, header
ospfv2AsExternalLsa Attributes
Attribute
Description
externalRouteMetric
Type: INTEGER
Default: 0
externalRouteTag
Type: INTEGER
Default: 0
forwardingAddress
Type: IPV4ADDR
Default: 1.1.1.1
Name
Type: string
networkMask
Type: IPV4ADDR
Default: 255.255.255.0
Ospfv2AttachedRouter
Description:
1761
Ospfv2AuthenticationParams
Parents: attachedRouters
Children: None
Ospfv2AttachedRouter Attributes
Attribute
Description
Name
more information.
Type: string
routerID
Type: IPV4ADDR
Default: 1.1.1.1
Ospfv2AuthenticationParams
Description:
Specifies the type of authentication to be used for OSPFv2.

Automatically created from: Ospfv2DeviceGenProtocolParams, Ospfv2RouterConfig, Ospfv2SharedSessionParams, VpnIgpOspfv2SessionParams
Ospfv2AuthenticationParams Writable Attributes

Writable Attribute
Description
Authentication
You must set Authentication to indicate which of the attributes of this object you want to use.
Type: enum
Default: NONE
Possible Values:
Value
Description
NONE
No attributes have been set (no authentication).
SIMPLE Use simple authentication.

MD5
Use the MD5 key ID for authentication.
Md5KeyId
Specifies the value of the MD5 key ID.

Type: u8
Default: 1
Password
Authentication password string for the MD5 Authentication type.

Type: string
Default: Spirent
Ospfv2AuthenticationParams Read-Only Attributes

Ospfv2DatabaseDescription (ospfv2:Ospfv2DatabaseDescription)
Description:
OSPFv2 Database Description packet. See RFC 2328.
Children: ddOptions, ddSpecificOptions, header, lsaHeaders
1762
Ospfv2DeviceGenProtocolParams
Ospfv2DatabaseDescription Attributes
Attribute
Description
interfaceMtu
Type: INTEGER
Default: 4096
Name
Type: string
sequenceNumber
Type: INTEGER
Default: 0
Description:
OSPFv2-specific router generator parameters.

Automatically-created children: Ospfv2AuthenticationParams
Ospfv2DeviceGenProtocolParams Writable Attributes

Writable Attribute
Description
Active, Name
AreaId
Area to which the emulated router belongs.

Type: ip
Default: 0.0.0.0
EnableBfd

Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
Enable BFD.
FALSE Disable BFD.

Enable or disable Graceful Restart.

Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
1763
Ospfv2ExternalLsaTosMetric
Writable Attribute
Description
GracefulRestartType
Type of graceful restart.

Type: enum
Default: NONE
Possible Values:
Value
Description
NONE
No graceful restart.
RFCSTANDARD Follows RFC 3623.

LLSIGNALLING
NetworkType
Link Layer Signalling.
Network Type. This setting is used to override the physical link type to emulate a P2P adjacency over Ethernet (VLAN) or
over POS, or Broadcast adjacency over Ethernet non-VLAN.
Type: enum
Default: NATIVE
Possible Values:
Value
Description
NATIVE
Native mode uses the network type determined from the type of the interface.
BROADCAST Broadcast mode.

P2P
Options
Point-to-point (P2P) mode.
A bit mask that specifies the settings of the Options field in Hello packets sent to the DUT. The Options field describes the
optional OSPF capabilities of the router. Section A.2 in RFC 2328 describes the Options field. Use hexadecimal for this
value. The default, 0x02, sets the E-bit (binary 00000010).
Type: enum
Default: EBIT
Possible Values:
Value
Description
TBIT
Type of Service (TOS) (T,0).
EBIT
Specifies the way AS-external-LSAs are flooded (E,1).
MCBIT
Specifies whether IP multicast datagrams are forwarded (MC,2).
NPBIT
Specifies the handling of Type-7 LSAs (NSSA) (N/P,3).
EABIT
Specifies the router's willingness to receive and forward External-Attributes-LSAs (EA,4).
DCBIT
Specifies the router's handling of demand circuits (DC,5).
OBIT
Specifies the router's willingness to receive and forward Opaque LSAs as specified in RFC 2370 (O,6).
UNUSED7 This bit is not used.

RouterPriority
Router priority for this router. This is used in the designated router election procedure. A router priority of 0 (the default)
makes the router ineligible to be the designated router.
Type: u8
Default: 0
Range: 0 - 255
Ospfv2DeviceGenProtocolParams Read-Only Attributes

Ospfv2ExternalLsaTosMetric
Description:
Parents: externalAdditionalMetrics
Children: None
1764
Ospfv2FloodLsasCommand
Ospfv2ExternalLsaTosMetric Attributes
Attribute
Description
eBit
Type: BITSTRING
Default: 0
externalLsaRouteMetrics
Type: INTEGER
Default: 0
externalLsaRouteTos
Type: Ospfv2ExternalLsaRouteTos
Default: 0
Possible Values:
Value Description
0
Normal
Minimize Monetary Cost
Maximize Monetary Cost
6
8
Maximize Throughput
10
12
14
16
Minimize Delay
18
20
22
24
26
28
30
forwardingAddress
Type: IPV4ADDR
Default: 1.1.1.1
Name
Type: string
Ospfv2FloodLsasCommand
Description:
Flood LSAs command. Advertise opaque LSA for Graceful LSA used with Graceful Restart type RFC.

Ospfv2FloodLsasCommand Writable Attributes

Writable Attribute
Description
1765
Ospfv2GlobalConfig
Writable Attribute
Description
RouterList
OSPFv2 protocol handles.

Type: handle
Default: 0
Ospfv2FloodLsasCommand Read-Only Attributes

Read-Only Attribute
Description

Ospfv2GlobalConfig
Description:
Global values for OSPFv2 router configuration. Attribute settings at the profile level take precedence over the global settings.

Parents: Project
Ospfv2GlobalConfig Writable Attributes

Writable Attribute
Description
Active, Name
EnableSequentialStartup
Sequential startup limits the number of OSPFv2 routers started simultaneously to the number specified by
SimultaneousSequentialStartupCount. As each router becomes fully adjacent, the next router in the startup
list is started. This reduces the CPU load during startup and may reduce test start time.
Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
Start routers sequentially.
FALSE Start routers simultaneously.

EnableUpdateThrottling
Acknowledges LS Update packets with minimal verification to reduce the likelihood of a retransmit flood from
the DUT.
Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
Perform quick acknowledges.
FALSE Do not perform quick acknowledges.

SimultaneousSequentialStartupCount
Specifies the number of routers to start simultaneously when Sequential Startup is enabled.
Type: u16
Default: 20
Range: 1 - 255
Ospfv2GlobalConfig Read-Only Attributes

1766
Ospfv2Hello
Ospfv2Hello (ospfv2:Ospfv2Hello)
Description:
OSPFv2 Hello packet. See RFC 2328.
Children: header, helloOptions, neighbors
Ospfv2Hello Attributes
Attribute
Description
backupDesignatedRouter
Type: IPV4ADDR
Default: 2.2.2.2
designatedRouter
Type: IPV4ADDR
Default: 1.1.1.1
helloInterval
Type: INTEGER
Default: 10
Name
Type: string
networkMask
Type: IPV4ADDR
Default: 255.255.255.0
routerDeadInterval
Type: INTEGER
Default: 40
routerPriority
Type: INTEGER
Default: 0
Ospfv2LinkStateAcknowledge (ospfv2:Ospfv2LinkStateAcknowledge)
Description:
OSPFv2 Link State Acknowledgment packet. See RFC 2328.
Children: header, lsaHeaders
Ospfv2LinkStateAcknowledge Attributes
Attribute
Description
Name
information.
Type: string
Ospfv2LinkStateRequest (ospfv2:Ospfv2LinkStateRequest)
Description:
OSPFv2 Link State Request packet. See RFC 2328.
1767
Ospfv2LinkStateUpdate
Children: header, requestedLsas
Ospfv2LinkStateRequest Attributes
Attribute
Description
Name
information.
Type: string
Ospfv2LinkStateUpdate (ospfv2:Ospfv2LinkStateUpdate)
Description:
OSPFv2 Link State Update packet. See RFC 2328.
Children: header, updatedLsas
Ospfv2LinkStateUpdate Attributes
Attribute
Description
Name
Type: string
numberOfLsas
Type: INTEGER
Default: 0
Ospfv2Lsa
Description:
Parents: updatedLsas
Children: ospfv2AsExternalLsa, ospfv2NetworkLsa, ospfv2RouterLsa, ospfv2SummaryAsbrLsa, ospfv2SummaryLsa
Ospfv2Lsa Attributes
Attribute
Description
Name
information.
Type: string
Ospfv2LsaGenParams
Description:
OSPFv2 LSA generator parameters.
1768
Ospfv2LsaGenParams

Parents: Project
RingTopologyGenParams, TeParams, TreeTopologyGenParams
Relations:
Side name
(Type)
Relative
Description
EmulatedDevice
Routers that LSAs will be generated on.
Ospfv2LsaGenParams Writable Attributes

Writable Attribute
Description
Active, Name
AreaType
Area type determines the type of LSAs that are flooded within the area and the options that are set on the LSAs.
Type: enum
Default: REGULAR
Possible Values:
Value
Description
REGULAR
REGULAR (Normal) areas support all LSA types. External routes are advertised as Type
5 LSAs and the OSPF options are set to 2 (external bit enabled).
STUB
STUB areas do not flood external routes into the area. Routing to external destinations
is based on default routes advertised by the area border routers. This keeps the link-state
database in stub areas as small as possible.
STUB_NO_SUMMARY STUB_NO_SUMMARY (Totally stubby) areas are similar to stub areas, however they do
not support summary LSAs in addition to external route LSAs. This further reduces the
size of the link-state database for the area.
NSSA
NSSA (Not-So-Stubby-Areas) areas are similar to stub areas (type 5 external route LSAs
are not flooded into the area) however, they distribute external route information within
the area using type 7 NSSA LSAs with options set to 8. NSSA LSAs are converted to type
5 external route LSAs at the NSSA border.
NSSA_NO_SUMMARY NSSA_NO_SUMMARY (Totally Not-So-Stubby-Areas) areas are similar to NSSA areas,

however they do not support summary LSAs in addition to external route LSAs.
EnableLoopbackAdvertisement
Enable this option to generate Router LSAs that each contain a /32 stub network equal to the LSAs advertising router
field. This enables a simulated OSPF router to advertise its router ID (loopback address) as a 32-bit Stub Network
in a self-originated Router LSA, as required for MPLS, Martini and TE tests.
Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
Advertise loopback addresses.
FALSE Don't advertise loopback addresses.

EnableTeRouterInformationTlv
Enable TeRouterInformation TLV.

Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
Enable TeRouterInformation TLV.
FALSE Disable TeRouterInformation TLV.

IfEnableIpAddrOverride
Determines if the IfIpAddrStart value will be used or the default values will be used.
Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
Use the IfIpAddrStart value.
FALSE Use the default value.
1769
Ospfv2LsaGenRouteAttrParams
Writable Attribute
Description
IfIpAddrStart
Starting interface IP address for numbered point to point links and broadcast links.
Type: ip
Default: 1.0.0.1
IfPrefixLength
Interface address prefix length.

Type: u8
Default: 24
Range: 1 - 31
IpAddrEnd
Global/default ending IP address value used for routes and interface addresses.
Type: ip
Default: 223.255.255.255
IpAddrStart
Global/default starting IP address value used for routes and interface addresses.
Type: ip
Default: 1.0.0.0
NumberedPointToPointLinkEnabled
Enable this option to generate numbered Point-to-Point links. For each link, the Link ID is set to the connected Router
ID and the Link Data is set to the simulated interface's IP address. The numbered link is coupled with the Stub
Network, with the Link ID set to the link's IP address and the Link Data set to the link's netmask.
Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
Create numbered point to point links.
FALSE Create unnumbered point to point links.

RouterIdStart
Starting router ID.

Type: ip
Default: 1.0.0.1
RouterIdStep
Step applied to the router ID for each subsequent router.

Type: ip
Default: 0.0.0.1
TeEnabled
Determines if TE options are enabled.

Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
TE options are enabled.
FALSE TE options are disabled.
Ospfv2LsaGenParams Read-Only Attributes

Description:
OSPFv2 specific route attribute parameters.

1770
Ospfv2Neighbor
Ospfv2LsaGenRouteAttrParams Writable Attributes

Writable Attribute
Description
Active, Name
PrimaryMetric
OSPF route metric used for primary routes.

Type: u16
Default: 1
Range: 1 - 65535
RouteType
OPSFv2 route type.

Type: enum
Default: EXTERNAL
Possible Values:
Value
Description
STUB
Stub network route.
SUMMARY Summary route.

EXTERNAL External route.
SecondaryMetric
OSPF route metric used for secondary routes.

Type: u16
Default: 2
Range: 1 - 65535
Ospfv2LsaGenRouteAttrParams Read-Only Attributes

Ospfv2Neighbor
Description:
Parents: neighbors
Children: None
Ospfv2Neighbor Attributes
Attribute
Description
Name
more information.
Type: string
neighborID
Type: IPV4ADDR
Default: 1.1.1.1
ospfv2NetworkLsa
Description:
OSPFv2 network-LSA. See RFC 2328.
Parents: Ospfv2Lsa
Children: attachedRouters, header
1771
Ospfv2PerformGracefulRestartCommand
ospfv2NetworkLsa Attributes
Attribute
Description
Name
more information.
Type: string
networkMask
Type: IPV4ADDR
Default: 255.255.255.0
Ospfv2PerformGracefulRestartCommand
Description:
Perform graceful restart.

Ospfv2PerformGracefulRestartCommand Writable Attributes

Writable Attribute
Description
RouterList
OSPFv2 router handle list.

Type: handle
Default: 0
Ospfv2PerformGracefulRestartCommand Read-Only Attributes

Read-Only Attribute
Description

Ospfv2ReadvertiseLsaCommand
Description:
Readvertise LSA command. Readvertise all LSAs to all or selected OSPF areas.

Ospfv2ReadvertiseLsaCommand Writable Attributes

Writable Attribute
Description
1772
Ospfv2RemoveNetworkLsaLinkCommand
Writable Attribute
Description
RouterList

Type: handle
Default: 0
Ospfv2ReadvertiseLsaCommand Read-Only Attributes

Read-Only Attribute
Description

Ospfv2RemoveNetworkLsaLinkCommand
Description:
Remove Network LSA Link command. Remove the selected router from the Network-LSA with the IP address and advertise the modified Network-LSA to the
SUT. This action is repeated for all pairs in the collection.

Ospfv2RemoveNetworkLsaLinkCommand Writable Attributes

Writable Attribute
Description
LsaLinkList
Link handle list.

Type: handle
Default: 0
Ospfv2RemoveNetworkLsaLinkCommand Read-Only Attributes

Read-Only Attribute
Description

Ospfv2RemoveRouterLsaLinkCommand
Description:
Remove Router LSA Link command. Remove the selected link and advertise the modified Router-LSA to the SUT. This action is repeated for all pairs in the
collection.

1773
Ospfv2RequestedLsa
Ospfv2RemoveRouterLsaLinkCommand Writable Attributes

Writable Attribute
Description
LsaLinkList
Link handle list.

Type: handle
Default: 0
Ospfv2RemoveRouterLsaLinkCommand Read-Only Attributes

Read-Only Attribute
Description

Ospfv2RequestedLsa
Description:
Parents: requestedLsas
Children: None
Ospfv2RequestedLsa Attributes
Attribute
Description
advertisingRouter
Type: IPV4ADDR
Default: 1.1.1.1
linkStateId
Type: IPV4ADDR
Default: 1.1.1.1
lsTypeWide
Type: Ospfv2LsTypesWide
Default: 1
Possible Values:
Value Description
Name
Router
Network
Summary
Summary-ASBR
AS-External Type-5
AS-External Type-7
Type: string
Ospfv2RestartRouterCommand
Description:
Restart router.
1774
Ospfv2RestoreRouterCommand

Ospfv2RestartRouterCommand Writable Attributes

Writable Attribute
Description
RouterList

Type: handle
Default: 0
Ospfv2RestartRouterCommand Read-Only Attributes

Read-Only Attribute
Description

Ospfv2RestoreRouterCommand
Description:
Restore router command. Resume sending Hello packets on selected OSPF router(s) and request all LSAs from SUT as if the emulated router has been
restarted and its database has been cleared.

Ospfv2RestoreRouterCommand Writable Attributes

Writable Attribute
Description
RouterList

Type: handle
Default: 0
Ospfv2RestoreRouterCommand Read-Only Attributes

Read-Only Attribute
Description

Ospfv2ResumeHellosCommand
Description:
Resume sending OSPFv2 Hello packets.
1775
Ospfv2RouterConfig

Ospfv2ResumeHellosCommand Writable Attributes

Writable Attribute
Description
RouterList

Type: handle
Default: 0
Ospfv2ResumeHellosCommand Read-Only Attributes

Read-Only Attribute
Description

Ospfv2RouterConfig
Description:
Defines the characteristics of an emulated OSPF version 2 router that will form an adjacency with the DUT. This is the OSPFv2 main router configuration
object.

Children: AsbrSummaryLsa, ExternalLsaBlock, NetworkLsa, RouterLsa, SummaryLsaBlock, TeLsa
Automatically-created children: Ospfv2AuthenticationParams, TeParams
Result children (automatically created): Ospfv2RouterResults
Relations:
Side name
(Type)
Relative
Description
ResultChild
(ResultChild)
Ospfv2RouterResults
UsesIf
(UsesIf)


Ospfv2RouterConfig Writable Attributes

Writable Attribute
Description
Active, Name
AreaId
Area to which the emulated router belongs. It must match an area ID configured for the DUT to enable communication with
the DUT.
Type: ip
Default: 0.0.0.0
1776
Ospfv2RouterConfig
Writable Attribute
Description
EnableBfd
Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
Enable BFD.
FALSE Disable BFD.


Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE

FloodDelay
Flood delay in milliseconds. This is the interval parameter to control the rate at which LSAs are generated by each emulated
OSPF router (inter-LSA delay).
Type: u32
Default: 100
Range: 20 - 2147483647
GracefulRestartMaxLoad
Enable or disable requesting all the LSA packets from the router during adjacency establishment.
Type: bool
Default: TRUE
Possible Values:
Value Description
TRUE
Protocol will request all LSAs advertised by the router during adjacency establishment.
FALSE Protocol will request no LSAs advertised by the router during adjacency establishment.
GracefulRestartReason
Specifies the graceful restart reason.

Type: enum
Default: UNKNOWN
Possible Values:
Value
Description
UNKNOWN Unknown.
SOFTWARE Software restart.
GracefulRestartStrictHelper
GracefulRestartTimer
RELOAD
Software reload or upgrade.
SWITCH
Switch to redundant control processor.
If an emulated router is a strict helper (per RFC 3623 or Cisco LLS Signalling drafts), it will cease to be a helper if its Link
State Database changes while it is helping a restarting router. When a router ceases to be a helper, graceful restart
procedures will be terminated and the restarting router will follow normal restart and adjacency forming procedures.
Type: enum
Default: NO
Possible Values:
Value Description
NO
Not a strict helper.
YES
Yes, a strict helper.
Graceful Restart Timer (seconds).

Type: u32
Default: 40
Range: 0 - 1800
1777
Ospfv2RouterConfig
Writable Attribute
Description
GracefulRestartType
Specifies the type of graceful restart.

Type: enum
Default: NONE
Possible Values:
Value
Description
NONE

LLSIGNALLING
GuaranteeDelivery
Determines how LSA configuration changes are handled.

Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
Protocol will transmit LSA configuration changes in one or more LS Update packets. The protocol will wait for
acknowledgement or the Retransmit Interval before sending the next packet.
FALSE Protocol will transmit LSA configuration changes in one or more LS Update packets separated by the interval
defined in the Flood Delay field. The protocol will not wait for acknowledgement before sending the next packet.
HelloInterval
Hello Interval in seconds. The time interval used by the emulated routers to pace Hello packet transmissions.
Type: u32
Default: 10
Range: 1 - 65535
IfCost
Interface Cost. The cost of the interface connecting the emulated router to the neighbor SUT router.
Type: u16
Default: 1
Range: 1 - 65535
LsaRefreshInterval
Maximum time in seconds between originations of an LSA. The time interval used to refresh the LS database to the neighbor
SUT router.
Type: u32
Default: 1800
Range: 10 - 21600
NetworkType
Type: enum
Default: NATIVE
Possible Values:
Value
Description
NATIVE
Network type = Native (Default).
BROADCAST Network type = Broadcast.

P2P
Options
Network type = Point-to-point (P2P).
optional OSPF capabilities of the router. Section A.2 in RFC 2328 describes the Options field. Use hexadecimal for this
value. The default, 0x02, sets the E-bit (binary 00000010).
Type: enum
Default: EBIT
Possible Values:
Value
Description
TBIT
EBIT
MCBIT
NPBIT
EABIT
DCBIT
OBIT
1778
Ospfv2RouterConfig
Writable Attribute
Description
RetransmitInterval
Retransmit interval in seconds. The interval before which the application transmits the packet again if an LSA transmission
fails.
Type: u32
Default: 5
Range: 1 - 2147483647
RouterDeadInterval
Router Dead interval in seconds. The time interval that the emulated router waits to receive packets from the neighbor SUT
router before deleting that neighbor from its topology.
Type: u32
Default: 40
Range: 1 - 65535
RouterPriority
Type: u8
Default: 0
Range: 0 - 255
TeInfoPresent
Indicates if TE Information is available.

Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
TE Info is available.
FALSE TE Info is not available.

TeMetric
Traffic engineering metric. The traffic engineering metric of a link from the Spirent TestCenter port to the DUT. This becomes
TE Metrics in the Link TLV of the TE LSA originated by the emulated router.
Type: u32
Default: 0
Range: 0 - 2147483647

Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE

ViewRoutes
If enabled, the stack will start to collect routes/LSAs it receives from the peer. Then later if a "View Routes" command is
issued, the stack can send the stored routes for display.
Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
View routes is enabled.
FALSE View routes is disabled.
1779
Ospfv2RouterConfig
Ospfv2RouterConfig Read-Only Attributes

Read-Only
Attribute
Description
AdjacencyStatus
OSPFv2 Adjacency State.

Type: enum
Default: DOWN
Possible Values:
Value
Description
DOWN
Initial state of a neighbor conversation. It indicates that there has been no recent information received from the neighbor.
ATTEMPT
This state is only valid for neighbors attached to non-broadcast networks. It indicates that no recent information has been
received from the neighbor, but that a more concerted effort should be made to contact the neighbor. This is done by
sending the neighbor Hello packets at intervals of HelloInterval.
INIT
An Hello packet has recently been seen from the neighbor. However, bidirectional communication has not yet been
established with the neighbor (the router itself did not appear in the neighbor's Hello packet). All neighbors in this state
(or higher) are listed in the Hello packets sent from the associated interface.
TWOWAYS
Communication between the two routers is bidirectional. This has been assured by the operation of the Hello Protocol.
This is the most advanced state short of beginning adjacency establishment. The Backup Designated Router (BDR) is
selected from the set of neighbors in the TWOWAYS state or greater.
EXSTART
This is the first step in creating an adjacency between the two neighboring routers. The goal of this step is to decide which
router is the master, and to decide upon the initial database description (DD) sequence number. Neighbor conversations
in this state or greater are called adjacencies.
EXCHANGE In this state the router is describing its entire link state database by sending Database Description packets to the neighbor.
Each Database Description Packet has a DD sequence number, and is explicitly acknowledged. Only one Database
Description Packet is allowed outstanding at any one time. In this state, Link State Request Packets may also be sent
asking for the neighbor's more recent advertisements. All adjacencies in Exchange state or greater are used by the
flooding procedure. In fact, these adjacencies are fully capable of transmitting and receiving all types of OSPF routing
protocol packets.
NeighborState
LOADING
Link State Request packets are sent to the neighbor asking for the more recent advertisements that have been discovered
(but not yet received) in the Exchange state.
FULL
Neighboring routers are fully adjacent. These adjacencies will now appear in router links and network links advertisements.
OSPFv2 neighbor state.
Type: enum
Default: DOWN
Possible Values:
Value
Description
DOWN
Initial state of a neighbor conversation. It indicates that there has been no recent information received from the neighbor.
ATTEMPT
This state is only valid for neighbors attached to non-broadcast networks. It indicates that no recent information has been
received from the neighbor, but that a more concerted effort should be made to contact the neighbor. This is done by
sending the neighbor Hello packets at intervals of HelloInterval.
INIT
An Hello packet has recently been seen from the neighbor. However, bidirectional communication has not yet been
established with the neighbor (the router itself did not appear in the neighbor's Hello packet). All neighbors in this state
(or higher) are listed in the Hello packets sent from the associated interface.
TWOWAYS
Communication between the two routers is bidirectional. This has been assured by the operation of the Hello Protocol.
This is the most advanced state short of beginning adjacency establishment. The Backup Designated Router (BDR) is
selected from the set of neighbors in the TWOWAYS state or greater.
EXSTART
This is the first step in creating an adjacency between the two neighboring routers. The goal of this step is to decide which
router is the master, and to decide upon the initial database description (DD) sequence number. Neighbor conversations
in this state or greater are called adjacencies.
EXCHANGE In this state the router is describing its entire link state database by sending Database Description packets to the neighbor.
Each Database Description Packet has a DD sequence number, and is explicitly acknowledged. Only one Database
Description Packet is allowed outstanding at any one time. In this state, Link State Request Packets may also be sent
asking for the neighbor's more recent advertisements. All adjacencies in Exchange state or greater are used by the
flooding procedure. In fact, these adjacencies are fully capable of transmitting and receiving all types of OSPF routing
protocol packets.
LOADING
Link State Request packets are sent to the neighbor asking for the more recent advertisements that have been discovered
(but not yet received) in the Exchange state.
FULL
Neighboring routers are fully adjacent. These adjacencies will now appear in router links and network links advertisements.
1780
ospfv2RouterLsa
Read-Only
Attribute
Description
RouterState
Reports the state of adjacency on the current port.

Type: enum
Default: NONE
Possible Values:
Value
Description
NONE
Configuration information has not been sent to the card.
NO_OSPFV2
No OSPFv2.
DOWN
No recent information received from any device.
LOOPBACK
Loopback.
WAITING
Emulating router is treating the network as Broadcast and it has a non-zero router priority. The emulated
router will stay in this state until the end of the Designated Router election process.
POINT_TO_POINT
Emulated router is treating the network as point-to-point. There is no Designated Router election
process, so the emulated router goes to this state immediately.
DR_OTHER
Emulated router is treating the network as Broadcast. If the emulated router's priority is zero, it will
immediately switch to this state when it is started (because it cannot become either DR or Backup DR).
If the emulated router's priority is non-zero, it will switch to this state if other routers are elected DR
and Backup DR.
BACKUP
Emulated router is treating the network as Broadcast, it has a non-zero router priority, and it has been
elected the Backup Designated Router.
DR
Emulated router is treating the network as Broadcast, it has a non-zero router priority, and it has been
elected the Designated Router.
GR_BIT_MASK
The emulated router state is GR.
HLPR_BIT_MASK
The emulated router state is GR Helper.
STATE_BIT_MASK
No state.
GR_DOWN
The emulated router state is GR Down.
GR_LOOPBACK
The emulated router state is GR Loopback.
GR_WAITING
The emulated router state is GR Waiting.
GR_POINT_TO_POINT
The emulated router state is GR Point-to-Point.
GR_DR_OTHER
The emulated router state is GR DR Other.
GR_BACKUP
The emulated router state is GR Backup.
GR_DR
The emulated router state is GR DR.
HLPR_DOWN
The emulated router state is Helper Down.
HLPR_LOOPBACK
The emulated router state is Helper Loopback.
HLPR_WAITING
The emulated router state is Helper Waiting.
HLPR_POINT_TO_POINT
The emulated router state is Helper Point-to-Point.
HLPR_DR_OTHER
The emulated router state is Helper DR Other.
HLPR_BACKUP
The emulated router state is Helper Backup.
HLPR_DR
The emulated router state is Helper DR.
GR_HLPR_DOWN
The emulated router state is GR Helper Down.
GR_HLPR_LOOPBACK
The emulated router state is GR Helper Loopback.
GR_HLPR_WAITING
The emulated router state is GR Helper Waiting.
GR_HLPR_POINT_TO_POINT The emulated router state is GR Helper Point-to-Point.

GR_HLPR_DR_OTHER
The emulated router state is GR Helper DR Other.
GR_HLPR_BACKUP
The emulated router state is GR Helper backup.
GR_HLPR_DR
The emulated router state is GR Helper DR.
ospfv2RouterLsa
Description:
OSPFv2 router-LSA. See RFC 2328.
1781
Ospfv2RouterLsaLink
Parents: Ospfv2Lsa
Children: header, routerLsaLinks, routerLsaOptions
ospfv2RouterLsa Attributes
Attribute
Description
Name
Type: string
numberOfLinks
Type: INTEGER
Default: 0
routerLsaReserved1
Type: INTEGER
Default: 0
Ospfv2RouterLsaLink
Description:
Parents: routerLsaLinks
Children: routerLsaTosMetrics
Ospfv2RouterLsaLink Attributes
Attribute
Description
linkData
Type: IPV4ADDR
Default: 0.0.0.0
linkId
Type: IPV4ADDR
Default: 1.1.1.1
Name
Type: string
numRouterLsaTosMetrics
Type: INTEGER
Default: 0
routerLinkMetrics
Type: INTEGER
Default: 0
routerLsaLinkType
Type: Ospfv2RouterLsaLinkTypes
Default: 3
Possible Values:
Value Description
1
Point-to-Point
Transit
Stub
Virtual
1782
Ospfv2RouterLsaTosMetric
Ospfv2RouterLsaTosMetric
Description:
Parents: routerLsaTosMetrics
Children: None
Ospfv2RouterLsaTosMetric Attributes
Attribute
Description
Name
Type: string
routerLsaLinkType
Type: Ospfv2RouterLsaLinkTypes
Default: 1
Possible Values:
Value Description
1
Point-to-Point
Transit
Stub
Virtual
routerLsaMetricReserved
Type: INTEGER
Default: 0
routerTosLinkMetrics
Type: INTEGER
Default: 0
Ospfv2RouterResults
Description:
OSPFv2 router results.

Relations:
Side name
(Type)
Relative
Description
ResultParent
(ResultChild)
Ospfv2RouterConfig
Ospfv2RouterResults Writable Attributes

Ospfv2RouterResults Read-Only Attributes

Read-Only Attribute
Description
RxAck
Received Acks - Number of Link State Acknowledgment packets received by the emulated router.
Type: u64
Default: 0
1783
Ospfv2RouterResults
Read-Only Attribute
Description
RxAsbrSummaryLsa
Received ASBR-Summary-LSAs - Number of ASBR-Summary-LSAs received by the emulated router.

Type: u64
Default: 0
RxAsExternalLsa
Received External-LSAs - Number of External LSAs received by the emulated router.

Type: u64
Default: 0
RxDd
Received DD - Number of Database Description packets (containing LSA headers) received by the emulated router.
Type: u64
Default: 0
RxHello
Received Hellos - Number of Hello packets received by the emulated router.

Type: u64
Default: 0
RxNetworkLsa
Received Network-LSAs - Number of Network LSAs received by the emulated router.

Type: u64
Default: 0
RxNssaLsa
Received NSSA-LSAs - Number of NSSA LSAs received by the emulated router.

Type: u64
Default: 0
RxRequest
Received Requests - Number of LS Request packets received by the emulated router.

Type: u64
Default: 0
RxRouterLsa
Received Router-LSAs - Number of Router LSAs received by the emulated router.

Type: u64
Default: 0
RxSummaryLsa
Received Summary-LSAs - Number of Summary LSAs received by the emulated router.

Type: u64
Default: 0
RxTeLsa
Received TE-LSAs - Number of TE-LSAs received by the emulated router.

Type: u64
Default: 0
RxUpdate
Number of update messages received.

Type: u64
Default: 0
TxAck
Sent Acks - Number of Link State Acknowledgment packets sent by the emulated router.
Type: u64
Default: 0
TxAsbrSummaryLsa
Sent ASBR-Summary-LSAs - Number of ASBR-Summary LSAs sent by the emulated router.

Type: u64
Default: 0
TxAsExternalLsa
Sent External-LSAs - Number of External LSAs sent by the emulated router.

Type: u64
Default: 0
TxDd
Sent DD - Number of Database Description packets sent by the emulated router.

Type: u64
Default: 0
TxHello
Sent Hellos - Number of Hello packets sent by the emulated router.

Type: u64
Default: 0
TxNetworkLsa
Sent Network-LSAs - Number of Network LSAs sent by the emulated router.

Type: u64
Default: 0
1784
Ospfv2SharedSessionParams
Read-Only Attribute
Description
TxNssaLsa
Sent NSSA-LSAs - Number of NSSA LSAs sent by the emulated router.

Type: u64
Default: 0
TxRequest
Sent Requests - Number of LS Request packets sent by the emulated router.

Type: u64
Default: 0
TxRouterLsa
Sent Router-LSAs - Number of Router LSAs sent by the emulated router.

Type: u64
Default: 0
TxSummaryLsa
Sent Summary-LSAs - Number of Summary LSAs sent by the emulated router.

Type: u64
Default: 0
TxTeLsa
Sent TE-LSAs - Number of TE-LSAs sent by the emulated router.

Type: u64
Default: 0
TxUpdate
Number of update messages sent.

Type: u64
Default: 0
Description:
Defines the characteristics of an emulated OSPF version 2 router that will form an adjacency with the DUT. This is for the OSPFv2 wizard use.

Automatically-created children: Ospfv2AuthenticationParams
Ospfv2SharedSessionParams Writable Attributes

Writable Attribute
Description
Active, Name
AreaId
Area to which the emulated router belongs. It must match an area ID configured for the DUT to enable communication with
the DUT.
Type: ip
Default: 0.0.0.0
EnableBfd
Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
Enable BFD.
FALSE Disable BFD.
1785
Writable Attribute
Description

Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE

GracefulRestartType
Specifies the type of graceful restart.

Type: enum
Default: NONE
Possible Values:
Value
Description
NONE

LLSIGNALLING
IfCost
Interface Cost. The cost of the interface connecting the emulated router to the neighbor SUT router.
Type: u16
Default: 1
Range: 1 - 65535
NetworkType
Type: enum
Default: NATIVE
Possible Values:
Value
Description
NATIVE
Network type = Native (Default).
BROADCAST Network type = Broadcast.

P2P
Options
Network type = Point-to-point (P2P).
optional OSPF capabilities of the router. Section A.2 in RFC 2328 describes the Options field. Use hexadecimal for this value.
The default, 0x02, sets the E-bit (binary 00000010).
Type: enum
Default: EBIT
Possible Values:
Value
Description
TBIT
EBIT
MCBIT
NPBIT
EABIT
DCBIT
OBIT

RouterPriority
Type: u8
Default: 0
Range: 0 - 255
Ospfv2SharedSessionParams Read-Only Attributes

1786
Ospfv2ShutdownRouterCommand
Ospfv2ShutdownRouterCommand
Description:
Shut down router command. Stop sending Hello packets on selected OSPF routers, simulating router shutdown.

Ospfv2ShutdownRouterCommand Writable Attributes

Writable Attribute
Description
RouterList

Type: handle
Default: 0
Ospfv2ShutdownRouterCommand Read-Only Attributes

Read-Only Attribute
Description

Ospfv2StateSummary
Description:
OSPFv2 router states summarized at port and project level.

Relations:
Side name
(Type)
Relative
Description
ResultParent
(ResultChild)
Port, Project
Ospfv2StateSummary Writable Attributes

Ospfv2StateSummary Read-Only Attributes

Read-Only Attribute
Description
BackupCount
Number of OSPFv2 routers in backup state.

Type: u32
Default: 0
DownCount
Number of OSPFv2 routers in down state.

Type: u32
Default: 0
1787
Ospfv2StopHellosCommand
Read-Only Attribute
Description
DrCount
Number of OSPFv2 routers in Dr state.

Type: u32
Default: 0
DrOtherCount
Number of OSPFv2 routers in DrOther state.

Type: u32
Default: 0
P2PCount
Number of OSPFv2 routers in P2P state.

Type: u32
Default: 0
WaitingCount
Number of OSPFv2 routers in waiting state.

Type: u32
Default: 0
Description:
Stop sending OSPFv2 Hello packets.

Ospfv2StopHellosCommand Writable Attributes

Writable Attribute
Description
RouterList

Type: handle
Default: 0
Ospfv2StopHellosCommand Read-Only Attributes

Read-Only Attribute
Description

ospfv2SummaryAsbrLsa
Description:
OSPFv2 ASBR-summary-LSA. See RFC 2328.
Parents: Ospfv2Lsa
Children: header, summaryAdditionalMetrics
1788
ospfv2SummaryLsa
ospfv2SummaryAsbrLsa Attributes
Attribute
Description
Name
Type: string
networkMask
Type: IPV4ADDR
Default: 255.255.255.0
summaryLsaMetric
Type: INTEGER
Default: 0
summaryLsaReserved1
Type: INTEGER
Default: 0
ospfv2SummaryLsa
Description:
OSPFv2 summary-LSA. See RFC 2328.
Parents: Ospfv2Lsa
Children: header, summaryAdditionalMetrics
ospfv2SummaryLsa Attributes
Attribute
Description
Name
Type: string
networkMask
Type: IPV4ADDR
Default: 255.255.255.0
summaryLsaMetric
Type: INTEGER
Default: 0
summaryLsaReserved1
Type: INTEGER
Default: 0
Ospfv2SummaryLsaTosMetric
Description:
Parents: summaryAdditionalMetrics
Children: None
1789
Ospfv2TeParams
Ospfv2SummaryLsaTosMetric Attributes
Attribute
Description
Name
Type: string
routerTosLinkMetrics
Type: INTEGER
Default: 0
summaryLsaMetricReserved
Type: INTEGER
Default: 0
Ospfv2TeParams
Description:
Contains additional sub-TLVs for use in traffic engineering LSAs.
Ospfv2TeParams Writable Attributes

Writable Attribute
Description
BandwidthUnit
Specifies whether the bandwidth is in bits per second or bytes per second. This affects the following attributes:
TeMaxBandwidth, TeRsvrBandwidth, and TeUnRsvrBandwidth0 to TeUnRsvrBandwidth7.
Type: enum
Possible Values:
Value
Description
BITS_PER_SEC
Bandwidth is in bits per second.
BYTES_PER_SEC Bandwidth is in bytes per second.

SubTlv
Indicates which of the attributes on this object you want to use.

Type: enum
Default: NONE
Possible Values:
Value
Description
NONE
No attributes have been set.
GROUP
Administrative group sub-TLV (type 9). A Link TLV parameter. Four-octet bit mask. Each bit corresponds
to one administrative group assigned to the interface.
MAX_BW
Maximum bandwidth sub-TLV (type 6), in bytes per second.
MAX_RSV_BW Maximum reservable bandwidth sub-TLV (type 7), in bytes per second.
UNRESERVED Unreserved bandwidth sub-TLV (type 8), priority 0.
Attributes teUnRsvrBandwidth0 through teUnRsvrBandwidth7 configure the 8 priority levels.
TeGroup
LOCAL_IP
Local interface IP address sub-TLV (type 3). Specifies the IP address of the interface corresponding
to the current link.
REMOTE_IP
Remote interface IP address sub-TLV (type 4). Specifies the IP address of the neighbor's interface
corresponding to the current link.
Administrative group sub-TLV (type 9). Four-octet bit mask. Each bit corresponds to one administrative group assigned
to the interface.
Type: u32
Default: 1
Range: 1 - 4294967295
1790
Ospfv2TeParams
Writable Attribute
Description
TeLocalIpv4Addr
Local interface IP address sub-TLV (type 3). The IP address of the interface corresponding to the current link.
Type: ip
Default: 0.0.0.0
TeMaxBandwidth
Maximum bandwidth sub-TLV (type 6). This is the maximum bandwidth that can be used on the link. The BandwidthUnit
attribute controls whether this is in bits per second or bytes per second.
Type: u32
Default: 100000
Range: 1 - 2147483647
TeRemoteIpv4Addr
Remote interface IP address sub-TLV (type 4). The IP address of the neighbor's interface corresponding to the current
link.
Type: ip
Default: 0.0.0.0
TeRsvrBandwidth
Maximum reservable bandwidth sub-TLV (type 7). This is the maximum bandwidth that can be reserved on the link. The
BandwidthUnit attribute controls whether this is in bits per second or bytes per second.
Type: u32
Default: 100000
Range: 1 - 2147483647
TeUnRsvrBandwidth0
Priority 0 of the Unreserved Bandwidth sub-TLV (type 8).

TeUnRsvrBandwidth0 through TeUnRsvrBandwidth7 set the 8 priority levels of the Unreserved Bandwidth sub-TLV.
Each priority level specifies the amount of bandwidth not yet reserved at that priority level.
The BandwidthUnit attribute controls whether the values of these attributes are in bits per second or bytes per second.
Type: u32
Default: 100000
Range: 1 - 2147483647
TeUnRsvrBandwidth1
Priority 1 of the Unreserved Bandwidth sub-TLV.

Type: u32
Default: 100000
Range: 1 - 2147483647
TeUnRsvrBandwidth2

Type: u32
Default: 100000
Range: 1 - 2147483647
TeUnRsvrBandwidth3

Type: u32
Default: 100000
Range: 1 - 2147483647
TeUnRsvrBandwidth4

Type: u32
Default: 100000
Range: 1 - 2147483647
TeUnRsvrBandwidth5

Type: u32
Default: 100000
Range: 1 - 2147483647
TeUnRsvrBandwidth6

Type: u32
Default: 100000
Range: 1 - 2147483647
TeUnRsvrBandwidth7

Type: u32
Default: 100000
Range: 1 - 2147483647
Ospfv2TeParams Read-Only Attributes

1791
Ospfv2Unknown
Ospfv2Unknown (ospfv2:Ospfv2Unknown)
Description:
Children: header
Ospfv2Unknown Attributes
Attribute
Description
Name
information.
Type: string
Ospfv2ViewRoutesCommand
Description:
View OSPFv2 routes.

Ospfv2ViewRoutesCommand Writable Attributes

Writable Attribute
Description
FileName

Default: routes.txt
RouterList

Type: handle
Default: 0
Ospfv2ViewRoutesCommand Read-Only Attributes

Read-Only Attribute
Description

Description:
Set MaxAge on selected External LSAs in selected OSPFv3 area(s).

1792
Ospfv3AgeInterAreaPrefixLsaCommand
Ospfv3AgeExternalLsaCommand Writable Attributes

Writable Attribute
Description
CategoryFilter

Type: enum
Default: ANY
Possible Values:
Value
Description
UNDEFINED
Undefined routes.
PRIMARY
Primary routes.
SECONDARY Secondary routes.

UNIQUE
Unique routes.
ANY
Any route.
LsaList
LSA handle list.

Type: handle
Default: 0
PercentFilter

Type: double
Default: 100.0
Range: 0 - 100
PrefixFilter
Type: u8
Default: 0
Range: 0 - 128
RouteCategory

Type: enum
Default: ANY
Possible Values:
Value
Description
UNDEFINED
PRIMARY

UNIQUE
ANY
Ospfv3AgeExternalLsaCommand Read-Only Attributes

Read-Only Attribute
Description

Ospfv3AgeInterAreaPrefixLsaCommand
Description:
Set MaxAge on selected Inter-Area Prefix LSAs in selected OSPFv3 area(s).

1793
Ospfv3AgeInterAreaRouterLsaCommand
Ospfv3AgeInterAreaPrefixLsaCommand Writable Attributes

Writable Attribute
Description
CategoryFilter

Type: enum
Default: ANY
Possible Values:
Value
Description
UNDEFINED
Undefined routes.
PRIMARY
Primary routes.

UNIQUE
Unique routes.
ANY
Any route.
LsaList
LSA handle list.

Type: handle
Default: 0
PercentFilter

Type: double
Default: 100.0
Range: 0 - 100
PrefixFilter
Type: u8
Default: 0
Range: 0 - 128
RouteCategory

Type: enum
Default: ANY
Possible Values:
Value
Description
UNDEFINED
PRIMARY

UNIQUE
ANY
Ospfv3AgeInterAreaPrefixLsaCommand Read-Only Attributes

Read-Only Attribute
Description

Ospfv3AgeInterAreaRouterLsaCommand
Description:
Set MaxAge on selected Inter-Area Router LSAs in selected OSPFv3 area(s).

1794
Ospfv3AgeIntraAreaPrefixLsaCommand
Ospfv3AgeInterAreaRouterLsaCommand Writable Attributes

Writable Attribute
Description
CategoryFilter

Type: enum
Default: ANY
Possible Values:
Value
Description
UNDEFINED
Undefined routes.
PRIMARY
Primary routes.

UNIQUE
Unique routes.
ANY
Any route.
LsaList
LSA handle list.

Type: handle
Default: 0
PercentFilter

Type: double
Default: 100.0
Range: 0 - 100
PrefixFilter
Type: u8
Default: 0
Range: 0 - 128
RouteCategory

Type: enum
Default: ANY
Possible Values:
Value
Description
UNDEFINED
PRIMARY

UNIQUE
ANY
Ospfv3AgeInterAreaRouterLsaCommand Read-Only Attributes

Read-Only Attribute
Description

Ospfv3AgeIntraAreaPrefixLsaCommand
Description:
Set MaxAge on selected Intra-Area Prefix LSAs in selected OSPFv3 area(s).

1795
Ospfv3AgeLinkLsaCommand
Ospfv3AgeIntraAreaPrefixLsaCommand Writable Attributes

Writable Attribute
Description
CategoryFilter

Type: enum
Default: ANY
Possible Values:
Value
Description
UNDEFINED
Undefined routes.
PRIMARY
Primary routes.

UNIQUE
Unique routes.
ANY
Any route.
LsaList
LSA handle list.

Type: handle
Default: 0
PercentFilter

Type: double
Default: 100.0
Range: 0 - 100
PrefixFilter
Type: u8
Default: 0
Range: 0 - 128
RouteCategory

Type: enum
Default: ANY
Possible Values:
Value
Description
UNDEFINED
PRIMARY

UNIQUE
ANY
Ospfv3AgeIntraAreaPrefixLsaCommand Read-Only Attributes

Read-Only Attribute
Description

Ospfv3AgeLinkLsaCommand
Description:
Set MaxAge on selected Link LSAs in selected OSPFv3 area(s).

1796
Ospfv3AgeLinkLsaCommand Writable Attributes

Writable Attribute
Description
CategoryFilter

Type: enum
Default: ANY
Possible Values:
Value
Description
UNDEFINED
Undefined routes.
PRIMARY
Primary routes.

UNIQUE
Unique routes.
ANY
Any route.
LsaList
LSA handle list.

Type: handle
Default: 0
PercentFilter

Type: double
Default: 100.0
Range: 0 - 100
PrefixFilter
Type: u8
Default: 0
Range: 0 - 128
RouteCategory

Type: enum
Default: ANY
Possible Values:
Value
Description
UNDEFINED
PRIMARY

UNIQUE
ANY
Ospfv3AgeLinkLsaCommand Read-Only Attributes

Read-Only Attribute
Description

Description:
Set MaxAge on selected Network LSAs. SUT will flush the LSAs from its database.

1797
Ospfv3AgeNssaLsaCommand
Ospfv3AgeNetworkLsaCommand Writable Attributes

Writable Attribute
Description
CategoryFilter

Type: enum
Default: ANY
Possible Values:
Value
Description
UNDEFINED
Undefined routes.
PRIMARY
Primary routes.

UNIQUE
Unique routes.
ANY
Any route.
LsaList
LSA handle list.

Type: handle
Default: 0
PercentFilter

Type: double
Default: 100.0
Range: 0 - 100
PrefixFilter
Type: u8
Default: 0
Range: 0 - 128
Ospfv3AgeNetworkLsaCommand Read-Only Attributes

Read-Only Attribute
Description

Ospfv3AgeNssaLsaCommand
Description:
Set MaxAge on selected NSSA LSAs in selected OSPFv3 area(s).

Ospfv3AgeNssaLsaCommand Writable Attributes

Writable Attribute
Description
1798
Writable Attribute
Description
CategoryFilter

Type: enum
Default: ANY
Possible Values:
Value
Description
UNDEFINED
Undefined routes.
PRIMARY
Primary routes.

UNIQUE
Unique routes.
ANY
Any route.
LsaList
LSA handle list.

Type: handle
Default: 0
PercentFilter

Type: double
Default: 100.0
Range: 0 - 100
PrefixFilter
Type: u8
Default: 0
Range: 0 - 128
RouteCategory

Type: enum
Default: ANY
Possible Values:
Value
Description
UNDEFINED
PRIMARY

UNIQUE
ANY
Ospfv3AgeNssaLsaCommand Read-Only Attributes

Read-Only Attribute
Description

Description:
Set MaxAge on selected Router LSAs. SUT will flush the LSAs from its database.

1799
Ospfv3AsExternalLsaBlock
Ospfv3AgeRouterLsaCommand Writable Attributes

Writable Attribute
Description
CategoryFilter

Type: enum
Default: ANY
Possible Values:
Value
Description
UNDEFINED
Undefined routes.
PRIMARY
Primary routes.

UNIQUE
Unique routes.
ANY
Any route.
LsaList
LSA handle list.

Type: handle
Default: 0
PercentFilter

Type: double
Default: 100.0
Range: 0 - 100
PrefixFilter
Type: u8
Default: 0
Range: 0 - 128
Ospfv3AgeRouterLsaCommand Read-Only Attributes

Read-Only Attribute
Description

Description:
Object that represents AS-External Prefix LSA attributes.

Ospfv3AsExternalLsaBlock Writable Attributes

Writable Attribute
Description
AdminTag
Administrative tag.
Type: u32
Default: 0
AdvertisingRouterId
Specifies the simulated router that will advertise Prefix LSAs.

Type: ip
Default: null
1800
Writable Attribute
Description
Age
Initial value of LS Age in an LSA header.

Type: u16
Default: 0
Range: 0 - 3600
CheckSum
Specifies the LSA will be advertised with a good or a bad checksum. A bad checksum indicates a corrupted LSA and is used
for negative testing.
Type: enum
Default: GOOD
Possible Values:
Value Description
BAD

ForwardingAddr
IPv6 address. If this is included, all data traffic to the advertised routes will be forwarded to this address.
Type: ipv6
Default: null
LinkStateId
LSA identifier, chosen arbitrarily by the advertising router.

Type: u32
Default: 0
LsType
Type of LSA advertised.

Type: enum
Default: NONE
Possible Values:
Value
Description
NONE
None.
ROUTER_LSA
Router LSA.
NETWORK_LSA
Network LSA.
INTER_AREA_PREFIX_LSA
Inter Area Prefix LSA.
INTER_AREA_ROUTER_LSA Inter Area Router LSA.

AS_EXT_LSA
As External LSA.
NSSA_LSA
NSSA LSA.
LINK_LSA
Link LSA.
INTRA_AREA_PREFIX_LSA
Intra Area Prefix LSA.
Metric
Cost of the advertised route.

Type: u32
Default: 1
Range: 1 - 16777215
MetricType
Indicates whether the route's cost should be included in the SPF calculation.
Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
Metric is considered larger than any intra-AS path.
FALSE Metric is expressed in the same units as interface cost.
1801
Writable Attribute
Description
PrefixOptions
This is a bit mask that describes the capabilities of the advertised prefix. The prefix options you set with this attribute will be
used for every prefix in the LSA.
See RFC 2740 for more information.
Type: enum
Default: 0
Possible Values:
Value
Description
NUBIT
NU (NU, Bit 1) - No Unicast capability bit. If set, the prefix is excluded from IPv6 unicast calculations.
LABIT
LA (LA, Bit 0) - Local Address capability bit. If set, the prefix becomes an IPv6 interface address of the advertising
router.
MCBIT
Multicast (MC, Bit 2) - Multicast capability bit. If set, the prefix is included in the IPv6 multicast calculations.
PBIT
NSSA (N/P, 3) - The "P" bit or "Propagate" bit. Set this on the NSSA area prefixes that should be readvertised
at the NSSA border.
UNUSED4 Unused bit.

UNUSED5 Unused bit.
UNUSED6 Unused bit.
UNUSED7 Unused bit.
RefLinkStateId
Specifies the LS ID of LSA that carries additional information for the advertised route.
Type: u32
Default: 0
RefLsType
Specifies the type of referenced LSA.

Type: u16
Default: 0
Range: 0 - 0xffff
RouteCategory

Type: enum
Default: UNDEFINED
Possible Values:
Value
Description
UNDEFINED
Category not defined. The default category assigned to a manually created block.
PRIMARY
Primary - a preferred route that has duplicates (secondary routes) advertised by other ports.
SECONDARY Secondary - a less preferred backup route.
SeqNum
UNIQUE
Unique - indicates that a single port in the test configuration advertises this route.
ANY
Any route.
Initial value of the LS Sequence Number in an LSA header.

Type: u32
Default: 0x80000001
Ospfv3AsExternalLsaBlock Read-Only Attributes

Description:
Attached router.

Parents: Ospfv3NetworkLsa
1802
Ospfv3AttachedRouter Writable Attributes

Writable Attribute
Description
Active, Name
RouterId
Router ID of the attached router.

Type: ip
Default: 0.0.0.0
Ospfv3AttachedRouter Read-Only Attributes

Description:
Specifies the OSPFv3-specific router generator parameters.

Ospfv3DeviceGenProtocolParams Writable Attributes

Writable Attribute
Description
Active, Name
AreaId

Type: ip
Default: 0.0.0.0
EnableBfd

Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
Enable BFD.
FALSE Disable BFD.

NetworkType
Network type. This setting is used to override the physical link type to emulate a P2P adjacency over Ethernet (VLAN) or
Type: enum
Default: NATIVE
Possible Values:
Value
Description
NATIVE
Native mode uses the network type determined from the type of the interface.
BROADCAST Broadcast mode.

P2P
Point-to-point (P2P) mode.
1803
Ospfv3GlobalConfig
Writable Attribute
Description
Options
Specifies the optional OSPF capabilities of the router. Each option represents one bit.
Type: enum
Default: V6BIT | RBIT | EBIT
Possible Values:
Value Description
V6BIT V6: if bit clear, the router/link should be excluded from IPv6 routing calculations (V, Bit 0).
EBIT
External Routing: specifies the way AS-external-LSAs are flooded (E, Bit 1).
MCBIT Multicast: specifies whether IP multicast datagrams are forwarded according to the specification in RFC 1586 (MC,
Bit 2).
NBIT
NSSA: describes the handling of Type-y LSA as specified in RFC 1584 (N/P, Bit 3).
RBIT
Router: specifies whether the originator is an active router. If clear, routers that transmit the advertising none cannot
be computed. (R, Bit 4).
DCBIT Demand Circuit: specifies how the router handles demand circuits (DC, Bit 5).
RouterPriority
Router priority of the emulated router. Set the router priority to a higher or lower value to influence the DR and Backup DR
selection process.
Type: u8
Default: 0
Range: 0 - 255
Ospfv3DeviceGenProtocolParams Read-Only Attributes

Ospfv3GlobalConfig
Description:
Global values for OSPFv3 router configuration. Attribute settings at the profile level take precedence over the global settings.

Parents: Project
Ospfv3GlobalConfig Writable Attributes

Writable Attribute
Description
Active, Name
EnableSequentialStartup
Sequential startup limits the number of OSPFv2 routers started simultaneously to the number specified by
SimultaneousSequentialStartupCount. As each router becomes fully adjacent, the next router in the startup
list is started. This reduces the CPU load during startup and may reduce test start time.
Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
Start routers sequentially.
FALSE Start routers simultaneously.

EnableUpdateThrottling
Acknowledges LS Update packets with minimal verification to reduce the likelihood of a retransmit flood from
the DUT.
Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
Perform quick acknowledges.
FALSE Do not perform quick acknowledges.
1804
Ospfv3InterAreaPrefixLsaBlk
Writable Attribute
Description
SimultaneousSequentialStartupCount
Specifies the number of routers to start simultaneously when Sequential Startup is enabled.
Type: u16
Default: 20
Range: 1 - 255
Ospfv3GlobalConfig Read-Only Attributes

Ospfv3InterAreaPrefixLsaBlk
Description:
Represents Inter Area Prefix LSA Block attributes.

Ospfv3InterAreaPrefixLsaBlk Writable Attributes

Writable Attribute
Description
AdvertisingRouterId
Simulated router that will advertise Prefix LSAs.

Type: ip
Default: null
Age

Type: u16
Default: 0
Range: 0 - 3600
CheckSum
Type: enum
Default: GOOD
Possible Values:
Value Description
BAD

LinkStateId

Type: u32
Default: 0
Metric

Type: u32
Default: 1
Range: 1 - 16777215
1805
Ospfv3InterAreaRouterLsaBlock
Writable Attribute
Description
PrefixOptions
8- bit field of capabilities advertised with each prefix.

Type: enum
Default: 0
Possible Values:
Value
Description
NUBIT
LABIT
router.
MCBIT
PBIT
at the NSSA border.
UNUSED4 Unused bit.

UNUSED5 Unused bit.
UNUSED6 Unused bit.
UNUSED7 Unused bit.
RefLsType

Type: u16
Default: 0
Range: 0 - 9999
RouteCategory

Type: enum
Default: UNDEFINED
Possible Values:
Value
Description
UNDEFINED
Undefined. The default category assigned to a manually created block.
PRIMARY
Primary. A preferred route that has duplicates (secondary routes) advertised by other ports.
SECONDARY Secondary. A less preferred backup route.
SeqNum
UNIQUE
Unique. Indicates that a single port in the test configuration advertises this route.
ANY
Any route.

Type: u32
Default: 0x80000001
Ospfv3InterAreaPrefixLsaBlk Read-Only Attributes

Description:
Represents Inter Area Router LSA block attributes.

1806
Ospfv3InterAreaRouterLsaBlock Writable Attributes

Writable Attribute
Description
AdvertisingRouterId

Type: ip
Default: null
Age

Type: u16
Default: 0
Range: 0 - 3600
AsbrRouterId
Router ID for the emulated Autonomous System Boundary Router.

Type: ip
Default: 0.0.0.0
CheckSum
Type: enum
Default: GOOD
Possible Values:
Value Description
BAD

LinkStateId

Type: u32
Default: 0
Metric
Route-cost metric to be used when advertising the specified Inter-Area LSAs.

Type: u32
Default: 1
Range: 1 - 16777215
1807
Ospfv3IntraAreaPrefixLsaBlk
Writable Attribute
Description
Options
OSPFv3 Options - Each option represents one bit.

Type: enum
Possible Values:
Value
Description
V6BIT
V6 (V, 0).
EBIT
External Routing (E,1).
MCBIT
Multicast (MC, 2).
NBIT
NSSA (N/P, 3).
RBIT
Router (R, 4).
DCBIT
Demand Circuit (DC, 5).
UNUSED6
Unused (Bit 6).
UNUSED7
Unused (Bit 7).
UNUSED8
Unused (Bit 8).
UNUSED9
Unused (Bit 9).
UNUSED10 Unused (Bit 10).

RouteCategory

Type: enum
Default: UNDEFINED
Possible Values:
Value
Description
UNDEFINED
PRIMARY
SeqNum
UNIQUE
ANY
Any route.

Type: u32
Default: 0x80000001
Ospfv3InterAreaRouterLsaBlock Read-Only Attributes

1808
Description:
Represents Intra Area Prefix LSA Block attributes.

Ospfv3IntraAreaPrefixLsaBlk Writable Attributes

Writable Attribute
Description
AdvertisingRouterId

Type: ip
Default: null
Age

Type: u16
Default: 0
Range: 0 - 3600
CheckSum
Specifies the LSA will be advertised with a good or a bad checksum. A bad checksum indicates a corrupted LSA and is
used for negative testing.
Type: enum
Default: GOOD
Possible Values:
Value Description
BAD

LinkStateId

Type: u32
Default: 0
PrefixMetric

Type: u16
Default: 1
Range: 1 - 65535
PrefixOptions
8-bit field of capabilities advertised with each prefix. You can use more than one of the values, as in this example:
NUBIT | LABIT | MCBIT
Type: enum
Default: 0
Possible Values:
Value
Description
NUBIT
LABIT
LA (LA, Bit 0) - Local Address capability bit. If set, the prefix becomes an IPv6 interface address of the
advertising router.
MCBIT
PBIT
at the NSSA border.
UNUSED4 Unused bit.

UNUSED5 Unused bit.
UNUSED6 Unused bit.
UNUSED7 Unused bit.
RefAdvertisingRouterId
Specifies the Router ID of the router that originated the LSA or the Designated Router.
Type: ip
Default: 0.0.0.0
RefLinkStateId
Specifies LS ID of LSA that carries additional information for the advertised route.
Type: u32
Default: 0
1809
Ospfv3LinkLsaBlk
Writable Attribute
Description
RefLsType

Type: u16
Default: 0
Range: 0 - 9999
RouteCategory

Type: enum
Default: UNDEFINED
Possible Values:
Value
Description
UNDEFINED
PRIMARY
SeqNum
UNIQUE
ANY
Any route.

Type: u32
Default: 0x80000001
Ospfv3IntraAreaPrefixLsaBlk Read-Only Attributes

Ospfv3LinkLsaBlk
Description:
Represents a Link LSA Block.

Ospfv3LinkLsaBlk Writable Attributes

Writable Attribute
Description
AdvertisingRouterId

Type: ip
Default: null
Age

Type: u16
Default: 0
Range: 0 - 3600
CheckSum
Specifies the LSA will be advertised with a good or a bad checksum. A bad checksum indicates a corrupted LSA and is used for
negative testing.
Type: enum
Default: GOOD
Possible Values:
Value Description
BAD
1810
Ospfv3LinkLsaBlk
Writable Attribute
Description
LinkLocalIfAddr
IPv6 address of the emulated router's link.

Type: ipv6
Default: FE80::1
LinkStateId

Type: u32
Default: 0
Options
OSPFv3 Options. Each option represents one bit.

Type: enum
Possible Values:
Value
Description
V6BIT
V6: if bit clear, the router/link should be excluded from IPv6 routing calculations (V, Bit 0).
EBIT
MCBIT
Multicast: specifies whether IP multicast datagrams are forwarded according to the specification in RFC 1586 (MC,
Bit 2).
NBIT
RBIT
DCBIT
Demand Circuit: specifies how the router handles demand circuits (DC, Bit 5).
UNUSED6
Unused (Bit 6).
UNUSED7
Unused (Bit 7).
UNUSED8
Unused (Bit 8).
UNUSED9
Unused (Bit 9).

PrefixOptions
8-bit field of capabilities advertised with each prefix.

Type: enum
Default: 0
Possible Values:
Value
Description
NUBIT
LABIT
router.
MCBIT
PBIT
NSSA (N/P, 3) - The "P" bit or "Propagate" bit. Set this on the NSSA area prefixes that should be readvertised at
the NSSA border.
UNUSED4 Unused bit.

UNUSED5 Unused bit.
UNUSED6 Unused bit.
UNUSED7 Unused bit.
1811
Ospfv3LsaGenParams
Writable Attribute
Description
RouteCategory

Type: enum
Default: UNDEFINED
Possible Values:
Value
Description
UNDEFINED
PRIMARY

UNIQUE
ANY
Any route.
RouterPriority
Router priority of the emulated router. You can set the router priority to a higher or lower value to influence the DR and Backup
DR selection process.
Type: u8
Default: 0
Range: 0 - 255
SeqNum

Type: u32
Default: 0x80000001
Ospfv3LinkLsaBlk Read-Only Attributes

Ospfv3LsaGenParams
Description:
OSPFv3 LSA generator parameters.

Parents: Project
Relations:
Side name
(Type)
Relative
Description
EmulatedDevice
Router or routers that LSAs will be generated on.
Ospfv3LsaGenParams Writable Attributes

Writable Attribute
Description
Active, Name
1812
Writable Attribute
Description
AreaType
Determines the type of LSAs that are flooded within the area and the options that are set on the LSAs.
Type: enum
Default: REGULAR
Possible Values:
Value
Description
REGULAR
REGULAR (Normal) areas support all LSA types. External routes are advertised as Type 5 LSAs.
Options are set to 0x13 (v6, external, and router bits enabled).
STUB
STUB areas do not flood external routes into the area. Routing to external destinations is based
on default routes advertised by the area border routers. This keeps the link-state database in stub
areas as small as possible. Options are set to 0x11 (v6, router bits set).
STUB_NO_SUMMARY STUB_NO_SUMMARY (Totally stubby) areas are similar to stub areas, however they do not support
summary inter-area LSAs in addition to external route LSAs. This further reduces the size of the
link-state database for the area. Options are set to 0x11 (v6, router bits set).
NSSA
NSSA (Not-So-Stubby-Areas) areas are similar to stub areas (type 5 external route LSAs are not
flooded into the area) however, they distribute external route information within the area using type
7 NSSA LSAs. NSSA LSAs are converted to type 5 external route LSAs at the NSSA border. Options
set to 0x11 (v6, router bits sets).
NSSA_NO_SUMMARY NSSA_NO_SUMMARY (Totally Not-So-Stubby-Areas) areas are similar to NSSA areas, however
they do not support summary inter-area LSAs in addition to external route LSAs.
IpAddrEnd
Global/default ending IP address value used for routes and interface addresses.
Type: ipv6
Default: 3ffe::
IpAddrStart
Global/default starting IP address value used for routes and interface addresses.
Type: ipv6
Default: 2000::
RouterIdStart
First router to be used.

Type: ip
Default: 1.0.0.1
RouterIdStep
All subsequent router IDs will be incremented by this number.

Type: ip
Default: 0.0.0.1
Ospfv3LsaGenParams Read-Only Attributes

Description:
OSPFv3 specific route attribute parameters.

Ospfv3LsaGenRouteAttrParams Writable Attributes

Writable Attribute
Description
Active, Name
PrimaryMetric
OSPF route metric used for primary routes.

Type: u16
Default: 1
Range: 1 - 65535
1813
Ospfv3NetworkLsa
Writable Attribute
Description
RouteType
OSPFv3 route type.

Type: enum
Default: EXTERNAL
Possible Values:
Value
Description
INTERAREA Inter-area route.
INTRAAREA Intra-area route.
EXTERNAL
SecondaryMetric
External route.
OSPF route metric used for secondary routes.

Type: u16
Default: 2
Range: 1 - 65535
Ospfv3LsaGenRouteAttrParams Read-Only Attributes

Ospfv3NetworkLsa
Description:
Represents router LSA attributes. OSPFv3 Network LSAs, sent by network DRs, describe aggregated (network-wide) link-state information for all routers in
the attached network. This information is flooded only within the originating area.

Children: Ospfv3AttachedRouter
Ospfv3NetworkLsa Writable Attributes

Writable Attribute
Description
AdvertisingRouterId
Simulated router that will advertise this LSA.

Type: ip
Default: null
Age

Type: u16
Default: 0
Range: 0 - 3600
CheckSum
Specifies whether the LSA will be advertised with a good or bad checksum. A bad checksum indicates a corrupted LSA and is
Type: enum
Default: GOOD
Possible Values:
Value Description
BAD

LinkStateId
ID of the interface connected to the transit network.

Type: u32
Default: 0
1814
Ospfv3NetworkLsa
Writable Attribute
Description
Options
See Section A.2 in RFC 2740 for more information about the options field.
Type: enum
Possible Values:
Value
Description
V6BIT
EBIT
MCBIT
Bit 2).
NBIT
RBIT
DCBIT
UNUSED6
Unused (Bit 6).
UNUSED7
Unused (Bit 7).
UNUSED8
Unused (Bit 8).
UNUSED9
Unused (Bit 9).

RouteCategory

Type: enum
Default: UNDEFINED
Possible Values:
Value
Description
UNDEFINED
PRIMARY
Primary route.
SeqNum
UNIQUE
Unique route.
ANY
Any route.

Type: u32
Default: 0x80000001
Ospfv3NetworkLsa Read-Only Attributes

1815
Ospfv3NssaLsaBlock
Ospfv3NssaLsaBlock
Description:
Represents an NSSA (Not-So-Stubby-Areas) LSA.

Ospfv3NssaLsaBlock Writable Attributes

Writable Attribute
Description
AdminTag
Administrative tag.
Type: u32
Default: 0
AdvertisingRouterId

Type: ip
Default: null
Age

Type: u16
Default: 0
Range: 0 - 3600
CheckSum
Type: enum
Default: GOOD
Possible Values:
Value Description
BAD

ForwardingAddr
IPv6 address. If this is included, all data traffic to the advertised routes will be forwarded to this address.
Type: ipv6
Default: null
LinkStateId

Type: u32
Default: 0
LsType
Type of LSA advertised.

Type: enum
Default: NONE
Possible Values:
Value
Description
NONE
None.
ROUTER_LSA
Router LSA.
NETWORK_LSA
Network LSA.
INTER_AREA_PREFIX_LSA
Inter Area Prefix LSA.
INTER_AREA_ROUTER_LSA Inter Area Router LSA.
Metric
AS_EXT_LSA
AS External LSA.
NSSA_LSA
NSSA LSA.
LINK_LSA
Link LSA.
INTRA_AREA_PREFIX_LSA
Intra Area Prefix LSA.

Type: u32
Default: 1
Range: 1 - 16777215
1816
Writable Attribute
Description
MetricType
Indicates whether the route's cost should be included in the SPF calculation.
Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
Metric is considered larger than any intra-AS path.
FALSE Metric is expressed in the same units as interface cost.

PrefixOptions
8- Bit field of capabilities advertised with each prefix.

Type: enum
Default: 0
Possible Values:
Value
Description
NUBIT
LABIT
router.
MCBIT
PBIT
at the NSSA border.
UNUSED4 Unused bit.

UNUSED5 Unused bit.
UNUSED6 Unused bit.
UNUSED7 Unused bit.
RefLinkStateId
Specifies LS ID of LSA that carries additional information for the advertised route.
Type: u32
Default: 0
RefLsType

Type: u16
Default: 0
Range: 0 - 0xffff
RouteCategory

Type: enum
Default: UNDEFINED
Possible Values:
Value
Description
UNDEFINED
PRIMARY
SeqNum
UNIQUE
ANY
Any route.

Type: u32
Default: 0x80000001
Ospfv3NssaLsaBlock Read-Only Attributes

Description:
1817
Ospfv3RemoveIfCommand
Readvertise all LSAs to all or selected OSPFv3 areas.

Ospfv3ReadvertiseLsaCommand Writable Attributes

Writable Attribute
Description
RouterList
Router handle list.

Type: handle
Default: 0
Ospfv3ReadvertiseLsaCommand Read-Only Attributes

Read-Only Attribute
Description

Ospfv3RemoveIfCommand
Description:
Remove the selected interface from the Router-LSA and advertise the modified Router-LSA to the SUT.

Ospfv3RemoveIfCommand Writable Attributes

Writable Attribute
Description
LsaLinkList
Link handle list.

Type: handle
Default: 0
Ospfv3RemoveIfCommand Read-Only Attributes

Read-Only Attribute
Description

Ospfv3RemoveRouterIdCommand
Description:
Remove the selected router ID from the Network-LSA and advertise the modified Network-LSA to the SUT.
1818
Ospfv3RestoreRoutersCommand

Ospfv3RemoveRouterIdCommand Writable Attributes

Writable Attribute
Description
LsaLinkList
Link handle list.

Type: handle
Default: 0
Ospfv3RemoveRouterIdCommand Read-Only Attributes

Read-Only Attribute
Description

Ospfv3RestoreRoutersCommand
Description:
Resume sending Hello packets on selected OSPFv3 router(s) and request all LSAs from SUT as if the emulated router has been restarted and its database
has been cleared.

Ospfv3RestoreRoutersCommand Writable Attributes

Writable Attribute
Description
RouterList
Router handle list.

Type: handle
Default: 0
Ospfv3RestoreRoutersCommand Read-Only Attributes

Read-Only Attribute
Description

Ospfv3ResumeHellosCommand
Description:
Resume sending OSPFv3 Hello packets.
1819
Ospfv3RouterConfig

Ospfv3ResumeHellosCommand Writable Attributes

Writable Attribute
Description
RouterList
Router handle list.

Type: handle
Default: 0
Ospfv3ResumeHellosCommand Read-Only Attributes

Read-Only Attribute
Description

Ospfv3RouterConfig
Description:
Defines the characteristics of an emulated OSPF version 3 router that will form an adjacency with the DUT.
If an Ospfv3RouterConfig object has other LSAs to advertise, you need to create a child Ospfv3RouterLsa under it.

Children: Ospfv3AsExternalLsaBlock, Ospfv3InterAreaPrefixLsaBlk, Ospfv3InterAreaRouterLsaBlock, Ospfv3IntraAreaPrefixLsaBlk, Ospfv3LinkLsaBlk,
Ospfv3NetworkLsa, Ospfv3NssaLsaBlock, Ospfv3RouterLsa
Result children (automatically created): Ospfv3RouterResults
Relations:
Side name
(Type)
Relative
Description
ResultChild
(ResultChild)
Ospfv3RouterResults
UsesIf
(UsesIf)


Ospfv3RouterConfig Writable Attributes

Writable Attribute
Description
Active, Name
1820
Ospfv3RouterConfig
Writable Attribute
Description
Advertise
Specifies which LSAs this emulated router advertises.

Type: enum
Default: ALL_LSAS
Possible Values:
Value
Description
REACHABLE_LSAS Router advertises only the routers it can reach through the simulated topology.
ALL_LSAS
Router advertises all LSAs in the area.
AreaId

To enable communication with the DUT, it must match an area ID configured for the DUT.
Type: ip
Default: 0.0.0.0
EnableBfd
Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
Enable BFD.
FALSE Disable BFD.

FloodDelay
Flood interval parameter to control the rate at which LSAs are generated by each emulated OSPF router (that is, inter-LSA
delay).
Type: u32
Default: 100
Range: 20 - 2147483647
GuaranteeDelivery
Determines how LSA configuration changes are handled.

Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
Protocol will transmit LSA configuration changes in one or more LS Update packets. The protocol will wait for
acknowledgement or the Retransmit Interval before sending the next packet.
FALSE Protocol will transmit LSA configuration changes in one or more LS Update packets separated by the interval defined
in the Flood Delay field. The protocol will not wait for acknowledgement before sending the next packet.
HelloInterval
Time interval used by the emulated routers to pace Hello packet transmissions.
Type: u16
Default: 10
Range: 1 - 65535
IfCost
Cost of the interface connecting the emulated router to the neighbor SUT router.
Type: u16
Default: 1
Range: 1 - 65535
IfId
Interface ID - The Interface ID is used in the Router, Network, and Link LSAs to describe the link between the DUT and the
emulated router. Used as the source address for OSPFv3 packets to identify the interface advertising the routes.
Type: u32
Default: 0
InstanceId
Identifies the OSPFv3 protocol instance. The Instance ID allows multiple independent OSPFv3 adjacencies to be established
over the same physical link. Each of these independent adjacencies must have a unique Instance ID.
Type: u8
Default: 0
Range: 0 - 255
LsaRefreshInterval
Time interval used to refresh the LS database to the neighbor SUT router.
Type: u16
Default: 1800
Range: 10 - 21600
1821
Ospfv3RouterConfig
Writable Attribute
Description
NetworkType
Setting to override the physical link type to emulate a PtP adjacency over Ethernet or over Ethernet VLANs.
Type: enum
Default: NATIVE
Possible Values:
Value
Description
NATIVE
Defined by the physical interface type (Broadcast adjacency on Ethernet port).
BROADCAST Adjacency is Broadcast, regardless of port type.

P2P
Options
Adjacency is Point-to-Point.
Type: enum
Possible Values:
Value
Description
V6BIT
EBIT
MCBIT
Multicast: specifies whether IP multicast datagrams are forwarded according to the specification in RFC 1586
(MC, Bit 2).
NBIT
RBIT
Router: specifies whether the originator is an active router. If clear, routers that transmit the advertising none
cannot be computed. (R, Bit 4).
DCBIT
UNUSED6
Unused (Bit 6).
UNUSED7
Unused (Bit 7).
UNUSED8
Unused (Bit 8).
UNUSED9
Unused (Bit 9).

RetransmitInterval
Wait the duration of the retransmit interval before re-transmitting the packet if an LSA transmission fails.
Type: u16
Default: 5
Range: 1 - 65535
RouterDeadInterval
Time interval that the emulated router waits to receive packets from the neighbor SUT router before deleting that neighbor
from its topology.
Type: u16
Default: 40
Range: 1 - 65535
RouterPriority
Router priority of the emulated router. Set the router priority to a higher or lower value to influence the DR and Backup DR
selection process.
Type: u8
Default: 0
Range: 0 - 255
1822
Ospfv3RouterConfig
Writable Attribute
Description
StateMachineMaxLoad
Type: bool
Default: TRUE
Possible Values:
Value Description
TRUE
FALSE

Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
Ospfv3RouterConfig Read-Only Attributes

Read-Only
Attribute
Description
AdjacencyStatus
State of adjacency with the DUT.

Type: enum
Default: DOWN
Possible Values:
Value
Description
DOWN
ATTEMPT
No recent information received from the neighbor - escalate effort to contact. Valid only for neighbors attached to a NBMA
network.
INIT
Router interface has detected a hello packet recently sent by a neighbor. Because the router did not appear in the
neighbor's Hello packet, bidirectional communication has not been established. All neighbors in this state (or higher) are
listed in the Hello packets sent from the associated interface.
TWOWAYS
Bidirectional communication with a neighbor has been established. The Backup Designated Router is selected from the
set of neighbors in state two-way or higher.
EXSTART
First step in establishing adjacency between neighbors. Routers decide which will be master, and decide upon the initial
Database Description (DD) sequence number. The sequence number ensures that routers always get the most recent
information. Neighbor conversations in this state, or higher, are called adjacencies.
EXCHANGE Router is describing its entire link-state database by sending DD packets to the neighbor. Each DD packet has a DD
sequence number and is explicitly acknowledged. Only one DD packet can be outstanding at any given time. The router
may also send Link-state Request Packets asking for the neighbor's more recent LSAs. All adjacencies in the Exchange
state, or greater, are used by the flooding procedure. These adjacencies are capable of transmitting and receiving all
types of OSPF routing protocol packets.
LOADING
If not initiated in the Exchange state, the router sends Link-state Request Packets asking for the neighbor's more recent
LSAs that have been discovered, but not yet received in the Exchange state.
FULL
Neighboring routers are fully adjacent. These adjacencies will now appear in router LSAs and in network LSAs.
1823
Ospfv3RouterLsa
Read-Only
Attribute
Description
NeighborState
State of the neighbor router.
Type: enum
Default: DOWN
Possible Values:
Value
Description
DOWN
ATTEMPT
No recent information received from the neighbor - escalate effort to contact. Valid only for neighbors attached to a NBMA
network.
INIT
Router interface has detected a hello packet recently sent by a neighbor. Because the router did not appear in the
neighbor's Hello packet, bidirectional communication has not been established. All neighbors in this state (or higher) are
listed in the Hello packets sent from the associated interface.
TWOWAYS
Bidirectional communication with a neighbor has been established. The Backup Designated Router is selected from the
set of neighbors in state two-way or higher.
EXSTART
First step in establishing adjacency between neighbors. Routers decide which will be master, and decide upon the initial
Database Description (DD) sequence number. The sequence number ensures that routers always get the most recent
information. Neighbor conversations in this state, or higher, are called adjacencies.
EXCHANGE Router is describing its entire link-state database by sending DD packets to the neighbor. Each DD packet has a DD
sequence number and is explicitly acknowledged. Only one DD packet can be outstanding at any given time. The router
may also send Link-state Request Packets asking for the neighbor's more recent LSAs. All adjacencies in the Exchange
state, or greater, are used by the flooding procedure. These adjacencies are capable of transmitting and receiving all
types of OSPF routing protocol packets.
RouterState
LOADING
If not initiated in the Exchange state, the router sends Link-state Request Packets asking for the neighbor's more recent
LSAs that have been discovered, but not yet received in the Exchange state.
FULL
Neighboring routers are fully adjacent. These adjacencies will now appear in router LSAs and in network LSAs.
Reports the state of adjacency on the current port.

Type: enum
Default: NONE
Possible Values:
Value
Description
NONE
Configuration information has not been sent to the card.
NO_OSPF
No OSPFv3.
DOWN
Down.
LOOPBACK
Loop Back.
WAITING
Emulating router is treating the network as Broadcast and it has a non-zero router priority. The emulated router
will stay in this state until the end of the Designated Router election process.
POINT_TO_POINT Emulated router is treating the network as point-to-point. There is no Designated Router election process, so the
emulated router goes to this state immediately.
DR_OTHER
Emulated router is treating the network as Broadcast. If the emulated router's priority is zero, it will immediately
switch to this state when it is started (because it cannot become either DR or Backup DR). If the emulated router's
priority is non-zero, it will switch to this state if other routers are elected DR and Backup DR.
BACKUP
Emulated router is treating the network as Broadcast, it has a non-zero router priority, and it has been elected the
Backup Designated Router.
DR
Emulated router is treating the network as Broadcast, it has a non-zero router priority, and it has been elected the
Designated Router.
Ospfv3RouterLsa
Description:
Represents router LSA attributes. An OSPFv3 router LSA describes a simulated router and its neighbors.

Children: Ospfv3RouterLsaIf
1824
Ospfv3RouterLsa
Ospfv3RouterLsa Writable Attributes

Writable Attribute
Description
AdvertisingRouterId
ID of the router that advertises a given LSA. A single router LSA emanates from each simulated router, and includes the complete
link. This ID is in IPv4 format.
Type: ip
Default: null
Age
This is the initial value of LS Age in an LSA header.

Type: u16
Default: 0
Range: 0 - 3600
CheckSum
Specifies whether the LSA will be advertised with a good or bad checksum. A bad checksum indicates a corrupted LSA and is
Type: enum
Default: GOOD
Possible Values:
Value Description
BAD

LinkStateId

Type: u32
Default: 0
Options
Type: enum
Possible Values:
Value
Description
V6BIT
EBIT
MCBIT
Bit 2).
NBIT
RBIT
DCBIT
UNUSED6
Unused (Bit 6).
UNUSED7
Unused (Bit 7).
UNUSED8
Unused (Bit 8).
UNUSED9
Unused (Bit 9).

1825
Ospfv3RouterLsaIf
Writable Attribute
Description
RouteCategory

Type: enum
Default: UNDEFINED
Possible Values:
Value
Description
UNDEFINED
PRIMARY
Primary route.
RouterType
UNIQUE
Unique route.
ANY
Any route.
Router type.
Type: enum
Default: 0
Possible Values:
Value Description
BBIT
Border Router (B).
EBIT
AS Boundary Router (E).
VBIT
Virtual Link (V).
WBIT Wild-card Multicast Receiver (W).

SeqNum
Initial value of the LS sequence number in an LSA header.

Type: u32
Default: 0x80000001
Ospfv3RouterLsa Read-Only Attributes

Ospfv3RouterLsaIf
Description:
OSPFv3 Router LSA interface.

Parents: Ospfv3RouterLsa
Ospfv3RouterLsaIf Writable Attributes

Writable Attribute
Description
Active, Name
IfId
Interface ID - Used to uniquely identify the simulated router's interface.

Type: u32
Default: 0
1826
Ospfv3RouterResults
Writable Attribute
Description
IfType
Type of interface to simulate.

Type: enum
Possible Values:
Value
Description
POINT_TO_POINT
Interface Type - Point to Point.
TRANSIT_NETWORK Interface Type - Transit Network.

VIRTUAL_LINK
Interface Type - Virtual Link.
Metric
Cost to reach the simulated neighbor.

Type: u16
Default: 1
Range: 1 - 65535
NeighborIfId
Neighbor interface ID. This uniquely identifies the neighboring router's interface for the same link.
Type: u32
Default: 0
NeighborRouterId
Neighbor router ID. For PtP adjacencies, it is the router ID of the neighboring router on this link. For broadcast links,
it is the router ID of the DR of this broadcast network.
Type: ip
Default: 0.0.0.0
Ospfv3RouterLsaIf Read-Only Attributes

Ospfv3RouterResults
Description:
OSPFv3 router results.

Relations:
Side name
(Type)
Relative
Description
ResultParent
(ResultChild)
Ospfv3RouterConfig
Ospfv3RouterResults Writable Attributes

Ospfv3RouterResults Read-Only Attributes

Read-Only Attribute
Description
RxAck
Received acks. The number of Link State Acknowledgment packets received by the emulated router.
Type: u64
Default: 0
RxAsExternalLsa
Received external-LSAs. The number of external LSAs received by the emulated router.
Type: u64
Default: 0
1827
Ospfv3RouterResults
Read-Only Attribute
Description
RxDd
Received DD - The number of Database Description packets (containing LSA headers) received by the emulated
router.
Type: u64
Default: 0
RxHello
Received Hellos - Number of Hello packets received by the emulated router.

Type: u64
Default: 0
RxInterAreaPrefixLsa
Received inter-area-prefix LSAs. The number of inter-area-prefix LSAs received by the emulated router.
Type: u64
Default: 0
RxInterAreaRouterLsa
Received inter-area-router LSAs. The number of inter-area-router LSAs received by the emulated router.
Type: u64
Default: 0
RxIntraAreaPrefixLsa
Received Intra-Area-Prefix-LSAs - Number of Intra-Area-Prefix LSAs received by the emulated router.

Type: u64
Default: 0
RxLinkLsa
Received link-LSAs. The number of link LSAs received by the emulated router.
Type: u64
Default: 0
RxNetworkLsa
Received Network-LSAs - Number of Network LSAs received by the emulated router.

Type: u64
Default: 0
RxNssaLsa
Received Link-LSAs. The number of Link LSAs received by the emulated router.
Type: u64
Default: 0
RxRequest
Received requests. The number of LS requests received by the emulated router.

Type: u64
Default: 0
RxRouterLsa
Received Router-LSAs - Number of Router LSAs received by the emulated router.

Type: u64
Default: 0
RxUpdate
Rx update.
Type: u64
Default: 0
TxAck
Sent acks. The number of Link State Acknowledgment packets sent by the emulated router.
Type: u64
Default: 0
TxAsExternalLsa
Sent external-LSAs. The number of external LSAs sent by the emulated router.
Type: u64
Default: 0
TxDd
Sent DD - Number of Database Description packets sent by the emulated router.

Type: u64
Default: 0
TxHello
Sent Hellos - Number of Hello packets sent by the emulated router.

Type: u64
Default: 0
TxInterAreaPrefixLsa
Sent inter-area-prefix LSAs. The number of inter-area-prefix LSAs sent by the emulated router.
Type: u64
Default: 0
1828
Read-Only Attribute
Description
TxInterAreaRouterLsa
Sent inter-area-router LSAs. The number of inter-area-router LSAs sent by the emulated router.
Type: u64
Default: 0
TxIntraAreaPrefixLsa
Sent Intra-Area-Prefix-LSAs - Number of Intra-Area-Prefix LSAs sent by the emulated router.

Type: u64
Default: 0
TxLinkLsa
Sent link-LSAs. The number of link LSAs sent by the emulated router.
Type: u64
Default: 0
TxNetworkLsa
Sent Network-LSAs - Number of Network LSAs sent by the emulated router.

Type: u64
Default: 0
TxNssaLsa
Sent NSSA-LSAs. The number of NSSA LSAs sent by the emulated router.
Type: u64
Default: 0
TxRequest
Sent requests. The number of LS request packets sent by the emulated router.
Type: u64
Default: 0
TxRouterLsa
Sent Router-LSAs - Number of Router LSAs sent by the emulated router.

Type: u64
Default: 0
TxUpdate
Tx update.
Type: u64
Default: 0
Description:
OSPFv3 shared session parameters used for wizard.
Ospfv3SharedSessionParams Writable Attributes

Writable Attribute
Description
Common Writable
Attributes
Active, Name
AreaId
Area to which the emulated router belongs. It must match an area ID configured for the DUT to enable communication with the
DUT.
Type: ip
Default: 0.0.0.0
EnableBfd
Enable or disable BFD (Bidirectional Forwarding Detection) for this router. You must also create a BfdRouterConfig object under
the parent Router object.
Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
Enable BFD.
FALSE Disable BFD.
1829
Writable Attribute
Description
NetworkType
Setting to override the physical link type to emulate a PtP adjacency over Ethernet or over Ethernet VLANs.
Type: enum
Default: NATIVE
Possible Values:
Value
Description
NATIVE
Defined by the physical interface type (Broadcast adjacency on Ethernet port).
BROADCAST Adjacency is Broadcast, regardless of port type.

P2P
Options
Adjacency is Point-to-Point.
Type: enum
Possible Values:
Value
Description
V6BIT
EBIT
MCBIT
Bit 2).
NBIT
RBIT
DCBIT
UNUSED6
Unused (Bit 6).
UNUSED7
Unused (Bit 7).
UNUSED8
Unused (Bit 8).
UNUSED9
Unused (Bit 9).

RouterPriority
Router priority for this router. This is used in the designated router election procedure. A router priority of 0 (the default) makes
the router ineligible to be the designated router.
Type: u8
Default: 0
Range: 0 - 255
Ospfv3SharedSessionParams Read-Only Attributes

1830
Ospfv3ShutdownRoutersCommand
Ospfv3ShutdownRoutersCommand
Description:
Stop sending Hello packets on selected OSPFv3 router(s), simulating router shutdown.

Ospfv3ShutdownRoutersCommand Writable Attributes

Writable Attribute
Description
RouterList
Router handle list.

Type: handle
Default: 0
Ospfv3ShutdownRoutersCommand Read-Only Attributes

Read-Only Attribute
Description

Ospfv3StateSummary
Description:
Router state summarized on port and project.

Relations:
Side name
(Type)
Relative
Description
ResultParent
(ResultChild)
Port, Project
Ospfv3StateSummary Writable Attributes

Ospfv3StateSummary Read-Only Attributes

Read-Only Attribute
Description
BackupCount
Number of routers in Backup state.

Type: u32
Default: 0
DownCount
Number of routers in Down state.

Type: u32
Default: 0
1831
Read-Only Attribute
Description
DrCount
Number of routers in Dr state.

Type: u32
Default: 0
DrOtherCount
Number of routers in Dr Other state.

Type: u32
Default: 0
P2PCount
Number of routers in P2P state.

Type: u32
Default: 0
WaitingCount
Number of routers in waiting state.

Type: u32
Default: 0
Description:
Stop sending OSPFv3 Hello packets.

Ospfv3StopHellosCommand Writable Attributes

Writable Attribute
Description
RouterList
Router handle list.

Type: handle
Default: 0
Ospfv3StopHellosCommand Read-Only Attributes

Read-Only Attribute
Description

outerdamac
Description:
Parents: CiscoDCECiscoStag, CiscoDCECiscoStag, CiscoDCE8021adSTag, CiscoDCE8021adSTag
Children: None
1832
outersamac
outerdamac Attributes
Attribute
Description
endnodeid
Type: INTEGER
Default: 1
endnodeid_2
Type: INTEGER
Default: 1
i_g
Type: BITSTRING
Default: 1
localid
Type: INTEGER
Default: 1
Name
Type: string
ooo_dl
Type: BITSTRING
Default: 1
rsvd
Type: BITSTRING
Default: 0
subswitchid
Type: INTEGER
Default: 1
switchid
Type: INTEGER
Default: 1
u_l
Type: BITSTRING
Default: 1
outersamac
Description:
Parents: CiscoDCECiscoStag, CiscoDCECiscoStag, CiscoDCE8021adSTag, CiscoDCE8021adSTag
Children: None
outersamac Attributes
Attribute
Description
endnodeid
Type: INTEGER
Default: 1
endnodeid_2
Type: INTEGER
Default: 1
i_g
Type: BITSTRING
Default: 1
localid
Type: INTEGER
Default: 1
Name
Type: string
1833
OverflowResults
Attribute
Description
ooo_dl
Type: BITSTRING
Default: 1
rsvd
Type: BITSTRING
Default: 0
subswitchid
Type: INTEGER
Default: 1
switchid
Type: INTEGER
Default: 1
u_l
Type: BITSTRING
Default: 1
OverflowResults
Description:
Provides statistics for the overflow stream, which is a single ever-present stream that acts as a catch-all stream for all the packets that could not be associated
with a normal stream.

Parents: Analyzer
Relations:
Side name
(Type)
Relative
Description
ResultParent
(ResultChild)
Analyzer
OverflowResults Writable Attributes

OverflowResults Read-Only Attributes

Read-Only Attribute
Description
BitRate
Rate at which bits are transmitted/received.

Type: u64
Default: 0
CounterTimestamp

Type: u64
Default: 0
FcsErrorFrameCount

Type: u64
Default: 0
FcsErrorFrameRate
Type: u64
Default: 0
FirstArrivalTime
Type: u64
Default: 0
1834
PacketChannel
Read-Only Attribute
Description
FrameCount

Type: u64
Default: 0
FrameRate
Rate at which frames are transmitted/received.

Type: u64
Default: 0

Type: u64
Default: 0
Type: u64
Default: 0
LastArrivalTime
Type: u64
Default: 0
MaxFrameLength

Type: u64
Default: 0
MinFrameLength

Type: u64
Default: 0
OctetCount

Type: u64
Default: 0
OctetRate
Rate at which bytes are transmitted/received.

Type: u64
Default: 0
SigFrameCount

Type: u64
Default: 0
SigFrameRate
Rate at which Spirent signature frames are transmitted/received.

Type: u64
Default: 0

Type: u64
Default: 0
Type: u64
Default: 0
PacketChannel
Description:
Define a packet socket channel characteristics for an emulated device.

Automatically-created children: PacketChannelStats, RxPacketChannelOptions, TxPacketChannelOptions
Result children (automatically created): PacketChannelStats
1835
PacketChannelStats
Relations:
Side name
(Type)
Relative
Description
ResultChild
(ResultChild)
PacketChannelStats
UsesIf
(UsesIf)


PacketChannel Writable Attributes

Writable Attribute
Description
Active, Name
EncapsulationType
Ethernet encapsulation type.

Type: enum
Default: IPV4
Possible Values:
Value Description
IPV4
IPv4 encapsulation.
IPV6
IPv6 encapsulation.
CLNP CLNP encapsulation.


Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
Uses partial block state.
PacketChannel Read-Only Attributes

Read-Only Attribute
Description
ChannelState
Current state of the channel.

Type: enum
Default: CHANNEL_STATE_NO_STATE
Possible Values:
Value
Description
CHANNEL_STATE_NO_STATE Channel has no state and unable to send or receive packets.
CHANNEL_STATE_UP
Channel is started and able to send or receive packets.
CHANNEL_STATE_DOWN
Channel is not started and unable to send or receive packets.
PacketChannelStats
Description:
Packet Channel Statistic counters.

Automatically created from: PacketChannel
Relations:
1836
pad1
Side name
(Type)
Relative
Description
ResultParent
(ResultChild)
PacketChannel
PacketChannelStats Writable Attributes

PacketChannelStats Read-Only Attributes

Read-Only Attribute
Description
InRxQueueCount
Number of packets in receive queue.

Type: u64
Default: 0
RxCount

Type: u64
Default: 0
RxDiscardedCount
Number of packets dropped due to queue overflow.

Type: u64
Default: 0
TxCount
Number of packets Transmitted.

Type: u64
Default: 0
pad1
Description:
Parents: Ipv6HopByHopOption, Ipv6DestinationOption
Children: None
pad1 Attributes
Attribute
Description
Name
information.
Type: string
pad1
Type: INTEGER
Default: 0
PadData
Description:
Parents: thepadData
Children: None
1837
padding
PadData Attributes
Attribute
Description
Name
more information.
Type: string
padData
Type: OCTETSTRING
Default: 00
padding
Description:
Parents: L2TPv2
Children: OffsetPadding
padding Attributes
Attribute
Description
Name
information.
Type: string
Padding
Description:
Parents: thePad
Children: None
Padding Attributes
Attribute
Description
Name
information.
Type: string
pad
Type: OCTETSTRING
Default: 00
Padding
Description:
Parents: thePad
1838
padN
Children: None
Padding Attributes
Attribute
Description
Name
information.
Type: string
pad
Type: OCTETSTRING
Default: 00
padN
Description:
Parents: Ipv6HopByHopOption, Ipv6DestinationOption
Children: None
padN Attributes
Attribute
Description
length
Type: INTEGER
Default: 1
Name
more information.
Type: string
padding
Type: OCTETSTRING
Default: 00
padN
Type: INTEGER
Default: 1
padTlv
Description:
Children: None
padTlv Attributes
Attribute
Description
length
Type: INTEGER
Default: 4
Name
more information.
Type: string
1839
paramReqList
Attribute
Description
option
Type: OptionType
Default: 1
Possible Values:
Value Description
1
1-Drop Pad TLV from reply
2-Copy Pad TLV to reply
padValue
Type: OCTETSTRING
Default: 000000
type
Type: INTEGER
Default: 3
paramReqList
Description:
DHCP parameter request list option
Parents: DHCPOption
Children: None
paramReqList Attributes
Attribute
Description
length
Type: OCTETSTRING
Default: 04
Name
more information.
Type: string
type
Type: OCTETSTRING
Default: 37
value
Type: OCTETSTRING
Default: 01060f21
ParentClockInfoResult
Description:
IEEE 1588v2 parent clock information results.

Relations:
Side name
(Type)
Relative
Description
ResultParent
(ResultChild)
1840
ParentClockInfoResult
ParentClockInfoResult Writable Attributes

Writable Attribute
Description
StepMode
Type: enum
Default: TWO_STEP
Possible Values:
Value
Description
TWO_STEP
ParentClockInfoResult Read-Only Attributes

Read-Only Attribute
Description
GrandmasterClockAccuracy
Accuracy of the grandmaster clock.

Type: enum
Default: 0
Possible Values:
Value
Description
LOCAL_CLOCK_ACCURACY Accuracy is based on the local clock.
LESS_025_0NS
Time is accurate to within 25 ns.
LESS_100_0NS
LESS_250_0NS
LESS_001_0US
Time is accurate to within 1 microsecond.
LESS_002_5US
Time is accurate to within 2 microsends.
LESS_010_0US
Time is accurate to within 10 microseconds.
LESS_025_0US
LESS_100_0US
LESS_250_0US
LESS_001_0MS
Time is accurate to within 1 ms.
LESS_002_5MS
Time is accurate to within 2.5 ms.
LESS_010_0MS
LESS_025_0MS
LESS_100_0MS
LESS_250_0MS
LESS_001_0S
Time is accurate to within 1 second.
LESS_010_0S
Time is accurate to within 10 seconds.
GREATER_010_0S
Time is accurate to greater than 10 seconds.
GrandmasterClockClass
Traceability of the time or frequency distributed by the grandmaster clock.

Type: u8
Default: 0
GrandmasterClockOffsetScaledLogVariance
Scaled log variance of the grandmaster clock offset.

Type: u16
Default: 0
GrandmasterIdentity
Grandmaster clock identity.

Type: u64
Default: 0
GrandmasterPriority1
Priority1 level of the grandmaster.

Type: u8
Default: 0
GrandmasterPriority2
Priority2 level of the grandmaster.

Type: u8
Default: 0
1841
Password
Read-Only Attribute
Description
ObservedParentClockPhaseChangeRate
Observed rate of change in the measured time with respect to the reference time. The phase change rate
is equal to the fractional frequency offset between the measured frequency and the reference frequency.
Type: u16
Default: 0
ObservedParentOffsetScaledLogVariance
Scaled log variance of the observed parent offset.

Type: u16
Default: 0
ParentClockIdentity
Parent clock identity.

Type: u64
Default: 0
ParentPortNum
Parent port number.

Type: u16
Default: 0
ParentStats
Boolean indicating whether the parent statistics have been measured and are valid.
Type: enum
Default: FALSE
Possible Values:
Value Description
FALSE Parent statistics are not valid.
TRUE
Parent statistics are valid.
Password
Description:
Parents: simplePassword
Children: None
Password Attributes
Attribute
Description
Name
more information.
Type: string
Password
Type: ASCII
Default: 0
PathDescriptor
Description:
Describes the path between two end points.

Relations:
1842
PauseDynamicResultViewCommand
Side name
(Type)
Relative
Description
DstBinding
(DstBinding)
Aal5If, Dhcpv4ServerDefaultPoolConfig, Dhcpv4ServerPoolConfig, Dhcpv6ServerAddrPoolConfig,

Dhcpv6ServerDefaultAddrPoolConfig, Dhcpv6ServerDefaultPrefixPoolConfig,
Dhcpv6ServerPrefixPoolConfig, EthIIIf, FcIf, GreIf, HdlcIf, Ipv4If, Ipv4NetworkBlock, Ipv6If,
Ipv6NetworkBlock, ItagIf, L2tpv2If, MacBlock, MplsIf, Pimv4JoinSrc, Pimv4PruneSrc, Pimv6JoinSrc,
Pimv6PruneSrc, PppIf, PppoeIf, PppoeServerIpv4PeerPool, PppoxServerIpv4PeerPool,
Specifies destination
endpoints bound to
StreamBlock.
Encapsulation
(Encapsulation)

SrcBinding
(SrcBinding)

Specifies the source endpoint

bound to StreamBlock.
PathDescriptor Writable Attributes

Writable Attribute
Description
Active, Name
Index
Index of path descriptor.

Type: u32
Default: 0
PathDescriptor Read-Only Attributes

PauseDynamicResultViewCommand
Description:

PauseDynamicResultViewCommand Writable Attributes

Writable Attribute
Description
DynamicResultView
Type: handle
Default: 0
KeepInBackground
Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
FALSE
1843
PauseMacControl
PauseDynamicResultViewCommand Read-Only Attributes

Read-Only Attribute
Description

PauseMacControl (ethernetpause:PauseMacControl)
Description:
Children: None
PauseMacControl Attributes
Attribute
Description
Name
Type: string
opCode
Type: OCTETSTRING
Default: 0001
pauseTime
Type: INTEGER
Default: 0
reserved
Type: OCTETSTRING
payload (overloaded)
payload (fc)
payload (fcsw)
payload Object (fc PDU library)

Description:
Parents: mergeRequest (StreamBlock.FCoE.fc.fcPayloads.FCPayload-Choice.mergeRequest)

Children: MRPayloadChoice
1844
PbbTeMip
payload Attributes
Attribute
Description
Name
information.
Type: string
payload Object (fcsw PDU library)

Description:
Parents: mergeRequest (StreamBlock.MReq)

Children: MRPayloadChoice
payload Attributes
Attribute
Description
Name
information.
Type: string
PbbTeMip (EOAMTLV:PbbTeMip)
Description:
Children: None
PbbTeMip Attributes
Attribute
Description
Length
Type: OCTETSTRING
Default: 000E
MipMac
Type: MACADDR
Default: 00:00:00:00:00:00
Name
Type: string
ReverseMac
Type: MACADDR
Default: 00:00:00:00:00:00
1845
PbbTeMipTLV
Attribute
Description
ReverseVid
Type: INTEGER
Default: 0
Type
Type: OCTETSTRING
Default: 09
PbbTeMipTLV
Description:
Parents: LBMTLVList, LTMTLVList
Children: None
PbbTeMipTLV Attributes
Attribute
Description
Length
Type: OCTETSTRING
Default: 000E
MipMac
Type: MACADDR
Default: 00:00:00:00:00:00
Name
Type: string
ReverseMac
Type: MACADDR
Default: 00:00:00:00:00:00
ReverseVid
Type: INTEGER
Default: 0
Type
Type: OCTETSTRING
Default: 09
Perspective
Description:

Parents: Project
Children: PerspectiveNode
Perspective Writable Attributes

Writable Attribute
Description
Active, Name
1846
PerspectiveNode
Writable Attribute
Description
PerspectiveViewOwner
Type: enum
Default: SYSTEM
Possible Values:
Value
Description
SYSTEM
USER
Perspective Read-Only Attributes

PerspectiveNode
Description:

Parents: Perspective
PerspectiveNode Writable Attributes

Writable Attribute
Description
Active, Name
ContentData
Type: string
Data
Type: string
Guid
Type: string
Default: 0
PerspectiveNode Read-Only Attributes

PFC (ethernetpause:PFC)
Description:
Children: classEnableVector
PFC Attributes
Attribute
Description
Name
Type: string
1847
PfcMeasurementConfig
Attribute
Description
opCode
Type: OCTETSTRING
Default: 0101
reserved
Type: OCTETSTRING
time0
Type: INTEGER
time1
Type: INTEGER
time2
Type: INTEGER
time3
Type: INTEGER
time4
Type: INTEGER
time5
Type: INTEGER
time6
Type: INTEGER
time7
Type: INTEGER
PfcMeasurementConfig
Description:
PFC measurement configuration.

Parents: Port
PfcMeasurementConfig Writable Attributes

Writable Attribute
Description
Active, Name
EnableXon
Enable XON delay.

Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
Enable XON delay.
FALSE Enable XON delay.
1848
PfcMeasureResponseTimeCommand
Writable Attribute
Description
PriorityEnable
Enable VLAN priority, start from P0 to P7.

Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
Priority is enabled.
FALSE Priority is disabled.

Time
Request pause time.

Type: u16
Default: 0
XonDelay
XON delay time.

Type: double
Default: 1.0
Range: 1 - 3273000
XonDelayUnit
XON delay time unit.

Type: enum
Default: PAUSE_QUANTA
Possible Values:
Value
Description
PAUSE_QUANTA Use quanta as the unit.
MICROSECONDS Use microseconds as the unit.
PfcMeasurementConfig Read-Only Attributes

PfcMeasureResponseTimeCommand
Description:
Measure PFC response time.

PfcMeasureResponseTimeCommand Writable Attributes

Writable Attribute
Description
PortList
Type: handle
Default: 0
PfcMeasureResponseTimeCommand Read-Only Attributes

Read-Only Attribute
Description

1849
PfcResults
PfcResults
Description:
PFC measurement results.

Parents: Port
Relations:
Side name
(Type)
Relative
Description
ResultParent
(ResultChild)
Port
PfcResults Writable Attributes

PfcResults Read-Only Attributes

Read-Only Attribute
Description
Pri0ActualPauseTime
Priority 0 actual pause time.

Type: u64
Default: null
Priority 0 requested pause time.

Type: u64
Default: null
Pri0ResponseTime
Priority 0 response time.

Type: u64
Default: null
Pri0XonResponseTime
Priority 0 xon response time.

Type: u64
Default: null
Pri1ActualPauseTime

Type: u64
Default: null

Type: u64
Default: null
Pri1ResponseTime

Type: u64
Default: null
Pri1XonResponseTime

Type: u64
Default: null
Pri2ActualPauseTime

Type: u64
Default: null

Type: u64
Default: null
Pri2ResponseTime

Type: u64
Default: null
1850
PfcResults
Read-Only Attribute
Description
Pri2XonResponseTime

Type: u64
Default: null
Pri3ActualPauseTime

Type: u64
Default: null

Type: u64
Default: null
Pri3ResponseTime

Type: u64
Default: null
Pri3XonResponseTime

Type: u64
Default: null
Pri4ActualPauseTime

Type: u64
Default: null

Type: u64
Default: null
Pri4ResponseTime

Type: u64
Default: null
Pri4XonResponseTime

Type: u64
Default: null
Pri5ActualPauseTime

Type: u64
Default: null

Type: u64
Default: null
Pri5ResponseTime

Type: u64
Default: null
Pri5XonResponseTime

Type: u64
Default: null
Pri6ActualPauseTime

Type: u64
Default: null

Type: u64
Default: null
Pri6ResponseTime

Type: u64
Default: null
Pri6XonResponseTime

Type: u64
Default: 0
1851
pfcTlv
Read-Only Attribute
Description
Pri7ActualPauseTime

Type: u64
Default: null

Type: u64
Default: null
Pri7ResponseTime

Type: u64
Default: null
Pri7XonResponseTime

Type: u64
Default: null
TotalTxPfcFrameCount
Total PFC frame count.

Type: u64
Default: 0
TxPri0FrameCount
Tx priority 0 frame count.

Type: u64
Default: 0
TxPri1FrameCount

Type: u64
Default: 0
TxPri2FrameCount

Type: u64
Default: 0
TxPri3FrameCount

Type: u64
Default: 0
TxPri4FrameCount

Type: u64
Default: 0
TxPri5FrameCount

Type: u64
Default: 0
TxPri6FrameCount

Type: u64
Default: 0
TxPri7FrameCount

Type: u64
Default: 0
pfcTlv (overloaded)
pfcTlv (lldp) - Object definition for the following paths:
StreamBlock.DcbxTlvt1.value.DcbxSubTlvt1.pfcTlv
pfcTlv (lldp) - Object definition for the following paths:
StreamBlock.DcbxTlvt2.value.DcbxSubTlvt2.pfcTlv
1852
pfcTlv
pfcTlv Object (lldp PDU library)

Description:

Children: header
pfcTlv Attributes
Attribute
Description
Name
more information.
Type: string
pe0
Type: INTEGER
Default: 0
pe1
Type: INTEGER
Default: 0
pe2
Type: INTEGER
Default: 0
pe3
Type: INTEGER
Default: 0
pe4
Type: INTEGER
Default: 0
pe5
Type: INTEGER
Default: 0
pe6
Type: INTEGER
Default: 0
pe7
Type: INTEGER
Default: 0
pfcTlv Object (lldp PDU library)

Description:

Children: header
pfcTlv Attributes
Attribute
Description
Name
Type: string
numTCPFCs
Type: INTEGER
Default: 0
1853
pgAllocation
Attribute
Description
pe0
Type: INTEGER
Default: 0
pe1
Type: INTEGER
Default: 0
pe2
Type: INTEGER
Default: 0
pe3
Type: INTEGER
Default: 0
pe4
Type: INTEGER
Default: 0
pe5
Type: INTEGER
Default: 0
pe6
Type: INTEGER
Default: 0
pe7
Type: INTEGER
Default: 0
pgAllocation
Description:
Parents: pgTlv
Children: None
pgAllocation Attributes
Attribute
Description
BW0
Type: INTEGER
Default: 0
BW1
Type: INTEGER
Default: 0
BW2
Type: INTEGER
Default: 0
BW3
Type: INTEGER
Default: 0
BW4
Type: INTEGER
Default: 0
BW5
Type: INTEGER
Default: 0
BW6
Type: INTEGER
Default: 0
BW7
Type: INTEGER
Default: 0
1854
pgTlv
Attribute
Description
Name
Type: string
pgTlv (overloaded)
pgTlv (lldp) - Object definition for the following paths:
StreamBlock.DcbxTlvt1.value.DcbxSubTlvt1.pgTlv
pgTlv (lldp) - Object definition for the following paths:
StreamBlock.DcbxTlvt2.value.DcbxSubTlvt2.pgTlv
pgTlv Object (lldp PDU library)

Description:

Children: bwg_percentage, header, priority0Allocation, priority1Allocation, priority2Allocation, priority3Allocation, priority4Allocation, priority5Allocation,
priority6Allocation, priority7Allocation
pgTlv Attributes
Attribute
Description
Name
information.
Type: string
pgTlv Object (lldp PDU library)

Description:

Children: header, pgAllocation, prioAllocation
pgTlv Attributes
Attribute
Description
Name
more information.
Type: string
1855
PhyCompensationOptions
Attribute
Description
numTCs
Type: INTEGER
Default: 0
PhyCompensationOptions
Description:

Parents: AtmPhy, Ethernet100GigFiber, Ethernet10GigCopper, Ethernet10GigFiber, Ethernet40GigFiber, EthernetCopper, EthernetFiber, FcPhy, POSPhy,
Wimax16dPhy
PhyCompensationOptions Writable Attributes

Writable Attribute
Description
Active, Name
CompensationMode
Type: enum
Default: ADDED
Possible Values:
Value
Description
ADDED
REMOVED
CompensationOffsetRx
Type: double
Default: 0.0
Range: -1000.0 - 1000.0
CompensationOffsetTx
Type: double
Default: 0.0
Range: -1000.0 - 1000.0
PhyCompensationOptions Read-Only Attributes

PhyOptions
Description:

PhyOptions Writable Attributes

Writable Attribute
Description
Active, Name
1856
PhysicalChassis
Writable Attribute
Description
EnableCompensationMode
Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
FALSE
PhyOptions Read-Only Attributes

PhysicalChassis
Description:
Represents a chassis that the application is currently connected to.

Parents: PhysicalChassisManager
Children: FeatureLicense, PhysicalChassisFan, PhysicalChassisPowerSupplyStatus, PhysicalChassisSyncTopology, PhysicalChassisTempStatus,
PhysicalChassisThermal, PhysicalTestModule
PhysicalChassis Writable Attributes

Writable Attribute
Description
Active, Name
Hostname
Hostname or IP address of the chassis.

Type: string
Default: 0
TcpPort
Port number used to establish a TCP connection with the chassis.

Type: u16
Default: 40004
PhysicalChassis Read-Only Attributes

Read-Only Attribute
Description
BackplaneHwVersion
Hardware version of the chassis backplane.

Type: u32
Default: 0
ControllerHwVersion
Hardware version of the chassis controller.

Type: u32
Default: 0
DiskFree
Chassis compact flash disk space currently available in kilobytes.

Type: u32
Default: 0
DiskUsed
Chassis compact flash disk space currently used in kilobytes.

Type: u32
Default: 0
1857
PhysicalChassis
Read-Only Attribute
Description
ExpectedFirmwareVersion
Expected firmware version.

Type: string
FirmwareInstallProgress
Current firmware installation progress in units of percentage complete.

Type: u32
Default: 0
FirmwareInstallStatus
Current chassis firmware installation status.

Type: enum
Default: FIRMWARE_INSTALL_INACTIVE
Possible Values:
Value
Description
FIRMWARE_INSTALL_INACTIVE
Firmware installation is not occurring on the chassis.
FIRMWARE_INSTALL_IN_PROGRESS Firmware installation is in progress on the chassis.

FIRMWARE_INSTALL_REBOOTING
Chassis is rebooting during the firmware installation process.
FIRMWARE_INSTALL_COMPLETE
Firmware installation has completed on the chassis.
FIRMWARE_INSTALL_FAILED
Firmware installation has failed on the chassis.
FirmwareVersion
Chassis firmware version (for example, "2.0.100").

Type: string
Default: 0
FirmwareVersionStatus
Description of version check.

Type: string
IsConnected
Indicates if the application is currently connected to the chassis.

Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
Application is currently connected to the chassis.
FALSE Application is currently not connected to the chassis.

IsFirmwareVersionValid
Whether the firmware version combination is valid.

Type: bool
Default: TRUE
Possible Values:
Value Description
TRUE
Version combination is valid.
FALSE Version combination is not valid.

Model
Chassis model identifier (for example, "CHASSIS_5U").

NOTE: It is recommended that you use the PartNum attribute instead of this one.
Type: enum
Default: CHASSIS_5U
Possible Values:
Value
Description
CHASSIS_5U 5U chassis.
PartNum
Part number of the chassis. It is recommended that you use this instead of the Model attribute.
Type: string
SerialNum
Controller serial number.

Type: string
Default: 0
1858
PhysicalChassis
Read-Only Attribute
Description
SlotCount
Number of slots for cards present in the chassis.

Type: u16
Default: 0
Status
Current chassis status (that is, UP or DOWN).

Type: enum
Default: CHASSIS_STATUS_DOWN
Possible Values:
Value
Description
CHASSIS_STATUS_UP
Chassis is currently up and ready.
CHASSIS_STATUS_DOWN Chassis is currently down.

StatusChanged
Chassis status change.

Type: enum
Default: CHASSIS_CHANGE_UNKNOWN
Possible Values:
Value
Description
CHASSIS_CHANGE_REBOOT
Chassis is rebooting.
CHASSIS_CHANGE_UNKNOWN Chassis status change is unknown.

SyncEvent
Last chassis sync event received (for example, SYNC_EVENT_SRC_DROPPED).

Type: enum
Default: SYNC_EVENT_COMPLETE
Possible Values:
Value
Description
SYNC_EVENT_SRC_DROPPED
Chassis time source lost/dropped.
SYNC_EVENT_RESYNC_EVENT Chassis is resynchronizing its time to the source.

SYNC_EVENT_COMPLETE
Chassis has completed synchronizing its time.
SYNC_EVENT_CHAIN_UPDATE Chassis sync topology has changed.

SYNC_EVENT_CHAIN_LOOP
SyncSrc
Chassis sync topology is in a loop.
Chassis sync/time source (for example, SYNC_SRC_INTERNAL).

Type: enum
Default: SYNC_SRC_INTERNAL
Possible Values:
Value
Description
SYNC_SRC_INTERNAL Chassis is using its internal time source.
SyncStatus
SYNC_SRC_CHASSIS
Chassis time is synchronized to another chassis (that is, it is a slave chassis).
SYNC_SRC_LEGACY
Chassis time is synchronized to a legacy SmartBits chassis.
SYNC_SRC_GPS
Chassis time is synchronized to a GPS device.
SYNC_SRC_CDMA
Chassis time is synchronized to a CDMA device.
SYNC_SRC_NTP
Chassis time is synchronized to a NTP device.
Chassis synchronization status (for example, CHASSIS_FULL_SYNC).

Type: enum
Default: CHASSIS_OUT_OF_SYNC
Possible Values:
Value
Description
CHASSIS_OUT_OF_SYNC
Chassis time source is out of sync.
CHASSIS_CALIBRATED_SYNC Chassis time source is calibrated.
TotalDiskSize
CHASSIS_ALIGNED_SYNC
Chassis time source is aligned.
CHASSIS_FULL_SYNC
Chassis time source is fully synchronized.
Total chassis compact flash disk size in kilobytes.

Type: u32
Default: 0
1859
PhysicalChassisFan
PhysicalChassisFan
Description:
Object representing a fan in a chassis.

Parents: PhysicalChassis
PhysicalChassisFan Writable Attributes

Writable Attribute
Description
Active, Name
PhysicalChassisFan Read-Only Attributes

Read-Only Attribute
Description
FanName
Fan name.
Type: string
FanState
Fan state (for example, FAN_STATE_ON).

Type: enum
Default: FAN_STATE_ON
Possible Values:
Value
Description
FAN_STATE_ON
Fan is on.
FAN_STATE_OFF
Fan is off.
FAN_STATE_STALLED Fan is currently stalled.

Id
Fan ID.
Type: u16
Default: 0
PhysicalChassisManager
Description:
Parent object for all chassis that the application is currently connected to.

Parents: StcSystem
Children: FeatureLicense, PhysicalChassis
PhysicalChassisManager Writable Attributes

Writable Attribute
Description
Active, Name
FirmwareArchiveDir
Directory containing the firmware packages for the chassis, test modules and port groups.
Type: string
RawImageArchiveDir
Directory containing the raw images for the chassis and test modules.
Type: string
1860
PhysicalChassisPowerSupplyStatus
Writable Attribute
Description
UserId
User ID value used by the application when establishing a login session with the firmware.
Type: string
PhysicalChassisManager Read-Only Attributes

Read-Only Attribute
Description
Hostname
Client PC's hostname used by the application when establishing a login session with the firmware.
Type: string
ProcessId
Process ID value used by the application when establishing a login session with the firmware.
Type: string
Timestamp
Timestamp value used by the application when establishing a login session with the firmware.
Type: string
Description:
Chassis power supply information(including name and status).

PhysicalChassisPowerSupplyStatus Writable Attributes

Writable Attribute
Description
Active, Name
PhysicalChassisPowerSupplyStatus Read-Only Attributes

Read-Only Attribute
Description
HighestPowerSupply
Position of power supply with highest error.

Type: string
HighestPowerSupplyCurrent
Power supply current.

Type: double
Default: 0
1861
Read-Only Attribute
Description
HighestPowerSupplyStatus
Status of power supply with most serious error.

Type: enum
Default: POWER_STATUS_NORMAL
Possible Values:
Value
Description
POWER_STATUS_NORMAL
Power supply is normal.
POWER_STATUS_AC_FAILURE
AC failure (possibly AC unplugged).
POWER_STATUS_DC_FAILURE
DC failure.
POWER_STATUS_BOOST_FAILURE
General power supply failure.
POWER_STATUS_FAN_FAILURE
Power supply fan failure.
POWER_STATUS_HIGH_VOLTAGE_SHUTDOWN Power supply high voltage shutdown.

POWER_STATUS_LOW_VOLTAGE_SHUTDOWN
Power supply low voltage shutdown.
POWER_STATUS_REMOTE_OFF_SHUTDOWN
Power supply remote off shutdown.
POWER_STATUS_MOD_DISABLE_SHUTDOWN
Power supply module disable shutdown.
POWER_STATUS_SHORT_PIN_SHUTDOWN
Power supply shorted pin shutdown.
POWER_STATUS_TEMP_ALARM
Power supply temperature alarm.
POWER_STATUS_LOW_VOLTAGE_ALARM
Power supply low voltage alarm.
POWER_STATUS_CURRENT_LIMIT
Power supply current limit.
HighestPowerSupplyVoltage
Power supply voltage.

Type: double
Default: 0
PowerSupplyCurrentList
List of power supply output currents.

Type: double
Default: 0
PowerSupplyList
List of 9U power supplies (top, middle, bottom).

Type: string
PowerSupplyStatusList
Status of the power supply.

Type: enum
Default: POWER_STATUS_NORMAL
Possible Values:
Value
Description
POWER_STATUS_NORMAL
Power supply is normal.
POWER_STATUS_AC_FAILURE
AC failure (possibly AC unplugged).
POWER_STATUS_DC_FAILURE
DC failure.
POWER_STATUS_BOOST_FAILURE
General power supply failure.
POWER_STATUS_FAN_FAILURE
Power supply fan failure.
POWER_STATUS_HIGH_VOLTAGE_SHUTDOWN Power supply high voltage shutdown.
PowerSupplyVoltageList
POWER_STATUS_LOW_VOLTAGE_SHUTDOWN
Power supply low voltage shutdown.
POWER_STATUS_REMOTE_OFF_SHUTDOWN
Power supply remote off shutdown.
POWER_STATUS_MOD_DISABLE_SHUTDOWN
Power supply module disable shutdown.
POWER_STATUS_SHORT_PIN_SHUTDOWN
Power supply shorted pin shutdown.
POWER_STATUS_TEMP_ALARM
Power supply temperature alarm.
POWER_STATUS_LOW_VOLTAGE_ALARM
Power supply low voltage alarm.
POWER_STATUS_CURRENT_LIMIT
Power supply current limit.
List of power supply output voltages.

Type: double
Default: 0
1862
PhysicalChassisSyncTopology
PhysicalChassisSyncTopology
Description:
Object representing a chassis residing in the sync topology chain of a chassis that the application is currently connected to.

PhysicalChassisSyncTopology Writable Attributes

Writable Attribute
Description
Active, Name
PhysicalChassisSyncTopology Read-Only Attributes

Read-Only Attribute
Description
Hostname
Hostname of the chassis.

Type: string
Ipv4Addr
IPv4 address of the chassis.

Type: ip
Default: 0.0.0.0
Ipv6Addr
IPv6 address of the chassis.

Type: ipv6
Default: ::0
Model
Chassis model (for example, "CTL-5001A").

Type: string
PartNum
Part number of the chassis.

Type: string
Relation
Sync topology relationship between the chassis and a connected chassis (for example, "DIRECT_MASTER").
Type: enum
Default: DIRECT_MASTER
Possible Values:
Value
Description
DIRECT_MASTER
A sync cable is connected from the "OUT" port of the chassis to the "IN" port of a connected chassis.
INDIRECT_MASTER Chassis is not directly connected with a sync cable to the "IN" port of a connected chassis, but is
a master chassis since it is further "upstream".
DIRECT_SLAVE
A sync cable is connected from the "OUT" port of a connected chassis to the "IN" port of the chassis.
INDIRECT_SLAVE
Chassis is not directly connected with a sync cable to the "OUT" port of a connected chassis, but
is a slave chassis since it is further "downstream".
PhysicalChassisTempStatus
Description:
Overall chassis temperature status.

1863
PhysicalChassisThermal
PhysicalChassisTempStatus Writable Attributes

Writable Attribute
Description
Active, Name
PhysicalChassisTempStatus Read-Only Attributes

Read-Only Attribute
Description
HighestSensor
The sensor with the most serious temperature violation.

Type: string
HighestSensorStatus
Status level of the sensor with the most serious violation.

Type: enum
Default: TEMP_STATUS_NORMAL
Possible Values:
Value
Description
TEMP_STATUS_NORMAL Temperature is normal.
TEMP_STATUS_WARN
Temperature at warning level.
TEMP_STATUS_ALARM
Temperature at alarm level.
HighestSensorTemp
Temperature of the sensor with the most serious violation.

Type: u8
Default: 0
SensorIdList
List of sensor IDs.

Type: u8
Default: 0
SensorList
List of temperature sensors.

Type: string
SensorStatusList
Indicates sensor is valid for that chassis type.

Type: u8
Default: 0
SensorTempList
List of temperatures for sensors.

Type: u8
Default: 0
PhysicalChassisThermal
Description:
Object representing a temperature sensor in a chassis.

PhysicalChassisThermal Writable Attributes

Writable Attribute
Description
Active, Name
1864
PhysicalPort
PhysicalChassisThermal Read-Only Attributes

Read-Only Attribute
Description
Sensor
Temperature sensor ID.

Type: u8
Default: 0
TempEvent
Current temperature sensor status (for example, "TEMP_CHANGE_DOWN_TO_OK").

Type: enum
Default: TEMP_CHANGE_DOWN_TO_OK
Possible Values:
Value
Description
TEMP_CHANGE_UP_TO_WARNING
Sensor has detected that the chassis temperature has reached warning level.
TEMP_CHANGE_UP_TO_ALARM
Sensor has detected that the chassis temperature has reached alarm level.
TEMP_CHANGE_DOWN_TO_WARNING Sensor has detected that the chassis temperature has lowered to warning level.
TEMP_CHANGE_DOWN_TO_OK
Sensor has detected that the chassis temperature has lowered to normal level.
PhysicalPort
Description:
Object representing a port residing on a port group.

Parents: PhysicalPortGroup
Relations:
Side name
(Type)
Relative
Description
LogicalPort
(PhysicalLogical)
ExternalDevicePort, Port
PhysicalPort Writable Attributes

Writable Attribute
Description
Active, Name
PhysicalPort Read-Only Attributes

Read-Only Attribute
Description
Index
Port index (value starts at 1).

Type: u16
Default: 1
Range: 1 - 0xFFFF
Location
Port "csp" location (for example, "//10.100.10.1/1/1").

Type: csp
1865
PhysicalPortGroup
PhysicalPortGroup
Description:
Object representing a port group residing in a test module.

Parents: PhysicalTestModule
Children: PhysicalPort
PhysicalPortGroup Writable Attributes

Writable Attribute
Description
Active, Name
PhysicalPortGroup Read-Only Attributes

Read-Only Attribute
Description
ExpectedTestPackageVersion
Expected test package version.

Type: string
Firmware installation progress (in units of percentage complete) for the port group.
Type: u32
Default: 0
Firmware installation status for the port group (for example, "FIRMWARE_INSTALL_IN_PROGRESS").
Type: enum
Possible Values:
Value
Description
Firmware installation is not occurring.
FIRMWARE_INSTALL_IN_PROGRESS Firmware installation is in progress.

Port group is rebooting during a firmware installation.
Firmware installation is complete.
Firmware installation failed.
Index
Port group index (value starts at 1).

Type: u16
Default: 1
Range: 1 - 0xFFFF
IsTestPackageVersionValid
Indicates if the active test package version is compatible with the application.
Type: bool
Default: TRUE
Possible Values:
Value Description
TRUE
Test package version is valid.
FALSE test package version is not valid.
1866
PhysicalPortGroup
Read-Only Attribute
Description
OwnerAccessLevel
Access level of the port group owner.

Type: enum
Default: ACCESS_LEVEL_VIEW
Possible Values:
Value
Description
ACCESS_LEVEL_NOAUTH
Owner is currently logged in with NOAUTH access level.
ACCESS_LEVEL_VIEW
Owner is currently logged in with VIEW access level.
ACCESS_LEVEL_SHARED
Owner is currently logged in with SHARED access level.
ACCESS_LEVEL_CONTROL Owner is currently logged in with CONTROL access level.

ACCESS_LEVEL_ADMIN
Owner is currently logged in with ADMIN access level.
ACCESS_LEVEL_DEBUG
Owner is currently logged in with DEBUG access level.
OwnerHostname
Hostname value used by the current owner when logging into the port group.
Type: string
OwnerProcessId
Process ID value used by the current owner when logging into the port group.
Type: string
OwnershipState
Ownership status of the port group.

Type: enum
Default: OWNERSHIP_STATE_AVAILABLE
Possible Values:
Value
Description
OWNERSHIP_STATE_AVAILABLE
Port group is available for reservation.
OWNERSHIP_STATE_RESERVED
Port group is currently reserved.
OWNERSHIP_STATE_DISCONNECTED Current owner has disconnected from the port group but still has it reserved.
OwnerTimestamp
Timestamp value used by the current owner when logging into the port group.
Type: string
OwnerUserId
User ID value used by the current owner when logging into the port group.
Type: string
ReservedByUser
Indicates if the port group is currently reserved by the application.

Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
Port group is reserved by the user.
FALSE Port group is not reserved by the user.

Status
Current port group status (for example, "MODULE_STATUS_UP").

Type: enum
Default: MODULE_STATUS_UNKNOWN
Possible Values:
Value
Description
MODULE_STATUS_UP
Port group is up.
MODULE_STATUS_DOWN
Port group is down.
MODULE_STATUS_ERROR
Port group is an error state.
MODULE_STATUS_UNKNOWN Port group status is unknown.
1867
PhysicalTestModule
Read-Only Attribute
Description
StatusChanged
Last status change for the port group (for example, "MODULE_CHANGE_INIT_DONE").
Type: enum
Default: MODULE_CHANGE_UNKNOWN
Possible Values:
Value
Description
MODULE_CHANGE_INIT_DONE
Port group initialization is complete and it is up.
MODULE_CHANGE_REBOOT
Port group is rebooting.
MODULE_CHANGE_HOTSWAP_IN
Module has been inserted.
MODULE_CHANGE_HOTSWAP_OUT Module has been removed.

MODULE_CHANGE_SHUTDOWN
Port group is in shutdown state.
MODULE_CHANGE_RESERVATION
Module reservation state has changed.
MODULE_CHANGE_UNKNOWN
Port group status change is unknown.
MODULE_CHANGE_RESTARTING
SyncStatus
Status indicating if a port group is in/out of sync with its time source (for example, "MODULE_IN_SYNC").
Type: enum
Default: MODULE_OUT_OF_SYNC
Possible Values:
Value
Description
MODULE_IN_SYNC
Port group is in sync with its time source.
MODULE_OUT_OF_SYNC
Port group out of sync with its time source.
MODULE_UNKNOWN_SYNC Port group sync status is unknown.

TestPackage
Current active test package (for example, "stc") running on the port group.
Type: string
TestPackageVersion
Version (for example, "2.0.100") for the active test package running on the port group.
Type: string
Default: 0
TestPackageVersionStatus
Description of test package version check.

Type: string
PhysicalTestModule
Description:
Object representing a test module residing in a chassis that the application is currently connected to.

Children: PhysicalPortGroup
PhysicalTestModule Writable Attributes

Writable Attribute
Description
Active, Name
1868
PhysicalTestModule
PhysicalTestModule Read-Only Attributes

Read-Only Attribute
Description
Description
Test module description (for example, "8 PORT 10/100/1000 COPPER RJ-45").
Type: string
Default: 8 PORT 10/100/1000 COPPER RJ-45
DiskFree
Compact flash space currently free, in kilobytes.

Type: u32
Default: 0
DiskUsed
Compact flash space currently in use in kilobytes.

Type: u32
Default: 0
ExpectedFirmwareVersion
Expected firmware version.

Type: string
Firmware installation progress (in units of percentage complete) for a test module.
Type: u32
Default: 0
Firmware installation status for a test module (for example, "FIRMWARE_INSTALL_IN_PROGRESS").

Type: enum
Possible Values:
Value
Description
Firmware installation is not occurring.
FIRMWARE_INSTALL_IN_PROGRESS Firmware installation is in progress.

Test module is rebooting during a firmware installation.
Firmware installation is complete.
Firmware installation failed.
FirmwareVersion
Test module firmware version (for example, "2.0.100").

Type: string
Default: 0
FirmwareVersionStatus
Status message for the case where the firmware version is incompatibility with the application.
Type: string
HwRevCode
Test module hardware revision code.

Type: string
Default: 0
Index
Chassis slot that the test module occupies (index value starts at 1).
Type: u16
Default: 1
Range: 1 - 0xFFFF
IsFirmwareVersionValid
Whether the firmware version is valid.

Type: bool
Default: TRUE
Possible Values:
Value Description
TRUE
Firmware version is valid.
FALSE Firmware version is not valid.
1869
PhysicalTestModule
Read-Only Attribute
Description
IsPortGroupRebootSupported
Indicates if the test module supports the capability to reboot individual port groups.
Type: bool
Default: TRUE
Possible Values:
Value Description
TRUE
Supports port group reboot.
FALSE Does not support port group reboot.

Model
Test module model identifier (for example, "CPR-2001A").

NOTE: It is recommended that you use the PartNum attribute instead of this one.
Type: string
PartNum
Part number of the test module. It is recommended that you use this instead of the Model attribute.
Type: string
PortCount
Number of ports in the test module.

Type: u16
Default: 0
PortGroupCount
Number of port groups/ccpus in the test module.

Type: u16
Default: 0
PortGroupSize
Number of ports per port group.

Type: u16
Default: 0
ProductFamily
Spirent-internal test module product family name (for example, "MYSTIQUE").

Type: string
Default: MYSTIQUE
ProductId
Spirent product ID/part number (for example, "800-5135-007").

Type: string
Default: 800-5135-007
SerialNum
Test module serial number.

Type: string
Default: 0
Status
Current test module status (for example, "MODULE_STATUS_UP").

Type: enum
Default: MODULE_STATUS_UNKNOWN
Possible Values:
Value
Description
MODULE_STATUS_UP
Test module is up.
MODULE_STATUS_DOWN
Test module is down.
MODULE_STATUS_ERROR
Test module is in an error state.
MODULE_STATUS_UNKNOWN Test module status is unknown.
1870
PhyVerifyLinkUpCommand
Read-Only Attribute
Description
StatusChanged
Last status change for a test module (for example, "MODULE_CHANGE_INIT_DONE").

Type: enum
Default: MODULE_CHANGE_UNKNOWN
Possible Values:
Value
Description
MODULE_CHANGE_INIT_DONE
Test module initialization has completed and it is up.
MODULE_CHANGE_REBOOT
Test module is rebooting.
MODULE_CHANGE_HOTSWAP_IN
Test module has been removed from the chassis.
MODULE_CHANGE_HOTSWAP_OUT Test module has been inserted into the chassis.

MODULE_CHANGE_SHUTDOWN
Test module is currently in shutdown state.
MODULE_CHANGE_RESERVATION
Test module port group(s) are currently reserved by a user.
MODULE_CHANGE_UNKNOWN
Test module status change is unknown.
SupportedPortGroupSizes
Available port group sizes that are configurable for the test module.
Type: u16
Default: 0
SyncStatus
Status indicating if a test module is in/out of sync with its time source (for example, "MODULE_IN_SYNC").
Type: enum
Default: MODULE_OUT_OF_SYNC
Possible Values:
Value
Description
MODULE_IN_SYNC
Test module is in sync with its time source.
MODULE_OUT_OF_SYNC
Test module is out of sync with its time source.
MODULE_UNKNOWN_SYNC Test module sync status is unknown.

TestPackages
Installed test package(s).

Type: string
TotalDiskSize
Total size of the compact flash on a test module in kilobytes.

Type: u32
Default: 0
PhyVerifyLinkUpCommand
Description:
Verify that the link is up for the port.

Parents: Sequencer
PhyVerifyLinkUpCommand Writable Attributes

Writable Attribute
Description
PortList

Type: handle
Default: 0
1871
pidAgentCircuitID
PhyVerifyLinkUpCommand Read-Only Attributes

Read-Only Attribute
Description
PassFailState
pidAgentCircuitID
Description:
Parents: portid
Children: None
pidAgentCircuitID Attributes
Attribute
Description
id
Type: OCTETSTRING
Default: 0000
Name
information.
Type: string
subtype
Type: PortIDSubTypeValues
Default: 06
Possible Values:
Value Description
01
Interface Alias
02
Port Component
03
MAC Address
04
Network Address
05
Interface Name
06
Agent Circuit ID
07
Locally Assigned
pidAgentCircuitID
Description:
Parents: PortIDList
Children: None
pidAgentCircuitID Attributes
Attribute
Description
Name
Type: string
PortID
Type: OCTETSTRING
Default: 00
1872
pidCustom
Attribute
Description
PortIDLength
Type: OCTETSTRING
Default: 00
PortIDLengthSub
Default: 07
Possible Values:
Value Description
01
Interface Alias
02
Port Component
03
MAC Address
04
Network Address
05
Interface Name
06
Agent Circuit ID
07
Locally Assigned
pidCustom
Description:
Parents: portid
Children: None
pidCustom Attributes
Attribute
Description
id
Type: OCTETSTRING
Default: 00
Name
more information.
Type: string
subtype
Type: OCTETSTRING
Default: 00
pidCustom
Description:
Parents: PortIDList
Children: None
pidCustom Attributes
Attribute
Description
Name
Type: string
1873
pidInterfaceAlias
Attribute
Description
PortID
Type: OCTETSTRING
PortIDLength
Type: OCTETSTRING
Default: 00
PortIDLengthSub
Type: OCTETSTRING
Default: 00
pidInterfaceAlias
Description:
Parents: portid
Children: None
pidInterfaceAlias Attributes
Attribute
Description
id
Type: ASCII
Default: SPIRENT
Name
information.
Type: string
subtype
Default: 01
Possible Values:
Value Description
01
Interface Alias
02
Port Component
03
MAC Address
04
Network Address
05
Interface Name
06
Agent Circuit ID
07
Locally Assigned
pidInterfaceAlias
Description:
Parents: PortIDList
Children: None
1874
pidInterfaceName
pidInterfaceAlias Attributes
Attribute
Description
Name
Type: string
PortID
Type: ASCII
Default: SPIRENT
PortIDLength
Type: OCTETSTRING
Default: 00
PortIDLengthSub
Default: 01
Possible Values:
Value Description
01
Interface Alias
02
Port Component
03
MAC Address
04
Network Address
05
Interface Name
06
Agent Circuit ID
07
Locally Assigned
pidInterfaceName
Description:
Parents: portid
Children: None
pidInterfaceName Attributes
Attribute
Description
id
Type: ASCII
Default: SPIRENT
Name
information.
Type: string
subtype
Default: 05
Possible Values:
Value Description
01
Interface Alias
02
Port Component
03
MAC Address
04
Network Address
05
Interface Name
06
Agent Circuit ID
07
Locally Assigned
1875
pidInterfaceName
pidInterfaceName
Description:
Parents: PortIDList
Children: None
pidInterfaceName Attributes
Attribute
Description
Name
Type: string
PortID
Type: ASCII
Default: SPIRENT
PortIDLength
Type: OCTETSTRING
Default: 00
PortIDLengthSub
Default: 05
Possible Values:
Value Description
01
Interface Alias
02
Port Component
03
MAC Address
04
Network Address
05
Interface Name
06
Agent Circuit ID
07
Locally Assigned
pidLocallyAssigned
Description:
Parents: portid
Children: None
pidLocallyAssigned Attributes
Attribute
Description
id
Type: INTEGER
Default: 0
Name
information.
Type: string
1876
pidLocallyAssigned
Attribute
Description
subtype
Default: 07
Possible Values:
Value Description
01
Interface Alias
02
Port Component
03
MAC Address
04
Network Address
05
Interface Name
06
Agent Circuit ID
07
Locally Assigned
pidLocallyAssigned
Description:
Parents: PortIDList
Children: None
pidLocallyAssigned Attributes
Attribute
Description
Name
Type: string
PortID
Type: ASCII
Default: SPIRENT
PortIDLength
Type: OCTETSTRING
Default: 00
PortIDLengthSub
Default: 07
Possible Values:
Value Description
01
Interface Alias
02
Port Component
03
MAC Address
04
Network Address
05
Interface Name
06
Agent Circuit ID
07
Locally Assigned
pidMacAddress
Description:
Parents: portid
1877
pidMacAddress
Children: None
pidMacAddress Attributes
Attribute
Description
id
Type: MACADDR
Default: 00:00:00:00:00:00
Name
Type: string
subtype
Default: 03
Possible Values:
Value Description
01
Interface Alias
02
Port Component
03
MAC Address
04
Network Address
05
Interface Name
06
Agent Circuit ID
07
Locally Assigned
pidMacAddress
Description:
Parents: PortIDList
Children: None
pidMacAddress Attributes
Attribute
Description
Name
more information.
Type: string
PortID
Type: MACADDR
PortIDLength
Type: OCTETSTRING
Default: 06
PortIDLengthSub
Default: 03
Possible Values:
Value Description
01
Interface Alias
02
Port Component
03
MAC Address
04
Network Address
05
Interface Name
06
Agent Circuit ID
07
Locally Assigned
1878
pidNetworkAddress4
pidNetworkAddress4
Description:
Parents: portid
Children: None
pidNetworkAddress4 Attributes
Attribute
Description
ianaAddrNo
Type: INTEGER
Default: 1
id
Type: IPV4ADDR
Default: 192.168.1.1
Name
more information.
Type: string
subtype
Default: 04
Possible Values:
Value Description
01
Interface Alias
02
Port Component
03
MAC Address
04
Network Address
05
Interface Name
06
Agent Circuit ID
07
Locally Assigned
pidNetworkAddress4
Description:
Parents: PortIDList
Children: None
Attribute
Description
IanaFamilyNumber
Default: 01
Possible Values:
Value Description
01
IPv4
02
IPv6
Name
Type: string
PortID
Type: IPV4ADDR
1879
pidNetworkAddress6
Attribute
Description
PortIDLength
Type: OCTETSTRING
Default: 05
PortIDLengthSub
Default: 04
Possible Values:
Value Description
01
Interface Alias
02
Port Component
03
MAC Address
04
Network Address
05
Interface Name
06
Agent Circuit ID
07
Locally Assigned
pidNetworkAddress6
Description:
Parents: portid
Children: None
Attribute
Description
ianaAddrNo
Type: INTEGER
Default: 2
id
Type: IPV6ADDR
Default: 2000::
Name
more information.
Type: string
subtype
Default: 04
Possible Values:
Value Description
01
Interface Alias
02
Port Component
03
MAC Address
04
Network Address
05
Interface Name
06
Agent Circuit ID
07
Locally Assigned
pidNetworkAddress6
1880
pidPortComponent
Description:
Parents: PortIDList
Children: None
Attribute
Description
IanaFamilyNumber
Default: 02
Possible Values:
Value Description
01
IPv4
02
IPv6
Name
Type: string
PortID
Type: IPV6ADDR
PortIDLength
Type: OCTETSTRING
Default: 11
PortIDLengthSub
Default: 04
Possible Values:
Value Description
01
Interface Alias
02
Port Component
03
MAC Address
04
Network Address
05
Interface Name
06
Agent Circuit ID
07
Locally Assigned
pidPortComponent
Description:
Parents: portid
Children: None
pidPortComponent Attributes
Attribute
Description
id
Type: ASCII
Default: SPIRENT
Name
information.
Type: string
1881
pidPortComponent
Attribute
Description
subtype
Default: 02
Possible Values:
Value Description
01
Interface Alias
02
Port Component
03
MAC Address
04
Network Address
05
Interface Name
06
Agent Circuit ID
07
Locally Assigned
pidPortComponent
Description:
Parents: PortIDList
Children: None
pidPortComponent Attributes
Attribute
Description
Name
Type: string
PortID
Type: ASCII
Default: SPIRENT
PortIDLength
Type: OCTETSTRING
Default: 00
PortIDLengthSub
Default: 02
Possible Values:
Value Description
01
Interface Alias
02
Port Component
03
MAC Address
04
Network Address
05
Interface Name
06
Agent Circuit ID
07
Locally Assigned
PimDeviceGenProtocolParams
Description:
Wizard object that holds the protocol parameters.
1882
PimGlobalConfig

PimDeviceGenProtocolParams Writable Attributes

Writable Attribute
Description
Active, Name
DrPriority
Designated Router (DR) priority of this router. This value is sent as an option in the Hello message.
Type: u32
Default: 1
IpVersion
IP version to be used for communication with the neighbor.

Type: enum
Default: IPV4
Possible Values:
Value Description
PimMode
IPV4
Use IPv4 version.
IPV6
Use IPv6 version.
Emulated router's PIM mode.

Type: enum
Default: SM
Possible Values:
Value Description
SM
Router supports all three group types: (S,G), (*,*,RP), and (*,G).
SSM
Router will not send Join/Prune messages for groups that are not (S,G). You cannot add (*,*,RP) or (*,G)
groups.
PimDeviceGenProtocolParams Read-Only Attributes

PimGlobalConfig
Description:
Global options used by the PIM (Protocol-Independent Multicast) protocol. Changes in this object affect all PIM routers on all ports.

PimGlobalConfig Writable Attributes

Writable Attribute
Description
Active, Name
DisableHelloExpireTimer
Option to disable hello expire timer in scalablity mode.

Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
Hello expire timer is disabled.
FALSE Hello expire timer is set to user-specified value.
1883
PimGlobalConfig
Writable Attribute
Description
DisableHelloRxInNeighborState
Option to not process hello messages in neighbor state to increase scalability.

Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
Hello messages are not processed in neighbor state.
FALSE All hello messages are processed in neighbor state.

DisableIncomingMsgProcessing
Option to disable processing of all incoming messages in neighbor state to increase scalability.
Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
All incoming messages are not processed in neighbor state.
FALSE All incoming messages are processed in neighbor state.

EnableMsgRate
Enable Maximum PIM message transmission rate.

Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
User-specified maximum PIM message transmission rate per second is used.
FALSE No limit on the PIM message transmission rate per second.

EnablePackGroupRecord
Specifies that multicast groups be combined in Join/Prune messages or sent individually.

Type: bool
Default: TRUE
Possible Values:
Value Description
TRUE
Enables Join/Prune message packing.
FALSE Disables Join/Prune message packing.

EnablingPruningDelayOption
Select to include the LAN Prune Delay option in PIM Hello messages.
Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
Enables sending the LAN Prune Delay PIM option.
FALSE Disables sending the LAN Prune Delay PIM option.

LanPruneDelay
Expected message propagation delay in milliseconds.

Type: u32
Default: 500
Range: 0 - 32767
MsgInterval
Minimum gap, in seconds, between successive PIM messages.

Type: u32
Default: 1
Range: 1 - 1000
MsgRate
Maximum rate, per second, at which PIM messages will be transmitted.

Type: u32
Default: 100
Range: 1 - 1000
OverrideInterval
Join/Prune override interval in milliseconds.

Type: u32
Default: 2500
Range: 0 - 65535
1884
PimIncrementGenIdCommand
Writable Attribute
Description
Tbit
Specifies the ability of the router to disable Joins suppression.

Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
Disable Joins suppression.
FALSE Enable Joins suppression.

TriggerHelloDelay
Randomized interval, in seconds, for initial Hello message on boot up or triggered Hello message to a rebooting
neighbor.
Type: u16
Default: 5
Range: 0 - 60
PimGlobalConfig Read-Only Attributes

PimIncrementGenIdCommand
Description:
Send the next Hello from the selected router(s) with incremented Generation ID.

PimIncrementGenIdCommand Writable Attributes

Writable Attribute
Description
RouterList
List of PIM router config handles.

Type: handle
Default: 0
PimIncrementGenIdCommand Read-Only Attributes

Read-Only Attribute
Description

PimResumeBsmsCommand
Description:
Resume sending PIM bootstrap messages (BSMs) for the selected PIM routers.

1885
PimResumeHellosCommand
PimResumeBsmsCommand Writable Attributes

Writable Attribute
Description
RouterList

Type: handle
Default: 0
PimResumeBsmsCommand Read-Only Attributes

Read-Only Attribute
Description

PimResumeHellosCommand
Description:
Resume sending Hellos for the selected PIM routers.

PimResumeHellosCommand Writable Attributes

Writable Attribute
Description
RouterList

Type: handle
Default: 0
PimResumeHellosCommand Read-Only Attributes

Read-Only Attribute
Description

PimResumeJoinsCommand
Description:
Resume Joins for the selected PIM groups.

1886
PimRouterConfig
PimResumeJoinsCommand Writable Attributes

Writable Attribute
Description
GroupList

Type: handle
Default: 0
PimResumeJoinsCommand Read-Only Attributes

Read-Only Attribute
Description

PimRouterConfig
Description:
Configuration parameters for a single PIM routing instance.

Children: Pimv4GroupBlk, Pimv4RpMap, Pimv6GroupBlk, Pimv6RpMap
Result children (automatically created): PimRouterResults
Relations:
Side name
(Type)
Relative
Description
MPLS control plane binding results.
ResultChild
(ResultChild)
PimRouterResults
UsesIf
(UsesIf)

WimaxIf

PimRouterConfig Writable Attributes

Writable Attribute
Description
Active, Name
BiDirOptionSet
If true (selected), the BI-DIR option is included in the Hello messages.

Spirent TestCenter does not support the BI-DIR specification. However, Spirent TestCenter does allow this option to be
sent in the Hello message.
Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
Enables sending BI-DIR option in Hello messages.
FALSE Disables sending BI-DIR option in Hello messages.
1887
PimRouterConfig
Writable Attribute
Description
BootstrapMessageInterval
Frequency in seconds with which bootstrap messages are transmitted.

Type: u16
Default: 60
Range: 1 - 3600
BsrPriority
8-bit priority of the emulated bootstrap router (BSR).

Type: u8
Default: 1
Range: 0 - 255
DrPriority
Designated Router (DR) priority of this router. This value is sent as an option in the Hello message.
Type: u32
Default: 1
EnableBsr
PIM routers enabled for bootstrap routing (BSR) functionality generate Bootstrap messages periodically.
Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
Enables sending Bootstrap messages.
FALSE Disables sending Bootstrap messages.

GenIdMode
Used in Spirent TestCenter to help negative-test DUTs.

In PIM, routers send the Generation ID as an option in the Hello messages. Every time a router starts up, it selects a
random number. The router uses that number as long as it remains operational. If the Generation ID changes, it is an
indication to the neighboring routers that this router has gone through a shutdown-restart cycle. This causes the neighboring
routers to reset their databases and start fresh. If the generation ID mode is Fixed, it emulates normal PIM router behavior.
Incremental or Random means Spirent TestCenter will send different generation IDs in successive Hello messages,
causing the DUTs to reset and rebuild their databases often.
The interactive menu option, Increment Generation ID, sends one Hello message with incremented Generation ID.
Type: enum
Default: FIXED
Possible Values:
Value
Description
FIXED
Emulates normal PIM router behavior.
INCREMENT Spirent TestCenter sends different Generation IDs in successive Hello messages, incrementing by one
each time.
RANDOM
Spirent TestCenter sends different Generation IDs in successive Hello messages, selecting a random
number each time.
HelloHoldtime
Hold time in seconds to keep neighbor state alive.

Type: u16
Default: 105
Range: 1 - 65535
HelloInterval
Periodic interval in seconds for Hello messages.

Type: u16
Default: 30
Range: 1 - 3600
IpVersion
IP version to be used for communication with the neighbor.

Type: enum
Default: V4
Possible Values:
Value Description
JoinPruneHoldtime
V4
Uses IP version 4.
V6
Uses IP version 6.
Hold time in seconds to advertise in Join/Prune messages.

Type: u16
Default: 210
Range: 1 - 65535
1888
PimRouterConfig
Writable Attribute
Description
JoinPruneInterval
Frequency in seconds at which Join/Prune messages are sent.

Type: u16
Default: 60
Range: 1 - 65535
PimMode
Specifies the emulated router's PIM mode.

Type: enum
Default: SM
Possible Values:
Value Description
SM
Router supports all three group types: (S,G), (*,*,RP), and (*,G).
SSM
Router will not send Join/Prune messages for groups that are not (S,G). You cannot add (*,*,RP) or (*,G) groups.
UpstreamNeighborV4
IPv4 upstream neighbor address to be used in Join/Prune messages.

Type: ip
Default: null
UpstreamNeighborV6
IPv6 upstream neighbor address to be used in Join/Prune messages.

Type: ipv6
Default: null

Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
PimRouterConfig Read-Only Attributes

Read-Only
Attribute
Description
RouterState
Reports the emulated router's status.

Type: enum
Default: NO_STATE
Possible Values:
Value
Description
NO_STATE Initial state of a router after it has been configured. It does not send Hellos or any other messages, and does not process
any incoming messages.
Transitions to Hello on receipt of a Start Router interactive event.
STOPPED
State of the router after it has been stopped by the user. It processes incoming messages and updates router statistics.
Transitions to Hello on receipt of a Start Router interactive event.
STARTED
Router is idle, incrementing received counters. It does not send Hellos or any other messages.
Transitions to Stopped on receipt of a Shutdown Router interactive event.
Transitions to Hello on receipt of a Resume Hellos interactive event.
HELLO
Initial state of a router after it has been started. In this state, the router sends periodic Hellos, and counts transmitted and
received packets.
Transitions to Started on receipt of a Stop Hellos interactive event.
Transitions to Neighbor on receipt of a Hello packet from a neighbor.
NEIGHBOR Router transitions into Neighbor state after it receives a Hello from its neighbor. In this state, the router sends periodic
Hellos, periodic Join/Prunes (if groups are configured), and periodic Bootstraps (if RP maps are configured).
Transitions to Started on receipt of a Stop Hellos interactive event.
Transitions to Hello if all existing neighbors time out (i.e., if the router does not receive a Hello from any neighbor for the
duration of Hello Holdtime).
DR
Internal state.
1889
PimRouterResults
PimRouterResults
Description:
PIM router results.

Parents: PimRouterConfig
Relations:
Side name
(Type)
Relative
Description
ResultParent
(ResultChild)
PimRouterConfig
PimRouterResults Writable Attributes

PimRouterResults Read-Only Attributes

Read-Only Attribute
Description
MdtJoinCount
Number of MDT join messages.

Type: u64
Default: 0
NeighborCount
Number of PIM neighbors for this router.

Type: u64
Default: 0
RxAssertCount
Number of Assert messages received.

Type: u64
Default: 0
RxBootstrapCount
Number of Bootstrap messages received.

Type: u64
Default: 0
RxCandRpAdvertCount
Number of candidate Rendezvous Point (RP) Advertisements received.

Type: u64
Default: 0
RxGroupRpCount
Number of (*,*,RP) groups received.

Type: u64
Default: 0
RxGroupSgCount
Number of (S,G) groups received.

Type: u64
Default: 0
RxGroupSgrptCount
Number of (S,G,rpt) groups received.

Type: u64
Default: 0
RxGroupStargCount
Number of (*,G) groups received.

Type: u64
Default: 0
RxHelloCount
Number of Hello messages received.

Type: u64
Default: 0
RxJoinPruneCount
Number of Join/Prune messages received.

Type: u64
Default: 0
1890
PimSendBsmsCommand
Read-Only Attribute
Description
RxRegisterCount
Number of Register messages received.

Type: u64
Default: 0
RxRegisterStopCount
Number of Register Stop messages received.

Type: u64
Default: 0
TxAssertCount
Number of Assert messages sent.

Type: u64
Default: 0
TxBootstrapCount
Number of Bootstrap messages sent.

Type: u64
Default: 0
TxCandRpAdvertCount
Number of candidate Rendezvous Point (RP) Advertisements sent.

Type: u64
Default: 0
TxGroupRpCount
Number of (*,*,RP) groups sent.

Type: u64
Default: 0
TxGroupSgCount
Number of (S,G) groups sent.

Type: u64
Default: 0
TxGroupSgrptCount
Number of (S,G,rpt) groups sent.

Type: u64
Default: 0
TxGroupStargCount
Number of (*,G) groups sent.

Type: u64
Default: 0
TxHelloCount
Number of Hello messages sent.

Type: u64
Default: 0
TxJoinPruneCount
Number of Join/Prune messages sent.

Type: u64
Default: 0
TxRegisterCount
Number of Register messages sent.

Type: u64
Default: 0
TxRegisterStopCount
Number of Register Stop messages sent.

Type: u64
Default: 0
PimSendBsmsCommand
Description:
Send bootstrap messages (BSMs) for the selected PIM routers.

1891
PimSendJoinsCommand
PimSendBsmsCommand Writable Attributes

Writable Attribute
Description
RouterList

Type: handle
Default: 0
PimSendBsmsCommand Read-Only Attributes

Read-Only Attribute
Description

PimSendJoinsCommand
Description:
Send Joins for the selected PIM groups.

PimSendJoinsCommand Writable Attributes

Writable Attribute
Description
GroupList

Type: handle
Default: 0
PimSendJoinsCommand Read-Only Attributes

Read-Only Attribute
Description

PimSendPrunesCommand
Description:
Send Prunes for the selected PIM groups.

1892
PimSharedSessionParams
PimSendPrunesCommand Writable Attributes

Writable Attribute
Description
GroupList

Type: handle
Default: 0
PimSendPrunesCommand Read-Only Attributes

Read-Only Attribute
Description

PimSharedSessionParams
Description:
PIM shared session parameters.
PimSharedSessionParams Writable Attributes

Writable Attribute
Description
Active, Name
BsrPriority
BSR Priority.
Type: u8
Default: 1
Range: 0 - 255
DrPriority
DR Priority.
Type: u32
Default: 1
EnableBsr
Whether to enable BSR.

Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
Enable BSR.
FALSE Disable BSR.

IpVersion
IP version.
Type: enum
Default: IPV4
Possible Values:
Value Description
IPV4
IPv4
IPV6
IPv6
1893
PimStateSummary
Writable Attribute
Description
PimMode
PIM mode.
Type: enum
Default: SM
Possible Values:
Value Description
SM
PIM-SM
SSM
PIM-SSM
PimSharedSessionParams Read-Only Attributes

PimStateSummary
Description:
Summary of PIM router states at port and project level.

Relations:
Side name
(Type)
Relative
Description
ResultParent
(ResultChild)
Port, Project
PimStateSummary Writable Attributes

PimStateSummary Read-Only Attributes

Read-Only Attribute
Description
DrCount
Number of DR PIM routers.

Type: u32
Default: 0
HelloCount
Number of Hello messages sent.

Type: u32
Default: 0
NeighborCount
Number of PIM neighbors for this router.

Type: u32
Default: 0
NotStartedCount
Number of PIM routers not started.

Type: u32
Default: 0
RouterDownCount
Number of PIM routers in DOWN state.

Type: u32
Default: 0
RouterUpCount
Number of PIM routers in UP state.

Type: u32
Default: 0
1894
PimStopBsmsCommand
Read-Only Attribute
Description
StartedCount
Number of PIM routers started.

Type: u32
Default: 0
StoppedCount
Number of PIM routers in STOP state.

Type: u32
Default: 0
PimStopBsmsCommand
Description:
Stop bootstrap messages (BSMs) for the selected PIM routers.

PimStopBsmsCommand Writable Attributes

Writable Attribute
Description
RouterList

Type: handle
Default: 0
PimStopBsmsCommand Read-Only Attributes

Read-Only Attribute
Description

PimStopHellosCommand
Description:
Stop sending Hellos for the selected PIM routers.

PimStopHellosCommand Writable Attributes

Writable Attribute
Description
1895
PimStopJoinsCommand
Writable Attribute
Description
RouterList

Type: handle
Default: 0
PimStopHellosCommand Read-Only Attributes

Read-Only Attribute
Description

PimStopJoinsCommand
Description:
Stop Joins for the selected PIM groups.

PimStopJoinsCommand Writable Attributes

Writable Attribute
Description
GroupList

Type: handle
Default: 0
PimStopJoinsCommand Read-Only Attributes

Read-Only Attribute
Description

PimSwitchTrafficToDataMdtCommand
Description:
Switch traffic from Default MDT to Data MDT.

1896
PimSwitchTrafficToDefaultMdtCommand
PimSwitchTrafficToDataMdtCommand Writable Attributes

Writable Attribute
Description
DataMdtMulticastGroup
Data MDT Multicast Group Handle.

Type: handle
Default: 0
MdtDelay
MDT Delay (seconds).

Type: u16
Default: 3
MdtInterval
MDT interval (seconds).

Type: u16
Default: 60
RouterList
PIM router handle list.

Type: handle
Default: 0
StreamBlockList
Stream block list.

Type: handle
Default: 0
PimSwitchTrafficToDataMdtCommand Read-Only Attributes

Read-Only Attribute
Description

PimSwitchTrafficToDefaultMdtCommand
Description:
Switch traffic to Default MDT.

PimSwitchTrafficToDefaultMdtCommand Writable Attributes

Writable Attribute
Description
RouterList
PIM router handle list.

Type: handle
Default: 0
StreamBlockList
Stream block list.

Type: handle
Default: 0
1897
Pimv4Assert
PimSwitchTrafficToDefaultMdtCommand Read-Only Attributes

Read-Only Attribute
Description

Pimv4Assert (pim:Pimv4Assert)
Description:
Children: groupAddr, header, sourceAddr
Pimv4Assert Attributes
Attribute
Description
metric
Type: INTEGER
Default: 0
metricPref
Type: INTEGER
Default: 0
Name
Type: string
rBit
Type: BITSTRING
Default: 0
Pimv4GroupBlk
Description:
IPv4 Multicast Group block.

Automatically-created children: Pimv4JoinSrc, Pimv4PruneSrc
Relations:
Side name
(Type)
Relative
Description
JoinedMulticastGroup
(JoinedGroup)
Ipv4Group
Identifies the IPv4 Multicast Group address block to use.
Pimv4GroupBlk Writable Attributes

Writable Attribute
Description
Active, Name
1898
Pimv4Hello
Writable Attribute
Description
EnablingPruning
Enables including the optional Prune source for (*,G) groups.

Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
Enables Prune source.
FALSE Disables Prune Source.

GroupType
Group designation. Notation represents a routing entry.

Type: enum
Default: STARG
Possible Values:
Value
Description
STARG
Default group-specific multicast group set type that is used in Join/Prune messages with (*,G) source
list entries.
SG
Group-specific multicast group set type that is used in Join/Prune messages with (S,G) source-specific
source list entries.
STARSTARRP Wildcard multicast group set type. This is used in (*,*,RP) Join/Prune messages.
RpIpAddr
Rendezvous Point Router (RPR) address = a PIM router configured as the root of a multicast distribution tree. Required
for (*,*,RP) and (*,G) groups.
Type: ip
Default: 192.0.0.1
Pimv4GroupBlk Read-Only Attributes

Pimv4Hello (pim:Pimv4Hello)
Description:
PIM IPv4 Hello message. See RFC 3973.
Children: header, options
Pimv4Hello Attributes
Attribute
Description
Name
information.
Type: string
Pimv4HelloOption
Description:
Parents: options
Children: addressList, drPriority, generationID, holdTime, lanPruneDelay
1899
Pimv4JoinPrune
Pimv4HelloOption Attributes
Attribute
Description
Name
information.
Type: string
Pimv4JoinPrune (pim:Pimv4JoinPrune)
Description:
PIM IPv4 Join/Prune message. See RFC 2362.
Children: groupRecords, header, upstreamNbr
Pimv4JoinPrune Attributes
Attribute
Description
holdTime
Type: INTEGER
Default: 105
Name
Type: string
numGroups
Type: INTEGER
Default: 1
reserved
Type: INTEGER
Default: 0
Pimv4JoinSrc
Description:
Required field for (S,G) groups.
The Join source block (Source Start IP address and Source Prefix length) represents the source address range from which the (S,G) group requests traffic.
Each Join/Prune message corresponding to this (S,G) group includes the specified source address in its Join source list (or in the Prune source list, if the
group is being deleted or made inactive).

Automatically created from: Pimv4GroupBlk
Relations:
Side name
(Type)
Relative
Description
DstBoundTo
(DstBinding)

StreamBlock.
EncapsulationSource
(Encapsulation)
PathDescriptor
1900
Pimv4JoinSrc
Side name
(Type)
Relative
Description
MemberOfVpn
(MemberOfVpn)

Port


VlanIf, WimaxIf

SrcBoundTo
(SrcBinding)

StreamBlock.
StackedOn
(StackedOnEndpoint)

VlanIf, WimaxIf
Port

Pimv4JoinSrc Writable Attributes

Writable Attribute
Description
Active, Name
AddrIncrement

Type: u32
Default: 1
NetworkCount

Type: u32
Default: 1
PrefixLength
Prefix length of the joined Source IP address.

Type: u8
Default: 24
Range: 0 - 32
StartIpList
Starting IP address of Join source range. Note: Only the first IP address in the list is used.
Type: ip
Default: 192.0.1.0
Pimv4JoinSrc Read-Only Attributes

1901
Pimv4NullRegister
Pimv4NullRegister (pim:Pimv4NullRegister)
Description:
Children: header
Next headers: ipv4:IPv4
Pimv4NullRegister Attributes
Attribute
Description
borderBit
Type: BITSTRING
Default: 0
Name
Type: string
nullBit
Type: BITSTRING
Default: 0
reserved
Type: INTEGER
Default: 0
Pimv4PruneSrc
Description:
Optional. Applies only to (*,G) groups.
The Prune source address block (Prune IP address and Prune Prefix length) represents the source range from which (*,G) groups request that NO traffic be
sent (i.e., send traffic for this group, except from this source).
This field is optional, since the exception requirement is not always necessary. Join/Prune messages corresponding to this (*,G) group will include the specified
address in their Prune list.

Relations:
Side name
(Type)
Relative
Description
DstBoundTo
(DstBinding)

StreamBlock.
EncapsulationSource
(Encapsulation)
PathDescriptor
MemberOfVpn
(MemberOfVpn)

Port

1902
Pimv4Register
Side name
(Type)
Relative
Description

VlanIf, WimaxIf

SrcBoundTo
(SrcBinding)

StreamBlock.
StackedOn
(StackedOnEndpoint)

VlanIf, WimaxIf
Port

Pimv4PruneSrc Writable Attributes

Writable Attribute
Description
Active, Name
AddrIncrement

Type: u32
Default: 1
NetworkCount

Type: u32
Default: 1
PrefixLength
Prefix length of the pruned Source IP address.

Type: u8
Default: 24
Range: 0 - 32
StartIpList
Starting IP address of Prune source range. Note: Only the first IP address in the list is used.
Type: ip
Default: 192.0.1.0
Pimv4PruneSrc Read-Only Attributes

Pimv4Register (pim:Pimv4Register)
Description:
PIM IPv4 Register message. See RFC 2362.
Children: header
1903
Pimv4RegisterStop
Pimv4Register Attributes
Attribute
Description
borderBit
Type: BITSTRING
Default: 0
multicastPacket
Type: OCTETSTRING
Name
Type: string
nullBit
Type: BITSTRING
Default: 0
reserved
Type: INTEGER
Default: 0
Pimv4RegisterStop (pim:Pimv4RegisterStop)
Description:
PIM IPv4 Register-Stop message. See RFC 2362.
Pimv4RegisterStop Attributes
Attribute
Description
Name
information.
Type: string
Pimv4RpMap
Description:
IPv4 Group-RP (Rendezvous Point) mapping.

Relations:
Side name
(Type)
Relative
Description
(JoinedGroup)
Ipv4Group
1904
Pimv6Assert
Pimv4RpMap Writable Attributes

Writable Attribute
Description
Active, Name
RpHoldTime
Hold time specified by the candidate Rendezvous Point (RP) router.

Type: u16
Default: 150
Range: 1 - 65535
RpIpAddr
Rendezvous Point Router address = a PIM router configured as the root of a multicast distribution tree.
Type: ip
Default: 192.0.0.1
RpPriority
Priority specified by the candidate Rendezvous Point (RP) router.

Type: u8
Default: 0
Pimv4RpMap Read-Only Attributes

Pimv6Assert (pim:Pimv6Assert)
Description:
Pimv6Assert Attributes
Attribute
Description
metric
Type: INTEGER
Default: 0
metricPref
Type: INTEGER
Default: 0
Name
Type: string
rBit
Type: BITSTRING
Default: 0
Pimv6GroupBlk
Description:
IPv6 Multicast Group block.

Automatically-created children: Pimv6JoinSrc, Pimv6PruneSrc
1905
Pimv6Hello
Relations:
Side name
(Type)
Relative
Description
(JoinedGroup)
Ipv6Group
Pimv6GroupBlk Writable Attributes

Writable Attribute
Description
Active, Name
EnablingPruning
Enables including the optional Prune source for (*,G) groups.

Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
Enables Prune source.
FALSE Disables Prune Source.

GroupType
Group designation. Notation represents a routing entry.

Type: enum
Default: STARG
Possible Values:
Value
Description
STARG
Default group-specific multicast group set type that is used in Join/Prune messages with (*,G) source
list entries.
SG
Group-specific multicast group set type that is used in Join/Prune messages with (S,G) source-specific
source list entries.
STARSTARRP Wildcard multicast group set type. This is used in (*,*,RP) Join/Prune messages.
RpIpAddr
Rendezvous Point Router (RPR) address = a PIM router configured as the root of a multicast distribution tree. Required
for (*,*,RP) and (*,G) groups.
Type: ipv6
Default: 2000::1
Pimv6GroupBlk Read-Only Attributes

Pimv6Hello (pim:Pimv6Hello)
Description:
PIM IPv6 Hello message. See RFC 3973.
Children: header, options
Pimv6Hello Attributes
Attribute
Description
Name
information.
Type: string
1906
Pimv6HelloOption
Pimv6HelloOption
Description:
Parents: options
Children: addressList, drPriority, generationID, holdTime, lanPruneDelay
Pimv6HelloOption Attributes
Attribute
Description
Name
information.
Type: string
Pimv6JoinPrune (pim:Pimv6JoinPrune)
Description:
PIM IPv6 Join/Prune message. See RFC 2362.
Children: groupRecords, header, upstreamNbr
Pimv6JoinPrune Attributes
Attribute
Description
holdTime
Type: INTEGER
Default: 105
Name
Type: string
numGroups
Type: INTEGER
Default: 1
reserved
Type: INTEGER
Default: 0
Pimv6JoinSrc
Description:
Required field for (S,G) groups.
The Join source block (Source Start IP address and Source Prefix length) represents the source address range from which the (S,G) group requests traffic.
Each Join/Prune message corresponding to this (S,G) group includes the specified source address in its Join source list (or in the Prune source list, if the
group is being deleted or made inactive).

Relations:
1907
Pimv6JoinSrc
Side name
(Type)
Relative
Description
DstBoundTo
(DstBinding)

StreamBlock.
EncapsulationSource
(Encapsulation)
PathDescriptor
MemberOfVpn
(MemberOfVpn)

Port


VlanIf, WimaxIf

SrcBoundTo
(SrcBinding)

StreamBlock.
StackedOn
(StackedOnEndpoint)

VlanIf, WimaxIf
Port

Pimv6JoinSrc Writable Attributes

Writable Attribute
Description
Active, Name
AddrIncrement

Type: u32
Default: 1
NetworkCount

Type: u32
Default: 1
PrefixLength
Prefix length of the joined Source IP address.

Type: u8
Default: 64
Range: 0 - 128
StartIpList
Starting IP address of Join source range. Note: Only the first IP address in the list is used.
Type: ipv6
Default: 2000::1
Pimv6JoinSrc Read-Only Attributes

1908
Pimv6PruneSrc
Pimv6PruneSrc
Description:
Optional. Applies only to (*,G) groups.
The Prune source address block (Prune IP address and Prune Prefix length) represents the source range from which (*,G) groups request that NO traffic be
sent (i.e., send traffic for this group, except from this source).
This field is optional, since the exception requirement is not always necessary. Join/Prune messages corresponding to this (*,G) group will include the specified
address in their Prune list.

Relations:
Side name
(Type)
Relative
Description
DstBoundTo
(DstBinding)

StreamBlock.
EncapsulationSource
(Encapsulation)
PathDescriptor
MemberOfVpn
(MemberOfVpn)

Port


VlanIf, WimaxIf

SrcBoundTo
(SrcBinding)

StreamBlock.
StackedOn
(StackedOnEndpoint)

VlanIf, WimaxIf
Port

Pimv6PruneSrc Writable Attributes

Writable Attribute
Description
Active, Name
AddrIncrement

Type: u32
Default: 1
NetworkCount

Type: u32
Default: 1
1909
Pimv6Register
Writable Attribute
Description
PrefixLength
Prefix length of the pruned source IP address.

Type: u8
Default: 64
Range: 0 - 128
StartIpList
Starting IP address of Prune source range. Note: Only the first IP address in the list is used.
Type: ipv6
Default: 2000::1
Pimv6PruneSrc Read-Only Attributes

Pimv6Register (pim:Pimv6Register)
Description:
PIM IPv6 Register message. See RFC 2362.
Children: header
Pimv6Register Attributes
Attribute
Description
borderBit
Type: BITSTRING
Default: 0
multicastPacket
Type: OCTETSTRING
Name
Type: string
nullBit
Type: BITSTRING
Default: 0
reserved
Type: INTEGER
Default: 0
Pimv6RegisterStop (pim:Pimv6RegisterStop)
Description:
PIM IPv4 Register-Stop message. See RFC 2362.
1910
Pimv6RpMap
Pimv6RegisterStop Attributes
Attribute
Description
Name
information.
Type: string
Pimv6RpMap
Description:
IPv6 Group-RP (Rendezvous Point) mapping.

Relations:
Side name
(Type)
Relative
Description
(JoinedGroup)
Ipv6Group
Pimv6RpMap Writable Attributes

Writable Attribute
Description
Active, Name
RpHoldTime
Hold time specified by the candidate Rendezvous Point (RP) router.

Type: u16
Default: 150
Range: 1 - 65535
RpIpAddr
Rendezvous Point Router address = a PIM router configured as the root of a multicast distribution tree.
Type: ipv6
Default: 2000::1
RpPriority
Priority specified by the candidate Rendezvous Point (RP) router.

Type: u8
Default: 0
Pimv6RpMap Read-Only Attributes

PingReport
Description:
Provides a Ping summary after each Ping command.

Relations:
1911
PingStartCommand
Side name
(Type)
Relative
Description
ResultParent
(ResultChild)
Port
PingReport Writable Attributes

Writable Attribute
Description
Active, Name
PingReport Read-Only Attributes

Read-Only Attribute
Description
AttemptedPingCount
Total number of attempted Pings.

Type: u32
Default: 0
FailedPingCount
Total number of failed Pings.

Type: u32
Default: 0
PingResult
Ping output prompt message.

Type: string
PingStatus
Ping status string from the PingStart command. This is constantly updated as Pings continue.
Type: enum
Default: IDLE
Possible Values:
Value
Description
IDLE
Ping is not in progress.
INPROGRESS Ping is in progress.

SUCCESSFUL Ping is successful.
FAILURE
SuccessfulPingCount
Ping failed.
Total number of successful Pings.

Type: u32
Default: 0
PingStartCommand
Description:
Ping the target IP address.

PingStartCommand Writable Attributes

Writable Attribute
Description
1912
PingStartCommand
Writable Attribute
Description
DeviceList
List of one or more Host or Router object handles. Tells which Host or Router objects will do the pinging.
Type: handle
Default: 0
FrameCount
How many Ping packets to transmit.

Type: u32
Default: 1
PingIpv4DstAddr
The Ping target IPv4 address.

Type: ip
Default: 0.0.0.0
PingIpv4SrcAddr
not use it.
The Ping source IPv4 address. You should set this to match the first IP address configured for the Ipv4If object
under the Host or Router object, because that is the IP address that will be used as the source of the Ping.
Type: ip
Default: 0.0.0.0
PingIpv6DstAddr
The Ping target IPv6 address.

Type: ipv6
Default: ::0
PingIpv6SrcAddr
not use it.
The Ping source IPv6 address.
Type: ipv6
Default: ::0
TimeInterval
Interval in seconds between Ping packets.

Type: u32
Default: 1
WaitForPingToFinish
Whether the command should wait for the Ping to finish.

Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
Wait for Ping to finish.
FALSE Do not wait for Ping to finish.
PingStartCommand Read-Only Attributes

Read-Only Attribute
Description

PingResult
Results of the Ping command.

Type: string
PingStatus
Whether the Ping command passed or failed.

Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
The Ping command passed.
FALSE The Ping command failed.

ProcessId
Ping process ID.

Type: u32
Default: 0
1913
PingStopCommand
PingStopCommand
Description:
Stops a Ping command.

PingStopCommand Writable Attributes

Writable Attribute
Description
DeviceList
List of one or more Host or Router object handles. Tells which Host or Router objects to stop the
pinging on.
Type: handle
Default: 0
ProcessId
The ProcessId to be stopped.

Type: u32
Default: 0
PingStopCommand Read-Only Attributes

Read-Only Attribute
Description

ExitCode
The exit code that determines if the process was completed successfully.
Type: u32
Default: 0
PingVerifyConnectivityCommand
Description:
Verify if ping succeeded.

Parents: Sequencer
PingVerifyConnectivityCommand Writable Attributes

Writable Attribute
Description
DeviceList
List of device or port handles.

Type: handle
Default: 0
FrameCount
Ping frame count.

Type: u32
Default: 1
TimeInterval
Ping time interval.

Type: u32
Default: 1
1914
platformAttributeEntries
PingVerifyConnectivityCommand Read-Only Attributes

Read-Only Attribute
Description
PassFailState
platformAttributeEntries (overloaded)
platformAttributeEntries (fc)
platformAttributeEntries (fcgs)
platformAttributeEntries Object (fc PDU library)

Description:
Parents: gpabAccept (StreamBlock.FCoE.fc.fcPayloads.FCPayload-Choice.gpabAccept)

Children: PlatformAttributeEntry
platformAttributeEntries Attributes
Attribute
Description
Name
information.
Type: string
platformAttributeEntries Object (fcgs PDU library)

Description:
Parents: gpabAccept (StreamBlock.GpabAccept)

Children: PlatformAttributeEntry
platformAttributeEntries Attributes
Attribute
Description
Name
information.
Type: string
1915
PlatformAttributeEntry
Description:
Parents: platformAttributeEntries
Children: None
PlatformAttributeEntry Attributes
Attribute
Description
attributeEntryLength
Type: INTEGER
Default: 0
attributeEntryType
Type: AttributeEntryType
Default: 0001
Possible Values:
Value Description
0001
Vendor ID
0002
Product ID
0003
Product Revision Level
0004
Description
0005
Label
0006
Location
0007
System ID
0008
System Management Address
0009
Cluster ID
000A Cluster Management Address

000B Supported FC-4 Types
attributeEntryValue
Type: ASCII
Name
Type: string
pad
Description:
Parents: platformAttributeEntries
Children: None
PlatformAttributeEntry Attributes
Attribute
Description
Type: INTEGER
Default: 0
1916
platformNameEntries
Attribute
Description
attributeEntryType
Default: 0001
Possible Values:
Value Description
0001
Vendor ID
0002
Product ID
0003
0004
Description
0005
Label
0006
Location
0007
System ID
0008
0009
Cluster ID

attributeEntryValue
Type: ASCII
Name
Type: string
pad
platformNameEntries (overloaded)
platformNameEntries (fc)
platformNameEntries (fcgs)
platformNameEntries Object (fc PDU library)

Description:
Parents: gpnlAccept (StreamBlock.FCoE.fc.fcPayloads.FCPayload-Choice.gpnlAccept)

Children: PlatformNameEntry
platformNameEntries Attributes
Attribute
Description
Name
information.
Type: string
1917
PlatformNameEntry
platformNameEntries Object (fcgs PDU library)

Description:
Parents: gpnlAccept (StreamBlock.GpnlAccept)

Children: PlatformNameEntry
platformNameEntries Attributes
Attribute
Description
Name
information.
Type: string
PlatformNameEntry
Description:
Parents: platformNameEntries
Children: None
PlatformNameEntry Attributes
Attribute
Description
Name
Type: string
platformName
Type: ASCII
platformNameFormat
Type: OCTETSTRING
Default: 02
platformNameLength
Type: INTEGER
Default: 0
reserved1
PlatformNameEntry
Description:
Parents: platformNameEntries
Children: None
1918
platformNodeNameEntries
PlatformNameEntry Attributes
Attribute
Description
Name
Type: string
platformName
Type: ASCII
platformNameFormat
Type: OCTETSTRING
Default: 02
platformNameLength
Type: INTEGER
Default: 0
reserved1
platformNodeNameEntries (overloaded)
platformNodeNameEntries (fc)
platformNodeNameEntries (fcgs)
platformNodeNameEntries Object (fc PDU library)

Description:
Parents: gplnlAccept (StreamBlock.FCoE.fc.fcPayloads.FCPayload-Choice.gplnlAccept)

Children: PlatformNodeNameEntry
platformNodeNameEntries Attributes
Attribute
Description
Name
information.
Type: string
platformNodeNameEntries Object (fcgs PDU library)

Description:
1919
PlatformNodeNameEntry
Parents: gplnlAccept (StreamBlock.GplnlAccept)

Children: PlatformNodeNameEntry
platformNodeNameEntries Attributes
Attribute
Description
Name
information.
Type: string
Description:
Parents: platformNodeNameEntries
Children: None
PlatformNodeNameEntry Attributes
Attribute
Description
Name
Type: string
platformNodeName
Type: WWN
Default: 10:00:10:94:00:00:00:00
Description:
Parents: platformNodeNameEntries
Children: None
PlatformNodeNameEntry Attributes
Attribute
Description
Name
Type: string
platformNodeName
Type: WWN
Default: 10:00:10:94:00:00:00:00
1920
plogiAccept
plogiAccept
Description:
plogiAccept Attributes
Attribute
Description
command
Type: OCTETSTRING
Default: 02
Name
Type: string
nodeName
Type: WWN
Default: 10:00:10:94:00:00:00:01
nPortName
Type: WWN
Default: 20:00:10:94:00:00:00:01
reserved1
Type: OCTETSTRING
Default: 000000
vendorVersionLevel
Type: OCTETSTRING
plogiReject
Description:
Children: None
plogiReject Attributes
Attribute
Description
command
Type: OCTETSTRING
Default: 01
Name
Type: string
reasonCode
Type: OCTETSTRING
Default: 3
reasonExplanation
Type: OCTETSTRING
Default: 0F
reserved1
Type: OCTETSTRING
Default: 00000000
vendorUnique
Type: OCTETSTRING
Default: 0
1921
plogiRequest
plogiRequest
Description:
plogiRequest Attributes
Attribute
Description
command
Type: OCTETSTRING
Default: 03
Name
Type: string
nodeName
Type: WWN
Default: 10:00:10:94:00:00:00:01
nPortName
Type: WWN
Default: 20:00:10:94:00:00:00:01
reserved1
Type: OCTETSTRING
Default: 000000
vendorVersionLevel
Type: OCTETSTRING
PluginInfo
Description:
Do not use this object.
Stores the results of GetPluginInfoCommand. Each PluginInfo object contains the name and version of a loaded plugin.

Parents: GetPluginInfoCommand
PluginInfo Writable Attributes

Writable Attribute
Description
Active, Name
PluginInfo Read-Only Attributes

Read-Only Attribute
Description
PackageName
Currently this is always an empty string.

Type: string
Version
The version of the plugin.

Type: string
1922
Port
Port
Description:

Parents: Project
Children: Aal5If, AtmPhy, BfdStateSummary, BgpStateSummary, Dhcpv4ServerDefaultPoolConfig, Dhcpv4ServerPoolConfig, Dhcpv6ServerAddrPoolConfig,
Dhcpv6ServerDefaultAddrPoolConfig, Dhcpv6ServerDefaultPrefixPoolConfig, Dhcpv6ServerPrefixPoolConfig, Dot1xPortConfig, Ethernet100GigFiber,
Ethernet10GigCopper, Ethernet10GigFiber, Ethernet40GigFiber, EthernetCopper, EthernetFiber, EthIIIf, FcIf, FcPhy, GreIf, HdlcIf, Ieee1588v2StateSummary,
Ipv4If, Ipv4NetworkBlock, Ipv6If, Ipv6NetworkBlock, IsisStateSummary, ItagIf, L2tpv2If, LacpPortConfig, LacpStateSummary, LdpStateSummary,
LldpStateSummary, LspPingStateSummary, MacBlock, MplsIf, Ospfv2StateSummary, Ospfv3StateSummary, PfcMeasurementConfig, PimStateSummary,
Pimv4JoinSrc, Pimv4PruneSrc, Pimv6JoinSrc, Pimv6PruneSrc, POSPhy, PppIf, PppoeIf, PppoeServerIpv4PeerPool, PppoxServerIpv4PeerPool,
PppoxServerIpv6PeerPool, Probe, RipngStateSummary, Ripv4StateSummary, RsvpStateSummary, StpStateSummary, StreamBlock, SyncEthPortConfig,
SyncEthStateSummary, TwampStateSummary, VlanBlock, VlanIf, VqAnalyzerPortGenParams, Wimax16dPhy, WimaxIf
Automatically-created children: Analyzer, AncpPortConfig, ArpCache, ArpNdReport, Capture, Dhcpv4PortConfig, Dhcpv6PortConfig, EoamPortConfig,
Generator, Host, IgmpPortConfig, L2tpPortConfig, MldPortConfig, PingReport, PppoxPortConfig, PppProtocolConfig, SaaPortConfig, StpPortConfig, VqAnalyzer
Result children (automatically created): ArpCache, ArpNdReport, ArpNdResults, BfdStateSummary, BgpStateSummary, FcResults, GreIfPortResults,
Ieee1588v2StateSummary, IptvPortResults, IsisStateSummary, LacpStateSummary, LdpStateSummary, LldpStateSummary, LspPingStateSummary,
Ospfv2StateSummary, Ospfv3StateSummary, PfcResults, PimStateSummary, PingReport, RipngStateSummary, Ripv4StateSummary, RsvpStateSummary,
RxPortPairResults, SipPortResults, SonetAlarmsResults, SonetResults, StpStateSummary, SyncEthStateSummary, TwampClientResults,
TwampPortTestSessionResults, TwampServerResults, TwampStateSummary, TxPortPairResults
Relations:
Side name
(Type)
Relative
Description
ActivePhy
(ActivePhy)
AtmPhy, Ethernet100GigFiber, Ethernet10GigCopper, Ethernet10GigFiber,

Ethernet40GigFiber, EthernetCopper, EthernetFiber, FcPhy, POSPhy,
Wimax16dPhy
Identifies the currently active PHY object

for this port. Use
PortSetupSetActivePhyCommand and
PortSetupGetActivePhyCommand
instead of manipulating this relation
directly.
AffiliatedPortSource
(AffiliationPort)
AccessTestGenPortParams, EmulatedDevice, FcLeftSidePortParams,

FcoeLeftSidePortParams, FcoeRightSidePortParams,
FcRightSidePortParams, Host, Router
ContainerResultChild
(ContainerResult)
RxPortPairResults, TxPortPairResults
General-purpose relation for result

objects. For example,
RxTrafficGroupResults objects are
linked to the StreamBlock object with
this relation.
DstBoundTo
(DstBinding)
TrafficDescriptor
Specifies destination endpoints bound

to StreamBlock.
ExpectedRxSource
(ExpectedRx)
StreamBlock
GroupSource
(GroupMembership)
PortGroup
MemberOfVpn
(MemberOfVpn)

VpnSiteInfoVplsLdp
TrafficDescriptorMonitorPortSrc
(MonitorPortBinding)
TrafficDescriptor
MulticastExpectedRxPortsSource

Dhcpv6ServerDefaultPrefixPoolConfig, Dhcpv6ServerPrefixPoolConfig,
EthIIIf, FcIf, GreIf, HdlcIf, Ipv4If, Ipv4NetworkBlock, Ipv6If, Ipv6NetworkBlock,
ItagIf, L2tpv2If, MacBlock, MplsIf, Pimv4JoinSrc, Pimv4PruneSrc,
Pimv6JoinSrc, Pimv6PruneSrc, PppIf, PppoeIf, PppoeServerIpv4PeerPool,
WimaxIf
Config
(MulticastMonitorPortBinding)
Rfc3918Config
PhysicalPort
(PhysicalLogical)
PhysicalPort
1923

relation.
Port
Side name
(Type)
Relative
Description
PrimaryIf
(PrimaryIf)

the DUT.
ResultChild
(ResultChild)
ArpCache, ArpNdReport, ArpNdResults, BfdStateSummary,

BgpStateSummary, FcResults, GreIfPortResults, Ieee1588v2StateSummary,
IptvPortResults, IsisStateSummary, LacpStateSummary, LdpStateSummary,
LldpStateSummary, LspPingStateSummary, Ospfv2StateSummary,
Ospfv3StateSummary, PfcResults, PimStateSummary, PingReport,
RipngStateSummary, Ripv4StateSummary, RsvpStateSummary,
RxPortPairResults, SipPortResults, SonetAlarmsResults, SonetResults,
StpStateSummary, SyncEthStateSummary, TwampClientResults,
TwampPortTestSessionResults, TwampServerResults,
TwampStateSummary, TxPortPairResults

an object.
DeviceGenParams
(SelectedPort)
EmulatedDeviceGenParams, HostGenParams,
MultiSegmentLeftSitePortParams, MultiSegmentRightSitePortParams,
MvpnGenCorePortParams, MvpnGenCustPortParams, RouterGenParams,
Vpn6PeGenCorePortParams, Vpn6PeGenCustPortParams,
Vpn6PeSiteGenParams, VpnBgpVplsGenCorePortParams,
VpnBgpVplsGenCustPortParams, VpnBgpVplsSiteGenParams,
VpnLdpVplsGenCorePortParams, VpnLdpVplsGenCustPortParams,
VpnLdpVplsSiteGenParams, VpnMartiniGenCorePortParams,
VpnMartiniGenCustPortParams, VpnRfc2547GenCorePortParams,
VpnRfc2547GenCustPortParams, VpnRfc2547SiteGenParams
SrcBoundTo
(SrcBinding)
TrafficDescriptor

StreamBlock.
TopLevelIf
(TopLevelIf)

interface stack.
UnicastExpectedRxPortsSource

Dhcpv6ServerDefaultPrefixPoolConfig, Dhcpv6ServerPrefixPoolConfig,
EthIIIf, FcIf, GreIf, HdlcIf, Ipv4If, Ipv4NetworkBlock, Ipv6If, Ipv6NetworkBlock,
ItagIf, L2tpv2If, MacBlock, MplsIf, Pimv4JoinSrc, Pimv4PruneSrc,
Pimv6JoinSrc, Pimv6PruneSrc, PppIf, PppoeIf, PppoeServerIpv4PeerPool,
WimaxIf

relation.
Port Writable Attributes

Writable Attribute
Description
Active, Name
AppendLocationToPortName
Type: bool
Default: TRUE
Possible Values:
Value Description
TRUE
FALSE
Layer3Type
Type: enum
Default: IPV4
Possible Values:
Value Description
IPV4
IPV6
IPV4V6
Location
Location of the physical port to bind with.

Type: csp
1924
PortAndProtocolVlanIdTlv
Writable Attribute
Description
UseDefaultHost
Type: bool
Default: TRUE
Possible Values:
Value Description
TRUE
FALSE
Port Read-Only Attributes

Read-Only Attribute
Description
Online
Online status of the port.

Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
Port is online.
FALSE Port is offline.

PortGroupSize
Type: u16
Default: 0
SupportedPhys
Supported physical layer interfaces under the port.

Type: enum
Default: ETHERNET_COPPER
Possible Values:
Value
Description
ETHERNET_COPPER
Copper Ethernet.
ETHERNET_FIBER
Fiber Ethernet.
Fiber 10 gigabit Ethernet.
POS
Packet over SONET.
ETHERNET_10_GIG_COPPER Copper 10 gigabit Ethernet.

ATM
FC
PortAndProtocolVlanIdTlv (lldp:PortAndProtocolVlanIdTlv)
Description:
Children: flags
lldp:NivSupportTlv
PortAndProtocolVlanIdTlv Attributes
Attribute
Description
length
Type: INTEGER
Default: 0
1925
PortAvgLatencyResults
Attribute
Description
Name
Type: string
oui
Type: OCTETSTRING
Default: 0080C2
portAndProtocolVlanId
Type: OCTETSTRING
Default: 0000
subtype
Type: OCTETSTRING
Default: 02
type
Type: INTEGER
Default: 127
PortAvgLatencyResults
Description:
Result object to aggregate all stream latency counters per port.

Parents: Analyzer
Relations:
Side name
(Type)
Relative
Description
ResultParent
(ResultChild)
Analyzer
PortAvgLatencyResults Writable Attributes

PortAvgLatencyResults Read-Only Attributes

Read-Only Attribute
Description
AvgLatency

Type: double
Default: 0
MaxLatency

Type: double
Default: 0
MinLatency

Type: double
Default: 0
portComponent
Description:
1926
portComponent
Parents: chassisid
Children: None
portComponent Attributes
Attribute
Description
id
Type: ASCII
Default: SPIRENT
Name
information.
Type: string
subtype
Default: 03
Possible Values:
Value Description
01
Chassis Component
02
Interface Alias
03
Port Component
04
MAC Address
05
Network Address
06
Interface Name
07
Locally Assigned
portComponent
Description:
Children: None
portComponent Attributes
Attribute
Description
ChassisID
Type: ASCII
Default: SPIRENT
ChassisIDSubtype
Default: 03
Possible Values:
Value Description
Name
01
Chassis Component
02
Interface Alias
03
Port Component
04
MAC Address
05
Network Address
06
Interface Name
07
Locally Assigned
more information.
Type: string
1927
PortDescriptionTlv
PortDescriptionTlv (lldp:PortDescriptionTlv)
Description:
Children: None
lldp:NivSupportTlv
PortDescriptionTlv Attributes
Attribute
Description
description
Type: ASCII
Default: Spirent Port
length
Type: INTEGER
Default: 0
Name
Type: string
type
Type: INTEGER
Default: 4
portEntries (overloaded)
portEntries (fc)
portEntries (fcgs)
portEntries Object (fc PDU library)

Description:
Parents: gplAccept (StreamBlock.FCoE.fc.fcPayloads.FCPayload-Choice.gplAccept)

Children: PortEntry
portEntries Attributes
Attribute
Description
Name
information.
Type: string
1928
PortEntry
portEntries Object (fcgs PDU library)

Description:
Parents: gplAccept (StreamBlock.GplAccept)

Children: PortEntry
portEntries Attributes
Attribute
Description
Name
information.
Type: string
PortEntry
Description:
Parents: portEntries
Children: None
PortEntry Attributes
Attribute
Description
Name
more information.
Type: string
portModuleType
Type: PortModuleType
Default: 01
Possible Values:
Value Description
portName
01
Unknown
02
Other
04
Embedded
05
GLM
06
GBIC with serial ID
07
GBIC without serial ID
08
SFP with serial ID
09
SFP without serial ID
0A
XFP
0B
X2 Short
0C
X2 Medium
0D
X2 Tall
0E
XPAK Short
0F
XPAK Medium
10
XPAK Tall
11
XENPAK
Type: WWN
Default: 20:00:10:94:00:00:00:00
1929
PortEntry
Attribute
Description
portTxType
Type: PortTxType
Default: 01
Possible Values:
Value Description
portType
reserved
01
Unknown
02
Long wave laser - LL
03
Short wave laser - SN
04
Long wave laser cost reduced - LC
05
Electrical - EL
Type: PortType
Default: 00
Possible Values:
Value Description
00
Unidentified
01
N_Port
02
NL_Port
03
F/NL_Port
7F
Nx_Port
81
F_Port
82
FL_Port
84
E_Port
85
B_Port
Type: OCTETSTRING
Default: 00
PortEntry
Description:
Parents: portEntries
Children: None
PortEntry Attributes
Attribute
Description
Name
more information.
Type: string
1930
PortEntry
Attribute
Description
portModuleType
Type: PortModuleType
Default: 01
Possible Values:
Value Description
01
Unknown
02
Other
04
Embedded
05
GLM
06
GBIC with serial ID
07
GBIC without serial ID
08
SFP with serial ID
09
SFP without serial ID
0A
XFP
0B
X2 Short
0C
X2 Medium
0D
X2 Tall
0E
XPAK Short
0F
XPAK Medium
10
XPAK Tall
11
XENPAK
portName
Type: WWN
Default: 20:00:10:94:00:00:00:00
portTxType
Type: PortTxType
Default: 01
Possible Values:
Value Description
portType
reserved
01
Unknown
02
Long wave laser - LL
03
Short wave laser - SN
04
Long wave laser cost reduced - LC
05
Electrical - EL
Type: PortType
Default: 00
Possible Values:
Value Description
00
Unidentified
01
N_Port
02
NL_Port
03
F/NL_Port
7F
Nx_Port
81
F_Port
82
FL_Port
84
E_Port
85
B_Port
Type: OCTETSTRING
Default: 00
1931
PortGroup
PortGroup
Description:
Group used for port objects.

Parents: Project
Relations:
Side name
(Type)
Relative
MemberOfGroup
(GroupMembership)
Port
GroupTypeSource
(GroupOfType)
GroupType
Description
PortGroup Writable Attributes

Writable Attribute
Description
Active, Name
GroupName
Name of the group.

Type: string
PortGroup Read-Only Attributes

portid
Description:
Parents: PortIdTlv
Children: pidAgentCircuitID, pidCustom, pidInterfaceAlias, pidInterfaceName, pidLocallyAssigned, pidMacAddress, pidNetworkAddress4, pidNetworkAddress6,
pidPortComponent
portid Attributes
Attribute
Description
Name
information.
Type: string
PortIdentifier
Description:
Parents: portIdentifiers
Children: None
1932
PortIdentifier
PortIdentifier Attributes
Attribute
Description
control
Type: BITSTRING
Default: 00000000
Name
Type: string
portIdentifier
Type: OCTETSTRING
Default: 000000
PortIdentifier
Description:
Parents: portIdentifiers
Children: None
PortIdentifier Attributes
Attribute
Description
control
Type: BITSTRING
Default: 00000000
Name
Type: string
portIdentifier
Type: OCTETSTRING
Default: 000000
portIdentifiers (overloaded)
portIdentifiers (fc)
portIdentifiers (fcgs)
portIdentifiers Object (fc PDU library)

Description:
Parents: gidNnAccept (StreamBlock.FCoE.fc.fcPayloads.FCPayload-Choice.gidNnAccept)

gidFtAccept (StreamBlock.FCoE.fc.fcPayloads.FCPayload-Choice.gidFtAccept)
gidPtAccept (StreamBlock.FCoE.fc.fcPayloads.FCPayload-Choice.gidPtAccept)
1933
PortIDList
Children: PortIdentifier
portIdentifiers Attributes
Attribute
Description
Name
information.
Type: string
portIdentifiers Object (fcgs PDU library)

Description:
Parents: gidNnAccept (StreamBlock.GidNnAccept)

gidFtAccept (StreamBlock.GidFtAccept)
gidPtAccept (StreamBlock.GidPtAccept)
Children: PortIdentifier
portIdentifiers Attributes
Attribute
Description
Name
information.
Type: string
PortIDList
Description:
Parents: theIPID, theEPID
Children: PIDAgentCircuitID, PIDCustom, PIDInterfaceAlias, PIDInterfaceName, PIDLocallyAssigned, PIDMacAddress, PIDNetworkAddress4,
PIDNetworkAddress6, PIDPortComponent
PortIDList Attributes
Attribute
Description
Name
information.
Type: string
1934
PortIdTlv
PortIdTlv (lldp:PortIdTlv)
Description:
Children: portid
Next headers: lldp:TimeToLiveTlv
PortIdTlv Attributes
Attribute
Description
length
Type: INTEGER
Default: 0
Name
more information.
Type: string
type
Type: INTEGER
Default: 2
PortIndexTlv
Description:
Children: None
PortIndexTlv Attributes
Attribute
Description
Length
Type: INTEGER
Default: 0
Name
Type: string
PortIndex
Type: OCTETSTRING
Default: 00000000
Type
Type: INTEGER
Default: 3
PortLoggingConfig
Description:

Parents: Project
1935
PortName
PortLoggingConfig Writable Attributes

Writable Attribute
Description
Active, Name
PortLoggingConfig Read-Only Attributes

Read-Only Attribute
Description
Description
Type: string
LogType
Type: string
PortGroupHandle
Type: handle
Default: 0
Severity
Type: enum
Default: NO_ALARM
Possible Values:
Value
Description
NO_ALARM
MINOR
MAJOR
CRITICAL
PortName
Description:
Parents: portNames
Children: None
PortName Attributes
Attribute
Description
control
Type: BITSTRING
Default: 00000000
Name
Type: string
portIdentifier
Type: OCTETSTRING
Default: 000000
portName
Type: WWN
Default: 20:00:10:94:00:00:00:00
reserved
Type: OCTETSTRING
Default: 00000000
1936
PortName
PortName
Description:
Parents: portNames
Children: None
PortName Attributes
Attribute
Description
control
Type: BITSTRING
Default: 00000000
Name
Type: string
portIdentifier
Type: OCTETSTRING
Default: 000000
portName
Type: WWN
Default: 20:00:10:94:00:00:00:00
reserved
Type: OCTETSTRING
Default: 00000000
portNames (overloaded)
portNames (fc)
portNames (fcgs)
portNames Object (fc PDU library)

Description:
Parents: gpnFtAccept (StreamBlock.FCoE.fc.fcPayloads.FCPayload-Choice.gpnFtAccept)

Children: PortName
portNames Attributes
Attribute
Description
Name
information.
Type: string
1937
portNames Object (fcgs PDU library)

Description:
Parents: gpnFtAccept (StreamBlock.GpnFtAccept)

Children: PortName
portNames Attributes
Attribute
Description
Name
information.
Type: string
Description:
Gets the current active Phy under port.

PortSetupGetActivePhyCommand Writable Attributes

Writable Attribute
Description
Port
Port ID whose active Phy is requested.

Type: handle
Default: 0
PortSetupGetActivePhyCommand Read-Only Attributes

Read-Only Attribute
Description

ActivePhy
Active Phy under the specified port.

Type: handle
Default: 0
PortSetupRestartAutoNegotiationCommand
Description:
Restarts autonegotiation.

1938
PortSetupSetActivePhyCommand

PortSetupRestartAutoNegotiationCommand Writable Attributes

Writable Attribute
Description
PortList

Type: handle
Default: 0
PortSetupRestartAutoNegotiationCommand Read-Only Attributes

Read-Only Attribute
Description

PortSetupSetActivePhyCommand
Description:
Sets an active Phy under port.

PortSetupSetActivePhyCommand Writable Attributes

Writable Attribute
Description
ActivePhy
ID of the Phy to be set as active.

Type: handle
Default: 0
PortSetupSetActivePhyCommand Read-Only Attributes

Read-Only Attribute
Description

PortStatusTLV (overloaded)
PortStatusTLV (EOAM)
PortStatusTLV (serviceoam)
1939
PortStatusTLV
PortStatusTLV Object (EOAM PDU library)

Description:

Children: None
PortStatusTLV Attributes
Attribute
Description
Length
Type: OCTETSTRING
Default: 0000
Name
Type: string
PortStatusValues
Type: psTLVvalues
Default: 01
Possible Values:
Value Description
Type
01
No (psBlocked)
02
Yes (psUp)
Type: OCTETSTRING
Default: 02
PortStatusTLV Object (serviceoam PDU library)

Description:

Children: None
PortStatusTLV Attributes
Attribute
Description
Length
Type: OCTETSTRING
Default: 0000
Name
Type: string
PortStatusValues
Type: psTLVvalues
Default: 02
Possible Values:
Value Description
01
No (psBlocked)
02
Yes (psUp)
1940
PortVlanIdTlv
Attribute
Description
Type
Type: OCTETSTRING
Default: 02
PortVlanIdTlv (lldp:PortVlanIdTlv)
Description:
Children: None
lldp:NivSupportTlv
PortVlanIdTlv Attributes
Attribute
Description
length
Type: INTEGER
Default: 0
Name
Type: string
oui
Type: OCTETSTRING
Default: 0080C2
portVlanId
Type: OCTETSTRING
Default: 0001
subtype
Type: OCTETSTRING
Default: 01
type
Type: INTEGER
Default: 127
POS (pos:POS)
Description:
Children: None
Next headers: ipv4:IPv4, ipv6:IPv6, ip:IPv6LL, mpls:Mpls, custom:Custom
POS Attributes
Attribute
Description
address
Type: OCTETSTRING
Default: FF
1941
POSPhy
Attribute
Description
control
Type: OCTETSTRING
Default: 03
Name
Type: string
protocolType
Type: PPPTypes
Default: 0021
Possible Values:
Value Description
0021
IPv4
0057
IPv6
0281
MPLS
POSPhy
Description:
Settings for ports in with their physical interface in Packet Over SONET mode.

Parents: Port
Automatically-created children: HdlcLinkConfig, SonetConfig, SonetInjectors, SonetPathConfig, SonetPathInjectors
Relations:
Side name
(Type)
Relative
ActivePhyPort
(ActivePhy)
Port
(ApplicableOnPhy)
HdlcIf, PppIf
Description
POSPhy Writable Attributes

Writable Attribute
Description
Active, Name
DataPathMode

Type: enum
Default: NORMAL
Possible Values:
Value
Description
NORMAL
LINE_MONITOR
1942
POSPhy
Writable Attribute
Description
EnforceMtuOnRx
Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
FALSE
Mtu

Type: u32
Default: 1500
Range: 0 - 16383
PortSetupMode

Type: enum
Possible Values:
Value
Description
REGISTERS_ONLY
POSPhy Read-Only Attributes

Read-Only Attribute
Description
Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
FALSE
IsMgtRegistersOnly
Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
Enable
FALSE Disable
LinkStatus
Status of link.
Type: enum
Default: NONE
Possible Values:
Value
Description
DOWN
Link is down.
UP
Link is up.
ERROR
Link has error.

SONET
Link is SONET.
NONE
No link present.
1943
POSPhy
Read-Only Attribute
Description
ModuleType

Type: enum
Default: NA
Possible Values:
Value
Description
NA
UNKNOWN
ABSENT
SFP_FIBER
SFP fiber media.
SFP_Copper
SFP copper media.
XFP
XFP
XENPAK
Xenpak
X2
X2
E1000
E1000
SFP_PLUS
SFP Plus
CFP
QSFP_PLUS
PersonalityCardType
Type: enum
Default: NA
Possible Values:
Value
Description
NA
UNKNOWN
ABSENT
SFP
SFP
XFP
XFP
XENPAK
Xenpak
X2
X2
CFP
1944
POSPhy
Read-Only Attribute
Description
TransceiverType

Type: enum
Possible Values:
Value
Description
MODULE_NONE
None
MODULE_10GBASE_ER
10GBASE-ER
MODULE_10GBASE_LR
10GBASE-LR
MODULE_10GBASE_SR
10GBASE-SR
MODULE_10GBASE_EW
10GBASE-EW
MODULE_10GBASE_LW
10GBASE-LW
MODULE_10GBASE_SW
10GBASE-SW
MODULE_10GBASE_CX4
10GBASE-CX4
MODULE_10GBASE_LX4
10GBASE-LX4
SPIRENT_10GBASE_CX4
Spirent 10GBASE-CX4
MODULE_OC48_LR
OC48-LR
MODULE_OC48_IR
OC48-IR
MODULE_OC48_SR
OC48-SR
MODULE_OC12_LR
OC12-LR
MODULE_OC12_IR
OC12-IR
MODULE_OC12_SR
OC12-SR
MODULE_OC3_LR
OC3-LR
MODULE_OC3_IR
OC3-IR
MODULE_OC3_SR
OC3-SR
MODULE_OC192_LR
OC192-LR
MODULE_OC192_IR
OC192-IR
MODULE_OC192_SR
OC192-SR
MODULE_OC192_VR
OC192-SR
MODULE_10GBASE_T
10GBASE-T
MODULE_XFP_CX4
XFP-CX4
MODULE_XFP_E
XFP-E
MODULE_1000BASE_T
1000BASE-T
MODULE_1000BASE_CX
1000BASE-CX
MODULE_1000BASE_LX
1000BASE-LX
MODULE_1000BASE_SX
1000BASE-SX
MODULE_40GBASE_LR
MODULE_40GBASE_SR
MODULE_40GBASE_CR4
MODULE_40GBASE_SR4
MODULE_100GBASE_LR
MODULE_100GBASE_SR
MODULE_FC_2G
MODULE_FC_4G
MODULE_FC_8G
MODULE_100BASE_FX
TransceiverTypeList

Type: string
1945
PowerViaMdiTlv
PowerViaMdiTlv (lldp:PowerViaMdiTlv)
Description:
Children: mdiPowerSupport
lldp:NivSupportTlv
PowerViaMdiTlv Attributes
Attribute
Description
length
Type: INTEGER
Default: 0
Name
Type: string
oui
Type: OCTETSTRING
Default: 00120F
psePowerClass
Type: EnumPSEPowerClass
Default: 1
Possible Values:
Value Description
psePowerPairs
01
Class 1
02
Class 2
03
Class 3
04
Class 4
05
Class 5
Type: EnumPSEPowerPair
Default: 1
Possible Values:
Value Description
01
Signal
02
Spare
subtype
Type: OCTETSTRING
Default: 02
type
Type: INTEGER
Default: 127
PPP (ppp:PPP)
Description:
Children: addresses, controls
Next headers: ipv4:IPv4, ipv6:IPv6, ip:IPv6LL, mpls:Mpls, custom:Custom
1946
PppAbortCommand
PPP Attributes
Attribute
Description
Name
more information.
Type: string
protocolType
Type: PPPTypes
Default: 0021
Possible Values:
Value Description
0021
IPv4
0057
IPv6
0281
MPLS
PppAbortCommand
Description:
Reset PPP emulation.

PppAbortCommand Writable Attributes

Writable Attribute
Description
BlockList
List of PppProtocolConfig object handles on which to abort PPP emulation.

Type: handle
Default: 0
ControlType

Type: enum
Default: UNDEFINED
Possible Values:
Value
Description
UNDEFINED
Undefined.
CONNECT
Connect.
RETRY
Retry.
PAUSE
Pause.
RESUME
Resume.
TERMINATE
Terminate.
PppAbortCommand Read-Only Attributes

Read-Only Attribute
Description

1947
PppClientBlockResults
Description:
PPP client block results object.

Automatically created from: PppoL2tpv2ClientBlockConfig
Relations:
Side name
(Type)
Relative
Description
ResultParent
(ResultChild)
PppoaClientBlockConfig, PppoaServerBlockConfig, PppoeClientBlockConfig,

PppoeServerBlockConfig, PppoL2tpv2ClientBlockConfig,
PppProtocolConfig

an object.
PppClientBlockResults Writable Attributes

PppClientBlockResults Read-Only Attributes

Read-Only Attribute
Description
State
AttemptedCount
Number of attempted session connects incremented the first time an LCP Configure-Request packet
is sent per session.
Type: u32
Default: 0
AvgSetupTime
Average amount of time taken to set up a session (milliseconds).

Type: u32
Default: 0
AvgSuccessTransactionCount
Average number of successful transactions needed to connect.

Type: u32
Default: 0
ConnectedSuccessCount
Number of sessions connected successfully.

Type: u32
Default: 0
DisconnectedSuccessCount
Number of sessions disconnected successfully.

Type: u32
Default: 0
FailedConnectCount
Number of failed connects.

Type: u32
Default: 0
FailedDisconnectCount
Number of failed disconnects.

Type: u32
Default: 0
MaxSetupTime
Maximum amount of time taken to set up a session (milliseconds).

Type: u32
Default: 0
MinSetupTime
Minimum amount of time taken to set up a session (milliseconds).

Type: u32
Default: 0
RetryCount
Number of times the failed sessions were retried.

Type: u32
Default: 0
1948
Read-Only Attribute
Description
RxChapCount
Number of CHAP packets received.

Type: u32
Default: 0
RxIpcpCount
Number of IPCP packets received.

Type: u32
Default: 0
RxIpv6cpCount
Number of IPv6CP packets received.

Type: u32
Default: 0
RxLcpConfigAckCount
Number of LCP configure ack packets received.

Type: u32
Default: 0
RxLcpConfigNakCount
Number of LCP configure nak packets received.

Type: u32
Default: 0
RxLcpConfigRejectCount
Number of LCP configure request packets received.

Type: u32
Default: 0
RxLcpConfigRequestCount
Number of LCP config request packets received.

Type: u32
Default: 0
RxLcpEchoReplyCount
Number of LCP echo reply packets received.

Type: u32
Default: 0
RxLcpEchoRequestCount
Number of LCP echo request packets received.

Type: u32
Default: 0
RxLcpTermAckCount
Number of LCP terminate ack packets received.

Type: u32
Default: 0
RxLcpTermRequestCount
Number of LCP terminate request packets received.

Type: u32
Default: 0
RxPapCount
Number of PAP packets received.

Type: u32
Default: 0
Sessions
Number of configured sessions.

Type: u32
Default: 0
SessionsUp
Number of sessions that are in the connected state.

Type: u32
Default: 0
SuccSetupRate
Session successful setup rate (sessions/sec).

Type: u32
Default: 0
TxChapCount
Number of CHAP packets transmitted.

Type: u32
Default: 0
TxIpcpCount
Number of IPCP packets transmitted.

Type: u32
Default: 0
1949
PppConnectCommand
Read-Only Attribute
Description
TxIpv6cpCount
Number of IPv6CP packets transmitted.

Type: u32
Default: 0
TxLcpConfigAckCount
Number of LCP configure ack packets transmitted.

Type: u32
Default: 0
TxLcpConfigNakCount
Number of LCP configure nak packets transmitted.

Type: u32
Default: 0
TxLcpConfigRejectCount
Number of LCP configure request packets transmitted.

Type: u32
Default: 0
TxLcpConfigRequestCount
Number of LCP config request packets transmitted.

Type: u32
Default: 0
TxLcpEchoReplyCount
Number of LCP echo reply packets transmitted.

Type: u32
Default: 0
TxLcpEchoRequestCount
Number of LCP echo request packets transmitted.

Type: u32
Default: 0
TxLcpTermAckCount
Number of LCP terminate ack packets transmitted.

Type: u32
Default: 0
TxLcpTermRequestCount
Number of LCP terminate request packets transmitted.

Type: u32
Default: 0
TxPapCount
Number of PAP packets transmitted.

Type: u32
Default: 0
PppConnectCommand
Description:
Connect PPP sessions.

PppConnectCommand Writable Attributes

Writable Attribute
Description
BlockList
List of PppProtocolConfig object handles on which to connect PPP.

Type: handle
Default: 0
1950
PppDisconnectCommand
Writable Attribute
Description
ControlType

Type: enum
Default: UNDEFINED
Possible Values:
Value
Description
UNDEFINED
Undefined.
CONNECT
Connect.
RETRY
Retry.
PAUSE
Pause.
RESUME
Resume.
TERMINATE
Terminate.
PppConnectCommand Read-Only Attributes

Read-Only Attribute
Description

PppDisconnectCommand
Description:
Disconnect PPP sessions.

PppDisconnectCommand Writable Attributes

Writable Attribute
Description
BlockList
List of PppProtocolConfig object handles on which to disconnect PPP.

Type: handle
Default: 0
ControlType

Type: enum
Default: UNDEFINED
Possible Values:
Value
Description
UNDEFINED
Undefined.
CONNECT
Connect.
RETRY
Retry.
PAUSE
Pause.
RESUME
Resume.
TERMINATE
Terminate.
1951
PppIf
PppDisconnectCommand Read-Only Attributes

Read-Only Attribute
Description

PppIf
Description:
PPP interface object.

Relations:
Side name
(Type)
Relative
Description
ApplicableOnPhy
(ApplicableOnPhy)
POSPhy
DstBoundTo
(DstBinding)

StreamBlock.
EncapsulationSource
(Encapsulation)
PathDescriptor
NetworkLink
(LinkSrc)

VplsLdpCeToPeLink
MemberOfVpn
(MemberOfVpn)

VpnSiteInfoVplsLdp
Port

relation.

WimaxIf

PrimaryIfSource
(PrimaryIf)

SUT

the DUT.
RelayBlockConfig
(RelayIf)
1952
PppIf
Side name
(Type)
Relative
Description
(ResolvesInterface)

RsvpRouterConfig

SrcBoundTo
(SrcBinding)

StreamBlock.
StackedOn
(StackedOnEndpoint)

WimaxIf
TopLevelIfSource
(TopLevelIf)

SUT

interface stack.
Port

UsesIfSource
(UsesIf)


PppIf Writable Attributes

Writable Attribute
Description
Active, Name
IfCountPerLowerIf

Type: u32
Default: 1
IfRecycleCount

Type: u32
Default: 0
IsLoopbackIf

Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
1953
PppMsgOption
Writable Attribute
Description
IsRange

Type: bool
Default: TRUE
Possible Values:
Value Description
TRUE
Not used.
FALSE Not used.

ProtocolId
Protocol ID.
Type: enum
Default: PPP_PROTOCOL_ID_IPV4
Possible Values:
Value
Description
IPv6 protocol ID.
IPv4 protocol ID.
PPP_PROTOCOL_ID_MPLS MPLS protocol ID.
PppIf Read-Only Attributes

Read-Only Attribute
Description
EffectiveBlockCount

Type: u32
Default: 1
IfState

Type: enum
Default: DISABLED
Possible Values:
Value
Description
READY
Ready.
DISABLED
Disabled.
DELETING
Deleting.
PppMsgOption
Description:
Set up custom options.

Parents: PppoaClientBlockConfig, PppoaServerBlockConfig, PppoeClientBlockConfig, PppoeServerBlockConfig, PppoL2tpv2ClientBlockConfig,
PppoL2tpv2ServerBlockConfig, PppProtocolConfig
PppMsgOption Writable Attributes

Writable Attribute
Description
Active, Name
Data
Data portion of the option field.

Type: string
1954
PppoaClientBlockConfig
Writable Attribute
Description
EnableWildcards
Enables use of wildcards in the data portion of the custom option.

Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
Enable wildcards (wildcard expressions will be expanded).
FALSE Disable wildcards (wildcard expressions will be ignored).

HexValue
Treat the data string as ASCII or hexadecimal.

Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
String is hexadecimal.
FALSE String is ASCII.

MsgCodeProto
Protocol(s) that will include the custom option. If you want to include the same option in multiple protocols, create
multiple (nearly-identical) options, and set the MsgCodeProto for each of them.
Type: enum
Default: LCP
Possible Values:
Value
Description
LCP
LCP.
IPCP
IPCP.
IPV6CP
IPv6CP.
PADI_PADR PADI_PADR.
OptionType
16-bit option type.

Type: u16
Default: 0
PppMsgOption Read-Only Attributes

Description:
PPPoA client block configuration settings.

Children: Ipv6NetworkBlock, PppMsgOption
Automatically-created children: Ipv4NetworkBlock, PppoaClientBlockResults
Result children (automatically created): PppClientBlockResults, PppoaClientBlockResults, PppoaServerBlockResults, PppoaSessionResults,
PppoeClientBlockResults, PppoePortResults, PppoeServerBlockResults, PppoL2tpv2SessionResults, PppServerBlockResults
Relations:
Side name
(Type)
Relative
Description
1955
Side name
(Type)
Relative
Description
ResultChild
(ResultChild)
PppClientBlockResults, PppoaClientBlockResults,
PppoaClientBlockResults, PppoaServerBlockResults,
PppoeClientBlockResults, PppoePortResults,
PppoeServerBlockResults, PppServerBlockResults
UsesIf
(UsesIf)


PppoaClientBlockConfig Writable Attributes

Writable Attribute
Description
Active, Name
Authentication
Type of authentication to use.

Type: enum
Default: NONE
Possible Values:
Value
Description
NONE
No authentication.
AUTO

PAP
AutoRetryCount

Type: u16
Default: 65535
Range: 1 - 65535
ChapAckTimeout
Timeout wait period for the server to send an ACK to a challenge response.
Type: u16
Default: 3
Range: 1 - 65535
ChapChalRequestTimeout
Timeout wait period in seconds for the server to send a CHAP challenge.
Type: u16
Default: 3
Range: 1 - 65535
EchoRequestGenFreq

Type: u16
Default: 10
Range: 0 - 65535
EnableAutoFillIpv6
Enables Auto Fill for the IPv6 address through transmission/receipt of RS/RA messages to the DUT.
Type: bool
Default: TRUE
Possible Values:
Value Description
TRUE
Enable Auto Fill for the IPv6 address (use RA/RS messages).
FALSE Disable Auto Fill for the IPv6 address (use the link-local address).
EnableAutoRetry

Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
1956
Writable Attribute
Description
EnableEchoRequest

Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE

EnableMagicNum
Enable or disable Magic Number negotiation.

Type: bool
Default: TRUE
Possible Values:
Value Description
TRUE
Enable Magic Number negotiation.
FALSE Disable Magic Number negotiation.

EnableMpls
For PPPoPOS, enable MPLS option.

Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
Enable the MPLS option.
FALSE Disable the MPLS option.

EnableMruNegotiation
Enable or disable MRU negotiation.

Type: bool
Default: TRUE
Possible Values:
Value Description
TRUE
Enable MRU negotiation.
FALSE Disable MRU negotiation.

EnableOsi
For PPPoPOS, enable OSI NLCP option.

Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
Enable OSI NLCP option.
FALSE Disable OSI NLCP option.

IncludeTxChapId

Type: bool
Default: TRUE
Possible Values:
Value Description
TRUE

IpcpEncap

Type: enum
Default: IPV4
Possible Values:
Value Description
IPV4
IPV6
1957
Writable Attribute
Description
LcpConfigRequestMaxAttempts
Maximum number of configure requests that can be sent, without acknowledgment, before a session fails.
Type: u16
Default: 10
Range: 1 - 65535
LcpConfigRequestTimeout
Timeout value in seconds for acknowledgment of a configure request.

Type: u16
Default: 3
Range: 1 - 65535
LcpDelay
Maximal amount of time STC will wait before transmitting the first LCP packet. The delay will be overridden (and LCP
will begin) if an LCP packet is received before the delay expires.
Type: u32
Default: 0
LcpTermRequestMaxAttempts
Maximum number of terminate requests that can be sent, without acknowledgment, before a session fails.
Type: u16
Default: 10
Range: 1 - 65535
LcpTermRequestTimeout
Timeout value in seconds for acknowledgment of a terminate request.

Type: u16
Default: 3
Range: 1 - 65535
MaxChapRequestReplyAttempts
Maximum CHAP response attempts by the client.

Type: u16
Default: 10
Range: 1 - 65535
Type: u16
Default: 0
Range: 0 - 65535
MaxNaks
Maximum Negative-Acknowledgments allowed during LCP and NCP configuration/negotiation.

Type: u16
Default: 5
Range: 1 - 65535
MaxPapRequestAttempts
Maximum PAP request attempts by the client.

Type: u16
Default: 10
Range: 1 - 65535
MruSize
Local maximum receive unit (MRU) transmit size in bytes.

Type: u16
Default: 1492
Range: 128 - 65535
NcpConfigRequestMaxAttempts
Maximum number of NCP Configure-Requests that can be sent, without acknowledgment, before a session fails.
Type: u16
Default: 10
Range: 1 - 65535
NcpConfigRequestTimeout
Timeout value in seconds for acknowledgment of an NCP Configure-Request.

Type: u16
Default: 3
Range: 1 - 65535
PapRequestTimeout
PAP Request timeout in seconds.

Type: u16
Default: 3
Range: 1 - 65535
1958
Writable Attribute
Description
Password
@p - Port name.
Type: string
Default: spirent
Protocol
Type of PPP session.

Type: enum
Default: UNDEFINED
Possible Values:
Value
Description
UNDEFINED
Nothing has been configured on the port.
PPPOPOS
PPPoPOS.
PPPOE
PPPoE with no VLAN.
PPPOEVLAN
PPPoE with a single VLAN.
PPPOESVLAN PPPoE with a single VLAN.

PPPOL2TPV2 PPPoL2TPv2.
PPPOEOA
PPP over Ethernet over ATM.
PPPOA
PPP over ATM.
Flag indicating partial block state as being used.

Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE

Username
@p - Port name.
Type: string
Default: spirent
1959
PppoaClientBlockResults
PppoaClientBlockConfig Read-Only Attributes

Read-Only Attribute
Description
BlockState
State of the sessions on the block.

Type: enum
Default: NONE
Possible Values:
Value
Description
NONE
Emulation is not configured.
IDLE
Emulation is not running.
CONNECTING
Sessions are available.
CONNECTED
All sessions on the server are bound.
DISCONNECTING Sessions are disconnecting.

TERMINATING
Sessions are terminating.
Description:
PPPoA client block results object.

Automatically created from: PppoaClientBlockConfig
Relations:
Side name
(Type)
Relative
Description
ResultParent
(ResultChild)
PppoaClientBlockConfig, PppoaClientBlockConfig, PppoaServerBlockConfig,

PppoeClientBlockConfig, PppoeServerBlockConfig,
PppProtocolConfig

an object.
PppoaClientBlockResults Writable Attributes

PppoaClientBlockResults Read-Only Attributes

Read-Only Attribute
Description
AttemptedCount
Number of attempted session connects. This value is incremented the first time an LCP Configure-Request
packet is sent per session.
Type: u32
Default: 0
AvgSetupTime
Average period of time (in milliseconds) from when the first LCP Configure-Request packet was sent out
to when an IPCP Configure-Ack packet was received for a single session.
Type: u32
Default: 0
Average number of successful transactions taken to connect sessions.

Type: u32
Default: 0

Type: u32
Default: 0
1960
Read-Only Attribute
Description
Number of disconnected sessions during which an LCP Terminate-Request packet was sent (from either
peer) and an LCP Terminate-Ack packet was received.
Type: u32
Default: 0
FailedConnectCount
Number of connect failures (Attempted value Connected Successfully value).

Type: u32
Default: 0
Number of disconnected sessions during which an LCP Terminate-Request packet was sent but an LCP
Terminate-Ack packet was not received (does not apply to invalid LCP Terminate-Request packets).
Type: u32
Default: 0
MaxSetupTime
Longest period of time (in milliseconds) from when the first LCP Configure-Request packet was sent out to
when an IPCP Configure-Ack packet was received for a single session).
Type: u32
Default: 0
MinSetupTime
Shortest period of time (in milliseconds) from when the first LCP Configure-Request packet was sent out
Type: u32
Default: 0
RetryCount

Type: u32
Default: 0
RxChapCount

Type: u32
Default: 0
RxIpcpCount

Type: u32
Default: 0
RxIpv6cpCount

Type: u32
Default: 0
RxLcpConfigAckCount

Type: u32
Default: 0
RxLcpConfigNakCount

Type: u32
Default: 0
Number of LCP configure reject packets received.

Type: u32
Default: 0

Type: u32
Default: 0
RxLcpEchoReplyCount

Type: u32
Default: 0

Type: u32
Default: 0
RxLcpTermAckCount

Type: u32
Default: 0
1961
Read-Only Attribute
Description

Type: u32
Default: 0
RxPapCount

Type: u32
Default: 0
Sessions
Number of sessions configured.

Type: u32
Default: 0
SessionsUp
Number of configured sessions in connected state.

Type: u32
Default: 0
State
Summary of the state of the PPPoX sessions contained in the block.

Type: enum
Default: IDLE
Possible Values:
Value
Description
NONE
PPPoX is not configured or has not yet been applied.
IDLE
None of the sessions in the block are connecting or disconnecting.
CONNECTING
At least one session in the block is connecting.
CONNECTED
At least one session in the block is connected.
DISCONNECTING At least one session in the block is disconnecting.

TERMINATING
Sessions are being terminated/aborted.
SuccSetupRate
Session successful setup rate (sessions per second).

Type: u32
Default: 0
TxChapCount

Type: u32
Default: 0
TxIpcpCount

Type: u32
Default: 0
TxIpv6cpCount

Type: u32
Default: 0
TxLcpConfigAckCount

Type: u32
Default: 0
TxLcpConfigNakCount

Type: u32
Default: 0
Number of LCP configure reject packets transmitted.

Type: u32
Default: 0

Type: u32
Default: 0
TxLcpEchoReplyCount

Type: u32
Default: 0
1962
PppoaDeviceGenProtocolParams
Read-Only Attribute
Description

Type: u32
Default: 0
TxLcpTermAckCount

Type: u32
Default: 0

Type: u32
Default: 0
TxPapCount

Type: u32
Default: 0
Description:
Device generator PPPoA protocol parameters.

PppoaDeviceGenProtocolParams Writable Attributes

Writable Attribute
Description
Active, Name
Authentication

Type: enum
Default: NONE
Possible Values:
Value
Description
NONE
No authentication.
AUTO

PAP
AutoRetryCount

Type: u16
Default: 65535
Range: 1 - 65535
EchoRequestGenFreq

Type: u16
Default: 10
Range: 0 - 65535
1963
Writable Attribute
Description
EmulationType

Type: enum
Default: CLIENT
Possible Values:
Value
Description
CLIENT
EnableAutoRetry

Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE

EnableEchoRequest

Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE

IncludeTxChapId

Type: bool
Default: TRUE
Possible Values:
Value Description
TRUE

IpcpEncap
Enable IPv4CP or IPv6CP. At least one must be enabled.

Type: enum
Default: IPV4
Possible Values:
Value Description
IPV4
IPV6
IPV4V6 Enable IPv4 and IPv6 addressing.

Ipv4AddrPoolCount

Type: u16
Default: 1
Range: 1 - 65535
Ipv4AddrPoolStart

Type: ip
Default: 192.0.1.0
Ipv4AddrPoolStep

Type: u16
Default: 1
Ipv6AddrPoolCount
Number of addresses in the IPv6 address pool.

Type: u16
Default: 1
Range: 1 - 65535

Type: ipv6
Default: ::2
1964
PppoaServerBlockConfig
Writable Attribute
Description

Type: ipv6
Default: ::1

Type: ipv6
Default: 2001::

Type: ipv6
Default: 0:0:0:1::
Type: u16
Default: 0
Range: 0 - 65535
Password
Password for authenticated PPP sessions.

Type: string
Default: spirent
Username
User name for authenticated PPP sessions.

Type: string
Default: spirent
PppoaDeviceGenProtocolParams Read-Only Attributes

Description:
PPPoA server block configuration settings.

Children: PppMsgOption, PppoxServerIpv6PeerPool
Automatically-created children: PppoaServerBlockResults, PppoxServerIpv4PeerPool
Result children (automatically created): PppClientBlockResults, PppoaClientBlockResults, PppoaServerBlockResults, PppoaSessionResults,
PppoeClientBlockResults, PppoePortResults, PppoeServerBlockResults, PppoL2tpv2SessionResults, PppServerBlockResults
Relations:
Side name
(Type)
Relative
Description
ResultChild
(ResultChild)
PppoaServerBlockResults, PppoaServerBlockResults,
UsesIf
(UsesIf)


1965
PppoaServerBlockConfig Writable Attributes

Writable Attribute
Description
Active, Name
Authentication

Type: enum
Default: NONE
Possible Values:
Value
Description
NONE
No authentication.
AUTO

PAP
ChapReplyTimeout
Timeout wait period for peer to send CHAP response.

Type: u16
Default: 3
Range: 1 - 65535
EchoRequestGenFreq

Type: u16
Default: 10
Range: 0 - 65535
EnableEchoRequest

Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE

EnableForceServerConnectMode
Whether to allow the server to be forced into CONNECTED state without having all of its sessions connected.
Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
Allow the server to be forced into CONNECTED state without having all of its sessions connected.
FALSE Do not allow the server to be forced into CONNECTED state.

EnableMagicNum

Type: bool
Default: TRUE
Possible Values:
Value Description
TRUE

EnableMpls

Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
1966
Writable Attribute
Description

Type: bool
Default: TRUE
Possible Values:
Value Description
TRUE

EnableOsi

Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE

IncludeTxChapId

Type: bool
Default: TRUE
Possible Values:
Value Description
TRUE

IpcpEncap

Type: enum
Default: IPV4
Possible Values:
Value Description
IPV4
IPV6
Type: u16
Default: 10
Range: 1 - 65535

Type: u16
Default: 3
Range: 1 - 65535
Type: u16
Default: 10
Range: 1 - 65535

Type: u16
Default: 3
Range: 1 - 65535
MaxChapRequestChallengeAttempts
Maximum CHAP challenge attempts.

Type: u16
Default: 10
Range: 1 - 65535
Type: u16
Default: 0
Range: 0 - 65535
1967
Writable Attribute
Description
MaxNaks

Type: u16
Default: 5
Range: 1 - 65535
MruSize

Type: u16
Default: 1492
Range: 128 - 65535
Type: u16
Default: 10
Range: 1 - 65535

Type: u16
Default: 3
Range: 1 - 65535
PapPeerRequestTimeout
Timeout wait period for PAP request Rx from peer.

Type: u16
Default: 3
Range: 1 - 65535
Password
@p - Port name.
Type: string
Default: spirent
Protocol

Type: enum
Default: UNDEFINED
Possible Values:
Value
Description
UNDEFINED
PPPOPOS
PPPoPOS.
PPPOE
PPPoE with no VLAN.
PPPOEVLAN
PPPOESVLAN PPPoE with more than one VLAN.

ServerInactivityTimer
PPPOEOA
PPPOA
PPP over ATM.
Number of seconds to wait before the server is forced into a connected state. Timer begins when the maximum
number of unconnected sessions is met. It is reset upon receipt of a packet on the server (excluding keepalives).
When the timer expires, the server is put into the connected state.
Type: u16
Default: 30
Range: 1 - 65535
1968
PppoaServerBlockResults
Writable Attribute
Description
UnconnectedSessionThreshold
Maximum number of unconnected sessions allowed before a PPPoX server is forced into connected state.
Type: u16
Default: 0
Range: 0 - 65535

Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE

Username
@p - Port name.
Type: string
Default: spirent
PppoaServerBlockConfig Read-Only Attributes

Read-Only Attribute
Description
BlockState
State of the PPPoL2TPv2 server block.

Type: enum
Default: NONE
Possible Values:
Value
Description
NONE
IDLE
CONNECTING
CONNECTED

TERMINATING
Description:
PPPoA server block results object.

Automatically created from: PppoaServerBlockConfig
Relations:
1969
Side name
(Type)
Relative
Description
ResultParent
(ResultChild)
PppoaClientBlockConfig, PppoaServerBlockConfig, PppoaServerBlockConfig,

PppProtocolConfig

an object.
PppoaServerBlockResults Writable Attributes

PppoaServerBlockResults Read-Only Attributes

Read-Only Attribute
Description
AvgSetupTime
Type: u32
Default: 0
Average number of successful transactions needed to connect a session.

Type: u32
Default: 0

Type: u32
Default: 0
Type: u32
Default: 0
FailedConnectCount
Number of failed connects (Attempted value Connected Successfully value).

Type: u32
Default: 0
Type: u32
Default: 0
MaxSetupTime
Longest period of time (in milliseconds) from when the first LCP Configure-Request packet was sent out
Type: u32
Default: 0
MinSetupTime
Type: u32
Default: 0
RxChapCount

Type: u32
Default: 0
RxIpcpCount

Type: u32
Default: 0
RxIpv6cpCount

Type: u32
Default: 0
RxLcpConfigAckCount

Type: u32
Default: 0
1970
Read-Only Attribute
Description
RxLcpConfigNakCount

Type: u32
Default: 0

Type: u32
Default: 0

Type: u32
Default: 0
RxLcpEchoReplyCount

Type: u32
Default: 0

Type: u32
Default: 0
RxLcpTermAckCount

Type: u32
Default: 0

Type: u32
Default: 0
RxPapCount

Type: u32
Default: 0
Sessions

Type: u32
Default: 0
SessionsUp

Type: u32
Default: 0
State
Summary of the state of the PPPoX sessions contained in the block.

Type: enum
Default: IDLE
Possible Values:
Value
Description
NONE
PPPoX is not configured or has not yet been applied.
IDLE
None of the sessions in the block are connecting or disconnecting.
CONNECTING
At least one session in the block is connecting.
CONNECTED
At least one session in the block is connected.
DISCONNECTING At least one session in the block is disconnecting.

TERMINATING
Sessions are being terminated/aborted.
SuccSetupRate
Session successful setup rate (sessions per second).

Type: u32
Default: 0
TxChapCount

Type: u32
Default: 0
TxIpcpCount

Type: u32
Default: 0
1971
PppoaSessionResults
Read-Only Attribute
Description
TxIpv6cpCount

Type: u32
Default: 0
TxLcpConfigAckCount

Type: u32
Default: 0
TxLcpConfigNakCount

Type: u32
Default: 0

Type: u32
Default: 0

Type: u32
Default: 0
TxLcpEchoReplyCount

Type: u32
Default: 0

Type: u32
Default: 0
TxLcpTermAckCount

Type: u32
Default: 0

Type: u32
Default: 0
TxPapCount

Type: u32
Default: 0
PppoaSessionResults
Description:
PPPoA session results.

Parents: PppoaClientBlockConfig, PppoaServerBlockConfig
PppoaSessionResults Writable Attributes

PppoaSessionResults Read-Only Attributes

Read-Only Attribute
Description
AttemptedCount
Number of times this session was attempted.

Type: u32
Default: 0
1972
PppoaSessionResults
Read-Only Attribute
Description
Number of times this session connected.

Type: u32
Default: 0
Number of times this session was successfully connected and disconnected.

Type: u32
Default: 0
FailedConnectCount
Number of times this session failed to connect.

Type: u32
Default: 0
Number of disconnected sessions where the LCP Terminate-Request packet was sent but an LCP Terminate-Ack
packet was not received (statistic does not apply to invalid LCP Terminate-Request packets).
Type: u32
Default: 0
FailureCode
Reason a session is not up.

Type: enum
Default: NULL
Possible Values:
Value
Description
NULL
No failure.
USER_TERMINATED
User brought the session down.
AUTHENTICATION_REFUSED_BY_PEER Peer refused to try and authenticate.

AUTHENTICATION_FAILED
No IPv4/IPv6 protocol configured.
NO_NETWORK_PROTOCOL
LINK_INACTIVE
No link.
CONNECT_EXPIRED
Connect time expired.
LOOPBACK
Loopback has been detected.
NO_PEER_RESPONSE
Peer not responding to keepalives.
LCP_REQUEST_TIMEOUT
LCP request timeout.
TERMINATE_ACK_RX
Received a terminate acknowledgment.
PROTOCOL_REJECT_RX
Peer rejected protocol configure request.
INVALID_CONFIG_NAK_OR_REJ_RX
Received invalid NAK or configure reject packet.
PEER_ADDR_UNKNOWN
Unable to negotiate peer IP address.
LOCAL_ADDR_UNKNOWN
Unable to negotiate local IP address.
LCP_DOWN
Link went down.
PADI_TIMEOUT
PADI timeout.
PADR_TIMEOUT
PADR timeout.
BAD_PADO_COUNT_EXCEEDED
Bad PADO packet received.
BAD_PADS_COUNT_EXCEEDED
Bad PADS packet received.
PADT_RX
PADT received.
TERMINATE_REQUEST_RX
Terminate request received.
AUTHENTICATION_TO_PEER_FAILED
Authentication to peer failed.
PPPOE_PAYLOAD_ERROR
Error in the PPPoE Payload.
PPP_L2TP_NO_SESSION
No PPPoL2TP session.
PPP_L2TP_SESSION_DOWN
PPPoL2TP session is down.
UNKNOWN
Unknown error.
Ipv4Addr
IP address assigned by the DUT to the subscriber.

Type: ip
Default: 0.0.0.0
Ipv6Addr
IPv6 address assigned by the DUT to the subscriber.

Type: ipv6
Default: ::
1973
PppoaSessionResults
Read-Only Attribute
Description
Ipv6GlobalAddr
IPv6 global address.

Type: ipv6
Default: ::
Ipv6GlobalAddrResolveState
IPv6 global address resolve state.

Type: enum
Default: NONE
Possible Values:
Value
Description
NONE
IPv6 global address has not been resolved.
RESOLVE_FAILED IPv6 global address resolution has failed.

RESOLVE_DONE
IPv6 global address was successfully resolved.
PeerIpv4Addr
Peer's negotiated IPv4 address.

Type: ip
Default: 0.0.0.0
PeerIpv6Addr

Type: ipv6
Default: ::
RetryCount
Number of times the failed session was retried.

Type: u32
Default: 0
RxChapCount
Total number of CHAP responses received.

Type: u32
Default: 0
RxIpcpCount
Total number of IPCP responses received (IPv4).

Type: u32
Default: 0
RxIpv6cpCount
Total number of IPv6CP responses received.

Type: u32
Default: 0
RxLcpConfigAckCount
Total number of Configure-Acknowledge packets received.

Type: u32
Default: 0
RxLcpConfigNakCount
Total number of Configure-Negative Acknowledge packets received.

Type: u32
Default: 0
Total number of Configure-Reject packets received.

Type: u32
Default: 0
Total number of Configure-Request packets received.

Type: u32
Default: 0
RxLcpEchoReplyCount
Total number of Echo-Reply packets received.

Type: u32
Default: 0
Total number of Echo-Request packets received.

Type: u32
Default: 0
RxLcpTermAckCount
Total number of Terminate-Acknowledge packets received.

Type: u32
Default: 0
1974
PppoaSessionResults
Read-Only Attribute
Description
Total number of Terminate-Request packets received.

Type: u32
Default: 0
RxPapCount
Total number of PAP responses received.

Type: u32
Default: 0
SessionState

Type: enum
Default: IDLE
Possible Values:
Value
Description
NONE
Session is in undefined state.
IDLE
Session is not connecting or disconnecting.
CONNECTING
Session is connecting.
CONNECTING_FAILED Session is in connecting failed state.

CONNECTED
Session is connected.
DISCONNECTING
Session is disconnected.
SetupTime
Time taken to bring up session.

Type: u32
Default: 0
TxChapCount
Total number of CHAP requests sent.

Type: u32
Default: 0
TxIpcpCount
Total number of IPCP requests sent (IPv4).

Type: u32
Default: 0
TxIpv6cpCount
Total number of IPv6CP requests sent.

Type: u32
Default: 0
TxLcpConfigAckCount
Total number of Configure-Acknowledge packets sent.

Type: u32
Default: 0
TxLcpConfigNakCount
Total number of Configure-Negative Acknowledge packets sent.

Type: u32
Default: 0
Total number of Configure-Reject packets sent.

Type: u32
Default: 0
Total number of Configure-Request packets sent.

Type: u32
Default: 0
TxLcpEchoReplyCount
Total number of Echo-Reply packets sent.

Type: u32
Default: 0
Total number of Echo-Request packets sent.

Type: u32
Default: 0
TxLcpTermAckCount
Total number of Terminate-Acknowledge packets sent.

Type: u32
Default: 0
1975
PppoeClientBlockConfig
Read-Only Attribute
Description
Total number of Terminate-Request packets sent.

Type: u32
Default: 0
TxPapCount
Total number of PAP requests sent.

Type: u32
Default: 0
Vci
VCI for this session.

Type: u16
Default: 32
Vpi
VPI for this session.

Type: u16
Default: 0
Description:
PPPoE client block configuration settings.

Children: Ipv4NetworkBlock, Ipv6NetworkBlock, PppMsgOption
Automatically-created children: PppoeClientBlockResults
Result children (automatically created): PppClientBlockResults, PppoaClientBlockResults, PppoaServerBlockResults, PppoeClientBlockResults,
PppoeoaSessionResults, PppoePortResults, PppoeServerBlockResults, PppoeSessionResults, PppServerBlockResults
Relations:
Side name
(Type)
Relative
Description
ResultChild
(ResultChild)
PppoaServerBlockResults, PppoeClientBlockResults,
UsesIf
(UsesIf)


PppoeClientBlockConfig Writable Attributes

Writable Attribute
Description
Active, Name
1976
Writable Attribute
Description
Authentication

Type: enum
Default: NONE
Possible Values:
Value
Description
NONE
No authentication.
AUTO
Sessions are authenticated using the protocol specified by the DUT (PAP or CHAP).

PAP
AutoRetryCount

Type: u16
Default: 65535
Range: 1 - 65535
ChapAckTimeout
Type: u16
Default: 3
Range: 1 - 65535
Timeout wait period for the server to send a CHAP challenge.

Type: u16
Default: 3
Range: 1 - 65535
CircuitId
a PPP packet from a client, destined for the access concentrator. Use wildcard characters to make each circuit ID
unique:
@p - Port name.
Type: string
Default: circuit @s
EchoRequestGenFreq

Type: u16
Default: 10
Range: 0 - 65535
EnableAutoFillIpv6
Type: bool
Default: TRUE
Possible Values:
Value Description
TRUE
EnableAutoRetry

Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
1977
Writable Attribute
Description
EnableEchoRequest

Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE

EnableMagicNum

Type: bool
Default: TRUE
Possible Values:
Value Description
TRUE

EnableMaxPayloadTag

Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
Enable the PPP-Max-Payload tag.
FALSE Disable the PPP-Max-Payload tag.

EnableMpls

Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
Enable MPLS option.
FALSE Disable MPLS option.


Type: bool
Default: TRUE
Possible Values:
Value Description
TRUE

EnableOsi

Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE

EnableRelayAgent

Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
1978
Writable Attribute
Description

Type: bool
Default: TRUE
Possible Values:
Value Description
TRUE


Type: bool
Default: TRUE
Possible Values:
Value Description
TRUE

IncludeTxChapId

Type: bool
Default: TRUE
Possible Values:
Value Description
TRUE
FALSE Don't include the Identifier field.

IpcpEncap

Type: enum
Default: IPV4
Possible Values:
Value Description
IPV4
IPV6
Type: u16
Default: 10
Range: 1 - 65535

Type: u16
Default: 3
Range: 1 - 65535
LcpDelay
Type: u32
Default: 0
Type: u16
Default: 10
Range: 1 - 65535

Type: u16
Default: 3
Range: 1 - 65535

Type: u16
Default: 10
Range: 1 - 65535
1979
Writable Attribute
Description
Type: u16
Default: 0
Range: 0 - 65535
MaxNaks

Type: u16
Default: 5
Range: 1 - 65535

Type: u16
Default: 10
Range: 1 - 65535
MaxPayloadBytes
messages.
Type: u16
Default: 1500
Range: 0 - 65535
MruSize
Local maximum receive unit (MRU) size in bytes.

Type: u16
Default: 1492
Range: 128 - 65535
Type: u16
Default: 10
Range: 1 - 65535

Type: u16
Default: 3
Range: 1 - 65535
PadiMaxAttempts
Type: u16
Default: 10
Range: 1 - 65535
PadiTimeout

Type: u16
Default: 3
Range: 1 - 65535
PadrMaxAttempts
Type: u16
Default: 10
Range: 1 - 65535
PadrTimeout

Type: u16
Default: 3
Range: 1 - 65535
PapRequestTimeout

Type: u16
Default: 3
Range: 1 - 65535
1980
Writable Attribute
Description
Password
@p - Port name.
Type: string
Default: spirent
Protocol
Select the type of PPP session.

Type: enum
Default: UNDEFINED
Possible Values:
Value
Description
UNDEFINED
PPPOPOS
PPPoPOS.
PPPOE
PPPoE no VLAN.
PPPOEVLAN
PPPoE with one VLAN.

PPPOEOA
PPPOA
PPP over ATM.
RelayAgentMacAddr
Type: mac
RelayAgentType

Type: enum
Default: RFC_2516
Possible Values:
Value
Description
RFC_2516

RemoteOrSessionId
@p - Port name.
Type: string
ServiceName
Type: string
1981
PppoeClientBlockResults
Writable Attribute
Description
TotalClients
Number of clients.
Type: u32
Default: 65535
Range: 0 - 65535

Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE

Username
@p - Port name.
Type: string
Default: spirent
PppoeClientBlockConfig Read-Only Attributes

Read-Only Attribute
Description
BlockState
Block state of the PPPoE client block.

Type: enum
Default: NONE
Possible Values:
Value
Description
NONE
Emulation is not configured or running.
IDLE
Sessions are down.
CONNECTING
At least one session is connecting.
CONNECTED
At least one session is connected.
DISCONNECTING At least one session is disconnecting.

TERMINATING
Description:
PPPoE client block results.

Automatically created from: PppoeClientBlockConfig
Relations:
1982
Side name
(Type)
Relative
Description
ResultParent
(ResultChild)

PppProtocolConfig

an object.
PppoeClientBlockResults Writable Attributes

PppoeClientBlockResults Read-Only Attributes

Read-Only Attribute
Description
State
AttemptedCount
Number of attempted session connects incremented the first time an LCP Configure-Request packet is
sent per session.
Type: u32
Default: 0
AvgSetupTime
Average period of time (in milliseconds) from when the first LCP Configure-Request packet was sent
out to when an IPCP Configure-Ack packet was received for a single session.
Type: u32
Default: 0
Average number of successful transactions taken to connect sessions.

Type: u32
Default: 0

Type: u32
Default: 0
Type: u32
Default: 0
FailedConnectCount
Number of connect failures (Attempted value Connected Successfully value).

Type: u32
Default: 0
Number of disconnected sessions during which an LCP Terminate-Request packet was sent but an LCP
Terminate-Ack packet was not received (does not apply to invalid LCP Terminate-Request packets).
Type: u32
Default: 0
MaxSetupTime
Type: u32
Default: 0
MinSetupTime
Shortest period of time (in milliseconds) from when the first LCP Configure-Request packet was sent
Type: u32
Default: 0
RetryCount

Type: u32
Default: 0
RxChapCount

Type: u32
Default: 0
1983
Read-Only Attribute
Description
RxIpcpCount

Type: u32
Default: 0
RxIpv6cpCount

Type: u32
Default: 0
RxLcpConfigAckCount

Type: u32
Default: 0
RxLcpConfigNakCount

Type: u32
Default: 0

Type: u32
Default: 0

Type: u32
Default: 0
RxLcpEchoReplyCount

Type: u32
Default: 0

Type: u32
Default: 0
RxLcpTermAckCount

Type: u32
Default: 0

Type: u32
Default: 0
RxPadoCount
Number of PADO packets received.

Type: u32
Default: 0
RxPadsCount
Number of PADS packets received.

Type: u32
Default: 0
RxPadtCount
Number of PADT packets received.

Type: u32
Default: 0
RxPapCount

Type: u32
Default: 0
Sessions
Type: u32
Default: 0
SessionsUp

Type: u32
Default: 0
SuccSetupRate

Type: u32
Default: 0
1984
PppoeDeviceGenProtocolParams
Read-Only Attribute
Description
TxChapCount

Type: u32
Default: 0
TxIpcpCount

Type: u32
Default: 0
TxIpv6cpCount

Type: u32
Default: 0
TxLcpConfigAckCount

Type: u32
Default: 0
TxLcpConfigNakCount

Type: u32
Default: 0

Type: u32
Default: 0

Type: u32
Default: 0
TxLcpEchoReplyCount

Type: u32
Default: 0

Type: u32
Default: 0
TxLcpTermAckCount

Type: u32
Default: 0

Type: u32
Default: 0
TxPadiCount
Number of PADI packets transmitted.

Type: u32
Default: 0
TxPadrCount
Number of PADR packets transmitted.

Type: u32
Default: 0
TxPadtCount
Number of PADT packets transmitted.

Type: u32
Default: 0
TxPapCount

Type: u32
Default: 0
1985
Description:
Device generator PPPoE protocol parameters.

PppoeDeviceGenProtocolParams Writable Attributes

Writable Attribute
Description
Active, Name
AcName

Type: string
Authentication

Type: enum
Default: NONE
Possible Values:
Value
Description
NONE
No authentication.
AUTO

PAP
AutoRetryCount

Type: u16
Default: 65535
Range: 1 - 65535
CircuitId
Enabled for DSL-type relay agents only. The circuit ID can be used to encode a local identifier for the circuit that
received a PPP packet from a client, destined for the access concentrator. Use wildcard characters to make each
circuit ID unique:
@p - Port name.
Type: string
Default: circuit @s
EchoRequestGenFreq
Type: u16
Default: 10
Range: 0 - 65535
EmulationType

Type: enum
Default: CLIENT
Possible Values:
Value
Description
CLIENT
1986
Writable Attribute
Description
EnableAutoRetry

Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE

EnableEchoRequest

Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE

EnableMaxPayloadTag

Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE

EnableRelayAgent

Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE


Type: bool
Default: TRUE
Possible Values:
Value Description
TRUE


Type: bool
Default: TRUE
Possible Values:
Value Description
TRUE

IncludeTxChapId

Type: bool
Default: TRUE
Possible Values:
Value Description
TRUE
1987
Writable Attribute
Description
IpcpEncap

Type: enum
Default: IPV4
Possible Values:
Value Description
IPV4
IPV6
Ipv4AddrPoolCount

Type: u16
Default: 1
Range: 1 - 65535
Ipv4AddrPoolStart

Type: ip
Default: 192.0.1.0
Ipv4AddrPoolStep

Type: u16
Default: 1
Ipv6AddrPoolCount

Type: u16
Default: 1
Range: 1 - 65535

Type: ipv6
Default: ::2

Type: ipv6
Default: ::1

Type: ipv6
Default: 2001::

Type: ipv6
Default: 0:0:0:1::
Type: u16
Default: 0
Range: 0 - 65535
MaxPayloadBytes
messages.
Type: u16
Default: 1500
Range: 0 - 65535
PadiMaxAttempts
Type: u16
Default: 10
Range: 1 - 65535
PadiTimeout

Type: u16
Default: 3
Range: 1 - 65535
1988
PPPoEDiscovery
Writable Attribute
Description
PadrMaxAttempts
Type: u16
Default: 10
Range: 1 - 65535
PadrTimeout

Type: u16
Default: 3
Range: 1 - 65535
Password
Password for authenticated PPP sessions.

Type: string
Default: spirent
RelayAgentMacAddr
Enabled for RFC 2516-type relay agents only. The Relay Agent MAC address is the MAC address of the next hop
from the subscriber client group to the access concentrator.
Type: mac
RelayAgentType

Type: enum
Default: RFC_2516
Possible Values:
Value
Description
RFC_2516

RemoteOrSessionId
@p - Port name.
Type: string
ServiceName
Type: string
Username
User name for authenticated PPP sessions.

Type: string
Default: spirent
PppoeDeviceGenProtocolParams Read-Only Attributes

PPPoEDiscovery (pppoe:PPPoEDiscovery)
1989
PppoeIf
Description:
Children: tags
PPPoEDiscovery Attributes
Attribute
Description
code
Type: PPPoECode
Default: 9
Possible Values:
Value Description
9
PADI
PADO
25
PADR
101
PADS
167
PADT
length
Type: INTEGER
Default: 0
Name
Type: string
sessionId
Type: INTEGER
Default: 0
type
Type: INTEGER
Default: 1
version
Type: INTEGER
Default: 1
PppoeIf
Description:
PPPoE interface object.

Relations:
Side name
(Type)
Relative
Description
DstBoundTo
(DstBinding)

StreamBlock.
EncapsulationSource
(Encapsulation)
PathDescriptor
1990
PppoeIf
Side name
(Type)
Relative
Description
NetworkLink
(LinkSrc)

MemberOfVpn
(MemberOfVpn)

VpnSiteInfoVplsLdp
Port

relation.

WimaxIf

PrimaryIfSource
(PrimaryIf)

SUT

the DUT.
RelayBlockConfig
(RelayIf)
(ResolvesInterface)

RsvpRouterConfig

SrcBoundTo
(SrcBinding)

StreamBlock.
StackedOn
(StackedOnEndpoint)

WimaxIf
TopLevelIfSource
(TopLevelIf)

SUT

interface stack.
Port

relation.
1991
PppoeIf
Side name
(Type)
Relative
Description
UsesIfSource
(UsesIf)


PppoeIf Writable Attributes

Writable Attribute
Description
Active, Name
IfCountPerLowerIf

Type: u32
Default: 1
IfRecycleCount
How many to times to increment the PPPoE session ID before returning to the starting value. See SessionId for more
information.
Type: u32
Default: 0
IsLoopbackIf

Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE

IsRange
Whether to use a combination of attributes to generate a range of session IDs, or to use the SessionIdList attribute
to specify the session IDs.
Type: bool
Default: TRUE
Possible Values:
Value Description
TRUE
Use a combination of attributes to generate a range of session IDs. The attributes are SessionId,
SessionIdStep, SessionIdRepeatCount, and IfRecycleCount. See SessionId for more information.
FALSE Use the SessionIdList attribute to specify the session IDs.

PeerMacAddrList
Peer MAC address list.

Type: mac
Default: 0
SessionId
PPPoE session ID. You can generate more than one PPPoE session ID by using SessionIdRepeatCount,
SessionIdStep, and IfRecycleCount. If you do that, then this attribute is the starting session ID.
Example: SessionId = 1, SessionIdStep = 1, IfRecycleCount = 2, SessionIdRepeatCount = 0. Generated values will
be 1, 2, 1, 2, 1, 2, and so on.
Example: SessionId = 1, SessionIdStep = 1, IfRecycleCount = 2, SessionIdRepeatCount = 1. Generated values will
be 1, 1, 2, 2, 1, 1, 2, 2, 1, 1, 2, 2, and so on.
Type: u16
Default: 0
Range: 0 - 65535
1992
PppoeoaDeviceGenProtocolParams
Writable Attribute
Description
SessionIdList
A Tcl list of session IDs. To use this attribute, the IsRange attribute must be FALSE.
Type: u16
Default: 0
SessionIdRepeatCount
How many times to repeat the same PPPoE session ID before incrementing it. See SessionId for more information.
Type: u16
Default: 0
SessionIdStep
PPPoE session ID step value. See SessionId for more information.

Type: s16
Default: 1
SessionResolver
Type: string
Default: default
PppoeIf Read-Only Attributes

Read-Only Attribute
Description
EffectiveBlockCount

Type: u32
Default: 1
IfState

Type: enum
Default: DISABLED
Possible Values:
Value
Description
READY
Ready.
DISABLED
Disabled.
DELETING
Deleting.

PeerMacAddr
Peer MAC address.

Type: mac
Default: 00:00:00:00:00:00
SessionResolveState
Session resolve state.

Type: enum
Possible Values:
Value
Description
RESOLVE_DONE
Resolve is done.
RESOLVE_NEEDED
Resolve is needed.
RESOLVE_FAILED
Resolve failed.
RESOLVE_IN_PROGRESS
Description:
Device generator PPPoEoA protocol parameters.

1993
PppoeoaDeviceGenProtocolParams Writable Attributes

Writable Attribute
Description
Active, Name
AcName

Type: string
Authentication

Type: enum
Default: NONE
Possible Values:
Value
Description
NONE
No authentication.
AUTO

PAP
AutoRetryCount

Type: u16
Default: 65535
Range: 1 - 65535
CircuitId
a PPP packet from a client, destined for the access concentrator. Use wildcard characters to make each circuit ID unique:
@p - Port name.
Type: string
Default: circuit @s
EchoRequestGenFreq

Type: u16
Default: 10
Range: 0 - 65535
EmulationType

Type: enum
Default: CLIENT
Possible Values:
Value
Description
CLIENT
EnableAutoRetry

Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
1994
Writable Attribute
Description
EnableEchoRequest

Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE

EnableMaxPayloadTag

Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
Enable the PPP-Max-Payload tag.
FALSE Disable the PPP-Max-Payload tag.

EnableRelayAgent

Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE


Type: bool
Default: TRUE
Possible Values:
Value Description
TRUE


Type: bool
Default: TRUE
Possible Values:
Value Description
TRUE

IncludeTxChapId

Type: bool
Default: TRUE
Possible Values:
Value Description
TRUE

IpcpEncap

Type: enum
Default: IPV4
Possible Values:
Value Description
IPV4
IPV6
1995
Writable Attribute
Description
Ipv4AddrPoolCount

Type: u16
Default: 1
Range: 1 - 65535
Ipv4AddrPoolStart

Type: ip
Default: 192.0.1.0
Ipv4AddrPoolStep

Type: u16
Default: 1
Ipv6AddrPoolCount

Type: u16
Default: 1
Range: 1 - 65535

Type: ipv6
Default: ::2

Type: ipv6
Default: ::1

Type: ipv6
Default: 2001::

Type: ipv6
Default: 0:0:0:1::
Type: u16
Default: 0
Range: 0 - 65535
MaxPayloadBytes
messages.
Type: u16
Default: 1500
Range: 0 - 65535
PadiMaxAttempts
Type: u16
Default: 10
Range: 1 - 65535
PadiTimeout

Type: u16
Default: 3
Range: 1 - 65535
PadrMaxAttempts
Type: u16
Default: 10
Range: 1 - 65535
PadrTimeout

Type: u16
Default: 3
Range: 1 - 65535
1996
Writable Attribute
Description
Password
@p - Port name.
Type: string
Default: spirent
RelayAgentMacAddr
Type: mac
RelayAgentType

Type: enum
Default: RFC_2516
Possible Values:
Value
Description
RFC_2516

RemoteOrSessionId
@p - Port name.
Type: string
ServiceName
Type: string
Username
@p - Port name.
Type: string
Default: spirent
1997
PppoeoaSessionResults
PppoeoaDeviceGenProtocolParams Read-Only Attributes

Description:
PPPoEoA session results.

Parents: PppoeClientBlockConfig, PppoeServerBlockConfig
PppoeoaSessionResults Writable Attributes

PppoeoaSessionResults Read-Only Attributes

Read-Only Attribute
Description
AttemptedCount

Type: u32
Default: 0

Type: u32
Default: 0

Type: u32
Default: 0
FailedConnectCount

Type: u32
Default: 0
Type: u32
Default: 0
1998
Read-Only Attribute
Description
FailureCode

Type: enum
Default: NULL
Possible Values:
Value
Description
NULL
No failure.
USER_TERMINATED

Authentication failed.
NO_NETWORK_PROTOCOL
LINK_INACTIVE
No link.
CONNECT_EXPIRED
LOOPBACK
NO_PEER_RESPONSE
LCP_REQUEST_TIMEOUT
TERMINATE_ACK_RX
PROTOCOL_REJECT_RX
PEER_ADDR_UNKNOWN
LOCAL_ADDR_UNKNOWN
LCP_DOWN
Link went down.
PADI_TIMEOUT
PADI timeout.
PADR_TIMEOUT
PADR timeout.
PADT_RX
PADT received.
PPPOE_PAYLOAD_ERROR
PPP_L2TP_NO_SESSION
UNKNOWN
Unknown error.
InnerVlanId
Inner VLAN ID for this session.

Type: u16
Default: 1
Ipv4Addr

Type: ip
Default: 0.0.0.0
Ipv6Addr

Type: ipv6
Default: ::
Ipv6GlobalAddr

Type: ipv6
Default: ::

Type: enum
Default: NONE
Possible Values:
Value
Description
NONE

RESOLVE_DONE
1999
Read-Only Attribute
Description
MacAddr
MAC address assigned by the DUT to the subscriber.

Type: mac
Default: 00-00-00-00-00-00
PeerIpv4Addr

Type: ip
Default: 0.0.0.0
PeerIpv6Addr

Type: ipv6
Default: ::
PeerMacAddr
Peer's negotiated MAC address.

Type: mac
Default: 00-00-00-00-00-00
PppoeSessionId
Unique session ID assigned by the DUT to the subscriber (applies to PPP over Ethernet and PPP over Ethernet
over ATM sessions only).
Type: u32
Default: 0
RetryCount

Type: u32
Default: 0
RxChapCount

Type: u32
Default: 0
RxIpcpCount

Type: u32
Default: 0
RxIpv6cpCount

Type: u32
Default: 0
RxLcpConfigAckCount

Type: u32
Default: 0
RxLcpConfigNakCount

Type: u32
Default: 0

Type: u32
Default: 0

Type: u32
Default: 0
RxLcpEchoReplyCount

Type: u32
Default: 0

Type: u32
Default: 0
RxLcpTermAckCount

Type: u32
Default: 0
2000
Read-Only Attribute
Description

Type: u32
Default: 0
RxPadiCount
Total number of PPPoE Active Discovery Initialized packets received.

Type: u32
Default: 0
RxPadoCount
Total number of PPPoE Active Discovery Offer packets received.

Type: u32
Default: 0
RxPadrCount
Total number of PPPoE Active Discovery Request packets received.

Type: u32
Default: 0
RxPadsCount
Total number of PPPoE Active Discovery Session-confirmation packets received.

Type: u32
Default: 0
RxPadtCount
Total number of PPPoE Active Discovery Terminate packets received.

Type: u32
Default: 0
RxPapCount

Type: u32
Default: 0
SessionState

Type: enum
Default: IDLE
Possible Values:
Value
Description
NONE
IDLE
CONNECTING

CONNECTED
DISCONNECTING
SetupTime

Type: u32
Default: 0
TxChapCount

Type: u32
Default: 0
TxIpcpCount

Type: u32
Default: 0
TxIpv6cpCount

Type: u32
Default: 0
TxLcpConfigAckCount

Type: u32
Default: 0
TxLcpConfigNakCount

Type: u32
Default: 0
2001
PppoePortResults
Read-Only Attribute
Description

Type: u32
Default: 0

Type: u32
Default: 0
TxLcpEchoReplyCount

Type: u32
Default: 0

Type: u32
Default: 0
TxLcpTermAckCount

Type: u32
Default: 0

Type: u32
Default: 0
TxPadiCount
Total number of PPPoE Active Discovery Initialized packets sent.

Type: u32
Default: 0
TxPadoCount
Total number of PPPoE Active Discovery Offer packets sent.

Type: u32
Default: 0
TxPadrCount
Total number of PPPoE Active Discovery Request packets sent.

Type: u32
Default: 0
TxPadsCount
Total number of PPPoE Active Discovery Session-confirmation packets sent.

Type: u32
Default: 0
TxPadtCount
Total number of PPPoE Active Discovery Terminate packets sent.

Type: u32
Default: 0
TxPapCount

Type: u32
Default: 0
Vci
VCI for this session.

Type: u16
Default: 32
VlanId
VLAN ID for this session.

Type: u16
Default: 1
Vpi
VPI for this session.

Type: u16
Default: 0
PppoePortResults
2002
PppoePortResults
Description:
Port-level PPPoE results.

Automatically created from: PppoxPortConfig
Relations:
Side name
(Type)
Relative
Description
ResultParent
(ResultChild)

PppoL2tpv2ServerBlockConfig, PppoxPortConfig, PppProtocolConfig

object.
PppoePortResults Writable Attributes

PppoePortResults Read-Only Attributes

Read-Only Attribute
Description
AttemptedCount
Number of attempted session connects incremented the first time an LCP Configure-Request packet is
sent per session.
Type: u32
Default: 0
AvgSetupTime
to when an IPCP Configure-Ack packet was received for all sessions.
Type: u32
Default: 0
Average number of transmit and receive messages for all successfully connected sessions on the port.
Type: u32
Default: 0

Type: u32
Default: 0
Number of disconnected sessions where the LCP Terminate-Request packet was sent (from either peer)
and an LCP Terminate-Ack packet was received.
Type: u32
Default: 0
FailedConnectCount
Number of session connects that failed (Attempted statistic minus Connected Successfully statistic).
Type: u32
Default: 0
Number of disconnected sessions where the LCP Terminate-Request packet was sent but an LCP
Terminate-Ack packet was not received (statistic does not apply to invalid LCP Terminate-Request packets).
Type: u32
Default: 0
MaxSetupTime
Type: u32
Default: 0
MinSetupTime
Type: u32
Default: 0
RetryCount

Type: u32
Default: 0
2003
PppoePortResults
Read-Only Attribute
Description
RxChapCount

Type: u32
Default: 0
RxIpcpCount

Type: u32
Default: 0
RxIpv6cpCount

Type: u32
Default: 0
RxLcpConfigAckCount

Type: u32
Default: 0
RxLcpConfigNakCount

Type: u32
Default: 0

Type: u32
Default: 0

Type: u32
Default: 0
RxLcpEchoReplyCount

Type: u32
Default: 0

Type: u32
Default: 0
RxLcpTermAckCount

Type: u32
Default: 0

Type: u32
Default: 0
RxPadiCount

Type: u32
Default: 0
RxPadoCount

Type: u32
Default: 0
RxPadrCount

Type: u32
Default: 0
RxPadsCount

Type: u32
Default: 0
RxPadtCount

Type: u32
Default: 0
RxPapCount

Type: u32
Default: 0
2004
PppoePortResults
Read-Only Attribute
Description
Sessions
Number of sessions configured.

Type: u32
Default: 0
SessionsUp
Number of sessions currently up (Connected Successfully minus Disconnected successfully minus Failed
releases).
Type: u32
Default: 0
SuccSetupRate
Average rate of successful connections in sessions per second.

Type: u32
Default: 0
TxChapCount

Type: u32
Default: 0
TxIpcpCount
Total number of IPCP request sent (IPv4).

Type: u32
Default: 0
TxIpv6cpCount

Type: u32
Default: 0
TxLcpConfigAckCount

Type: u32
Default: 0
TxLcpConfigNakCount

Type: u32
Default: 0

Type: u32
Default: 0

Type: u32
Default: 0
TxLcpEchoReplyCount

Type: u32
Default: 0

Type: u32
Default: 0
TxLcpTermAckCount

Type: u32
Default: 0

Type: u32
Default: 0
TxPadiCount

Type: u32
Default: 0
TxPadoCount

Type: u32
Default: 0
2005
PppoeServerBlockConfig
Read-Only Attribute
Description
TxPadrCount

Type: u32
Default: 0
TxPadsCount

Type: u32
Default: 0
TxPadtCount

Type: u32
Default: 0
TxPapCount

Type: u32
Default: 0
Description:
PPPoE server block configuration settings.

Parents: EmulatedDevice, PppoxServerIpv6PeerPool
Children: PppMsgOption
Automatically created from: PppoeServerIpv4PeerPool
Automatically-created children: PppoeServerBlockResults
PppoeoaSessionResults, PppoePortResults, PppoeServerBlockResults, PppoeSessionResults, PppServerBlockResults
Relations:
Side name
(Type)
Relative
Description
ResultChild
(ResultChild)
PppoePortResults, PppoeServerBlockResults,
UsesIf
(UsesIf)


PppoeServerBlockConfig Writable Attributes

Writable Attribute
Description
Active, Name
AcName

Type: string
2006
Writable Attribute
Description
Authentication

Type: enum
Default: NONE
Possible Values:
Value
Description
NONE
No authentication.
AUTO
Sessions are authenticated using the protocol specified by the DUT (PAP or CHAP).

PAP
ChapReplyTimeout

Type: u16
Default: 3
Range: 1 - 65535
CircuitId
Enabled for DSL-type relay agents only. The circuit ID can be used to encode a local identifier for the circuit that
received a PPP packet from a client, destined for the access concentrator. Not applicable for the PPPoX server
mode.
Type: string
Default: circuit @s
EchoRequestGenFreq

Type: u16
Default: 10
Range: 0 - 65535
EchoVendorSpecificTagInPado
Specifies whether to include the Vendor-Specific Tag in the PADO.

Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
Include the Vendor-Specific Tag in the PADO.
FALSE Do not include the Vendor-Specific Tag in the PADO.

EchoVendorSpecificTagInPads
Specifies whether to include the Vendor-Specific Tag in the PADS.

Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
Include the Vendor-Specific tag in the PADS.
FALSE Do not include the Vendor-Specific tag in the PADS.

EnableAutoFillIpv6
Type: bool
Default: TRUE
Possible Values:
Value Description
TRUE
EnableEchoRequest

Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
2007
Writable Attribute
Description
Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE

EnableMagicNum

Type: bool
Default: TRUE
Possible Values:
Value Description
TRUE

EnableMaxPayloadTag
Enable or disable the PPP-Max-Payload-Tag (see RFC 4638).

Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE

EnableMpls

Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
Enable MPLS option.


Type: bool
Default: TRUE
Possible Values:
Value Description
TRUE

EnableOsi

Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE

EnableRelayAgent

Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
2008
Writable Attribute
Description
Include the relay agent tags in transmitted PADI messages. Not applicable for the PPPoX server mode.
Type: bool
Default: TRUE
Possible Values:
Value Description
TRUE

Include the relay agent tags in transmitted PADR messages. Not applicable for the PPPoX server mode.
Type: bool
Default: TRUE
Possible Values:
Value Description
TRUE

IncludeTxChapId

Type: bool
Default: TRUE
Possible Values:
Value Description
TRUE

IpcpEncap

Type: enum
Default: IPV4
Possible Values:
Value Description
IPV4
IPV6
IPV4V6 Enable both IPv4 and IPv6 addressing on the same PPP link.
Type: u16
Default: 10
Range: 1 - 65535

Type: u16
Default: 3
Range: 1 - 65535
Type: u16
Default: 10
Range: 1 - 65535

Type: u16
Default: 3
Range: 1 - 65535

Type: u16
Default: 10
Range: 1 - 65535
Type: u16
Default: 0
Range: 0 - 65535
2009
Writable Attribute
Description
MaxNaks

Type: u16
Default: 5
Range: 1 - 65535
MaxPayloadBytes
messages.
Type: u16
Default: 1500
Range: 0 - 65535
MruSize
Local maximum receive unit (MRU) size in bytes.

Type: u16
Default: 1492
Range: 128 - 65535
Type: u16
Default: 10
Range: 1 - 65535

Type: u16
Default: 3
Range: 1 - 65535

Type: u16
Default: 3
Range: 1 - 65535
Password
@p - Port name.
Type: string
Default: spirent
Protocol

Type: enum
Default: UNDEFINED
Possible Values:
Value
Description
UNDEFINED
PPPOPOS
PPPoPOS.
PPPOE
PPPoE with no VLAN.
PPPOEVLAN

PPPOEOA
PPPOA
PPP over ATM.
2010
Writable Attribute
Description
RelayAgentMacAddr
Enabled for RFC 2516-type relay agents only. The Relay Agent MAC address is the MAC address of the next hop
from the subscriber client group to the access concentrator. Not applicable for the PPPoX server mode.
Type: mac
RelayAgentType
Select the type of relay agent. Not applicable for the PPPoX server mode.
Type: enum
Default: RFC_2516
Possible Values:
Value
Description
RFC_2516

RemoteOrSessionId
Remote ID or Session ID depending on the Relay Agent type. Not applicable for the PPPoX server mode.
Type: string
Type: u16
Default: 30
Range: 1 - 65535
ServiceName
Type: string
TotalClients
Number of clients.
Type: u32
Default: 65535
Range: 0 - 65535
Type: u16
Default: 0
Range: 0 - 65535

Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE

Username
@p - Port name.
Type: string
Default: spirent
2011
PppoeServerBlockResults
PppoeServerBlockConfig Read-Only Attributes

Read-Only Attribute
Description
BlockState
State of the server block.

Type: enum
Default: NONE
Possible Values:
Value
Description
NONE
IDLE
CONNECTING
CONNECTED
All sessions are bound, there are no available sessions on this server block.

TERMINATING
Description:
PPPoE server block results object.

Automatically created from: PppoeServerBlockConfig
Relations:
Side name
(Type)
Relative
Description
ResultParent
(ResultChild)

PppoeServerBlockConfig, PppoeServerBlockConfig,
PppProtocolConfig

an object.
PppoeServerBlockResults Writable Attributes

PppoeServerBlockResults Read-Only Attributes

Read-Only Attribute
Description
State
AvgSetupTime
Type: u32
Default: 0
Average number of successful transactions needed to connect a session.

Type: u32
Default: 0

Type: u32
Default: 0
Type: u32
Default: 0
2012
Read-Only Attribute
Description
FailedConnectCount
(Attempted value Connected Successfully value).

Type: u32
Default: 0
Number of disconnected sessions during which an LCP Terminate-Request packet was sent but an
LCP Terminate-Ack packet was not received (does not apply to invalid LCP Terminate-Request packets).
Type: u32
Default: 0
MaxSetupTime
Longest period of time (in milliseconds) from when the first LCP Configure-Request packet was sent
Type: u32
Default: 0
MinSetupTime
Type: u32
Default: 0
RxChapCount

Type: u32
Default: 0
RxIpcpCount

Type: u32
Default: 0
RxIpv6cpCount

Type: u32
Default: 0
RxLcpConfigAckCount

Type: u32
Default: 0
RxLcpConfigNakCount

Type: u32
Default: 0

Type: u32
Default: 0

Type: u32
Default: 0
RxLcpEchoReplyCount

Type: u32
Default: 0

Type: u32
Default: 0
RxLcpTermAckCount

Type: u32
Default: 0

Type: u32
Default: 0
RxPadiCount
Number of PADI packets received.

Type: u32
Default: 0
2013
Read-Only Attribute
Description
RxPadrCount
Number of PADR packets received.

Type: u32
Default: 0
RxPadtCount
Number of PADT packets received.

Type: u32
Default: 0
RxPapCount

Type: u32
Default: 0
Sessions

Type: u32
Default: 0
SessionsUp

Type: u32
Default: 0
SuccSetupRate

Type: u32
Default: 0
TxChapCount

Type: u32
Default: 0
TxIpcpCount

Type: u32
Default: 0
TxIpv6cpCount

Type: u32
Default: 0
TxLcpConfigAckCount

Type: u32
Default: 0
TxLcpConfigNakCount

Type: u32
Default: 0

Type: u32
Default: 0

Type: u32
Default: 0
TxLcpEchoReplyCount

Type: u32
Default: 0

Type: u32
Default: 0
TxLcpTermAckCount

Type: u32
Default: 0

Type: u32
Default: 0
2014
PppoeServerIpv4PeerPool
Read-Only Attribute
Description
TxPadoCount
Number of PADO packets transmitted.

Type: u32
Default: 0
TxPadsCount
Number of PADS packets transmitted.

Type: u32
Default: 0
TxPadtCount
Number of PADT packets transmitted.

Type: u32
Default: 0
TxPapCount

Type: u32
Default: 0
PppoeServerIpv4PeerPool
Description:
PPPoE IPv4 server pool.

Automatically created from: PppoeServerBlockConfig
Relations:
Side name
(Type)
Relative
Description
DstBoundTo
(DstBinding)

StreamBlock.
EncapsulationSource
(Encapsulation)
PathDescriptor
MemberOfVpn
(MemberOfVpn)

Port


VlanIf, WimaxIf

SrcBoundTo
(SrcBinding)

StreamBlock.
StackedOn
(StackedOnEndpoint)

VlanIf, WimaxIf
2015
PPPoESession
Side name
(Type)
Relative
Description
Port

PppoeServerIpv4PeerPool Writable Attributes

Writable Attribute
Description
Active, Name
AddrIncrement
IP address increment value.

Type: u32
Default: 1
Ipv4PeerPoolAddr
IPv4 Peer Pool start address.

Type: ip
Default: 0.0.0.0
NetworkCount
Number of IP address in server address pool.

Type: u32
Default: 1
PrefixLength
Currently not used.

Type: u8
Default: 24
Range: 0 - 32
StartIpList
Starting IP address in the address pool. If a IP list is specified the first IP address is used as the starting
address and the remaining IP addresses are ignored.
Type: ip
Default: 192.0.1.0
PppoeServerIpv4PeerPool Read-Only Attributes

PPPoESession (pppoe:PPPoESession)
Description:
Children: None
PPPoESession Attributes
Attribute
Description
code
Type: INTEGER
Default: 0
length
Type: INTEGER
Default: 0
Name
Type: string
2016
PppoeSessionResults
Attribute
Description
sessionId
Type: INTEGER
Default: 0
type
Type: INTEGER
Default: 1
version
Type: INTEGER
Default: 1
PppoeSessionResults
Description:
PPPoE Session results.

Parents: PppoeClientBlockConfig, PppoeServerBlockConfig
PppoeSessionResults Writable Attributes

PppoeSessionResults Read-Only Attributes

Read-Only Attribute
Description
AttemptedCount

Type: u32
Default: 0

Type: u32
Default: 0

Type: u32
Default: 0
FailedConnectCount

Type: u32
Default: 0
Type: u32
Default: 0
2017
PppoeSessionResults
Read-Only Attribute
Description
FailureCode

Type: enum
Default: NULL
Possible Values:
Value
Description
NULL
No failure.
USER_TERMINATED

NO_NETWORK_PROTOCOL
LINK_INACTIVE
No link.
CONNECT_EXPIRED
LOOPBACK
NO_PEER_RESPONSE
LCP_REQUEST_TIMEOUT
TERMINATE_ACK_RX
PROTOCOL_REJECT_RX
PEER_ADDR_UNKNOWN
LOCAL_ADDR_UNKNOWN
LCP_DOWN
Link went down.
PADI_TIMEOUT
PADI timeout.
PADR_TIMEOUT
PADR timeout.
PADT_RX
PADT received.
PPPOE_PAYLOAD_ERROR
PPP_L2TP_NO_SESSION
UNKNOWN
Unknown error.
InnerVlanId
Inner VLAN ID for this session.

Type: u16
Default: 1
Ipv4Addr

Type: ip
Default: 0.0.0.0
Ipv6Addr

Type: ipv6
Default: ::
Ipv6GlobalAddr

Type: ipv6
Default: ::

Type: enum
Default: NONE
Possible Values:
Value
Description
NONE

RESOLVE_DONE
2018
PppoeSessionResults
Read-Only Attribute
Description
MacAddr
MAC address assigned by the DUT to the subscriber.

Type: mac
Default: 00-00-00-00-00-00
PeerIpv4Addr

Type: ip
Default: 0.0.0.0
PeerIpv6Addr

Type: ipv6
Default: ::
PeerMacAddr
Peer's negotiated MAC address.

Type: mac
Default: 00-00-00-00-00-00
PppoeSessionId
Unique session ID assigned by the DUT to the subscriber (applies to PPP over Ethernet and PPP over Ethernet
over ATM sessions only).
Type: u32
Default: 0
RetryCount

Type: u32
Default: 0
RxChapCount

Type: u32
Default: 0
RxIpcpCount

Type: u32
Default: 0
RxIpv6cpCount

Type: u32
Default: 0
RxLcpConfigAckCount

Type: u32
Default: 0
RxLcpConfigNakCount

Type: u32
Default: 0

Type: u32
Default: 0

Type: u32
Default: 0
RxLcpEchoReplyCount

Type: u32
Default: 0

Type: u32
Default: 0
RxLcpTermAckCount

Type: u32
Default: 0
2019
PppoeSessionResults
Read-Only Attribute
Description

Type: u32
Default: 0
RxPadiCount

Type: u32
Default: 0
RxPadoCount

Type: u32
Default: 0
RxPadrCount

Type: u32
Default: 0
RxPadsCount

Type: u32
Default: 0
RxPadtCount

Type: u32
Default: 0
RxPapCount

Type: u32
Default: 0
SessionState

Type: enum
Default: IDLE
Possible Values:
Value
Description
NONE
IDLE
CONNECTING

CONNECTED
DISCONNECTING
SetupTime

Type: u32
Default: 0
TxChapCount

Type: u32
Default: 0
TxIpcpCount

Type: u32
Default: 0
TxIpv6cpCount

Type: u32
Default: 0
TxLcpConfigAckCount

Type: u32
Default: 0
TxLcpConfigNakCount

Type: u32
Default: 0
2020
PPPoETag
Read-Only Attribute
Description

Type: u32
Default: 0

Type: u32
Default: 0
TxLcpEchoReplyCount

Type: u32
Default: 0

Type: u32
Default: 0
TxLcpTermAckCount

Type: u32
Default: 0

Type: u32
Default: 0
TxPadiCount

Type: u32
Default: 0
TxPadoCount

Type: u32
Default: 0
TxPadrCount

Type: u32
Default: 0
TxPadsCount

Type: u32
Default: 0
TxPadtCount

Type: u32
Default: 0
TxPapCount

Type: u32
Default: 0
VlanId
VLAN ID for this session.

Type: u16
Default: 1
PPPoETag
Description:
Parents: tags
Children: acCookie, acName, acSystemError, endOfList, genericError, hostUniq, relaySessionId, serviceName, serviceNameError, vendorSpecific
2021
PppoL2tpv2ClientBlockConfig
PPPoETag Attributes
Attribute
Description
Name
information.
Type: string
Description:
PPPoL2TPv2 client block configuration settings.

Children: Ipv6NetworkBlock, PppMsgOption
Automatically-created children: Ipv4NetworkBlock, PppClientBlockResults
PppoePortResults, PppoeServerBlockResults, PppoL2tpv2SessionResults, PppServerBlockResults
Relations:
Side name
(Type)
Relative
Description
ResultChild
(ResultChild)
PppClientBlockResults, PppClientBlockResults,
PppoaClientBlockResults, PppoaServerBlockResults,
UsesIf
(UsesIf)


PppoL2tpv2ClientBlockConfig Writable Attributes

Writable Attribute
Description
Active, Name
Authentication

Type: enum
Default: NONE
Possible Values:
Value
Description
NONE
No authentication.
AUTO

PAP
AutoRetryCount

Type: u16
Default: 65535
Range: 1 - 65535
2022
Writable Attribute
Description
ChapAckTimeout
Type: u16
Default: 3
Range: 1 - 65535
Timeout wait period in seconds for the server to send a CHAP challenge.
Type: u16
Default: 3
Range: 1 - 65535
EchoRequestGenFreq

Type: u16
Default: 10
Range: 0 - 65535
EnableAutoFillIpv6
Type: bool
Default: TRUE
Possible Values:
Value Description
TRUE
EnableAutoRetry

Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE

EnableEchoRequest

Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE

EnableMagicNum

Type: bool
Default: TRUE
Possible Values:
Value Description
TRUE

EnableMpls
For PPPoPOS, enable the MPLS option.

Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE


Type: bool
Default: TRUE
Possible Values:
Value Description
TRUE
2023
Writable Attribute
Description
EnableOsi

Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE

IncludeTxChapId

Type: bool
Default: TRUE
Possible Values:
Value Description
TRUE

IpcpEncap

Type: enum
Default: IPV4
Possible Values:
Value Description
IPV4
IPV6
Type: u16
Default: 10
Range: 1 - 65535

Type: u16
Default: 3
Range: 1 - 65535
LcpDelay
Type: u32
Default: 0
Type: u16
Default: 10
Range: 1 - 65535

Type: u16
Default: 3
Range: 1 - 65535

Type: u16
Default: 10
Range: 1 - 65535
Type: u16
Default: 0
Range: 0 - 65535
MaxNaks

Type: u16
Default: 5
Range: 1 - 65535
2024
Writable Attribute
Description

Type: u16
Default: 10
Range: 1 - 65535
MruSize

Type: u16
Default: 1492
Range: 128 - 65535
Type: u16
Default: 10
Range: 1 - 65535

Type: u16
Default: 3
Range: 1 - 65535
PapRequestTimeout

Type: u16
Default: 3
Range: 1 - 65535
Password
@p - Port name.
Type: string
Default: spirent
Protocol

Type: enum
Default: UNDEFINED
Possible Values:
Value
Description
UNDEFINED
PPPOPOS
PPPoPOS.
PPPOE
PPPoE with no VLAN.
PPPOEVLAN

PPPOEOA
PPPOA
PPP over ATM.

Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
2025
PppoL2tpv2DeviceGenProtocolParams
Writable Attribute
Description
Username
@p - Port name.
Type: string
Default: spirent
PppoL2tpv2ClientBlockConfig Read-Only Attributes

Read-Only Attribute
Description
BlockState
State of the sessions on the block.

Type: enum
Default: NONE
Possible Values:
Value
Description
NONE
IDLE
Sessions are down.
CONNECTING
At least one session is connecting.
CONNECTED

TERMINATING
PppoL2tpv2DeviceGenProtocolParams
Description:
Specifies the PPPoL2TP specific Host generator parameters.

PppoL2tpv2DeviceGenProtocolParams Writable Attributes

Writable Attribute
Description
Active, Name
EnableAuthentication
Flag indicating if authentication of sessions is enabled.

Type: bool
Default: TRUE
Possible Values:
Value Description
TRUE
Enable authentication of sessions.
FALSE Disable authentication of sessions.
2026
PppoL2tpv2ServerBlockConfig
Writable Attribute
Description
HostName
Host name.
Type: string
L2tpNodeType
L2TP node emulation type.

Type: enum
Default: LAC
Possible Values:
Value Description
LAC
Node is a LAC.
LNS
Node is an LNS.
RemoteIpv4Addr

Type: ip
Default: 0.0.0.0
RemoteIpv4AddrStepPerL2tpNode
Remote IPv4 address step per L2TP node.

Type: ip
Default: 0.0.0.0
SessionsPerTunnel
Number of sessions per tunnel.

Type: u32
Default: 1
Range: 1 - 65535
TunnelPassword
Tunnel password.
Type: string
Default: spirent
TunnelsPerL2tpNode
Number of tunnels per L2TP node.

Type: u32
Default: 1
Range: 1 - 65535
Flag indicating the Gateway IP should be used as the Remote IP.

Type: bool
Default: TRUE
Possible Values:
Value Description
TRUE
Use the Gateway as the Remote IP.
FALSE Do not use the Gateway as the Remote IP.
PppoL2tpv2DeviceGenProtocolParams Read-Only Attributes

Description:
PPPoL2TPv2 server block configuration settings.

Children: PppMsgOption, PppoxServerIpv6PeerPool
Automatically-created children: PppoxServerIpv4PeerPool, PppServerBlockResults
PppoePortResults, PppoeServerBlockResults, PppoL2tpv2SessionResults, PppServerBlockResults
2027
Relations:
Side name
(Type)
Relative
Description
ResultChild
(ResultChild)
PppServerBlockResults, PppServerBlockResults
UsesIf
(UsesIf)


PppoL2tpv2ServerBlockConfig Writable Attributes

Writable Attribute
Description
Active, Name
Authentication

Type: enum
Default: NONE
Possible Values:
Value
Description
NONE
No authentication.
AUTO

PAP
ChapReplyTimeout

Type: u16
Default: 3
Range: 1 - 65535
EchoRequestGenFreq

Type: u16
Default: 10
Range: 0 - 65535
EnableEchoRequest

Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE

Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE

EnableMagicNum

Type: bool
Default: TRUE
Possible Values:
Value Description
TRUE
2028
Writable Attribute
Description
EnableMpls

Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE


Type: bool
Default: TRUE
Possible Values:
Value Description
TRUE

EnableOsi

Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE

IncludeTxChapId

Type: bool
Default: TRUE
Possible Values:
Value Description
TRUE

IpcpEncap

Type: enum
Default: IPV4
Possible Values:
Value Description
IPV4
IPV6
Type: u16
Default: 10
Range: 1 - 65535

Type: u16
Default: 3
Range: 1 - 65535
Type: u16
Default: 10
Range: 1 - 65535

Type: u16
Default: 3
Range: 1 - 65535
2029
Writable Attribute
Description

Type: u16
Default: 10
Range: 1 - 65535
Type: u16
Default: 0
Range: 0 - 65535
MaxNaks

Type: u16
Default: 5
Range: 1 - 65535
MruSize

Type: u16
Default: 1492
Range: 128 - 65535
Type: u16
Default: 10
Range: 1 - 65535

Type: u16
Default: 3
Range: 1 - 65535

Type: u16
Default: 3
Range: 1 - 65535
Password
@p - Port name.
Type: string
Default: spirent
Protocol

Type: enum
Default: UNDEFINED
Possible Values:
Value
Description
UNDEFINED
PPPOPOS
PPPoPOS.
PPPOE
PPPoE with no VLAN.
PPPOEVLAN

PPPOEOA
PPPOA
PPP over ATM.
2030
PppoL2tpv2SessionResults
Writable Attribute
Description
Type: u16
Default: 30
Range: 1 - 65535
Type: u16
Default: 0
Range: 0 - 65535

Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE

Username
@p - Port name.
Type: string
Default: spirent
PppoL2tpv2ServerBlockConfig Read-Only Attributes

Read-Only Attribute
Description
BlockState
State of the PPPoL2TPv2 server block.

Type: enum
Default: NONE
Possible Values:
Value
Description
NONE
IDLE
CONNECTING
CONNECTED
All sessions on the server are bound.

TERMINATING
Description:
PPPoL2TPv2 session results.
2031

Parents: PppoaClientBlockConfig, PppoaServerBlockConfig, PppoL2tpv2ClientBlockConfig, PppoL2tpv2ServerBlockConfig
PppoL2tpv2SessionResults Writable Attributes

Writable Attribute
Description
LocalIpv4Addr
Local IPv4 address.

Type: ip
Default: 0.0.0.0
RemoteIpv4Addr

Type: ip
Default: 0.0.0.0
PppoL2tpv2SessionResults Read-Only Attributes

Read-Only Attribute
Description
AttemptedCount
Number of attempted session connects (maximum of one per session); incremented the first time an LCP
Configure-Request packet is sent per session.
Type: u32
Default: 0

Type: u32
Default: 0
Number of disconnected sessions where the LCP Terminate-Request packet was sent (from either peer) and
an LCP Terminate-Ack packet was received.
Type: u32
Default: 0
FailedConnectCount
Number of session connects that failed (Attempted statistic minus Connected Successfully statistic).
Type: u32
Default: 0
Number of disconnected sessions where the LCP Terminate-Request packet was sent but an LCP
Terminate-Ack packet was not received (statistic does not apply to invalid LCP Terminate-Request packets).
Type: u32
Default: 0
2032
Read-Only Attribute
Description
FailureCode

Type: enum
Default: NULL
Possible Values:
Value
Description
NULL
No failure.
USER_TERMINATED
AUTHENTICATION_REFUSED_BY_PEER Authentication refused by peer.

NO_NETWORK_PROTOCOL
No network protocol.
LINK_INACTIVE
Link inactive.
CONNECT_EXPIRED
Connect expired.
LOOPBACK
Loopback.
NO_PEER_RESPONSE
LCP_REQUEST_TIMEOUT
TERMINATE_ACK_RX
Terminate ACK received.
PROTOCOL_REJECT_RX
Protocol reject received.
Received invalid config NAK or reject.
PEER_ADDR_UNKNOWN
LOCAL_ADDR_UNKNOWN
LCP_DOWN
Link went down.
PADI_TIMEOUT
PADI timeout.
PADR_TIMEOUT
PADR timeout.
Bad PADR packet received.
PADT_RX
PADT received.
Received terminate request.
PPPOE_PAYLOAD_ERROR
PPPoE payload error.
PPP_L2TP_NO_SESSION
UNKNOWN
Unknown error occurred.
InnerVlanId
Inner VLAN ID.

Type: u16
Default: 1
Ipv4Addr
IPv4 address.
Type: ip
Default: 0.0.0.0
Ipv6Addr
IPv6 address.
Type: ipv6
Default: ::
Ipv6GlobalAddr

Type: ipv6
Default: ::

Type: enum
Default: NONE
Possible Values:
Value
Description
NONE

RESOLVE_DONE
2033
Read-Only Attribute
Description
LocalSessionId
Local Session ID.

Type: u16
Default: 0
LocalTunnelId
Local Tunnel ID.

Type: u16
Default: 0
MacAddr
MAC address.
Type: mac
Default: 00-00-00-00-00-00
PeerIpv4Addr
Peer's IPv4 address.

Type: ip
Default: 0.0.0.0
PeerIpv6Addr
Peer's IPv6 address.

Type: ipv6
Default: ::
RemoteSessionId
Remote Session ID.

Type: u16
Default: 0
RemoteTunnelId
Remote Tunnel ID.

Type: u16
Default: 0
RetryCount

Type: u32
Default: 0
RxChapCount
Total number of CHAP requests received.

Type: u32
Default: 0
RxIpcpCount
Total number of IPCP requests received (IPv4).

Type: u32
Default: 0
RxIpv6cpCount
Total number of IPv6CP requests received.

Type: u32
Default: 0
RxLcpConfigAckCount

Type: u32
Default: 0
RxLcpConfigNakCount

Type: u32
Default: 0

Type: u32
Default: 0

Type: u32
Default: 0
RxLcpEchoReplyCount

Type: u32
Default: 0

Type: u32
Default: 0
2034
Read-Only Attribute
Description
RxLcpTermAckCount

Type: u32
Default: 0

Type: u32
Default: 0
RxPapCount
Total number of PAP requests received.

Type: u32
Default: 0
SessionState

Type: enum
Default: IDLE
Possible Values:
Value
Description
NONE
PPPoL2TP is not yet configured.
IDLE
Session is down.
CONNECTING
CONNECTING_FAILED Session failed to connect.

CONNECTED
DISCONNECTING
Session is disconnecting.
SetupTime
Setup time (milliseconds).

Type: u32
Default: 0
TxChapCount

Type: u32
Default: 0
TxIpcpCount

Type: u32
Default: 0
TxIpv6cpCount

Type: u32
Default: 0
TxLcpConfigAckCount

Type: u32
Default: 0
TxLcpConfigNakCount

Type: u32
Default: 0

Type: u32
Default: 0

Type: u32
Default: 0
TxLcpEchoReplyCount

Type: u32
Default: 0

Type: u32
Default: 0
2035
PppoxAbortCommand
Read-Only Attribute
Description
TxLcpTermAckCount

Type: u32
Default: 0

Type: u32
Default: 0
TxPapCount

Type: u32
Default: 0
Vci
VCI
Type: u16
Default: 32
VlanId
VLAN ID.
Type: u16
Default: 1
Vpi
VPI
Type: u16
Default: 0
PppoxAbortCommand
Description:
Reset PPPoX emulation.

PppoxAbortCommand Writable Attributes

Writable Attribute
Description
BlockList
List of PPPoX client/server block config object handles (that is, PppoeClientBlockConfig, PppoaClientBlockConfig,
PppoL2tpv2ClientBlockConfig, PppoeServerBlockConfig, PppoaServerBlockConfig, or PppoL2tpv2ServerBlockConfig)
on which to abort PPPoX emulation.
Type: handle
Default: 0
ControlType

Type: enum
Default: UNDEFINED
Possible Values:
Value
Description
UNDEFINED
Undefined.
CONNECT
Connect.
RETRY
Retry.
PAUSE
Pause.
RESUME
Resume.
TERMINATE
Terminate.
2036
PppoxClearStatsCommand
PppoxAbortCommand Read-Only Attributes

Read-Only Attribute
Description

PppoxClearStatsCommand
Description:
Clear the PPPoX statistics.

PppoxClearStatsCommand Writable Attributes

Writable Attribute
Description
BlockList
List of PPPoX client/server block config object handles (that is, PppoeClientBlockConfig,
PppoaClientBlockConfig, PppoL2tpv2ClientBlockConfig, PppoeServerBlockConfig, PppoaServerBlockConfig,
or PppoL2tpv2ServerBlockConfig) on which to clear PPPoX stats.
Type: handle
Default: 0
PppoxClearStatsCommand Read-Only Attributes

Read-Only Attribute
Description

PppoxConnectCommand
Description:
Connect PPPoX sessions.

PppoxConnectCommand Writable Attributes

Writable Attribute
Description
2037
PppoxConnectWaitCommand
Writable Attribute
Description
BlockList
PppoL2tpv2ClientBlockConfig, PppoeServerBlockConfig, PppoaServerBlockConfig, or PppoL2tpv2ServerBlockConfig) on
which to connect PPPoX sessions.
Type: handle
Default: 0
ControlType

Type: enum
Default: UNDEFINED
Possible Values:
Value
Description
UNDEFINED
Undefined.
CONNECT
Connect.
SeqType
RETRY
Retry.
PAUSE
Pause.
RESUME
Resume.
TERMINATE
Terminate.
Instead of this attribute, use the SeqType attribute on the PppoxPortConfig object.
Type: enum
Default: SEQUENTIAL
Possible Values:
Value
Description
SEQUENTIAL
Sessions are attempted sequentially across host blocks under the command.
ROUND_ROBIN Sessions are attempted in a round-robin style across host blocks under the command.
PppoxConnectCommand Read-Only Attributes

Read-Only Attribute
Description

PppoxConnectWaitCommand
Description:
Wait for PPPoX sessions to go into connected state.

Parents: Sequencer
PppoxConnectWaitCommand Writable Attributes

Writable Attribute
Description
ErrorOnFailure
2038
PppoxDisconnectCommand
Writable Attribute
Description
BlockConnectedState

Type: enum
Default: CONNECTED
Possible Values:
Value
Description
NONE
Null state.
IDLE
Idle state.
CONNECTING
Connecting state.
CONNECTED
Connected state.

TERMINATING
Terminating state.
ObjectList
List of object handles (that is, Project, Port, or EmulatedDevice) on which to wait for connected state on.
Type: handle
Default: 0
WaitTime
Maximum amount of time to wait for sessions to go into connected state.

Type: double
Default: 30.0
Range: 0.005 - 2147483647.0
PppoxConnectWaitCommand Read-Only Attributes

Read-Only Attribute
Description
PppoxDisconnectCommand
Description:
Disconnect PPPoX sessions.

PppoxDisconnectCommand Writable Attributes

Writable Attribute
Description
BlockList
PppoL2tpv2ClientBlockConfig, PppoeServerBlockConfig, PppoaServerBlockConfig, or PppoL2tpv2ServerBlockConfig) on
which to disconnect PPPoX sessions.
Type: handle
Default: 0
2039
PppoxDisconnectWaitCommand
Writable Attribute
Description
ControlType

Type: enum
Default: UNDEFINED
Possible Values:
Value
Description
UNDEFINED
Undefined.
CONNECT
Connect.
L2tpSessionDisconnect
RETRY
Retry.
PAUSE
Pause.
RESUME
Resume.
TERMINATE
Terminate.
Whether to enable L2TP tunnel disconnect when the last PPPoX session comes down.
Type: bool
Default: TRUE
Possible Values:
Value Description
TRUE
Disconnect L2TP tunnels after PPPoX sessions come down.
FALSE Do not disconnect L2TP tunnels after PPPoX sessions come down.
SeqType
Instead of this attribute, use the SeqType attribute on the PppoxPortConfig object.
Port-level sequence type that determines in what order sessions are brought down.
Type: enum
Default: SEQUENTIAL
Possible Values:
Value
Description
SEQUENTIAL
Bring down the sessions sequentially (all of one host block before proceeding to the next).
ROUND_ROBIN Bring down the sessions in a round-robin fashion (loop over the host blocks bringing down one session
at a time).
PppoxDisconnectCommand Read-Only Attributes

Read-Only Attribute
Description

PppoxDisconnectWaitCommand
Description:
Wait for PPPoX sessions to disconnect and become idle.

Parents: Sequencer
PppoxDisconnectWaitCommand Writable Attributes

Writable Attribute
Description
ErrorOnFailure
2040
PppoxOptions
Writable Attribute
Description
BlockDisconnectState

Type: enum
Default: IDLE
Possible Values:
Value
Description
NONE
None state.
IDLE
Idle state.
CONNECTING
Connecting state.
CONNECTED
Connected state.

TERMINATING
Terminating state.
ObjectList
List of object handles (that is, Project, Port, or EmulatedDevice) on which to wait for idle state on.
Type: handle
Default: 0
WaitTime
Maximum amount of time to wait for sessions to go into idle state.

Type: double
Default: 30.0
Range: 0.005 - 2147483647.0
PppoxDisconnectWaitCommand Read-Only Attributes

Read-Only Attribute
Description
PppoxOptions
Description:
Project-wide PPPoX settings.

PppoxOptions Writable Attributes

Writable Attribute
Description
Active, Name
TrafficBehavior

Type: enum
Default: REQUIRE_ALL_SESSIONS_CONNECTED
Possible Values:
Value
Description
REQUIRE_ALL_SESSIONS_CONNECTED Start traffic only if all sessions are connected.
PppoxOptions Read-Only Attributes

2041
Start traffic while ignoring sessions that failed to connect.
PppoxPauseCommand
PppoxPauseCommand
Description:
Pause PPPoX connect or disconnect.

PppoxPauseCommand Writable Attributes

Writable Attribute
Description
BlockList
on which to pause PPPoX connect or disconnect.
Type: handle
Default: 0
ControlType

Type: enum
Default: UNDEFINED
Possible Values:
Value
Description
UNDEFINED
Undefined.
CONNECT
Connect.
RETRY
Retry.
PAUSE
Pause.
RESUME
Resume.
TERMINATE
Terminate.
PppoxPauseCommand Read-Only Attributes

Read-Only Attribute
Description

PppoxPortConfig
Description:
Port-level PPPoX configuration settings.

Automatically-created children: PppoePortResults
Result children (automatically created): PppoePortResults
Relations:
2042
PppoxPortConfig
Side name
(Type)
Relative
Description
ResultChild
(ResultChild)
PppoePortResults
PppoxPortConfig Writable Attributes

Writable Attribute
Description
Active, Name
ConnectRate
Maximum rate in the number of session attempts per second at which session attempts will be made.
Type: u16
Default: 100
Range: 1 - 1000
DisconnectRate
Maximum rate in the number of sessions per second at which sessions will be disconnected.
Type: u16
Default: 1000
Range: 1 - 1000
EmulationType

Type: enum
Default: CLIENT
Possible Values:
Value
Description
CLIENT
SERVER
All nodes under this port will run PPPoX server emulation.
PPPOL2TP All nodes under this port will run PPPoL2TP emulation.
SeqType
Type: enum
Default: SEQUENTIAL
Possible Values:
Value
Description
PARALLEL
SessionOutstanding
Maximum number of sessions in progress, which includes the sessions in the process of coming up or disconnecting,
at one time.
Type: u32
Default: 100
Range: 2 - 65535
PppoxPortConfig Read-Only Attributes

Read-Only Attribute
Description
PortState
State of the PPP engine.

Type: enum
Default: NONE
Possible Values:
Value
Description
NONE
None of the host blocks are configured for PPPoX.
IDLE
None of the host blocks are connecting or disconnecting.
CONNECTING
At least one session in one of the host blocks is connecting.
CONNECTED
At least one session in one host block is connected.
DISCONNECTING
At least one host block is disconnecting.
TERMINATING
All host blocks are being terminated/aborted.
CONNECTING_DISCONNECTING Sessions on this port are connecting on some host blocks and disconnecting others.
2043
PppoxResumeCommand
PppoxResumeCommand
Description:
Resume PPPoX connect or disconnect.

PppoxResumeCommand Writable Attributes

Writable Attribute
Description
BlockList
on which to resume PPPoX connect or disconnect.
Type: handle
Default: 0
ControlType

Type: enum
Default: UNDEFINED
Possible Values:
Value
Description
UNDEFINED
Undefined.
CONNECT
Connect.
RETRY
Retry.
PAUSE
Pause.
RESUME
Resume.
TERMINATE
Terminate.
PppoxResumeCommand Read-Only Attributes

Read-Only Attribute
Description

PppoxRetryCommand
Description:
Retry failed PPPoX sessions.

PppoxRetryCommand Writable Attributes

Writable Attribute
Description
2044
PppoxRetryWaitCommand
Writable Attribute
Description
BlockList
on which to retry PPPoX sessions.
Type: handle
Default: 0
ControlType

Type: enum
Default: UNDEFINED
Possible Values:
Value
Description
UNDEFINED
Undefined.
CONNECT
Connect.
RETRY
Retry.
PAUSE
Pause.
RESUME
Resume.
TERMINATE
Terminate.
PppoxRetryCommand Read-Only Attributes

Read-Only Attribute
Description

PppoxRetryWaitCommand
Description:
Wait for PPPoX sessions to retry.

Parents: Sequencer
PppoxRetryWaitCommand Writable Attributes

Writable Attribute
Description
ErrorOnFailure
BlockRetryState

Type: enum
Default: CONNECTED
Possible Values:
Value
Description
NONE
None state.
IDLE
Idle state.
CONNECTING
Connecting state.
CONNECTED
Connected state.

TERMINATING
Terminating state.
2045
PppoxServerIpv4PeerPool
Writable Attribute
Description
ObjectList
on which to wait for retry on.
Type: handle
Default: 0
WaitTime
Maximum amount of time to wait for sessions to retry.

Type: double
Default: 30.0
Range: 0.005 - 2147483647.0
PppoxRetryWaitCommand Read-Only Attributes

Read-Only Attribute
Description
Description:
PPPoX server IPv4 address pool.

Automatically created from: PppoaServerBlockConfig, PppoL2tpv2ServerBlockConfig
Relations:
Side name
(Type)
Relative
Description
DstBoundTo
(DstBinding)

StreamBlock.
EncapsulationSource
(Encapsulation)
PathDescriptor
MemberOfVpn
(MemberOfVpn)

Port


VlanIf, WimaxIf

SrcBoundTo
(SrcBinding)

StreamBlock.
2046
Side name
(Type)
Relative
Description
StackedOn
(StackedOnEndpoint)

VlanIf, WimaxIf
Port

PppoxServerIpv4PeerPool Writable Attributes

Writable Attribute
Description
Active, Name
AddrIncrement
IP address increment value.

Type: u32
Default: 1
Ipv4PeerPoolAddr
IPv4 peer pool start address.

Type: ip
Default: 0.0.0.0
NetworkCount
Number of IP addresses in the server pool.

Type: u32
Default: 1
PrefixLength
Currently not used.

Type: u8
Default: 24
Range: 0 - 32
StartIpList
Starting IP address in the address pool. If a IP list is specified the first IP address is used as the starting
address and the remaining IP addresses are ignored.
Type: ip
Default: 192.0.1.0
PppoxServerIpv4PeerPool Read-Only Attributes

Description:
PPPoX server IPv6 address pool.

Parents: EmulatedDevice, ExternalDevice, ExternalDevicePort, Host, IptvChannelBlock, Port, PppoaServerBlockConfig, PppoeServerBlockConfig,
PppoL2tpv2ServerBlockConfig, Router, SUT
Relations:
2047
Side name
(Type)
Relative
Description
DstBoundTo
(DstBinding)

StreamBlock.
EncapsulationSource
(Encapsulation)
PathDescriptor
MemberOfVpn
(MemberOfVpn)

Port


VlanIf, WimaxIf

SrcBoundTo
(SrcBinding)

StreamBlock.
StackedOn
(StackedOnEndpoint)

VlanIf, WimaxIf
Port

PppoxServerIpv6PeerPool Writable Attributes

Writable Attribute
Description
Active, Name
AddrIncrement
Currently not used.

Type: u32
Default: 1
Ipv6IntfId

Type: ipv6
Default: ::2
Ipv6IntfIdStep

Type: ipv6
Default: ::1
Ipv6PeerPoolPrefix

Type: ipv6
Default: 2001::
Ipv6PeerPoolPrefixStep

Type: ipv6
Default: 0:0:0:1::
2048
PppoxSessionInfoCommand
Writable Attribute
Description
NetworkCount
Number of IPv6 addresses (prefixes and interface identifiers) in the pool.

Type: u32
Default: 1
PrefixLength
Currently not used.

Type: u8
Default: 64
Range: 0 - 128
StartIpList
List of resolved session IPv6 addresses.

Type: ipv6
Default: 2000::1
PppoxServerIpv6PeerPool Read-Only Attributes

PppoxSessionInfoCommand
Description:
Get PPPoX session information.

PppoxSessionInfoCommand Writable Attributes

Writable Attribute
Description
BlockList
on which to get PPPoX session information.
Type: handle
Default: 0
FileName
Filename to which the session information results will be saved.

Default: pppoesessions.csv
SaveToFile
Whether to save PPPoX session information results to a file.

Type: bool
Default: TRUE
Possible Values:
Value Description
TRUE
Save PPPoX session information results to file.
FALSE Do not save PPPoX session information results to file.

TimestampFilename

Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
Include timestamp as part of the filename.
FALSE Do not include timestamp as part of the filename.
2049
PppoxShowSessionInfoCommand
PppoxSessionInfoCommand Read-Only Attributes

Read-Only Attribute
Description

PppoxShowSessionInfoCommand
Description:
Show the PPPoX session info (GUI only).

PppoxShowSessionInfoCommand Writable Attributes

Writable Attribute
Description
BlockList
List of PPPoX client/server block config object handles (that is, PppoeClientBlockConfig,
PppoaClientBlockConfig, PppoL2tpv2ClientBlockConfig, PppoeServerBlockConfig, PppoaServerBlockConfig,
or PppoL2tpv2ServerBlockConfig) on which to show session info.
Type: handle
Default: 0
PppoxShowSessionInfoCommand Read-Only Attributes

Read-Only Attribute
Description

PppProtocolConfig
Description:
PPP Protocol configuration settings.

Children: PppMsgOption
Automatically-created children: PppProtocolResults
PppoePortResults, PppoeServerBlockResults, PppProtocolResults, PppServerBlockResults
Relations:
Side name
(Type)
Relative
Description
2050
PppProtocolConfig
Side name
(Type)
Relative
Description
ResultChild
(ResultChild)
PppProtocolResults, PppServerBlockResults
UsesIf
(UsesIf)


PppProtocolConfig Writable Attributes

Writable Attribute
Description
Active, Name
Authentication

Type: enum
Default: NONE
Possible Values:
Value
Description
NONE
No authentication.
AUTO

PAP
AutoRetryCount

Type: u16
Default: 65535
Range: 1 - 65535
ChapAckTimeout
Type: u16
Default: 3
Range: 1 - 65535
Timeout wait period for the server to send a CHAP challenge.

Type: u16
Default: 3
Range: 1 - 65535
EchoRequestGenFreq

Type: u16
Default: 10
Range: 0 - 65535
EnableAutoRetry

Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE

EnableEchoRequest

Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
2051
PppProtocolConfig
Writable Attribute
Description
EnableMagicNum

Type: bool
Default: TRUE
Possible Values:
Value Description
TRUE

EnableMpls

Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
Enable MPLS option.


Type: bool
Default: TRUE
Possible Values:
Value Description
TRUE

EnableOsi

Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE

IncludeTxChapId

Type: bool
Default: TRUE
Possible Values:
Value Description
TRUE

IpcpEncap

Type: enum
Default: IPV4
Possible Values:
Value Description
IPV4
IPV6
Ipv4PeerAddr

Type: ip
Default: 0.0.0.0
Ipv6PeerAddr

Type: ipv6
Default: ::
Type: u16
Default: 10
Range: 1 - 65535
2052
PppProtocolConfig
Writable Attribute
Description

Type: u16
Default: 3
Range: 1 - 65535
Type: u16
Default: 10
Range: 1 - 65535

Type: u16
Default: 3
Range: 1 - 65535

Type: u16
Default: 10
Range: 1 - 65535
Type: u16
Default: 0
Range: 0 - 65535
MaxNaks
Maximum number of Negative-Acknowlegments allowed during LCP and NCP configuration/negotiation.

Type: u16
Default: 5
Range: 1 - 65535

Type: u16
Default: 10
Range: 1 - 65535
MruSize
Local maximum receive unit (MRU) size in bytes. If not set, will default to 1492 bytes.
Type: u16
Default: 1492
Range: 128 - 65535
Type: u16
Default: 10
Range: 1 - 65535

Type: u16
Default: 3
Range: 1 - 65535
PapRequestTimeout
Time between the re-transmission of a PAP request.

Type: u16
Default: 3
Range: 1 - 65535
2053
PppProtocolConfig
Writable Attribute
Description
Password
@p - Port name.
Type: string
Default: spirent
Protocol

Type: enum
Default: UNDEFINED
Possible Values:
Value
Description
UNDEFINED
PPPOPOS
PPPoPOS.
PPPOE
PPPoE no VLAN.
PPPOEVLAN

PPPOEOA
PPPOA
PPP over ATM.

Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE

Username
@p - Port name.
Type: string
Default: spirent
2054
PppProtocolResults
PppProtocolConfig Read-Only Attributes

Read-Only Attribute
Description
BlockState
State of the block.

Type: enum
Default: NONE
Possible Values:
Value
Description
NONE
IDLE
Sessions are down.
CONNECTING
At least one sessions is connecting.
CONNECTED

TERMINATING
PppProtocolResults
Description:
PPP protocol results.

Automatically created from: PppProtocolConfig
Relations:
Side name
(Type)
Relative
Description
ResultParent
(ResultChild)
PppProtocolConfig
PppProtocolResults Writable Attributes

PppProtocolResults Read-Only Attributes

Read-Only Attribute
Description
Ipv4CpState
IPv4 CP State.
Type: enum
Default: INITIAL
Possible Values:
Value
Description
INITIAL
Lower layer is unavailable and no attempt has been made to open a link.
STARTING
An attempt has been made to open a link, but the lower layer is unavailable.
CLOSED
Lower layer is available but that there is no active attempt to open a link.
STOPPED
Terminate request has been sent and the ack has been received.
CLOSING
Terminate request is being sent.
STOPPING
Terminate request has been sent but an ack has not been received.
REQUEST_TX A configure request has been sent but a configure ack has not been received nor sent.
ACK_RX
A configure request has been sent and a configure ack has been received.
ACK_TX
Both a configure request and a configure ack have been sent but a configure ack has not yet been received.
OPENED
A configure ack has been both sent and received.
2055
PppProtocolResults
Read-Only Attribute
Description
Ipv4LocalAddr
Local IPv4 address for the interface to be requested.

Type: ip
Default: 0.0.0.0
Ipv4PeerAddr
Peer IPv4 address.

Type: ip
Default: 0.0.0.0
Ipv6CpState
IPv6 CP state.
Type: enum
Default: INITIAL
Possible Values:
Value
Description
INITIAL
STARTING
CLOSED
STOPPED
CLOSING
STOPPING
ACK_RX
ACK_TX
OPENED
Ipv6LocalAddr
Local IPv6 address for the interface to be requested.

Type: ipv6
Default: ::
Ipv6PeerAddr
Peer IPv6 address.

Type: ipv6
Default: ::
MplsCpState
MPLS CP State.
Type: enum
Default: INITIAL
Possible Values:
Value
Description
INITIAL
STARTING
CLOSED
STOPPED
CLOSING
STOPPING
ACK_RX
ACK_TX
OPENED
2056
PppProtocolResults
Read-Only Attribute
Description
OsiNlcpState
OSI NLCP State.

Type: enum
Default: INITIAL
Possible Values:
Value
Description
INITIAL
STARTING
CLOSED
STOPPED
CLOSING
STOPPING
PosChapAuthState
ACK_RX
ACK_TX
OPENED
POS CHAP Authentication state.

Type: enum
Default: INITIAL
Possible Values:
Value
Description
INITIAL
PPP link is down.
STARTED
Waiting for CHAP request.
PENDING
Sent response, waiting for ack.
AUTHENTICATION_FAILED Authentication failed and was denied.

OPENED
PosLcpOrNcpState
CHAP authentication passed.
POS LCP/NCP state.

Type: enum
Default: INITIAL
Possible Values:
Value
Description
INITIAL
STARTING
An attempt has been made to open a link but the lower layer is unavailable.
CLOSED
Lower layer is available but there is no active attempt to open a link.
STOPPED
CLOSING
STOPPING
PosPapAuthState
ACK_RX
ACK_TX
A configure request and a configure ack have been sent but a configure ack has not yet been received.
OPENED
POS PAP Authentication state.

Type: enum
Default: INITIAL
Possible Values:
Value
Description
INITIAL
PPP link is down.
CLOSED
PPP has been established, but PAP authentication has not yet been requested.
PENDING
PPP connection is not established and PAP authentication has not been requested.
LISTENING
Listening for authentication.
OPENED
PAP authentication passed and is up.
Authentication failed and was denied.
AUTHENTICATION_REQUEST_TX Transmitting authentication request.
2057
PppServerBlockResults
Read-Only Attribute
Description
PosPortState
State of the POS port.

Type: enum
Default: DEAD
Possible Values:
Value
Description
DEAD
PPP is not up and not ready to be established.
INITIALIZE
PPP is initializing.
DORMANT
Unused state.
ESTABLISH
PPP is trying to establish a link using link control protocol.
AUTHENTICATE PPP is authenticating itself with a peer using either PAP or CHAP.
CALLBACK
Unused state.
NETWORK
PPP link is established.
DISCONNECT
PPP is terminating the link.
HOLDOFF
Unused state.
DISABLED
Unused state.
RxMruSize
Local maximum receive unit (MRU) receive size in bytes.

Type: u16
Default: 0
TxMruSize

Type: u16
Default: 0
Description:
PPP server block results.

Automatically created from: PppoL2tpv2ServerBlockConfig
Relations:
Side name
(Type)
Relative
Description
ResultParent
(ResultChild)

PppoL2tpv2ServerBlockConfig, PppoL2tpv2ServerBlockConfig,
PppProtocolConfig

an object.
PppServerBlockResults Writable Attributes

PppServerBlockResults Read-Only Attributes

Read-Only Attribute
Description
State
AvgSetupTime
Type: u32
Default: 0
2058
Read-Only Attribute
Description
Average number of successful transactions taken to connect.

Type: u32
Default: 0

Type: u32
Default: 0
Number of disconnected sessions during which an LCP Terminate-Request packet was sent (from
either peer) and an LCP Terminate-Ack packet was received.
Type: u32
Default: 0
FailedConnectCount
Number of failed connects (Attempted value Connected Successfully value).

Type: u32
Default: 0
Number of disconnected sessions during which an LCP Terminate-Request packet was sent but an
LCP Terminate-Ack packet was not received (does not apply to invalid LCP Terminate-Request packets).
Type: u32
Default: 0
MaxSetupTime
Maximum amount of time taken to set up a session (milliseconds).

Type: u32
Default: 0
MinSetupTime
Type: u32
Default: 0
RxChapCount

Type: u32
Default: 0
RxIpcpCount

Type: u32
Default: 0
RxIpv6cpCount

Type: u32
Default: 0
RxLcpConfigAckCount

Type: u32
Default: 0
RxLcpConfigNakCount

Type: u32
Default: 0

Type: u32
Default: 0

Type: u32
Default: 0
RxLcpEchoReplyCount

Type: u32
Default: 0

Type: u32
Default: 0
2059
Read-Only Attribute
Description
RxLcpTermAckCount

Type: u32
Default: 0

Type: u32
Default: 0
RxPapCount

Type: u32
Default: 0
Sessions

Type: u32
Default: 0
SessionsUp
Number of sessions in the connected state.

Type: u32
Default: 0
SuccSetupRate

Type: u32
Default: 0
TxChapCount

Type: u32
Default: 0
TxIpcpCount

Type: u32
Default: 0
TxIpv6cpCount

Type: u32
Default: 0
TxLcpConfigAckCount

Type: u32
Default: 0
TxLcpConfigNakCount

Type: u32
Default: 0

Type: u32
Default: 0

Type: u32
Default: 0
TxLcpEchoReplyCount

Type: u32
Default: 0

Type: u32
Default: 0
TxLcpTermAckCount

Type: u32
Default: 0

Type: u32
Default: 0
2060
PppSessionResults
Read-Only Attribute
Description
TxPapCount

Type: u32
Default: 0
PppSessionResults
Description:
PPP session results.
PppSessionResults Writable Attributes

PppSessionResults Read-Only Attributes

Read-Only Attribute
Description
AttemptedCount
Attempted count.
Type: u32
Default: 0
Successfully connected count.

Type: u32
Default: 0
Disconnected successfully count.

Type: u32
Default: 0
FailedConnectCount
Failed connect count.

Type: u32
Default: 0
Failed disconnect count.

Type: u32
Default: 0
2061
PppSessionResults
Read-Only Attribute
Description
FailureCode
Session failure code.

Type: enum
Default: NULL
Possible Values:
Value
Description
NULL
No failure.
USER_TERMINATED
User terminated.
AUTHENTICATION_REFUSED_BY_PEER Authentication refused by peer.

NO_NETWORK_PROTOCOL
No network protocol.
LINK_INACTIVE
Link inactive.
CONNECT_EXPIRED
Connect expired.
LOOPBACK
Loopback.
NO_PEER_RESPONSE
No peer response.
LCP_REQUEST_TIMEOUT
TERMINATE_ACK_RX
Terminate ACK received.
PROTOCOL_REJECT_RX
Protocol reject received.
Received invalid config NAK or reject.
PEER_ADDR_UNKNOWN
LOCAL_ADDR_UNKNOWN
LCP_DOWN
LCP is down.
PADI_TIMEOUT
PADI timeout.
PADR_TIMEOUT
PADR timeout.
Bad PADO count exceeded.
Bad PADS count exceeded.
PADT_RX
Received PADT.
Received terminate request.
PPPOE_PAYLOAD_ERROR
PPPoE payload error.
PPP_L2TP_NO_SESSION
UNKNOWN
Unknown error.
Ipv4Addr
IPv4 address.
Type: ip
Default: 0.0.0.0
Ipv6Addr
IPv6 address.
Type: ipv6
Default: ::
Ipv6GlobalAddr

Type: ipv6
Default: ::

Type: enum
Default: NONE
Possible Values:
Value
Description
NONE

RESOLVE_DONE
PeerIpv4Addr
Peer IPv4 address.

Type: ip
Default: 0.0.0.0
2062
PppSessionResults
Read-Only Attribute
Description
PeerIpv6Addr
Peer IPv6 address.

Type: ipv6
Default: ::
RetryCount
Retry count.
Type: u32
Default: 0
RxChapCount
Receive CHAP count.

Type: u32
Default: 0
RxIpcpCount
Receive IPCP count.

Type: u32
Default: 0
RxIpv6cpCount
Receive IPv6CP count.

Type: u32
Default: 0
RxLcpConfigAckCount
Receive LCP config ACK count.

Type: u32
Default: 0
RxLcpConfigNakCount
Receive LCP config NAK count.

Type: u32
Default: 0
Receive LCP config reject count.

Type: u32
Default: 0
Receive LCP config request count.

Type: u32
Default: 0
RxLcpEchoReplyCount
Receive LCP echo reply count.

Type: u32
Default: 0
Receive LCP echo request count.

Type: u32
Default: 0
RxLcpTermAckCount
Receive LCP terminate ACK count.

Type: u32
Default: 0
Receive LCP terminate request count.

Type: u32
Default: 0
RxPapCount
Receive PAP count.

Type: u32
Default: 0
2063
PppSessionResults
Read-Only Attribute
Description
SessionState
Session state.
Type: enum
Default: IDLE
Possible Values:
Value
Description
NONE
IDLE
CONNECTING
CONNECTING_FAILED Session connection failed.

CONNECTED
DISCONNECTING
Session is disconnecting.
SetupTime
Setup time (milliseconds).

Type: u32
Default: 0
TxChapCount
Transmit CHAP count.

Type: u32
Default: 0
TxIpcpCount
Transmit IPCP count.

Type: u32
Default: 0
TxIpv6cpCount
Transmit IPv6CP count.

Type: u32
Default: 0
TxLcpConfigAckCount
Transmit LCP config ACK count.

Type: u32
Default: 0
TxLcpConfigNakCount
Transmit LCP config NAK count.

Type: u32
Default: 0
Transmit LCP config reject count.

Type: u32
Default: 0
Transmit LCP config request count.

Type: u32
Default: 0
TxLcpEchoReplyCount
Transmit LCP echo reply count.

Type: u32
Default: 0
Transmit LCP echo request count.

Type: u32
Default: 0
TxLcpTermAckCount
Transmit LCP terminate ACK count.

Type: u32
Default: 0
Transmit LCP terminate request count.

Type: u32
Default: 0
TxPapCount
Transmit PAP count.

Type: u32
Default: 0
2064
PrefixInformation
PrefixInformation
Description:
Parents: prefixOption
Children: None
PrefixInformation Attributes
Attribute
Description
aBit
Type: BITSTRING
Default: 1
lBit
Type: BITSTRING
Default: 1
length
Type: INTEGER
Default: 4
Name
Type: string
preferredLifetime
Type: INTEGER
Default: 1
prefix
Type: IPV6ADDR
Default: 2000::0
prefixLen
Type: INTEGER
Default: 64
reserved1
Type: INTEGER
Default: 0
reserved2
Type: INTEGER
Default: 0
type
Type: NdOptionType
Default: 3
Possible Values:
Value Description
validLifetime
Prefix Information
Redirected Header
MTU
Type: INTEGER
Default: 1
prefixOption
Description:
Used in ICMPv6 as a parent for PrefixInformation objects
Parents: RouterAdvertisement
Children: PrefixInformation
2065
prefixOption Attributes
Attribute
Description
Name
information.
Type: string
Description:
Provides SQL like syntax for defining the result that users are interested in.

Parents: DynamicChartResultView, DynamicResultView
Result children (automatically created): ResultViewData
PresentationResultQuery Writable Attributes

Writable Attribute
Description
Active, Name
ArchivingInterval
Controls archiving interval. Used only if Archiving option is PERIOIDIC. The unit is "seconds".
Type: u32
Default: 10
ArchivingOption
Controls whether view data is archived.

Type: enum
Default: NONE
Possible Values:
Value
Description
NONE
No archiving.
PERIODIC Archive periodically, depending on the archiving interval.

UPDATE
DatabaseFileName
Specifies database file name. This is only used when querying result from end of test result database.
Type: inputFilePath
DisableAutoGrouping
Used to indicate if auto grouping is disable.

Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
FALSE
FromObjects
A list of objects to indicate the scope of results. All the objects in the list have to be the same type.
Type: handle
Default: 0
GroupByProperties
A list of conditions to indicate how the results will be group. Only config properties that exist in the SelectProperties
could be used in the GroupByProperties
Type: string
2066
PreviewCustomConfigCommand
Writable Attribute
Description
LimitOffset
Specifies start of range to show within available data.

Type: u16
Default: 0
LimitSize
Specifies end of range to show within available data.

Type: u16
Default: 50
SelectProperties
A list of strings to indicate what properties to view.

Type: string
SortBy
A list of properties to indicate the order of result. Only properties that exist in the SelectProperties could be used
in SortBy.
Type: string
WhereConditions
A list of conditions to indicate the filter for the result. Only properties that exist in the SelectProperties could be
used in the WhereConditions.
Type: string
PresentationResultQuery Read-Only Attributes

PreviewCustomConfigCommand
Description:
Returns a tree of Endpoints supported for multi-port.

PreviewCustomConfigCommand Writable Attributes

Writable Attribute
Description
CustomConfigHandle
Custom config apply handle.

Type: handle
Default: 0
PreviewCustomConfigCommand Read-Only Attributes

Read-Only Attribute
Description

CommandList
List of sequencer commands handles.

Type: handle
Default: 0
2067
PreviewData
PreviewData
Description:
Stream block preview data.

PreviewData Writable Attributes

PreviewData Read-Only Attributes

Read-Only Attribute
Description
ColumnHeaders
Names of columns for the preview table.

Type: string
Data
Specifies column header and data as an array of strings. Each string represents a row. String contains "/" between
values. Each value represents a field in the packet generated by the stream block.
Type: string
HexData
Strings containing hex data for preview.

Type: string
prioAllocation
Description:
Parents: pgTlv
Children: None
prioAllocation Attributes
Attribute
Description
Name
Type: string
pgid0
Type: INTEGER
Default: 0
pgid1
Type: INTEGER
Default: 0
pgid2
Type: INTEGER
Default: 0
pgid3
Type: INTEGER
Default: 0
pgid4
Type: INTEGER
Default: 0
pgid5
Type: INTEGER
Default: 0
2068
priority
Attribute
Description
pgid6
Type: INTEGER
Default: 0
pgid7
Type: INTEGER
Default: 0
priority
Description:
Parents: DL-Choice
Children: None
priority Attributes
Attribute
Description
length
Type: INTEGER
Default: 1
Name
Type: string
priority
Type: OCTETSTRING
Default: 64
reserved
Type: OCTETSTRING
Default: 00
type
Type: INTEGER
Default: 1
priority0Allocation
Description:
Parents: pgTlv, pgTlv, pgTlv, pgTlv, pgTlv, pgTlv, pgTlv, pgTlv
Children: None
priority0Allocation Attributes
Attribute
Description
bw_percentage
Type: INTEGER
Default: 0
bwg_id
Type: INTEGER
Default: 0
Name
Type: string
2069
priority1Allocation
Attribute
Description
reserved0
Type: INTEGER
Default: 0
strict_prio
Type: INTEGER
Default: 0
priority1Allocation
Description:
Children: None
Attribute
Description
bw_percentage
Type: INTEGER
Default: 0
bwg_id
Type: INTEGER
Default: 0
Name
Type: string
reserved0
Type: INTEGER
Default: 0
strict_prio
Type: INTEGER
Default: 0
priority2Allocation
Description:
Children: None
Attribute
Description
bw_percentage
Type: INTEGER
Default: 0
bwg_id
Type: INTEGER
Default: 0
Name
Type: string
2070
priority3Allocation
Attribute
Description
reserved0
Type: INTEGER
Default: 0
strict_prio
Type: INTEGER
Default: 0
priority3Allocation
Description:
Children: None
Attribute
Description
bw_percentage
Type: INTEGER
Default: 0
bwg_id
Type: INTEGER
Default: 0
Name
Type: string
reserved0
Type: INTEGER
Default: 0
strict_prio
Type: INTEGER
Default: 0
priority4Allocation
Description:
Children: None
Attribute
Description
bw_percentage
Type: INTEGER
Default: 0
bwg_id
Type: INTEGER
Default: 0
Name
Type: string
2071
priority5Allocation
Attribute
Description
reserved0
Type: INTEGER
Default: 0
strict_prio
Type: INTEGER
Default: 0
priority5Allocation
Description:
Children: None
Attribute
Description
bw_percentage
Type: INTEGER
Default: 0
bwg_id
Type: INTEGER
Default: 0
Name
Type: string
reserved0
Type: INTEGER
Default: 0
strict_prio
Type: INTEGER
Default: 0
priority6Allocation
Description:
Children: None
Attribute
Description
bw_percentage
Type: INTEGER
Default: 0
bwg_id
Type: INTEGER
Default: 0
Name
Type: string
2072
priority7Allocation
Attribute
Description
reserved0
Type: INTEGER
Default: 0
strict_prio
Type: INTEGER
Default: 0
priority7Allocation
Description:
Children: None
Attribute
Description
bw_percentage
Type: INTEGER
Default: 0
bwg_id
Type: INTEGER
Default: 0
Name
Type: string
reserved0
Type: INTEGER
Default: 0
strict_prio
Type: INTEGER
Default: 0
priorityAssign
Description:
Parents: ETSConfigurationTlv, ETSRecommendationTlv
Children: None
priorityAssign Attributes
Attribute
Description
Name
Type: string
priority0
Type: INTEGER
Default: 0
priority1
Type: INTEGER
Default: 0
2073
PriorityBasedFlowControlTlv
Attribute
Description
priority2
Type: INTEGER
Default: 0
priority3
Type: INTEGER
Default: 0
priority4
Type: INTEGER
Default: 0
priority5
Type: INTEGER
Default: 0
priority6
Type: INTEGER
Default: 0
priority7
Type: INTEGER
Default: 0
PriorityBasedFlowControlTlv (lldp:PriorityBasedFlowControlTlv)
Description:
Children: None
lldp:PortAndProtocolVlanIdTlv, lldp:ProtocolIdentityTlv, lldp:OrganizationallySpecificTlv, lldp:TrafficClassesSupportedTlv, lldp:ApplicationPriorityTlv,
lldp:ETSConfigurationTlv, lldp:ETSRecommendationTlv, lldp:CongestionNotificationTlv, lldp:NivSupportTlv
PriorityBasedFlowControlTlv Attributes
Attribute
Description
length
Type: INTEGER
Default: 6
mbc
Type: BITSTRING
Default: 1
Name
Type: string
oui
Type: OCTETSTRING
Default: 0080C2
pfcCap
Type: INTEGER
Default: 0
pfcEnable
Type: BITSTRING
Default: 00000000
reserved
Type: BITSTRING
Default: 000
subtype
Type: OCTETSTRING
Default: 11
type
Type: INTEGER
Default: 127
2074
Probe
Attribute
Description
willing
Type: BITSTRING
Default: 1
Probe
Description:

Parents: Port
Probe Writable Attributes

Writable Attribute
Description
Active, Name
Probe Read-Only Attributes

ProfileNameTlv (overloaded)
ProfileNameTlv (VICTLV) - Object definition for the following paths:
StreamBlock.ProvisioningInfoTLV.Info.ProvList.VmWare.SubTlvs.VmWareSubTlvList.ProfileNameTlv
ProfileNameTlv (VICTLV) - Object definition for the following paths:
StreamBlock.ProvisioningInfoTLV.Info.ProvList.Fixed.SubTlvs.FixedSubTlvList.ProfileNameTlv
ProfileNameTlv Object (VICTLV PDU library)

Description:
Parents: VmWareSubTlvList (StreamBlock.ProvisioningInfoTLV.Info.ProvList.VmWare.SubTlvs.VmWareSubTlvList)

Children: None
ProfileNameTlv Attributes
Attribute
Description
Length
Type: INTEGER
Default: 0
Name
Type: string
2075
ProfilesLoadFromTemplateCommand
Attribute
Description
ProfileName
Type: ASCII
Default: SPIRENT
Type
Type: INTEGER
Default: 0
ProfileNameTlv Object (VICTLV PDU library)

Description:
Parents: FixedSubTlvList (StreamBlock.ProvisioningInfoTLV.Info.ProvList.Fixed.SubTlvs.FixedSubTlvList)

Children: None
ProfileNameTlv Attributes
Attribute
Description
Length
Type: INTEGER
Default: 0
Name
Type: string
ProfileName
Type: ASCII
Default: SPIRENT
Type
Type: INTEGER
Default: 1
ProfilesLoadFromTemplateCommand
Description:
Load profiles from a template.

ProfilesLoadFromTemplateCommand Writable Attributes

Writable Attribute
Description
FileName
Name of the file from which the profile will be loaded.

Type: inputFilePath
2076
ProfilesSaveAsTemplateCommand
ProfilesLoadFromTemplateCommand Read-Only Attributes

Read-Only Attribute
Description

Profile
The handle of the profile to which configuration has been loaded, returned by the command.
Type: handle
Default: 0
ProfilesSaveAsTemplateCommand
Description:
Save a profile as a template.

ProfilesSaveAsTemplateCommand Writable Attributes

Writable Attribute
Description
FileName
Name of the file to which the profile will be saved.

Profile
The handle of the profile object to be saved as template.

Type: handle
Default: 0
ProfilesSaveAsTemplateCommand Read-Only Attributes

Read-Only Attribute
Description

Project
Description:
Automatically-created root object of a test hierarchy. Only one Project object can exist in a configuration.

Parents: StcSystem
Children: AccessConcentratorGenParams, AccessStabilityGenParams, AnalyzerPreloadProfile, AncpAccessLoopGenParams, AncpDslLineProfile,
BfdStateSummary, BgpImportRouteTableParams, BgpRouteGenParams, BgpStateSummary, ClientLoadProfile, ClientProfile, ContinuousTestConfig,
DcbTestConfig, DeviceGroup, DeviceRole, EmulatedDevice, EmulatedDeviceGenParams, EoamGenConfig, EoamMegConfig, ExposedConfig, ExternalDevice,
ExternalDevicePort, ExternalDummyDevice, FcFcoeTrafficParams, FcGlobalParams, FcoeGlobalParams, FcoeTestGenParams, FcTestGenParams,
FixedDurationTestConfig, FrameLengthDistribution, GroupCollection, GroupType, Host, HostGenParams, HostGroup, Ieee1588v2StateSummary,
IptvChannelBlock, IptvViewedChannels, IptvViewingProfileConfig, Ipv4Group, Ipv6Group, IsisLspGenParams, IsisStateSummary,
L4L7GenerateTrafficConfigParams, LacpGroupConfig, LacpStateSummary, LdpStateSummary, LldpStateSummary, LogFileQuerySet, LspPingStateSummary,
2077
Project
MacGroup, MstpRegionConfig, Ospfv2GlobalConfig, Ospfv2LsaGenParams, Ospfv2StateSummary, Ospfv3GlobalConfig, Ospfv3LsaGenParams,

Ospfv3StateSummary, Perspective, PimStateSummary, Port, PortGroup, PortLoggingConfig, Rfc2544BackToBackFramesConfig, Rfc2544FrameLossConfig,
Rfc2544LatencyConfig, Rfc2544ThroughputConfig, Rfc2889AddrCachingCapacityConfig, Rfc2889AddrLearningRateConfig,
Rfc2889BroadcastFrameForwardingConfig, Rfc2889BroadcastFrameLatencyConfig, Rfc2889CongestionControlConfig, Rfc2889ErroredFramesFilteringConfig,
Rfc2889ForwardingConfig, Rfc2889ForwardPressureConfig, Rfc2889MaxForwardingRateConfig, Rfc3918Config, RipngStateSummary, RipRouteGenParams,
Ripv4StateSummary, Router, RouterGenParams, RsvpCustomObject, RsvpStateSummary, ServerProfile, ServiceClass, StepTestConfig, StpStateSummary,
StreamBlock, StreamBlockLoadProfile, SUT, SyncEthStateSummary, ThroughputTestConfig, TrafficDescriptorGroup, TwampStateSummary, UserNote,
Vpn6PeSiteGenParams, VpnBgpVplsSiteGenParams, VpnIdGroup, VpnLdpVplsSiteGenParams, VpnRfc2547SiteGenParams, VpnSiteInfo6Pe,
VpnSiteInfoRfc2547, VpnSiteInfoVplsBgp, VpnSiteInfoVplsLdp, VqAnalyzerGenParams
Automatically-created children: ArpNdConfig, BgpGlobalConfig, DeviceAddrOptions, Dhcpv4Options, Dhcpv6Options, Dot1xOptions, EoamGlobalConfig,
ExternalDeviceOption, FcGlobalConfig, IsisPlsbGlobalConfig, L2LearningConfig, LabelBindingGlobalConfig, PhyOptions, PimGlobalConfig, PppoxOptions,
ResultOptions, TestResultSetting, TrafficOptions, VicGlobalConfig, VqAnalyzerOptions
Result children (automatically created): BfdStateSummary, BgpStateSummary, CounterResultFilter, DebugResultRenderer, DynamicChartResultView,
DynamicResultView, Ieee1588v2StateSummary, IptvTestResults, IsisStateSummary, LacpStateSummary, LdpStateSummary, LldpStateSummary,
LspPingStateSummary, Ospfv2StateSummary, Ospfv3StateSummary, PimStateSummary, ResultChartQuerySet, ResultDataSet, ResultOptions,
Rfc2544AsymmetricFrameLossPerLoadResult, Rfc2544AsymmetricFrameLossStreamGroupResult, Rfc2544AsymmetricLatencyPerLoadResult,
Rfc2544AsymmetricLatencyStreamGroupResult, Rfc2544AsymmetricThroughputPerFrameSizeResult, Rfc2544AsymmetricThroughputPerLoadResult,
Rfc2544AsymmetricThroughputStreamGroupResult, Rfc2544Back2BackPerCoexistenceRatioResult, Rfc2544Back2BackPerFrameSizeResult,
Rfc2544Back2BackPerIterationResult, Rfc2544Back2BackPerLoadResult, Rfc2544Back2BackTestResult, Rfc2544FrameLossPerCoexistenceRatioResult,
Rfc2544FrameLossPerFrameSizeResult, Rfc2544FrameLossPerIpv6ExtensionHeaderResult, Rfc2544FrameLossPerIterationResult,
Rfc2544FrameLossPerLoadResult, Rfc2544FrameLossTestResult, Rfc2544LatencyPerCoexistenceRatioResult, Rfc2544LatencyPerFrameSizeResult,
Rfc2544LatencyPerIpv6ExtensionHeaderResult, Rfc2544LatencyPerIterationResult, Rfc2544LatencyPerLoadResult, Rfc2544LatencyTestResult,
Rfc2544ThroughputPerCoexistenceRatioResult, Rfc2544ThroughputPerFrameSizeResult, Rfc2544ThroughputPerIpv6ExtensionHeaderResult,
Rfc2544ThroughputPerIterationResult, Rfc2544ThroughputPerLoadResult, Rfc2544ThroughputTestResult, Rfc2889AddrCachingPerAddrResult,
Rfc2889AddrCachingPerFrameSizeResult, Rfc2889AddrCachingPerIterationResult, Rfc2889AddrCachingPerPortResult, Rfc2889AddrCachingTestResult,
Rfc2889AddrLearningPerFrameSizeResult, Rfc2889AddrLearningPerIterationResult, Rfc2889AddrLearningPerLearningRateResult,
Rfc2889AddrLearningPerPortResult, Rfc2889AddrLearningTestResult, Rfc2889BroadcastFrameForwardingPerBurstSizeResult,
Rfc2889BroadcastFrameForwardingPerFrameSizeResult, Rfc2889BroadcastFrameForwardingPerIterationResult,
Rfc2889BroadcastFrameForwardingPerLoadResult, Rfc2889BroadcastFrameForwardingTestResult, Rfc2889BroadcastFrameLatencyPerFrameSizePerPortResult,
Rfc2889BroadcastFrameLatencyPerFrameSizeResult, Rfc2889BroadcastFrameLatencyPerIterationResult, Rfc2889BroadcastFrameLatencyTestResult,
Rfc2889CongestionControlPerBurstSizeResult, Rfc2889CongestionControlPerFrameSizeResult, Rfc2889CongestionControlPerIterationResult,
Rfc2889CongestionControlPerLoadResult, Rfc2889CongestionControlPerPortResult, Rfc2889CongestionControlTestResult,
Rfc2889ErroredFramesFilteringPerErrorTypeResult, Rfc2889ErroredFramesFilteringPerIterationResult, Rfc2889ErroredFramesFilteringPerLoadResult,
Rfc2889ErroredFramesFilteringTestResult, Rfc2889ForwardingPerBurstSizeResult, Rfc2889ForwardingPerFrameSizeResult,
Rfc2889ForwardingPerIterationResult, Rfc2889ForwardingPerLoadResult, Rfc2889ForwardingTestResult, Rfc2889ForwardPressurePerFrameSizeResult,
Rfc2889ForwardPressurePerIterationResult, Rfc2889ForwardPressureTestResult, Rfc2889MaxForwardingRatePerBurstSizeResult,
Rfc2889MaxForwardingRatePerFrameSizeResult, Rfc2889MaxForwardingRatePerIterationResult, Rfc2889MaxForwardingRatePerLoadResult,
Rfc2889MaxForwardingRateTestResult, RipngStateSummary, Ripv4StateSummary, RsvpStateSummary, RxPortResultFilter, StpStateSummary,
StreamBlockResultFilter, SyncEthStateSummary, TestResultSetting, TwampStateSummary, ViewControlPlaneMplsBindingResult
Relations:
Side name
(Type)
Relative
DefaultSelection
(DefaultSelection)
Description
2078
ProtocolAdvertiseCommand
Side name
(Type)
Relative
Description
ResultChild
(ResultChild)
BfdStateSummary, BgpStateSummary, Ieee1588v2StateSummary, IptvTestResults, IsisStateSummary,

LacpStateSummary, LdpStateSummary, LldpStateSummary, LspPingStateSummary, Ospfv2StateSummary,
Ospfv3StateSummary, PimStateSummary, Rfc2544AsymmetricFrameLossPerLoadResult,
Rfc2544AsymmetricLatencyPerLoadResult, Rfc2544AsymmetricThroughputPerFrameSizeResult,
Rfc2544AsymmetricThroughputPerLoadResult, Rfc2544Back2BackPerCoexistenceRatioResult,
Rfc2544Back2BackPerFrameSizeResult, Rfc2544Back2BackPerIterationResult, Rfc2544Back2BackPerLoadResult,
Rfc2544FrameLossPerCoexistenceRatioResult, Rfc2544FrameLossPerFrameSizeResult,
Rfc2544FrameLossPerIpv6ExtensionHeaderResult, Rfc2544FrameLossPerIterationResult,
Rfc2544FrameLossPerLoadResult, Rfc2544LatencyPerCoexistenceRatioResult, Rfc2544LatencyPerFrameSizeResult,
Rfc2544LatencyPerIpv6ExtensionHeaderResult, Rfc2544LatencyPerIterationResult, Rfc2544LatencyPerLoadResult,
Rfc2544ThroughputPerCoexistenceRatioResult, Rfc2544ThroughputPerFrameSizeResult,
Rfc2544ThroughputPerIpv6ExtensionHeaderResult, Rfc2544ThroughputPerIterationResult,
Rfc2544ThroughputPerLoadResult, Rfc2889AddrCachingPerAddrResult, Rfc2889AddrCachingPerFrameSizeResult,
Rfc2889AddrCachingPerIterationResult, Rfc2889AddrCachingPerPortResult, Rfc2889AddrCachingTestResult,
Rfc2889AddrLearningPerFrameSizeResult, Rfc2889AddrLearningPerIterationResult,
Rfc2889AddrLearningPerLearningRateResult, Rfc2889AddrLearningPerPortResult, Rfc2889AddrLearningTestResult,
Rfc2889BroadcastFrameForwardingPerBurstSizeResult, Rfc2889BroadcastFrameForwardingPerFrameSizeResult,
Rfc2889BroadcastFrameForwardingPerIterationResult, Rfc2889BroadcastFrameForwardingPerLoadResult,
Rfc2889BroadcastFrameForwardingTestResult, Rfc2889BroadcastFrameLatencyPerFrameSizePerPortResult,
Rfc2889BroadcastFrameLatencyPerFrameSizeResult, Rfc2889BroadcastFrameLatencyPerIterationResult,
Rfc2889BroadcastFrameLatencyTestResult, Rfc2889CongestionControlPerBurstSizeResult,
Rfc2889CongestionControlPerFrameSizeResult, Rfc2889CongestionControlPerIterationResult,
Rfc2889CongestionControlPerLoadResult, Rfc2889CongestionControlPerPortResult,
Rfc2889CongestionControlTestResult, Rfc2889ErroredFramesFilteringPerErrorTypeResult,
Rfc2889ErroredFramesFilteringPerIterationResult, Rfc2889ErroredFramesFilteringPerLoadResult,
Rfc2889ErroredFramesFilteringTestResult, Rfc2889ForwardingPerBurstSizeResult,
Rfc2889ForwardingPerFrameSizeResult, Rfc2889ForwardingPerIterationResult, Rfc2889ForwardingPerLoadResult,
Rfc2889ForwardingTestResult, Rfc2889ForwardPressurePerFrameSizeResult,
Rfc2889ForwardPressurePerIterationResult, Rfc2889ForwardPressureTestResult,
Rfc2889MaxForwardingRatePerBurstSizeResult, Rfc2889MaxForwardingRatePerFrameSizeResult,
Rfc2889MaxForwardingRatePerIterationResult, Rfc2889MaxForwardingRatePerLoadResult,
Rfc2889MaxForwardingRateTestResult, RipngStateSummary, Ripv4StateSummary, RsvpStateSummary,
StpStateSummary, SyncEthStateSummary, TwampStateSummary
Use this to
connect a
results object
to an object.
Project Writable Attributes

Writable Attribute
Description
Active, Name
ConfigurationFileName
Set by the system on load to show which file was last loaded.
Type: string
Default: Untitled.tcc
SelectedTechnologyProfiles
Type: string
Default: 0
TestMode
Type: string
Default: L2L3
Project Read-Only Attributes

ProtocolAdvertiseCommand
Description:
Advertise routes after protocol has been established.

2079
ProtocolAttachCommand
ProtocolAdvertiseCommand Writable Attributes

Writable Attribute
Description
ProtocolList

Type: handle
Default: 0
ProtocolAdvertiseCommand Read-Only Attributes

Read-Only Attribute
Description

ProtocolAttachCommand
Description:
Attaches a protocol to an interface stack.

ProtocolAttachCommand Writable Attributes

Writable Attribute
Description
ProtocolList
List of protocols that need to be attached to interface stacks.

Type: handle
Default: 0
UsesIfList
Specifies the interface object that the protocol needs to be attached to.
If multiple protocols are specified, this parameter needs to have the same number of interface handles.
Type: handle
Default: 0
ProtocolAttachCommand Read-Only Attributes

Read-Only Attribute
Description

ProtocolCreateCommand
Description:
Creates a protocol object under a device.
2080
ProtocolDescriptor

Parents: Sequencer
ProtocolCreateCommand Writable Attributes

Writable Attribute
Description
CreateClassId
Class ID of the protocol object to be created.

Type: classId
Default: 0
CreateCount
Must use 1.
Type: u32
Default: 1
ParentList
Specifies the list of devices under which the protocol object needs to be created.
Type: handle
Default: 0
UsesIfList
Specifies the interface object under the device that this protocol needs to use.
If multiple parent devices are specified, this parameter needs to have the same number of interface handles.
Type: handle
Default: 0
ProtocolCreateCommand Read-Only Attributes

Read-Only Attribute
Description
ReturnList
List of protocol handles that are created.

Type: handle
Default: 0
ProtocolDescriptor
Description:
Parents: escProtocolDescriptors
Children: vendorID
ProtocolDescriptor Attributes
Attribute
Description
Name
Type: string
protocolID
Type: OCTETSTRING
Default: 0002
reserved
Type: OCTETSTRING
Default: 0000
2081
ProtocolDescriptor
ProtocolDescriptor
Description:
Parents: escProtocolDescriptors
Children: vendorID
ProtocolDescriptor Attributes
Attribute
Description
Name
Type: string
protocolID
Type: OCTETSTRING
Default: 0002
reserved
Type: OCTETSTRING
Default: 0000
ProtocolDetachCommand
Description:
Detaches a protocol from an interface stack.

ProtocolDetachCommand Writable Attributes

Writable Attribute
Description
ProtocolList
List of protocols that need to be detached from interface stacks.

Type: handle
Default: 0
UsesIfList
Specifies the interface object that the protocol needs to be detached from.
If multiple protocols are specified, this parameter needs to have the same number of interface handles.
Type: handle
Default: 0
ProtocolDetachCommand Read-Only Attributes

Read-Only Attribute
Description

ProtocolEstablishCommand
2082
ProtocolIdentityTlv
Description:
Establish a protocol without advertising routes.

ProtocolEstablishCommand Writable Attributes

Writable Attribute
Description
ProtocolList

Type: handle
Default: 0
ProtocolEstablishCommand Read-Only Attributes

Read-Only Attribute
Description

ProtocolIdentityTlv (lldp:ProtocolIdentityTlv)
Description:
Children: None
lldp:NivSupportTlv
ProtocolIdentityTlv Attributes
Attribute
Description
length
Type: INTEGER
Default: 0
Name
Type: string
oui
Type: OCTETSTRING
Default: 0080C2
protocolIdentity
Type: OCTETSTRING
Default: 0000
protocolIdentityLength
Type: INTEGER
Default: 0
subtype
Type: OCTETSTRING
Default: 04
type
Type: INTEGER
Default: 127
2083
ProtocolStartCommand
ProtocolStartCommand
Description:
Starts the specified protocol.

ProtocolStartCommand Writable Attributes

Writable Attribute
Description
ProtocolList
List of protocols to start.

Type: handle
Default: 0
ProtocolStartCommand Read-Only Attributes

Read-Only Attribute
Description

ProtocolStopCommand
Description:
Stops the specified protocol.

ProtocolStopCommand Writable Attributes

Writable Attribute
Description
ProtocolList
List of protocols to stop.

Type: handle
Default: 0
ProtocolStopCommand Read-Only Attributes

Read-Only Attribute
Description

2084
ProvisioningInfoTLV
ProvisioningInfoTLV (VICTLV:ProvisioningInfoTLV)
Description:
Children: Info
Next headers: VICTLV:CustomTLV
ProvisioningInfoTLV Attributes
Attribute
Description
Length
Type: INTEGER
Default: 0
Name
Type: string
ProvisioningInfoTypeSpace
Type: OCTETSTRING
Default: 000000
Type
Type: INTEGER
Default: 12
ProvList
Description:
Parents: Info
Children: Custom, Fixed, VmWare
ProvList Attributes
Attribute
Description
Name
information.
Type: string
PrtStat (EOAMTLV:PrtStat)
Description:
Children: None
PrtStat Attributes
Attribute
Description
Length
Type: OCTETSTRING
Default: 0000
2085
prunedSources
Attribute
Description
Name
Type: string
PortStatusValues
Type: psTLVvalues
Default: 02
Possible Values:
Value Description
Type
01
No (psBlocked)
02
Yes (psUp)
Type: OCTETSTRING
Default: 02
prunedSources (overloaded)
prunedSources (pim) - Object definition for the following paths:
StreamBlock.Pimv4JoinPrune.groupRecords.JoinPrunev4GroupRecord.prunedSources
prunedSources (pim) - Object definition for the following paths:
StreamBlock.Pimv6JoinPrune.groupRecords.JoinPrunev6GroupRecord.prunedSources
prunedSources Object (pim PDU library)

Description:

prunedSources Attributes
Attribute
Description
Name
information.
Type: string
prunedSources Object (pim PDU library)

Description:

2086
PseudoWireSwitchingPointTlv
prunedSources Attributes
Attribute
Description
Name
information.
Type: string
Description:
Switching Point (S-PE) TLV object definition for Multi-segment Pseudowire (MS-PW).

Parents: GeneralizedPwidLsp, VcLsp
PseudoWireSwitchingPointTlv Writable Attributes

Writable Attribute
Description
Active, Name
AttachmentGroupId
Start Attachment Group Identifier for the last pseudowire segment traversed, if the FEC
type of the last segment traversed is Generalized PWid (FEC 129).
Type: string
Default: 100:1
Attachment Group Identifier (AGI) increment for the last pseudowire segment traversed,
if the FEC type of the last segment traversed is Generalized PWid (FEC 129).
Type: string
Default: 0:1
EnableLastSegmentTraversedSubTlv
Enable or disable Sub-TLV to specify the FEC of the last pseudowire segment traversed
for the Multi-segment Pseudowire (MS-PW).
Type: bool
Default: TRUE
Possible Values:
Value Description
TRUE
Enable Sub-TLV to specify the FEC of the last pseudowire segment traversed.
FALSE Disable Sub-TLV to specify the FEC of the last pseudowire segment traversed.
EnableSwitchingPointPseudoWireAddrSubTlv
Enable or disable Sub-TLV for specifying L2 address of PW Switching Point.

Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
Enable Sub-TLV for specifying L2 address of PW Switching Point.
FALSE Disable Sub-TLV for specifying L2 address of PW Switching Point.
2087
Writable Attribute
Description
LastPseudoWireSegmentFecType
FEC type of the last pseudowire segment traversed.

Type: enum
Default: FEC_128
Possible Values:
Value
Description
FEC_128 FEC type of the last pseudowire segment traversed is VC/PWid FEC (FEC
128).
FEC_129 FEC type of the last pseudowire segment traversed is Generalized PWid
FEC (FEC 129).
LocalIpv4Addr
If not null, then inserts a sub-TLV for specifying the Router ID/loopback IPv4 address
of the local Switching Point, with a TLV value of the specified IPv4 address.
Type: ip
Default: null
RemoteIpv4Addr
If not null, then inserts a sub-TLV for specifying the Router ID/loopback IPv4 address
of the last PW Switching Point traversed or of the T-PE, with a TLV value of the calculated
IPv4 address.
Type: ip
Default: null
RemoteIpv4AddrIncrement
Increment value for the Remote IPv4 Address field.

Type: ip
Default: 0.0.0.0
RemoteIpv4AddrRecycleCount

This field specifies the number of unique IPv4 addresses that will be created for the
TLV value of the Remote IPv4 Sub-TLV. The unique addresses are used in a round-robin
fashion. A value of 0 for this field indicates that all created IPv4 addresses are unique.
Type: u32
Default: 0
RemoteIpv4AddrRepeatCount
This field specifies the number of times a created Remote IPv4 address should be
repeated as the TLV value of Remote IPv4 Sub-TLV, before using the next created
Remote IPv4 address. A value of 0 indicates that a created IPv4 address should not
be repeated.
Type: u32
Default: 0
RemoteIpv4UniqueAddrCount
Type: u32
Default: 0
Start Source Attachment Individual Identifier (SAII) for the last pseudowire segment
traversed, if the FEC type of the last segment traversed is Generalized PWid (FEC 129).
Type: string
Default: 192.0.0.1
Source Attachment Individual Identifier (SAII) increment for the last pseudowire segment
Type: string
Default: 0.0.0.0
StartVcId
Start VC ID of the last pseudowire segment traversed, if the FEC type of the last segment
traversed is VC/PWid (FEC 128).
Type: u32
Default: 1
SwitchingPointDescription
If not null, inserts PW switching point description string Sub-TLV with TLV value of the
specified string.
Type: string
SwitchingPointPseudoWireAddrAttachmentCircuitId
Start value for attachment circuit identifier that should be used in the Sub-TLV for
specifying L2 address of PW switching point.
Type: string
Default: 0.0.0.1
2088
QlTlv
Writable Attribute
Description
SwitchingPointPseudoWireAddrAttachmentCircuitIdIncrement
Attachment circuit identifier increment corresponding to the attachment circuit identifier

field used in the Sub-TLV for specifying L2 address of PW switching point.
Type: string
Default: 0.0.0.1
SwitchingPointPseudoWireAddrGlobalId
Global ID that should be used in the Sub-TLV for specifying L2 address of PW Switching
Point.
Type: u32
Default: 1
SwitchingPointPseudoWireAddrPrefix
Pseudowire address prefix that should be used in the Sub-TLV for specifying L2 address
of PW Switching Point.
Type: ip
Default: 192.0.0.1
Start Target Attachment Individual Identifier (TAII) for the last pseudowire segment
Type: string
Default: 192.0.0.1
Target Attachment Individual Identifier (TAII) increment for the last pseudowire segment
Type: string
Default: 0.0.0.0
VcIdIncrement
VC ID increment for the last pseudowire segment traversed, if the FEC type of the last
segment traversed is VC/PWid (FEC 128).
Type: u32
Default: 1
PseudoWireSwitchingPointTlv Read-Only Attributes

QlTlv (ethernetssm:QlTlv)
Description:
Children: None
QlTlv Attributes
Attribute
Description
length
Type: OCTETSTRING
Default: 0004
Name
Type: string
reserved
Type: INTEGER
Default: 0
ssmCode
Type: INTEGER
Default: 11
type
Type: OCTETSTRING
Default: 01
2089
QueryResultCommand
QueryResultCommand
Description:
Provides access to the results databases produced by Spirent TestCenter. Specifically, you can access the views of the database that are used by the Spirent
TestCenter Results Reporter application.
Important: Node names (a node is one of the named units in the Results Reporter tree, such as "Port Traffic") and column names are case-sensitive, and
cannot contain spaces when used with this command. If you use the names that are displayed in the Results Reporter, you must remove any spaces. For
example, Basic Traffic Counters in Results Reporter becomes BasicTrafficCounters for use with this command. See the examples in the attributes below.
Spaces in names that are returned are stripped out.

Parents: Sequencer
QueryResultCommand Writable Attributes

Writable Attribute
Description
AttributeList
Specifies which attributes (columns) to return. The default (no argument) returns all columns. Use a space-separated list of
column names. If there are spaces in the column name, remove the spaces in the corresponding argument.
Example: -attributeList "PortName TotalTxFrameCount TotalRxFrameCount"
Type: string
Count
Number of rows to return. By default this count starts from the first row, but you can use the Offset attribute to start from a
different row.
Type: u32
Default: 0xffffffff
Name of the results database (summary database or iteration file) to open and query.
Type: string
Default: result.db
Filter
Filters the rows that are returned. The default returns all rows. You can use the following comparison operators:
== (equals)
!= (does not equal)
> (greater than)
>= (greater than or equal to)
< (less than)
<= (less than or equal to)
Example: -filter "TotalTxFrameCount > 50"
This example will return rows that have TotalTxFrameCount values of 75 or 300, but not will not return rows with
TotalTxFrameCount values of 48 or 50.
Type: string
Offset
Used with the Count attribute to retrieve a subset of rows. The value of Offset is the first row number of Count number of rows
to retrieve.
Type: u32
Default: 0
ResultPath
The complete path to the Results Reporter tree view node. Use forward slashes / to separate nodes. The default returns the
entire tree.
Example: -resultPath "SavedResult/PortTraffic/BasicTrafficCounters/BasicCounters"
Type: string
ResultType
Use the ResultPath attribute instead.
Type: string
2090
RandomModifier
QueryResultCommand Read-Only Attributes

Read-Only Attribute
Description
Columns
Name of each column returned in the Output attribute.

Example: -Columns {PortName TotalTxFrameCount TotalRxFrameCount}
Type: string
Output
A Tcl list of lists containing each row of the output. The names of the columns of this output are returned by the Columns
attribute.
Example: -Output {{{Port //7/3} 100 0} {{Port //7/4} 0 100}}
This example shows two rows. The column names for this example are given in the example for the Columns attribute.
Type: string
RandomModifier
Description:
Use this object to vary a specific portion of a stream block's packet content with random values.

RandomModifier Writable Attributes

Writable Attribute
Description
Active, Name
DataType
Specifies the type to use for the Mask attribute.

Type: enum
Default: NATIVE
Possible Values:
Value
Description
NATIVE Mask attribute is the same type as the PDU field being modified.
BYTE
EnableStream
Mask attribute is a hexadecimal byte pattern.
Whether to use streams or VFDs (Variable Field Definitions) to generate modified values.
Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
Use streams to generate modified values. A unique signature per stream is generated. The RepeatCount attribute
can be an integer value if the per-port limit of 32k streams total across all stream blocks is not exceeded.
FALSE Use VFDs to generate modified values. The RepeatCount attribute must be a power of two. The number of modifiers
with EnableStream set to FALSE is limited by the Spirent TestCenter hardware (4 or 6 depending on the card series).
Mask
Byte mask that specifies the data bytes to be modified. The mask size must be the same size as the data.
Type: string
Default: FF
Offset
Data offset in bytes (starting from most significant byte) to which this modifier applies. This is used when the DataType attribute
is set to BYTE.
Type: u32
Default: 0
2091
RandomPatternDescriptor
Writable Attribute
Description
OffsetReference
String that indicates the protocol field in the PDU object to which the offset applies. Use the format objectName.attribute,
where objectName is the value of the Name attribute on the PDU object, and attribute is the attribute you want to reference
on that object.
For example, if you want to reference the hardware field in an ARP object, create the ARP object and set its Name attribute
to "MyArpPdu". Then in the OffsetReference attribute of the RandomModifier object, refer to this ARP field as
MyArpPdu.hardware.
Type: string
RecycleCount
Specifies the number of times the value will change before reverting to the initial value (applicable only if EnableStream is
TRUE).
Note: A large RecycleCount value can degrade performance. If it takes too long to create the stream, try reducing RecycleCount.
Type: u32
Default: 0
RepeatCount
Specifies the number of times the value will be repeated (applicable only if EnableStream is TRUE).
Type: u32
Default: 0
Seed
Seed used for generating random numbers.

Type: u32
Default: 0
RandomModifier Read-Only Attributes

RandomPatternDescriptor
Description:
Describes a random type load.

RandomPatternDescriptor Writable Attributes

Writable Attribute
Description
Active, Name
Height
Maximum amount of load to apply. The LoadType attribute in the ClientLoadProfile object controls the type
of load that is generated.
Type: s32
Default: 30
RampTime

Type: u32
Default: 20
Repetitions

Type: u32
Default: 1
SteadyTime
Length of time to apply the load. The time unit is controlled by the LoadPhaseDurationUnits attribute on
the ClientLoadPhase object.
Type: u32
Default: 40
2092
RangeModifier
RandomPatternDescriptor Read-Only Attributes

RangeModifier
Description:
Use this object to vary a specific portion of a stream block's packet content with a range of values. It is considered an error if the number of modifiers with
EnableStream set to False is greater than the VFDs (variable field definitions) supported by the hardware. If the data type is MAC address, IPv4 address, or
IPv6 address, the offset is ignored, and will automatically be updated according to the step value and count.

Relations:
Side name
(Type)
Relative
Description
CarryChainTo
(CarryChainTo)
RangeModifier, TableModifier
Specifies to link to another modifier.
RangeModifier Writable Attributes

Writable Attribute
Description
Active, Name
Data
Specifies the data that is the vector of bytes to be modified.

Type: string
Default: 00
DataType
Specifies the type to use for the Data, StepValue, and Mask attributes.
Type: enum
Default: NATIVE
Possible Values:
Value
Description
NATIVE Data, StepValue, and Mask attributes are the same type as the PDU field being modified. For example,
XX:XX:XX:XX:XX:XX for MAC addresses and X.X.X.X for IPv4 addresses.
BYTE
EnableStream
Data, StepVaue, and Mask attributes are hexadecimal byte patterns.
Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
FALSE Use VFDs to generate modified values. The RepeatCount attribute must be a power of two. The number of modifiers
with EnableStream set to FALSE is limited by the Spirent TestCenter hardware (4 or 6 depending on the card series).
Mask
Byte mask that specifies the data bytes to be modified. The mask size must be the same size as the data.
Type: string
Default: FF
2093
RARP
Writable Attribute
Description
ModifierMode
Specifies the step mode.

Type: enum
Default: INCR
Possible Values:
Value
Description
INCR
Increment data values.
DECR
Decrement data values.
SHUFFLE Provide every data value once in random order.

Offset
Data offset in bytes (starting from most significant byte) to which this modifier applies. This is used when the DataType attribute
is set to BYTE.
Type: u32
Default: 0
OffsetReference
on that object.
to "MyArpPdu". Then in the OffsetReference attribute of the RangeModifier object, refer to this ARP field as
MyArpPdu.hardware.
Type: string
RecycleCount
Specifies the number of times the value will change before reverting to the initial value.
Note: A large RecycleCount value can degrade performance. If it takes too long to create the stream, try reducing RecycleCount.
Type: u32
Default: 0
RepeatCount
Specifies the number of times the value will be repeated.

Type: u32
Default: 0
StepValue
Specifies the step value of the modifier. If EnableStream is FALSE, the value is constrained to be a power of 2 and a maximum
size of 4 bytes.
Type: string
Default: 01
RangeModifier Read-Only Attributes

RARP (arp:RARP)
Description:
The RARP message
Children: None
2094
RawTcpClientProtocolConfig
RARP Attributes
Attribute
Description
hardware
Hardware type
Type: HardwareByte
Default: 0001
Possible Values:
Value Description
0001
Ethernet
ihAddr
Hardware address length

Type: INTEGER
Default: 6
ipAddr
Protocol address length

Type: INTEGER
Default: 4
Name
Type: string
operation
Operation code
Type: RARPOperationByte
Default: 3
Possible Values:
Value Description
protocol
RARP Request
RARP Reply
Protocol type
Type: ProtocolByte
Default: 0800
Possible Values:
Value Description
0800
Internet IP
senderHwAddr
Sender hardware address

Type: MACADDR
Default: 00:00:01:00:00:02
senderPAddr
Sender IP address
Type: IPV4ADDR
Default: 192.85.1.2
targetHwAddr
Target hardware address

Type: MACADDR
Default: 00:00:00:00:00:00
targetPAddr
Target IP address
Type: IPV4ADDR
Default: 0.0.0.0
Description:

2095
Result children (automatically created): RawTcpClientResults

Relations:
Side name
(Type)
Relative
Description
ClientLoadProfile
ClientLoadProfile
ClientProfile
ClientProfile
ResultChild
(ResultChild)
RawTcpClientResults

object.
UsesIf
(UsesIf)


RawTcpClientProtocolConfig Writable Attributes

Writable Attribute
Description
Active, Name
ClientName
User-defined name for the client. Relevant only to the user.

Type: string
DynamicLoad
Type: s32
Default: 30
Range: 1 - 500000

Type: enum
Default: PAIR
Possible Values:
Value
Description
PAIR
Pair connections.
BACKBONE_SRC_FIRST
BACKBONE_DST_FIRST


Type: u32
Default: 10
Range: 1 - 4294967295
Unused.
Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
Unused.
FALSE Unused.
2096
RawTcpClientProtocolProfile
RawTcpClientProtocolConfig Read-Only Attributes

Read-Only Attribute
Description
LoadProfileRunState

Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
Is running.
RawTcpClientProtocolProfile
Description:
Raw TCP protocol traffic-specific attributes for a potential raw TCP endpoint.

RawTcpClientProtocolProfile Writable Attributes

Writable Attribute
Description
Active, Name
EnablePipelining
Indicate if client should pipeline Raw TCP requests to server.

Type: bool
Default: TRUE
Possible Values:
Value Description
TRUE
Pipeline Raw TCP requests.
FALSE Don't pipeline Raw TCP requests.

MaxPipelineDepth
Maximum depth of Raw TCP request pipeline.

Type: u8
Default: 8
Range: 1 - 255
TcpPortNum
Starting TCP port number to be used for connections.

Type: u16
Default: 40000
Range: 1 - 65535
TcpPortNumList
List of TCP port numbers. Used when the UseTcpPortRange attribute is set to FALSE.
Type: u16
Default: 0
Range: 1 - 65535
TcpPortNumRepeatCount
Number of times to re-use the current TCP port number.

Type: s16
Default: 0
TcpPortNumStep
Increment/decrement for TCP port number to be used for connections.

Type: s16
Default: 1
2097
RawTcpClientResults
Writable Attribute
Description
UseTcpPortRange
Whether to specify TCP ports with a range or a list.

Type: bool
Default: TRUE
Possible Values:
Value Description
TRUE
Use a range.
FALSE Use a list.
RawTcpClientProtocolProfile Read-Only Attributes

RawTcpClientResults
Description:
Raw TCP client results.

Parents: RawTcpClientProtocolConfig
Relations:
Side name
(Type)
Relative
Description
ResultParent
(ResultChild)
RawTcpClientResults Writable Attributes

RawTcpClientResults Read-Only Attributes

Read-Only Attribute
Description
AbortedConnections

Type: u64
Default: 0
Type: u64
Default: 0
AbortedTransactions

Type: u64
Default: 0
Type: u64
Default: 0
ActiveConnections
Number of connections open or attempting for this client at this instant.

Type: u32
Default: 0
2098
RawTcpClientResults
Read-Only Attribute
Description
Total number of attempted connections from the client block. Note: Active Connections on the server
will typically be fewer in number than Active Connections on the associated client due to differences
in the events that inform the server and client processes that a connection has been started and
terminated.
Type: u64
Default: 0
Type: u64
Default: 0

Type: u64
Default: 0
Type: u64
Default: 0
BlockIndex
Internally-allocated index for this raw TCP client block.

Type: u32
Default: 0
ElapsedSeconds
Time duration in seconds that this client block instance has been running.
Type: u64
Default: 0
GoodputAvgRxRateBps

Type: u64
Default: 0
GoodputAvgTxRateBps
Average goodput transmit rate in bits per second.

Type: u64
Default: 0
GoodputMaxRxRateBps

Type: u64
Default: 0
GoodputMaxTxRateBps
Maximum transmitted goodput rate in bits per second.

Type: u64
Default: 0
GoodputMinRxRateBps

Type: u64
Default: 0
GoodputMinTxRateBps
Minimum transmitted goodput rate in bits per second.

Type: u64
Default: 0
GoodputRxBps

Type: u64
Default: 0
GoodputRxBytes

Type: u64
Default: 0
GoodputTxBps

Type: u64
Default: 0
GoodputTxBytes

Type: u64
Default: 0
2099
RawTcpProtocolParams
Read-Only Attribute
Description
IntendedLoad
Type: u32
Default: 0
ParentName
Name of parent protocol for which the results apply.

Type: string

Type: u64
Default: 0
Type: u64
Default: 0

Type: u64
Default: 0
Type: u64
Default: 0

Type: u64
Default: 0
Type: u64
Default: 0

Type: u64
Default: 0
Type: u64
Default: 0
RawTcpProtocolParams
Description:
Configure raw TCP specific parameters in the ALP Traffic Wizard.

Relations:
Side name
(Type)
Relative
ClientLoadProfile
ClientLoadProfile
ClientProfile
ClientProfile
ServerProfile
ServerProfile
2100
Description
RawTcpServerProtocolConfig
RawTcpProtocolParams Writable Attributes

Writable Attribute
Description
Active, Name

Type: u32
Default: 10
Range: 1 - 4294967295

Type: u32
Default: 4294967295
Range: 1 - 4294967295

Type: u32
Default: 10
Range: 1 - 4294967295
RawTcpProtocolParams Read-Only Attributes

Description:
Raw TCP protocol client.

Result children (automatically created): RawTcpServerResults
Relations:
Side name
(Type)
Relative
Description
ServerProfile
ServerProfile
Specifies server profile used by a server.
ResultChild
(ResultChild)
RawTcpServerResults
UsesIf
(UsesIf)


RawTcpServerProtocolConfig Writable Attributes

Writable Attribute
Description
Active, Name
2101
RawTcpServerProtocolProfile
Writable Attribute
Description

Type: u32
Default: 10
Range: 1 - 4294967295

Type: u32
Default: 4294967295
Range: 1 - 4294967295
ServerName
Type: string
Unused.
Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
Unused.
FALSE Unused.
RawTcpServerProtocolConfig Read-Only Attributes

RawTcpServerProtocolProfile
Description:
Raw TCP protocol-specific attributes for a potential raw TCP server.

Automatically-created children: RawTcpServerResponseConfig
RawTcpServerProtocolProfile Writable Attributes

Writable Attribute
Description
Active, Name
ServerPortNum

Type: u16
Default: 3357
Range: 1 - 65535
RawTcpServerProtocolProfile Read-Only Attributes

RawTcpServerResponseConfig
Description:
2102
RawTcpServerResponseConfig
Common response configuration options for a raw TCP server.

Automatically created from: RawTcpServerProtocolProfile
RawTcpServerResponseConfig Writable Attributes

Writable Attribute
Description
Active, Name
BodyContentType

Type: enum
Default: ASCII
Possible Values:
Value
Description
ASCII
ASCII content type.

BodySizeType

Type: enum
Default: FIXED
Possible Values:
Value
Description
FIXED
Fixed body size.

FixedBodySize

Type: u32
Default: 64
Type: u32
Default: 0
RandomBodySizeMean
Type: u32
Default: 0
Type: u32
Default: 0

Type: u32
Default: 0
Type: u32
Default: 0
ResponseTimingType

Type: enum
Default: FIXED
Possible Values:
Value
Description
FIXED
RawTcpServerResponseConfig Read-Only Attributes

2103
RawTcpServerResults
RawTcpServerResults
Description:
Raw TCP server results.

Parents: RawTcpServerProtocolConfig
Relations:
Side name
(Type)
Relative
Description
ResultParent
(ResultChild)
RawTcpServerResults Writable Attributes

RawTcpServerResults Read-Only Attributes

Read-Only Attribute
Description
ActiveConnections
Number of connections open (accepted) for this server at this instant. Note: Active Connections on the
server will typically be fewer in number than Active Connections on the associated client due to
differences in the events that inform the server and client processes that a connection has been started
and terminated.
Type: u32
Default: 0
BlockIndex
Internally-allocated index for this raw TCP server block.

Type: u32
Default: 0
ElapsedSeconds
Time duration in seconds that this server block has been running.
Type: u64
Default: 0
GoodputAvgRxRateBps

Type: u64
Default: 0
GoodputAvgTxRateBps
Average goodput transmit rate in bits per second.

Type: u64
Default: 0
GoodputMaxRxRateBps

Type: u64
Default: 0
GoodputMaxTxRateBps
Maximum transmitted goodput rate in bits per second.

Type: u64
Default: 0
GoodputMinRxRateBps

Type: u64
Default: 0
GoodputMinTxRateBps
Minimum transmitted goodput rate in bits per second.

Type: u64
Default: 0
GoodputRxBps

Type: u64
Default: 0
2104
rch
Read-Only Attribute
Description
GoodputRxBytes

Type: u64
Default: 0
GoodputTxBps

Type: u64
Default: 0
GoodputTxBytes

Type: u64
Default: 0
ParentName

Type: string
Total number of successful transactions from the server block.

Type: u64
Default: 0
Total number of successful transactions per second from the server block.
Type: u64
Default: 0
TotalConnections
Total number of connections handled by this HTTP server.

Type: u64
Default: 0
TotalConnectionsPerSecond
Total number of connections per second from the server block.

Type: u64
Default: 0
Total number of unsuccessful transactions from the server block.

Type: u64
Default: 0
Total number of unsuccessful transactions per second from the server block.
Type: u64
Default: 0
rch
Description:
Parents: DataFrame, ControlFrame
Children: baseControl, extendedControl
rch Attributes
Attribute
Description
dstMac
Type: MACADDR
Default: 00:00:01:00:00:01
hec
Type: INTEGER
Default: 0
Name
more information.
Type: string
2105
rcsId
Attribute
Description
srcMac
Type: MACADDR
Default: 00:00:01:00:00:02
ttl
Type: OCTETSTRING
Default: 1
ttlBase
Type: OCTETSTRING
Default: 1
rcsId
Description:
rcsId Attributes
Attribute
Description
classOfService
Type: OCTETSTRING
Default: 00000000
Name
Type: string
portIdentifier
Type: OCTETSTRING
Default: 000000
reserved
Type: OCTETSTRING
Default: 00
RcsId (fcgs:RcsId)
Description:
RcsId Attributes
Attribute
Description
classOfService
Type: OCTETSTRING
Default: 00000000
Name
Type: string
portIdentifier
Type: OCTETSTRING
Default: 000000
2106
Rdi
Attribute
Description
reserved
Type: OCTETSTRING
Default: 00
Rdi (fcsw:Rdi)
Description:
Children: domainID
Rdi Attributes
Attribute
Description
command
Type: OCTETSTRING
Default: 13
length
Type: INTEGER
Default: 16
Name
Type: string
reqSwitchName
Type: WWN
Default: 20:00:10:94:00:00:00:01
reserved
Type: OCTETSTRING
Default: 98
rdiAccept
Description:
Parents: FCPayload-Choice, FCPayload-Choice
Children: domainID
rdiAccept Attributes
Attribute
Description
command
Type: OCTETSTRING
Default: 13
length
Type: INTEGER
Default: 16
Name
Type: string
reqSwitchName
Type: WWN
Default: 20:00:10:94:00:00:00:01
2107
RdiDomainId
Attribute
Description
reserved
Type: OCTETSTRING
Default: 98
RdiDomainId
Description:
Parents: domainID
Children: None
RdiDomainId Attributes
Attribute
Description
domainID
Type: OCTETSTRING
Default: 00
Name
Type: string
reserved
Type: OCTETSTRING
Default: 000000
RdiDomainId
Description:
Parents: domainID
Children: None
RdiDomainId Attributes
Attribute
Description
domainID
Type: OCTETSTRING
Default: 00
Name
Type: string
reserved
Type: OCTETSTRING
Default: 000000
rdiRequest
Description:
2108
read10
Parents: FCPayload-Choice, FCPayload-Choice

Children: domainID
rdiRequest Attributes
Attribute
Description
command
Type: OCTETSTRING
Default: 13
length
Type: INTEGER
Default: 16
Name
Type: string
reqSwitchName
Type: WWN
Default: 20:00:10:94:00:00:00:01
reserved
Type: OCTETSTRING
Default: 98
read10
Description:
Parents: fcpCdb
Children: None
read10 Attributes
Attribute
Description
control
Type: OCTETSTRING
Default: 00
dpo
Type: BITSTRING
Default: 0
fua
Type: BITSTRING
Default: 0
fua_nv
Type: BITSTRING
Default: 0
groupNumber
Type: INTEGER
Default: 0
lba
Type: OCTETSTRING
Default: 00000000
Name
Type: string
obsolete
Type: BITSTRING
Default: 0
opCode
Type: OCTETSTRING
Default: 28
2109
Read10
Attribute
Description
rdProtect
Type: BITSTRING
Default: 000
reserved1
Type: BITSTRING
Default: 0
reserved2
Type: BITSTRING
Default: 000
transferLength
Type: INTEGER
Default: 0
Read10 (scsi:Read10)
Description:
Children: None
Read10 Attributes
Attribute
Description
control
Type: OCTETSTRING
Default: 00
dpo
Type: BITSTRING
Default: 0
fua
Type: BITSTRING
Default: 0
fua_nv
Type: BITSTRING
Default: 0
groupNumber
Type: INTEGER
Default: 0
lba
Type: OCTETSTRING
Default: 00000000
Name
Type: string
obsolete
Type: BITSTRING
Default: 0
opCode
Type: OCTETSTRING
Default: 28
rdProtect
Type: BITSTRING
Default: 000
reserved1
Type: BITSTRING
Default: 0
reserved2
Type: BITSTRING
Default: 000
2110
read6
Attribute
Description
transferLength
Type: INTEGER
Default: 0
read6
Description:
Parents: fcpCdb
Children: None
read6 Attributes
Attribute
Description
control
Type: OCTETSTRING
Default: 00
lba
Type: INTEGER
Default: 0
Name
Type: string
opCode
Type: OCTETSTRING
Default: 08
reserved
Type: BITSTRING
Default: 000
transferLength
Type: INTEGER
Default: 0
Read6 (scsi:Read6)
Description:
Children: None
Read6 Attributes
Attribute
Description
control
Type: OCTETSTRING
Default: 00
lba
Type: INTEGER
Default: 0
2111
readBuffer
Attribute
Description
Name
Type: string
opCode
Type: OCTETSTRING
Default: 08
reserved
Type: BITSTRING
Default: 000
transferLength
Type: INTEGER
Default: 0
readBuffer
Description:
Parents: fcpCdb
Children: None
readBuffer Attributes
Attribute
Description
allocationLength
Type: INTEGER
Default: 0
bufferId
Type: INTEGER
Default: 0
bufferOffset
Type: INTEGER
Default: 0
control
Type: OCTETSTRING
Default: 00
mode
Type: INTEGER
Default: 0
Name
Type: string
opCode
Type: OCTETSTRING
Default: 3C
reserved
Type: BITSTRING
Default: 000
ReadBuffer (scsi:ReadBuffer)
Description:
Children: None
2112
readCapacity10
ReadBuffer Attributes
Attribute
Description
allocationLength
Type: INTEGER
Default: 0
bufferId
Type: INTEGER
Default: 0
bufferOffset
Type: INTEGER
Default: 0
control
Type: OCTETSTRING
Default: 00
mode
Type: INTEGER
Default: 0
Name
Type: string
opCode
Type: OCTETSTRING
Default: 3C
reserved
Type: BITSTRING
Default: 000
readCapacity10
Description:
Parents: fcpCdb
Children: None
readCapacity10 Attributes
Attribute
Description
control
Type: OCTETSTRING
Default: 00
lba
Type: OCTETSTRING
Default: 00000000
Name
Type: string
obsolete
Type: BITSTRING
Default: 0
opCode
Type: OCTETSTRING
Default: 25
pmi
Type: BITSTRING
Default: 0
2113
ReadCapacity10
Attribute
Description
reserved1
Type: BITSTRING
Default: 0000000
reserved2
Type: OCTETSTRING
Default: 0000
reserved3
Type: BITSTRING
Default: 0000000
ReadCapacity10 (scsi:ReadCapacity10)
Description:
Children: None
ReadCapacity10 Attributes
Attribute
Description
control
Type: OCTETSTRING
Default: 00
lba
Type: OCTETSTRING
Default: 00000000
Name
Type: string
obsolete
Type: BITSTRING
Default: 0
opCode
Type: OCTETSTRING
Default: 25
pmi
Type: BITSTRING
Default: 0
reserved1
Type: BITSTRING
Default: 0000000
reserved2
Type: OCTETSTRING
Default: 0000
reserved3
Type: BITSTRING
Default: 0000000
readLong10
Description:
Parents: fcpCdb
Children: None
2114
ReadLong10
readLong10 Attributes
Attribute
Description
control
Type: OCTETSTRING
Default: 00
corrct
Type: BITSTRING
Default: 0
lba
Type: OCTETSTRING
Default: 00000000
Name
Type: string
obsolete
Type: BITSTRING
Default: 0
opCode
Type: OCTETSTRING
Default: 3E
pblock
Type: BITSTRING
Default: 0
reserved1
Type: BITSTRING
Default: 00000
reserved2
Type: OCTETSTRING
Default: 00
transferLength
Type: INTEGER
Default: 0
ReadLong10 (scsi:ReadLong10)
Description:
Children: None
ReadLong10 Attributes
Attribute
Description
control
Type: OCTETSTRING
Default: 00
corrct
Type: BITSTRING
Default: 0
lba
Type: OCTETSTRING
Default: 00000000
Name
Type: string
2115
RealtimeChartSeries
Attribute
Description
obsolete
Type: BITSTRING
Default: 0
opCode
Type: OCTETSTRING
Default: 3E
pblock
Type: BITSTRING
Default: 0
reserved1
Type: BITSTRING
Default: 00000
reserved2
Type: OCTETSTRING
Default: 00
transferLength
Type: INTEGER
Default: 0
RealtimeChartSeries
Description:

Parents: Result
RealtimeChartSeries Writable Attributes

RealtimeChartSeries Read-Only Attributes

Read-Only Attribute
Description
DataSourcePropertyId
Type: propertyId
Default: 0
DataStream
Type: chartPoint
Default: 0,0
Query
Type: handle
Default: 0
RealTimeResultColumnDefinition
Description:
Describes a column in a table that displays real time results data. Used by the GUI.

2116
RealTimeResultGroupDefinition
RealTimeResultColumnDefinition Writable Attributes

Writable Attribute
Description
Active, Name
ColumnClassName
Name of the result class.

Type: string
ColumnDescription
A brief description of the property displayed in this column.

Type: string
ColumnPrecision
Type: u8
Default: 255
ColumnPropertyName
Name of the property displayed in this column.

Type: string
ColumnSortType
How the column is sorted.

Type: enum
Default: NONE
Possible Values:
Value
Description
NONE
Not sorted.
ASCENDING
Ascending.
DESCENDING Descending.
ColumnUnits
Type: u8
Default: 255
ColumnWidth
Width of the column.

Type: u32
Default: 0
RealTimeResultColumnDefinition Read-Only Attributes

RealTimeResultGroupDefinition
Description:
Defines a tab on a real-time result grid in the GUI.

RealTimeResultGroupDefinition Writable Attributes

Writable Attribute
Description
Active, Name
ColumnClassName
This and ColumnPropertyName are parallel arrays. So the nth element in this together with the nth element
in ColumnPropertyName describe the nth Class.Property in the Group.
Type: string
2117
RebootEquipmentCommand
Writable Attribute
Description
ColumnPropertyName
ColumnClassName and this are parallel arrays. So the nth element in ColumnClassName together with the
nth element in this describe the nth Class.Property in the Group.
Type: string
GroupId
URI that uniquely identifies this group.

Type: string
GroupName
Name displayed on the tab.

Type: string
SqlString
An SQL statement used to store results to the end-of-test results database.

Type: string
UseCustomSqlString
Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
FALSE
RealTimeResultGroupDefinition Read-Only Attributes

RebootEquipmentCommand
Description:
Reboot one or more chassis, test module, port group or port.

RebootEquipmentCommand Writable Attributes

Writable Attribute
Description
EquipmentList
List of one or more chassis, test module, port group or port to reboot.
"Project" objects may also be included in the list in which case the corresponding ports will be rebooted.
Type: handle
Default: 0
RebootEquipmentCommand Read-Only Attributes

Read-Only Attribute
Description

2118
recordRoute
recordRoute
Description:
Children: addrList
recordRoute Attributes
Attribute
Description
length
Type: INTEGER
Default: 0
Name
Type: string
pointer
Type: INTEGER
Default: 0
type
Default: 7
Possible Values:
Value Description
0
End of Options List
NOP
130
Security
131
Loose Source Route
68
Time Stamp
133
Extended Security
Record Route
136
Stream Identifier
137
Strict Source Route
11
MTU Probe
12
MTU Reply
82
Traceroute
147
Address Extension
148
Router Alert
149
Redirect (icmpv6:Redirect)
Description:
Children: linkLayerOption, redirectedHdrOption
Redirect Attributes
Attribute
Description
checksum
Type: INTEGER
Default: 0
code
Type: INTEGER
Default: 0
2119
redirectedHdrOption
Attribute
Description
destAddress
Type: IPV6ADDR
Default: 2000::1
Name
more information.
Type: string
reserved
Type: INTEGER
Default: 0
targetAddress
Type: IPV6ADDR
Default: 2000::1
type
Type: Icmpv6Type
Default: 137
Possible Values:
Value Description
1
Packet Too Big
Time Exceeded
Parameter Problem
128
Echo Request
129
Echo Reply
130
MLDv1 Query
131
132
MLDv1 Listener Done
133
Router Solicitation
134
135
136
137
Redirect
143
redirectedHdrOption
Description:
Used in ICMPv6 as a parent of RedirectedHeader objects
Parents: Redirect
Children: RedirectedHeader
redirectedHdrOption Attributes
Attribute
Description
Name
information.
Type: string
2120
RedirectedHeader
RedirectedHeader
Description:
Parents: redirectedHdrOption
Children: ipData
RedirectedHeader Attributes
Attribute
Description
length
Type: INTEGER
Default: 4
Name
more information.
Type: string
reserved1
Type: INTEGER
Default: 0
reserved2
Type: INTEGER
Default: 0
type
Type: NdOptionType
Default: 4
Possible Values:
Value Description
1
Prefix Information
Redirected Header
MTU
RefreshResultViewCommand
Description:
Retrieve the latest results for the EOT (end of test, non-real-time) result type subscriptions.
Example: If you have a subscription for TxPortPairResults, which is not supported for real-time results, performing this command on the ResultDataSet for the
subscription will update the result object and the result CSV file with the latest results.
Note: EOT result types include TxPortPairResults, RxPortPairResults, TxStreamBlockResults, RxStreamBlockResults, and PortAvgLatencyResults.

RefreshResultViewCommand Writable Attributes

Writable Attribute
Description
ResultDataSet
Result data set handle for the subscription for which you want to refresh the results.
Type: handle
Default: 0
2121
regMax
RefreshResultViewCommand Read-Only Attributes

Read-Only Attribute
Description

regMax
Description:
Parents: fs, ControlFrameSize
Children: theReservedDataSelect
regMax Attributes
Attribute
Description
Name
information.
Type: string
reg
Type: OCTETSTRING
RejectedReply (oncrpcv2:RejectedReply)
Description:
Children: None
Next headers: oncrpcv2:MismatchInfo, oncrpcv2:RejectedReplyAuthStat
RejectedReply Attributes
Attribute
Description
Name
information.
Type: string
stat
Type: RejectStat
Default: 0
Possible Values:
Value Description
0
RPC_MISMATCH
AUTH_ERROR
2122
RejectedReplyAuthStat
RejectedReplyAuthStat (oncrpcv2:RejectedReplyAuthStat)
Description:
Children: None
RejectedReplyAuthStat Attributes
Attribute
Description
Name
Type: string
stat
Type: AuthStat
Default: 0
Possible Values:
Value Description
0
AUTH_OK
AUTH_BADCRED
AUTH_REJECTEDCRED
AUTH_BADVERF
AUTH_REJECTEDVERF
AUTH_TOOWEAK
AUTH_INVALIDRESP
AUTH_FAILED
AUTH_KERB_GENERIC
AUTH_TIMEEXPIRE
10
AUTH_TKT_FILE
11
AUTH_DECODE
12
AUTH_NET_ADDR
13
RPCSEC_GSS_CREDPROBLEM
14
RPCSEC_GSS_CTXPROBLEM
relaySessionId
Description:
Parents: PPPoETag
Children: None
relaySessionId Attributes
Attribute
Description
length
Type: OCTETSTRING
Default: 0000
Name
more information.
Type: string
type
Type: OCTETSTRING
Default: 0110
2123
ReleasePortCommand
Attribute
Description
value
Type: OCTETSTRING
ReleasePortCommand
Description:
Release one or more ports.

ReleasePortCommand Writable Attributes

Writable Attribute
Description
Location
Port location(for example, "10.0.0.1/1/1").

Type: csp
PortList
List of handles of the ports to release.

Type: handle
Default: 0
ReleasePortCommand Read-Only Attributes

Read-Only Attribute
Description

ReorderRelativesCommand
Description:

ReorderRelativesCommand Writable Attributes

Writable Attribute
Description
2124
ReplyBody
Writable Attribute
Description
Direction
Type: enum
Possible Values:
Value
Description
DESTINATION
CHILD
CHILDREN
DOWN
DOWNWARD
FORWARD
SOURCE
PARENT
UP
UPWARD
BACKWARD
BIDIRECTIONAL
BOTH
ALL
RelationType
Type: string
Source
Type: handle
Default: 0
Targets
Type: handle
Default: 0
ReorderRelativesCommand Read-Only Attributes

Read-Only Attribute
Description

ReplyBody (oncrpcv2:ReplyBody)
Description:
Children: None
Next headers: oncrpcv2:AcceptedReply, oncrpcv2:RejectedReply, custom:Custom
ReplyBody Attributes
Attribute
Description
Name
information.
Type: string
2125
ReplyEgressTLVFormatTLV
Attribute
Description
stat
Type: ReplyStat
Default: 0
Possible Values:
Value Description
0
MSG_ACCEPTED
MSG_DENIED
ReplyEgressTLVFormatTLV (overloaded)
ReplyEgressTLVFormatTLV (EOAM)
ReplyEgressTLVFormatTLV (serviceoam)
ReplyEgressTLVFormatTLV Object (EOAM PDU library)

Description:

Children: theEPID, theEPIDL, theEPIDLS
ReplyEgressTLVFormatTLV Attributes
Attribute
Description
EgressAction
Type: EgressActionFieldValues
Default: 01
Possible Values:
Value Description
01
EgrOk
02
EgrDown
03
EgrBlocked
04
EgrVID
EgressMac
Type: MACADDR
Default: 00:00:01:00:00:01
Length
Type: OCTETSTRING
Default: 0000
Name
Type: string
Type
Type: OCTETSTRING
Default: 06
2126
ReplyIngressTLVFormatTLV
ReplyEgressTLVFormatTLV Object (serviceoam PDU library)

Description:

Children: theEPID
ReplyEgressTLVFormatTLV Attributes
Attribute
Description
EgressAction
Default: 01
Possible Values:
Value Description
01
EgrOk
02
EgrDown
03
EgrBlocked
04
EgrVID
EgressMac
Type: MACADDR
Default: 00:00:01:00:00:01
Length
Type: OCTETSTRING
Default: 0000
Name
Type: string
Type
Type: OCTETSTRING
Default: 06
ReplyIngressTLVFormatTLV (overloaded)
ReplyIngressTLVFormatTLV (EOAM)
ReplyIngressTLVFormatTLV (serviceoam)
ReplyIngressTLVFormatTLV Object (EOAM PDU library)

Description:

Children: theIPID, theIPIDL, theIPIDLS
2127
ReplyIngressTLVFormatTLV
ReplyIngressTLVFormatTLV Attributes
Attribute
Description
IngressAction
Type: IngressActionFieldValues
Default: 01
Possible Values:
Value Description
01
IngOk
02
IngDown
03
IngBlock
04
IngVID
IngressMac
Type: MACADDR
Default: 00:00:01:00:00:01
Length
Type: OCTETSTRING
Default: 0000
Name
Type: string
Type
Type: OCTETSTRING
Default: 05
ReplyIngressTLVFormatTLV Object (serviceoam PDU library)

Description:

Children: theIPID
ReplyIngressTLVFormatTLV Attributes
Attribute
Description
IngressAction
Default: 01
Possible Values:
Value Description
01
IngOk
02
IngDown
03
IngBlock
04
IngVID
IngressMac
Type: MACADDR
Default: 00:00:01:00:00:01
Length
Type: OCTETSTRING
Default: 0000
Name
Type: string
2128
replyTOSByteTlv
Attribute
Description
Type
Type: OCTETSTRING
Default: 05
replyTOSByteTlv
Description:
Children: None
replyTOSByteTlv Attributes
Attribute
Description
length
Type: INTEGER
Default: 4
Name
Type: string
replyTos
Type: INTEGER
Default: 0
reserved
Type: INTEGER
Default: 0
type
Type: INTEGER
Default: 9
reportLUNs
Description:
Parents: fcpCdb
Children: None
reportLUNs Attributes
Attribute
Description
allocationLength
Type: OCTETSTRING
Default: 00000000
control
Type: OCTETSTRING
Default: 00
Name
Type: string
2129
ReportLUNs
Attribute
Description
opCode
Type: OCTETSTRING
Default: A0
reserved1
Type: OCTETSTRING
Default: 00
reserved2
Type: OCTETSTRING
Default: 000000
reserved3
Type: OCTETSTRING
Default: 00
selectReport
Type: OCTETSTRING
Default: 00
ReportLUNs (scsi:ReportLUNs)
Description:
Children: None
ReportLUNs Attributes
Attribute
Description
allocationLength
Type: OCTETSTRING
Default: 00000000
control
Type: OCTETSTRING
Default: 00
Name
Type: string
opCode
Type: OCTETSTRING
Default: A0
reserved1
Type: OCTETSTRING
Default: 00
reserved2
Type: OCTETSTRING
Default: 000000
reserved3
Type: OCTETSTRING
Default: 00
selectReport
Type: OCTETSTRING
Default: 00
reqAddr
Description:
2130
requestedLsas
DHCP requested IP address option

Parents: DHCPOption
Children: None
reqAddr Attributes
Attribute
Description
length
Type: OCTETSTRING
Default: 04
Name
more information.
Type: string
reqAddr
Type: IPV4ADDR
Default: 0.0.0.0
type
Type: OCTETSTRING
Default: 32
requestedLsas
Description:
Parents: Ospfv2LinkStateRequest
Children: Ospfv2RequestedLsa
requestedLsas Attributes
Attribute
Description
Name
information.
Type: string
ReservedData
Description:
Parents: theReservedDataSelect
Children: None
ReservedData Attributes
Attribute
Description
Name
more information.
Type: string
reserved
Type: OCTETSTRING
2131
ReservePortCommand
ReservePortCommand
Description:
Reserve one or more ports.

ReservePortCommand Writable Attributes

Writable Attribute
Description
Location
List of chassis/slot/port values (example: "10.100.10.1/1/1") for the ports to reserve.

Type: csp
PortList
List of handles of the ports to reserve.

Type: handle
Default: 0
RevokeOwner
Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
ReservePortCommand Read-Only Attributes

Read-Only Attribute
Description

ResetActiveEventDefaultResponseCommand
Description:

ResetActiveEventDefaultResponseCommand Writable Attributes

Writable Attribute
Description
2132
ResetConfigCommand
ResetActiveEventDefaultResponseCommand Read-Only Attributes

Read-Only Attribute
Description

ResetConfigCommand
Description:
Resets to default values all objects that are not connected to a port. Use this command after a call to ChassisDisconnectAll to reset the in-memory configuration.

ResetConfigCommand Writable Attributes

Writable Attribute
Description
Config
Handle of the object to reset.

Type: handle
Default: 0
ResetConfigCommand Read-Only Attributes

Read-Only Attribute
Description

ResourceLimitCapTLV (VICTLV:ResourceLimitCapTLV)
Description:
Children: None
VICTLV:CustomTLV
ResourceLimitCapTLV Attributes
Attribute
Description
Length
Type: INTEGER
Default: 6
Name
Type: string
2133
Result
Attribute
Description
NumUifsSupported
Type: INTEGER
Default: 0
NumVifListsSupported
Type: INTEGER
Default: 0
NumVifsSupported
Type: INTEGER
Default: 1
Type
Type: INTEGER
Default: 18
Result
Description:
Base object for results.

Children: RealtimeChartSeries, StaticChartSeries
Relations:
Side name
(Type)
Relative
Description
ResultParent
(ResultChild)
LogFileQuerySet, ResultChartQuerySet,
ResultDataSet
Result Writable Attributes

Writable Attribute
Description
Active, Name
Result Read-Only Attributes

ResultChartQuerySet
Description:
Used to chart real-time results. After apply a ChartSeries object is attached to this object (via ResultChild relation) for each requested result. See ChartSeries
for more info.

Parents: Project
Children: EventMessageChartSeries, ValueEventMessageChartSeries
Result children (automatically created): Result, ResultViewData
Relations:
2134
ResultChartQuerySet
Side name
(Type)
Relative
Description
ResultChild
(ResultChild)
ResultChartQuerySet Writable Attributes

Writable Attribute
Description
Active, Name
Description
Description of the results in this dataset.

Type: string
DisablePaging
Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
FALSE
Identifier
Do not modify. For internal GUI use. (Associates a ResultDataSet with a GUI presentation node or a table).
Type: string
Do not modify. For internal GUI use.

Type: string
NotifyInterval
Currently only supported by certain types of l2l3 results. How often updates should be sent.
Type: u16
Default: 1000
Range: 1000 - 60000
PageNumber
Currently only supported by certain types of l2l3 results. Used along with RecordsPerPage to limit the result
objects to those with indices between (PageNumber-1) * RecordsPerPage and ((PageNumber-1) *
RecordsPerPage) + (RecordsPerPage-1).
Type: u16
Default: 1
Path
Do not modify. For internal GUI use. (Associates a ResultDataSet with a presentation node).
Type: string
PrimaryClass
Do not modify. For internal GUI use. (Associates a ResultDataSet with a presentation node).
Type: string
RecordsPerPage
Currently only supported by certain types of l2l3 results. The maximum number of result objects that can be
displayed simultaneously by this ResultDataSet.
Type: u16
Default: 100
ResultViewOwner

Type: enum
Default: SYSTEM
Possible Values:
Value
Description
SYSTEM Dataset was created by the system.
USER
XAxisLabel
Dataset was created by the user (in the GUI).
Type: string
2135
ResultClearAllTrafficCommand
Writable Attribute
Description
YAxisLabel
Type: string
ZAxisLabel
Type: string
ResultChartQuerySet Read-Only Attributes

Read-Only Attribute
Description
ResultState
ResultHandleList
Contains the handles of result objects attached to this dataset.

Type: handle
Default: 0
TotalPageCount
Currently only supported by certain types of l2l3 results. It is the total number of
results/RecordsPerPage.
Type: u16
Default: 1
ResultClearAllTrafficCommand
Description:
Clears all traffic results in the system.

ResultClearAllTrafficCommand Writable Attributes

Writable Attribute
Description
PortList
List of ports to clear results on.

Type: handle
Default: 0
ResultClearAllTrafficCommand Read-Only Attributes

Read-Only Attribute
Description

ResultDataSet
Description:
Used to request real-time results. After apply, the requested results are attached to this object using the ResultChild relation.
Spirent TestCenter creates this object automatically when you establish a subscription.
2136
ResultDataSet

Parents: Project
Children: ChartAxis
Result children (automatically created): CounterResultFilterInfo, RealTimeResultColumnDefinition, RealTimeResultGroupDefinition, Result, ResultQuery,
ResultViewData
Relations:
Side name
(Type)
Relative
Description
ResultChild
(ResultChild)
ResultDataSet Writable Attributes

Writable Attribute
Description
Active, Name
Description
Description of the results in this dataset.

Type: string
DisablePaging
Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
FALSE
Identifier
Do not modify. For internal GUI use. (Associates a ResultDataSet with a GUI presentation node or ra table.)
Type: string

Type: string
NotifyInterval
How often updates should be sent. Currently only supported by certain types of l2l3 results.
Type: u16
Default: 1000
Range: 1000 - 60000
PageNumber
Used with the paged results mechanism. This attribute identifies the results page to retrieve. To retrieve all of the data
produced by a subscription, set PageNumber to 1 and then increment its value until it reaches the TotalPageCount
value.
The paged results mechanism is supported by the following result objects: AnalyzerPortResults, DiffServResults,
FilteredStreamResults, GeneratorPortResults, PortAvgLatencyResults, RxCpuPortResults, RxPortPairResults,
RxStreamBlockResults, RxStreamSummaryResults, RxTrafficGroupResults, TxCpuPortResults, TxPortPairResults,
TxStreamBlockResults, TxStreamResults, TxTrafficGroupResults.
Type: u16
Default: 1
Path
Do not modify. For internal GUI use. (Associates a ResultDataSet with a presentation node.)
Type: string
PrimaryClass
Do not modify. For internal GUI use. (Associates a ResultDataSet with a presentation node.)
Type: string
RecordsPerPage
Used with the paged results mechanism. Defines the amount of data in a results page. A record corresponds to the
data associated with one results object.
See the PageNumber attribute for a list of the objects that support the paged results mechanism.
Type: u16
Default: 100
2137
ResultDataSetCreateCommand
Writable Attribute
Description
ResultViewOwner

Type: enum
Default: SYSTEM
Possible Values:
Value
Description
SYSTEM Dataset was created by the system.
USER
Dataset was created by the user (in the GUI).
ResultDataSet Read-Only Attributes

Read-Only Attribute
Description
ResultState
ResultHandleList
Contains the handles of results objects attached to this ResultDataSet.

Type: handle
Default: 0
TotalPageCount
Used with the paged results mechanism. Gives the total number of results pages. This number depends
on the setting of the ResultsPerPage attribute.
See the PageNumber attribute for a list of the objects that support the paged results mechanism.
Type: u16
Default: 1
ResultDataSetCreateCommand
Description:
Creates a blank/default result dataset with the specified number of (blank) queries, column definitions and group definitions. Useful for creating a ResultDataSet
with a large number of queries, column definitions and group definitions.

ResultDataSetCreateCommand Writable Attributes

Writable Attribute
Description
ExistingDataSet
If this is 0 the command will create a new ResultDataSet. If it corresponds to an existing ResultDataSet the
command will update it.
Type: handle
Default: 0
NumColumns
Number of blank RealTimeResultColumnDefintion objects to create under the ResultDataset.

Type: u32
Default: 1
NumGroups
Number of blank RealTimeResultGroupDefinition objects to create under the ResultDataset.

Type: u32
Default: 1
NumQueries
Number of blank ResultQuery objects to create under the ResultDataset.

Type: u32
Default: 1
2138
ResultDataSetPauseCommand
ResultDataSetCreateCommand Read-Only Attributes

Read-Only Attribute
Description

ResultDataSet
Handle of the result dataset that the command operated on. This is useful when the you specify 0 as the
ExistingDataSet to indicate that the command should create a ResultDataSet.
Type: handle
Default: 0
ResultDataSetPauseCommand
Description:
Pauses updates to results associated with a ResultDataSet.

ResultDataSetPauseCommand Writable Attributes

Writable Attribute
Description
ResultDataSet
Handle of a ResultDataSet to pause.

Type: handle
Default: 0
ResultDataSetPauseCommand Read-Only Attributes

Read-Only Attribute
Description

ResultDataSetResumeCommand
Description:
Resumes updates to results associated with a ResultDataSet.

ResultDataSetResumeCommand Writable Attributes

Writable Attribute
Description
2139
ResultDataSetSubscribeCommand
Writable Attribute
Description
ResultDataSet
Handle of a ResultDataSet to pause.

Type: handle
Default: 0
ResultDataSetResumeCommand Read-Only Attributes

Read-Only Attribute
Description

ResultDataSetSubscribeCommand
Description:
Activates result collection and optionally records the results. A non-empty FileNameprefix causes a CSV file to be generated. The file is updated every interval
seconds with the latest.

ResultDataSetSubscribeCommand Writable Attributes

Writable Attribute
Description
ResultDataSet
Handle of new ResultDataSet object on success.

Type: handle
Default: 0
ResultDataSetSubscribeCommand Read-Only Attributes

Read-Only Attribute
Description

ResultDataSetUnsubscribeCommand
Description:
Deactivates result collection for the specified ResultDataSet. The ResultDataSet handles returned from subscribe can be used with this command.

2140
ResultOptions
ResultDataSetUnsubscribeCommand Writable Attributes

Writable Attribute
Description
ResultDataSet
ResultDataSet handle returned from the corresponding subscribe command.

Type: handle
Default: 0
ResultDataSetUnsubscribeCommand Read-Only Attributes

Read-Only Attribute
Description

ResultOptions
Description:
Configure result options.

ResultOptions Writable Attributes

Writable Attribute
Description
Active, Name
CollectStrayFrame
Whether to collect stray frames on the port when RxStreamSummaryResults is subscribed.

Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
Collect stray frames.
FALSE Do not collect stray frames.

DeleteAllAnalyzerStreams
Whether to delete all streams from analyzer when clearing results with ResultsClearAllCommand.
Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
Delete all analyzer streams.
FALSE Do not delete all analyzer streams.

JitterMode
Choose which method to use for calculation of jitter values.

Type: enum
Default: RFC3393ABSOLUTEVALUE
Possible Values:
Value
Description
RFC3393ABSOLUTEVALUE Use specification from RFC3393 to calculate jitter values.
RFC4689ABSOLUTEVALUE Use specification from RFC4689 to calculate jitter values.
2141
ResultOptions
Writable Attribute
Description
PreambleByteLength
Ethernet preamble byte length used for layer1 counter calculation.

Type: u8
Default: 8
Range: 4 - 32
ResultViewMode
Choose which counters will be included in the results view. This applies only to stream-related views.
Choose a result view mode prior to running any test. Changing this mode while a test is running will invalidate
the current counter results.
The following counters are available in all modes: Comp16_1, Comp16_2, Comp16_3, Comp16_4, Comp32,
FrameCount, and StreamIndex.
Type: enum
Default: BASIC
Possible Values:
Value
Description
BASIC
Provides the basic traffic counters. The following additional counters are available in
this mode:
AvgLatency, BitRate, DroppedFrameCount, DroppedFrameRate, DuplicateFrameCount,
DuplicateFrameRate, ExpectedSeqNum, FcsErrorFrameCount, FcsErrorFrameRate,
FrameRate, InOrderFrameCount, InOrderFrameRate, Ipv4ChecksumErrorCount,
Ipv4ChecksumErrorRate, LateFrameCount, LateFrameRate, MaxFrameLength,
MaxLatency, MinFrameLength, MinLatency, OctetCount, OctetRate, PrbsBitErrorCount,
PrbsBitErrorRate, PrbsFillOctetCount, PrbsFillOctetRate, ReorderedFrameCount,
ReorderedFrameRate, SeqRunLength, SigFrameCount, SigFrameRate,
TcpUdpChecksumErrorCount, TcpUdpChecksumErrorRate.
HISTOGRAM
Provides the histogram counters for the following histograms: frame length, latency,
sequence diffcheck, and sequence run length. The following additional counters are
available in this mode:
AvgLatency, BitRate, FcsErrorFrameCount, FcsErrorFrameRate, FrameRate,
HistBin1Count to HistBin16Count, HistBin1Rate to HistBin16Rate, InSeqFrameCount,
InSeqFrameRate, Ipv4ChecksumErrorCount, Ipv4ChecksumErrorRate, LastSeqNum,
MaxFrameLength, MaxLatency, MinFrameLength, MinLatency, OctetCount, OctetRate,
OutSeqFrameCount, OutSeqFrameRate, PrbsBitErrorCount, PrbsBitErrorRate,
PrbsFillOctetCount, PrbsFillOctetRate, SeqRunLength, SigFrameCount, SigFrameRate,
TcpUdpChecksumErrorCount, TcpUdpChecksumErrorRate.
JITTER
Provides the histogram and minimum, maximum, and average jitter counters. The
following additional counters are available in this mode:
AvgJitter, FirstArrivalTime, HistBin1Count to HistBin16Count, HistBin1Rate to
HistBin16Rate, InSeqFrameCount, LastArrivalTime, LastSeqNum, MaxJitter,
MaxLatency, MinJitter, MinLatency, OutSeqFrameCount, SeqRunLength, TotalJitter,
TotalJitterRate.
INTERARRIVALTIME Provides the inter-arrival histogram and minimum, maximum, and average counter
values. The following additional counters are available in this mode:
AvgInterarrivalTime, FirstArrivalTime, FrameRate, HistBin1Count to HistBin16Count,
HistBin1Rate to HistBin16Rate, InSeqFrameCount, InSeqFrameRate,
Ipv4ChecksumErrorCount, Ipv4ChecksumErrorRate, LastArrivalTime, LastSeqNum,
MaxInterarrivalTime, MaxLatency, MinInterarrivalTime, MinLatency, OutSeqFrameCount,
OutSeqFrameRate, SeqRunLength, TotalInterarrivalTime.
SaveAtEotProperties
FORWARDING
Provides the advanced sequencing counters and minimum, maximum, and average
inter-arrival counters. The following additional counters are available in this mode:
AvgInterarrivalTime, BitRate, DroppedFrameCount, DroppedFrameRate,
DuplicateFrameCount, DuplicateFrameRate, ExpectedSeqNum, FirstArrivalTime,
FrameRate, InOrderFrameCount, InOrderFrameRate, Ipv4ChecksumErrorCount,
Ipv4ChecksumErrorRate, LastArrivalTime, LateFrameCount, LateFrameRate,
MaxFrameLength, MaxInterarrivalTime, MinFrameLength, MinInterarrivalTime,
OctetCount, OctetRate, PrbsBitErrorCount, PrbsBitErrorRate, PrbsFillOctetCount,
PrbsFillOctetRate, ReorderedFrameCount, ReorderedFrameRate, SeqRunLength,
TotalInterarrivalTime.
LATENCY_JITTER
Provides the minimum, maximum and avegrage Latency and Jitter counters. The
following additional counters are available in this mode:
SeqRunLength, ExpectedSeqNum, DroppedFrameCount, DroppedFrameRate,
InOrderFrameCount, InOrderFrameRate, ReorderedFrameCount, ReorderedFrameRate,
DuplicateFrameCount, DuplicateFrameRate, LateFrameCount, LateFrameRate,
FirstArrivalTime, LastArrivalTime.
Specifies the configuration properties to be saved at the end of test.

Type: string
2142
ResultProviderRegistry
Writable Attribute
Description
StopAnalyzerBeforeClearingResults
Whether to stop analyzers before clearing results with ResultsClearAllCommand. You must set this before
invoking ResultsClearAllCommand.
Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
Stop all analyzers, clear results for all views, and then start the analyzers again.
FALSE Clear results for all views without stopping analyzers.

StopTrafficBeforeClearingResults
Whether to stop traffic generators before clearing results with ResultsClearAllCommand. You must set this
before invoking ResultsClearAllCommand.
Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
Stop all generators, clear results for all views, and then start the generators again.
FALSE Clear results for all views without stopping generators.

SyncClearResults
NOTE: This attribute is not available if StopTrafficBeforeClearingResults or StopAnalyzerBeforeClearingResults

is TRUE.
Whether to synchronize clearing across all ports when you invoke ResultsClearAllCommand. Generators and
analyzers will not be stopped.
Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
Synchronize clearing across all ports.
FALSE Do not synchronize clearing across all ports.

TimedRefreshInterval
Define the refresh interval in seconds when PERIODIC mode is selected as TimedRefreshResultViewMode.
Type: u16
Default: 10
Range: 1 - 65535
TimedRefreshResultViewMode
Auto refresh for result views which does not update results in real time.
Type: enum
Default: MANUAL
Possible Values:
Value
Description
MANUAL
Result view does not get refreshed automatically.
CONTINUOUS Result view get refreshed continuously.

PERIODIC
TxPortExpectMCastTrafficSentFromSelf
Result view get refreshed as per interval defined in TimedRefreshInterval.
Whether the Tx port will expect to receive traffic from itself.

Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
Tx port will expect to receive traffic from itself.
FALSE Tx port will not expect to receive traffic from itself.
ResultOptions Read-Only Attributes

ResultProviderRegistry
2143
ResultQuery
Description:

Parents: StcSystem
Result children (automatically created): ExternalEquationResultProperty
ResultProviderRegistry Writable Attributes

Writable Attribute
Description
Active, Name
ResultProviderRegistry Read-Only Attributes

Read-Only Attribute
Description
ResultProviders
Type: string
ResultQuery
Description:
Results that match this query will be related to the parent ResultDataSet object using the parent's ResultChild relation.

Children: ChartAxisMapping
Result children (automatically created): ExternalEquationResultProperty
Relations:
Side name
(Type)
Relative
Description
ResultFilter
(ResultFilters)
CounterResultFilter, RxPortResultFilter, StreamBlockResultFilter
ResultQuery Writable Attributes

Writable Attribute
Description
Active, Name
ArchivingOption
Type: enum
Default: NONE
Possible Values:
Value
Description
NONE
PERIODIC
UPDATE
ConfigClassId
Type of object that is the parent of the result (specified in ResultClassId). For example, if ResultClassId is
dhcpv4.Dhcpv4PortResults, then the ConfigClassId can be either dhcpv4.Dhcpv4PortConfig, core.Port, or
framework.Project.
Type: classId
Default: 0
2144
ResultsClearAllCommand
Writable Attribute
Description
PropertyHandleArray
Handles of the properties to get.

Type: handle
Default: 0
PropertyIdArray
Properties to get. The properties must be properties of ResultClassId.

Type: propertyId
Default: 0
ResultClassId
Type of result object.

Type: classId
Default: 0
ResultOptions
Currently only used when subscribing to event messages. In this case it is a ;-delimited string of event message
types.
Type: string
ResultRootList
A list of object handles under which to search for results. For example, if it contains handle of project, query
refers to all results; if it contains the handles for port1 and port2, it refers to all results under port 1 and 2.
Type: handle
Default: 0
ResultQuery Read-Only Attributes

ResultsClearAllCommand
Description:
Clears all the results in the specified ports. By default, traffic generators and analyzers are not stopped when you invoke this command. To change this
behavior, use the ResultOptions object.

ResultsClearAllCommand Writable Attributes

Writable Attribute
Description
PortList
A list of the handles of one or more ports whose results you want to clear.
Type: handle
Default: 0
ResultsClearAllCommand Read-Only Attributes

Read-Only Attribute
Description

2145
ResultsClearAllProtocolCommand
ResultsClearAllProtocolCommand
Description:
Clears all protocol results in the system.

ResultsClearAllProtocolCommand Writable Attributes

Writable Attribute
Description
ResultsClearAllProtocolCommand Read-Only Attributes

Read-Only Attribute
Description

ResultsClearChartCommand
Description:
Clears chart results.

ResultsClearChartCommand Writable Attributes

Writable Attribute
Description
ChartList
List of charts to clear.

Type: handle
Default: 0
ChartSeriesList
List of chart series to clear.

Type: handle
Default: 0
ResultsClearChartCommand Read-Only Attributes

Read-Only Attribute
Description

2146
ResultsClearRoutingCommand
ResultsClearRoutingCommand
Description:
Clear results for routing protocols.

ResultsClearRoutingCommand Writable Attributes

Writable Attribute
Description
ProtocolList
One or more protocol names. The protocol names are Bfd, Bgp, Isis, Lacp, Ldp, Ospfv2, Ospfv3, Pim,
Rip, Rsvp, and Stp.
Tcl example: -protocolList "Ospfv3 Bfd"
Type: string
ResultsClearRoutingCommand Read-Only Attributes

Read-Only Attribute
Description

ResultsClearViewCommand
Description:
A command to clear the result view.

ResultsClearViewCommand Writable Attributes

Writable Attribute
Description
ResultDataSet
A handle of the result data set that need to clear result.

Type: handle
Default: 0
ResultList
A list of result handles that need to clear result.

Type: handle
Default: 0
ResultsClearViewCommand Read-Only Attributes

Read-Only Attribute
Description

2147
ResultsSubscribeCommand
ResultsSubscribeCommand
Description:
Activates result collection and optionally records the results. A non-empty FileNamePrefix attribute causes a CSV file to be generated. The file is updated
every Interval seconds with the latest results.

ResultsSubscribeCommand Writable Attributes

Writable Attribute
Description
ConfigType
The configuration object under which you want the results.

Type: string
DisablePaging
Type: bool
Default: TRUE
Possible Values:
Value Description
TRUE
FALSE
FileNamePrefix
The first (filename) part of the output filename. Use the OutputFormat attribute to configure the filename extension.
An empty filename disables CSV output, so that only the data model is updated.
Type: string
FilterList
Type: handle
Default: 0
Interval
Number of seconds between updates to the CSV file. At each update to the CSV file, the latest values from the
ResultType objects are written to the file.
Type: u32
Default: 1
OutputChildren
Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
FALSE
OutputFormat
Filename extension of the output filename.

Type: string
Default: csv
Parent
This must be the handle of the Project object.

Type: handle
Default: 0
RecordsPerPage
Type: u16
Default: 100
ResultParent
The object in the configuration under which you want results. If you want results for every port, use the Project object.
If you want results for just specific ports, use the port handles.
Type: handle
Default: 0
2148
ResultViewData
Writable Attribute
Description
ResultType
Results object type to use. There are many of these to choose from. Some examples: AnalyzerPortResults,
PppoeSessionResults, Ospfv2RouterResults.
Type: string
ViewAttributeList
A list of attributes in the results object. You can use this to choose just the attributes you are interested in. An empty
string, the default, means all attributes.
Attributes that are not in this list will not be updated and will always be zero in the data model. Only the ones specified
with this attribute will be written to the CSV file.
You specify the results object with the ResultType attribute. See the documentation for your chosen results object
to learn the attributes it contains.
Type: string
ViewName
To be implemented.
Type: string
ResultsSubscribeCommand Read-Only Attributes

Read-Only Attribute
Description

ReturnedResultDataSet
Handle of the new ResultDataSet object on success.

Type: string
ResultViewData
Description:

Parents: PresentationResultQuery
Children:
Result children (automatically created): ResultViewData
Relations:
Side name
(Type)
Relative
Description
ResultParent
(ResultChild)
LogFileQuerySet, ResultChartQuerySet,
ResultDataSet
ResultViewData Writable Attributes

Writable Attribute
Description
Active, Name
ResultViewData Read-Only Attributes

Read-Only Attribute
Description
ColumnCount
Type: u8
Default: 0
2149
ResumeDynamicResultViewCommand
Read-Only Attribute
Description
IsDummy
Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
FALSE
IsGrouped
Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
FALSE
ResultData
Type: string
RowId
Type: u32
Default: 0xFFFFFFFF
ResumeDynamicResultViewCommand
Description:

ResumeDynamicResultViewCommand Writable Attributes

Writable Attribute
Description
DynamicResultView
Type: handle
Default: 0
ResumeDynamicResultViewCommand Read-Only Attributes

Read-Only Attribute
Description

Rfc2544AsymmetricFrameLossPerLoadResult
Description:
Used in the end of test result database. You cannot subscribe to this object to get results.

Parents: Project
2150
Relations:
Side name
(Type)
Relative
Description
ResultParent
(ResultChild)
Project, TrafficDescriptorResult
Rfc2544AsymmetricFrameLossPerLoadResult Writable Attributes

Rfc2544AsymmetricFrameLossPerLoadResult Read-Only Attributes

Read-Only Attribute
Description
AvgJitter
Average jitter measured in microseconds.

Type: double
Default: 0
AvgLatency
Maximum latency measured in microseconds.

Type: double
Default: 0
BurstSize
Specifies the configured burst size use for the test.

Type: u64
Default: 0
ChecksumErrorCount
Total number of IP/UDP/TCP checksum errors received during the test.

Type: u64
Default: 0
ConfiguredFrameSize
User configured frame size.

Type: double
Default: 0
DuplicateFrameCount
Minimum number of duplicate frames received during a test run. This number may not be accurate due to
the analyzer mode used for the RFC 2544/2889 tests.
Type: u64
Default: 0
ExpectedFrameCount
Total number of test frames that were expected to be received.

Type: u64
Default: 0
FcsErrorFrameCount
Total number of frame check sequence errors received during the test.
Type: u64
Default: 0
FloodCount
do not use it.
Total number of test frames flooded to the incorrect egress port during the test.
Type: u64
Default: 0
FloodedFrameCount
Type: u64
Default: 0
ForwardingRate
Measured, average forwarding rate of the Device Under Test (DUT) in frames per second (fps) during the
test.
Type: double
Default: 0
iMIX distribution.
Type: string
Default: N/A
2151
Read-Only Attribute
Description
FrameLoss
Number of frames lost.

Type: u64
Default: 0
FrameRate
do not use it.
Rate at which frames are transmitted.
Type: double
Default: 0
FrameSize
Frame size.
Type: double
Default: 0
FrameSizeType
Frame size type.

Type: string
Default: 0
IntendedLoad
Number of frames per second that the application attempts to transmit to a DUT/SUT for forwarding to a
specified output interface or interfaces.
Type: double
Default: 0
Ipv4AvgJitter
Average jitter in microseconds of IPv4 traffic.

Type: double
Default: 0
Ipv4AvgLatency
Average latency in microseconds of IPv4 traffic.

Type: double
Default: 0
Ipv4FrameLoss
Number of IPv4 frames lost.

Type: u64
Default: 0
Ipv4IntendedLoad
Intended load for IPv4 traffic.

Type: double
Default: 0
Ipv4MaxJitter
Maximum jitter in microseconds of IPv4 traffic.

Type: double
Default: 0
Ipv4MaxLatency
Maximum latency in microseconds of IPv4 traffic.

Type: double
Default: 0
Ipv4MinJitter
Minimum jitter in microseconds of IPv4 traffic.

Type: double
Default: 0
Ipv4MinLatency
Minimum latency in microseconds of IPv4 traffic.

Type: double
Default: 0
Ipv4OfferedLoad
Offered load for IPv4 traffic.

Type: double
Default: 0
Ipv4RxFrameCount

Type: u64
Default: 0
Ipv4TxFrameCount
Number of IPv4 frames transmitted.

Type: u64
Default: 0
2152
Read-Only Attribute
Description
Ipv4TxFrameRate
Number of IPv4 frames transmitted per second.

Type: double
Default: 0
Ipv6AvgJitter

Type: double
Default: 0
Ipv6AvgLatency

Type: double
Default: 0
Ipv6ExtensionHeader
IPv6 extension header.

Type: string
Default: N/A
Ipv6FrameLoss

Type: u64
Default: 0
Ipv6IntendedLoad

Type: double
Default: 0
Ipv6Ipv4CoexistenceRatio
IPv6 to IPv4 Coexistence Ratio in terms of weights.

Type: string
Default: N/A
Ipv6MaxJitter

Type: double
Default: 0
Ipv6MaxLatency

Type: double
Default: 0
Ipv6MinJitter

Type: double
Default: 0
Ipv6MinLatency

Type: double
Default: 0
Ipv6OfferedLoad

Type: double
Default: 0
Ipv6RxFrameCount

Type: u64
Default: 0
Ipv6TxFrameCount

Type: u64
Default: 0
Ipv6TxFrameRate

Type: double
Default: 0
IterationNum
do not use it.
Trial number been run.
Type: u8
Default: 0
2153
Read-Only Attribute
Description
LoadIterationNum
Load iteration number.

Type: u32
Default: 0
LoadResult
Load Result.
Type: string
LoadSize
do not use it.
Traffic load.
Type: double
Default: 0
LoadSizeType
Specifies how the traffic load was configured. Can be Fixed or Random.
Type: string
Default: 0
MaxJitter
Maximum jitter measured in microseconds.

Type: double
Default: 0
MaxLatency

Type: double
Default: 0
MbpsLineRate
do not use it.
Offered load (OLoad) in megabits per second.
Type: double
Default: 0
MinJitter
Minimum jitter measured in microseconds.

Type: double
Default: 0
MinLatency
Minimum latency measured in microseconds.

Type: double
Default: 0
OfferedLoad
Load (in percent or frames per second) offered by the DUT.

Type: double
Default: 0
OtherFrameCount
Total number of non-test traffic frames received during the test.

Type: u64
Default: 0
OutOfSeqCount

Type: u64
Default: 0
PauseFrameCount
Total number of pause frames received by the test ports during the test.
Type: u64
Default: 0
PercentLoss
Frame loss percentage.

Type: double
Default: 0
PfcFrameCount
Number of PFC frames received.

Type: u64
Default: 0
PortHandle
Port handle.
Type: handle
Default: 0
2154
Read-Only Attribute
Description
Profile
Profile name.
Type: string
Result
Iteration result indicating if the traffic at the given rate satisfied the pass condition for throughput.
Type: string
Default: Failed
RxExpectedFrameCount
do not use it.
Total number of signature frames expected during a test.
Type: u64
Default: 0
RxFrameCount

Type: u64
Default: 0
RxNonSigFrameCount
do not use it.
Total number of non-signature test frames received during a test.
Type: u64
Default: 0
RxSigFrameCount
do not use it.
Total number of signature frames received during a test.
Type: u64
Default: 0
SearchKey
Unique search configuration identifier for traffic loop.

Type: string
Default: N/A
StreamBlock
Stream block.
Type: string
StreamBlockHandle
Stream block handle.

Type: handle
Default: 0
TrafficGroupWeightRatio
Traffic group weight ratio.

Type: string
Default: N/A
TrialNum
Number of the current trial.

Type: u8
Default: 0
TxBitRate
Rate at which bits are transmitted.

Type: double
Default: 0
TxFrameCount
Number of frames transmitted.

Type: u64
Default: 0
TxFrameRate
Specifies the intended frame rate (ILoad) for the test.

Type: double
Default: 0
TxMbpsLoad
Intended load (ILoad) in megabits per second.

Type: double
Default: 0
2155
Rfc2544AsymmetricFrameLossStreamGroupResult
Read-Only Attribute
Description
TxOctetCount
Number of octets transmitted.

Type: u64
Default: 0
TxPort
Transmitting port.
Type: string
TxSigFrameCount
do not use it.
Total number of signature frames transmitted during a test.
Type: u64
Default: 0
Rfc2544AsymmetricFrameLossStreamGroupResult
Description:

Parents: Project
Result children (automatically created): Rfc2544AsymmetricFrameLossStreamResult
Rfc2544AsymmetricFrameLossStreamGroupResult Writable Attributes

Rfc2544AsymmetricFrameLossStreamGroupResult Read-Only Attributes

Read-Only Attribute
Description
Duration
Scalar value of duration.

Type: double
Default: 0
iMIX distribution.
Type: string
Default: N/A
FrameSize
Frame size.
Type: u64
Default: 0
FrameSizeType
Frame size type.

Type: string
Default: N/A
InterFrameOverHead
Inter frame overhead.

Type: u32
Default: 20
IterationNum

Type: u32
Default: 0
LoadIterationNum

Type: u32
Default: 0
2156
Rfc2544AsymmetricFrameLossStreamResult
Rfc2544AsymmetricFrameLossStreamResult
Description:

Parents: Rfc2544AsymmetricFrameLossStreamGroupResult
Rfc2544AsymmetricFrameLossStreamResult Writable Attributes

Rfc2544AsymmetricFrameLossStreamResult Read-Only Attributes

Read-Only Attribute
Description
LoadPassed
Flag to indicate all the frames for the configured load value were received successfully.
Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
All of the frames for the configured load value were received successfully.
FALSE All of the frames for the configured load value were not received successfully.
LoadResult
Load Result.
Type: string
Default: Failed
Result
Type: string
Default: Failed
RxFrameCount

Type: u64
Default: 0
SrcEmulatedDeviceHnd
Source emulated device handle.

Type: u64
Default: 0
StreamBlockHnd

Type: u64
Default: 0
TxFrameCount

Type: u64
Default: 0
TxOctetCount
Tx octet count.
Type: u64
Default: 0
Rfc2544AsymmetricLatencyPerLoadResult
Description:

Parents: Project
Relations:
2157
Side name
(Type)
Relative
Description
ResultParent
(ResultChild)
Rfc2544AsymmetricLatencyPerLoadResult Writable Attributes

Rfc2544AsymmetricLatencyPerLoadResult Read-Only Attributes

Read-Only Attribute
Description
AvgJitter

Type: double
Default: 0
AvgLatency
Average latency measured in microseconds.

Type: double
Default: 0
BurstSize

Type: u64
Default: 0
ChecksumErrorCount

Type: u64
Default: 0
ConfiguredFrameSize

Type: double
Default: 0
DuplicateFrameCount
Type: u64
Default: 0
ExpectedFrameCount

Type: u64
Default: 0
FcsErrorFrameCount
Type: u64
Default: 0
FloodCount
NOTE: This is deprecated. It will be removed in subsequent releases, so it is recommended that

you do not use it.
Type: u64
Default: 0
FloodedFrameCount
Type: u64
Default: 0
ForwardingRate
test.
Type: double
Default: 0
iMIX distribution.
Type: string
Default: N/A
2158
Read-Only Attribute
Description
FrameLoss
Total number of test frames expected, but not received during the test.
Type: u64
Default: 0
FrameRate

you do not use it.
Type: double
Default: 0
FrameSize
Frame size.
Type: double
Default: 0
FrameSizeType
Frame size type.

Type: string
Default: 0
HistBin10Count
Histogram bucket 10.

Type: u64
Default: 0
HistBin11Count

Type: u64
Default: 0
HistBin12Count

Type: u64
Default: 0
HistBin13Count

Type: u64
Default: 0
HistBin14Count

Type: u64
Default: 0
HistBin15Count

Type: u64
Default: 0
HistBin16Count

Type: u64
Default: 0
HistBin1Count
Histogram bucket 1.
Type: u64
Default: 0
HistBin2Count
Histogram bucket 2.
Type: u64
Default: 0
HistBin3Count
Histogram bucket 3.
Type: u64
Default: 0
HistBin4Count
Histogram bucket 4.
Type: u64
Default: 0
HistBin5Count
Histogram bucket 5.
Type: u64
Default: 0
2159
Read-Only Attribute
Description
HistBin6Count
Histogram bucket 6.
Type: u64
Default: 0
HistBin7Count
Histogram bucket 7.
Type: u64
Default: 0
HistBin8Count
Histogram bucket 8.
Type: u64
Default: 0
HistBin9Count
Histogram bucket 9.
Type: u64
Default: 0
IntendedLoad
Type: double
Default: 0
Ipv4AvgJitter

Type: double
Default: 0
Ipv4AvgLatency

Type: double
Default: 0
Ipv4FrameLoss

Type: u64
Default: 0
Ipv4IntendedLoad

Type: double
Default: 0
Ipv4MaxJitter

Type: double
Default: 0
Ipv4MaxLatency

Type: double
Default: 0
Ipv4MinJitter

Type: double
Default: 0
Ipv4MinLatency

Type: double
Default: 0
Ipv4OfferedLoad

Type: double
Default: 0
Ipv4RxFrameCount

Type: u64
Default: 0
Ipv4TxFrameCount

Type: u64
Default: 0
2160
Read-Only Attribute
Description
Ipv4TxFrameRate

Type: double
Default: 0
Ipv6AvgJitter

Type: double
Default: 0
Ipv6AvgLatency

Type: double
Default: 0
Ipv6ExtensionHeader

Type: string
Default: N/A
Ipv6FrameLoss

Type: u64
Default: 0
Ipv6IntendedLoad

Type: double
Default: 0

Type: string
Default: N/A
Ipv6MaxJitter

Type: double
Default: 0
Ipv6MaxLatency

Type: double
Default: 0
Ipv6MinJitter

Type: double
Default: 0
Ipv6MinLatency

Type: double
Default: 0
Ipv6OfferedLoad

Type: double
Default: 0
Ipv6RxFrameCount

Type: u64
Default: 0
Ipv6TxFrameCount

Type: u64
Default: 0
Ipv6TxFrameRate

Type: double
Default: 0
IterationNum

you do not use it.
Type: u8
Default: 0
2161
Read-Only Attribute
Description
LoadIterationNum

Type: u32
Default: 0
LoadResult
Load result.
Type: string
LoadSize

you do not use it.
Traffic load.
Type: double
Default: 0
LoadSizeType
Load size type.

Type: string
Default: 0
MaxJitter

Type: double
Default: 0
MaxLatency

Type: double
Default: 0
MbpsLineRate

you do not use it.
Type: double
Default: 0
MinJitter

Type: double
Default: 0
MinLatency

Type: double
Default: 0
OfferedLoad

Type: double
Default: 0
OtherFrameCount

Type: u64
Default: 0
OutOfSeqCount

Type: u64
Default: 0
PauseFrameCount
Type: u64
Default: 0
PercentLoss
Percentage of test frames that were expected, but not received.

Type: double
Default: 0
PfcFrameCount

Type: u64
Default: 0
PortHandle
Port handle.
Type: handle
Default: 0
2162
Read-Only Attribute
Description
Profile
Profile name.
Type: string
Result
Type: string
Default: Failed

you do not use it.
Type: u64
Default: 0
RxFrameCount

Type: u64
Default: 0
RxNonSigFrameCount

you do not use it.
Type: u64
Default: 0
RxSigFrameCount

you do not use it.
Type: u64
Default: 0
SearchKey

Type: string
Default: N/A
StreamBlock
Stream block.
Type: string
StreamBlockHandle

Type: handle
Default: 0

Type: string
Default: N/A
TrialNum

Type: u8
Default: 0
TxBitRate
Tx bit rate.
Type: double
Default: 0
TxFrameCount

Type: u64
Default: 0
TxFrameRate

Type: double
Default: 0
TxMbpsLoad

Type: double
Default: 0
2163
Rfc2544AsymmetricLatencyStreamGroupResult
Read-Only Attribute
Description
TxOctetCount
Total number of octets transmitted.

Type: u64
Default: 0
TxPort
Transmitting port.
Type: string
TxSigFrameCount

you do not use it.
Type: u64
Default: 0
Rfc2544AsymmetricLatencyStreamGroupResult
Description:

Parents: Project
Result children (automatically created): Rfc2544AsymmetricLatencyStreamResult
Rfc2544AsymmetricLatencyStreamGroupResult Writable Attributes

Rfc2544AsymmetricLatencyStreamGroupResult Read-Only Attributes

Read-Only Attribute
Description
Duration

Type: double
Default: 0
iMIX distribution.
Type: string
Default: N/A
FrameSize
Frame size.
Type: u64
Default: 0
FrameSizeType
Frame size type.

Type: string
Default: N/A
InterFrameOverHead

Type: u32
Default: 20
IterationNum

Type: u32
Default: 0
LoadIterationNum

Type: u32
Default: 0
2164
Rfc2544AsymmetricLatencyStreamResult
Description:

Parents: Rfc2544AsymmetricLatencyStreamGroupResult
Rfc2544AsymmetricLatencyStreamResult Writable Attributes

Rfc2544AsymmetricLatencyStreamResult Read-Only Attributes

Read-Only Attribute
Description
AvgJitter

Type: double
Default: 0
AvgLatency

Type: double
Default: 0
HistBin10Count

Type: u64
Default: 0
HistBin11Count

Type: u64
Default: 0
HistBin12Count

Type: u64
Default: 0
HistBin13Count

Type: u64
Default: 0
HistBin14Count

Type: u64
Default: 0
HistBin15Count

Type: u64
Default: 0
HistBin16Count

Type: u64
Default: 0
HistBin1Count
Histogram bucket 1.
Type: u64
Default: 0
HistBin2Count
Histogram bucket 2.
Type: u64
Default: 0
HistBin3Count
Histogram bucket 3.
Type: u64
Default: 0
HistBin4Count
Histogram bucket 4.
Type: u64
Default: 0
2165
Read-Only Attribute
Description
HistBin5Count
Histogram bucket 5.
Type: u64
Default: 0
HistBin6Count
Histogram bucket 6.
Type: u64
Default: 0
HistBin7Count
Histogram bucket 7.
Type: u64
Default: 0
HistBin8Count
Histogram bucket 8.
Type: u64
Default: 0
HistBin9Count
Histogram bucket 9.
Type: u64
Default: 0
LoadPassed
Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
All of the frames for the configured load value were received successfully.
FALSE All of the frames for the configured load value were not received successfully.
LoadResult
Load Result.
Type: string
Default: Failed
MaxJitter

Type: double
Default: 0
MaxLatency

Type: double
Default: 0
MinJitter

Type: double
Default: 0
MinLatency

Type: double
Default: 0
Result
Type: string
Default: Failed
RxFrameCount

Type: u64
Default: 0
Source emulated device handle.

Type: u64
Default: 0
StreamBlockHnd
Stream block handles.

Type: u64
Default: 0
2166
Rfc2544AsymmetricThroughputPerFrameSizeResult
Read-Only Attribute
Description
TotalJitter
Total jitter measured in microseconds.

Type: double
Default: 0
TotalLatency
Total latency measured in microseconds.

Type: double
Default: 0
TxFrameCount

Type: u64
Default: 0
TxOctetCount
Tx octet count.
Type: u64
Default: 0
Description:

Parents: Project
Relations:
Side name
(Type)
Relative
Description
ResultParent
(ResultChild)
Rfc2544AsymmetricThroughputPerFrameSizeResult Writable Attributes

Rfc2544AsymmetricThroughputPerFrameSizeResult Read-Only Attributes

Read-Only Attribute
Description
AvgJitter
Average jitter value calculated from all measured jitter values in microseconds.
Type: double
Default: 0
AvgLatency
Average latency value calculated from all measured latency values in microseconds.
Type: double
Default: 0
BestLoadIterationNum
Best load iteration number.

Type: u32
Default: 0
BurstSize

Type: u64
Default: 0
ChecksumErrorCount

Type: u64
Default: 0
2167
Read-Only Attribute
Description
ConfiguredFrameSize

Type: double
Default: 0
DuplicateFrameCount
Minimum number of duplicate frames received during a test run. This number may not be accurate due to the
analyzer mode used for the RFC 2544/2889 tests.
Type: u64
Default: 0
DurationInSec
Duration test traffic was transmitted in seconds.

Type: double
Default: 0
ExpectedFrameCount

Type: u64
Default: 0
FcsErrorFrameCount
Type: u64
Default: 0
FloodCount
do not use it.
Type: u64
Default: 0
FloodedFrameCount
Type: u64
Default: 0
ForwardingRate
Number of frames per second that a device can be observed to successfully transmit to the correct destination
interface in response to a specified offered load.
Type: double
Default: 0
iMIX distribution.
Type: string
Default: N/A
FrameLoss

Type: u64
Default: 0
FrameRate
do not use it.
Type: double
Default: 0
FrameSize
Frame size.
Type: double
Default: 0
FrameSizeType
Frame size type.

Type: string
Default: 0
IntendedLoad
Type: double
Default: 0
Ipv4AvgJitter

Type: double
Default: 0
2168
Read-Only Attribute
Description
Ipv4AvgLatency

Type: double
Default: 0
Ipv4FrameLoss

Type: u64
Default: 0
Ipv4IntendedLoad

Type: double
Default: 0
Ipv4MaxJitter

Type: double
Default: 0
Ipv4MaxLatency

Type: double
Default: 0
Ipv4MinJitter

Type: double
Default: 0
Ipv4MinLatency

Type: double
Default: 0
Ipv4OfferedLoad

Type: double
Default: 0
Ipv4RxFrameCount

Type: u64
Default: 0
Ipv4TxFrameCount

Type: u64
Default: 0
Ipv4TxFrameRate

Type: double
Default: 0
Ipv6AvgJitter

Type: double
Default: 0
Ipv6AvgLatency

Type: double
Default: 0
Ipv6ExtensionHeader

Type: string
Default: N/A
Ipv6FrameLoss

Type: u64
Default: 0
Ipv6IntendedLoad

Type: double
Default: 0

Type: string
Default: N/A
2169
Read-Only Attribute
Description
Ipv6MaxJitter

Type: double
Default: 0
Ipv6MaxLatency

Type: double
Default: 0
Ipv6MinJitter

Type: double
Default: 0
Ipv6MinLatency

Type: double
Default: 0
Ipv6OfferedLoad

Type: double
Default: 0
Ipv6RxFrameCount

Type: u64
Default: 0
Ipv6TxFrameCount

Type: u64
Default: 0
Ipv6TxFrameRate

Type: double
Default: 0
IterationNum
do not use it.
Type: u8
Default: 0
LoadResult
Load result.
Type: string
LoadSize
do not use it.
Traffic load value.
Type: double
Default: 0
LoadSizeType
Type: string
Default: 0
MaxJitter
Largest measured jitter value in the set of all measured jitter values in microseconds.
Type: double
Default: 0
MaxLatency
Largest measured latency value in the set of all measured latency values in microseconds.
Type: double
Default: 0
MaxLatencyThresholdExceeded
Whether the maximum latency threshold has been exceeded.

Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
Maximum latency threshold has been exceeded.
FALSE Maximum latency threshold has not been exceeded.
2170
Read-Only Attribute
Description
MbpsLineRate
do not use it.
Type: double
Default: 0
MinJitter
Smallest measured jitter value in the set of all measured jitter values in microseconds.
Type: double
Default: 0
MinLatency
Smallest measured latency value in the set of all measured latency values in microseconds.
Type: double
Default: 0
OfferedLoad

Type: double
Default: 0
OtherFrameCount

Type: u64
Default: 0
OutOfSeqCount
Total number of test frames received in an order different from the order in which they were transmitted.
Type: u64
Default: 0
OutOfSeqThresholdExceeded
Whether the out of sequence frames threshold has been exceeded.

Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
Out of sequence frames threshold has been exceeded.
FALSE Out of sequence frames threshold has not been exceeded.

PauseFrameCount
Type: u64
Default: 0
PercentLoss

Type: double
Default: 0
PfcFrameCount

Type: u64
Default: 0
PortHnd
Port handle.
Type: handle
Default: 0
Profile
Profile name.
Type: string
ProfileHnd
Profile handle.
Type: handle
Default: 0
Result
Type: string
Default: Failed
do not use it.
Type: u64
Default: 0
2171
Read-Only Attribute
Description
RxFrameCount

Type: u64
Default: 0
RxNonSigFrameCount
do not use it.
Type: u64
Default: 0
RxSigFrameCount
do not use it.
Type: u64
Default: 0
SearchKey

Type: string
Default: N/A
StreamBlock
Stream block.
Type: string
StreamBlockHnd

Type: handle
Default: 0
Throughput
Measured throughput value for the test.

Type: double
Default: 0
ThroughputRate
do not use it.
Throughput rate.
Type: double
Default: 0

Type: string
Default: N/A
TrialNum

Type: u8
Default: 0
TxBitRate
Rate at which bits are transmitted.

Type: double
Default: 0
TxFrameCount

Type: u64
Default: 0
TxFrameRate

Type: double
Default: 0
TxMbpsLoad

Type: double
Default: 0
TxOctetCount

Type: u64
Default: 0
2172
Rfc2544AsymmetricThroughputPerLoadResult
Read-Only Attribute
Description
TxPort
Transmitting port.
Type: string
TxSigFrameCount
do not use it.
Type: u64
Default: 0
Description:

Parents: Project
Relations:
Side name
(Type)
Relative
Description
ResultParent
(ResultChild)
Rfc2544AsymmetricThroughputPerLoadResult Writable Attributes

Rfc2544AsymmetricThroughputPerLoadResult Read-Only Attributes

Read-Only Attribute
Description
AvgJitter

Type: double
Default: 0
AvgLatency

Type: double
Default: 0
BurstSize

Type: u64
Default: 0
ChecksumErrorCount

Type: u64
Default: 0
ConfiguredFrameSize

Type: double
Default: 0
DuplicateFrameCount
Type: u64
Default: 0
2173
Read-Only Attribute
Description
DurationInSec

Type: double
Default: 0
ExpectedFrameCount

Type: u64
Default: 0
FcsErrorFrameCount
Type: u64
Default: 0
FloodCount
do not use it.
Type: u64
Default: 0
FloodedFrameCount
Type: u64
Default: 0
ForwardingRate
Type: double
Default: 0
iMIX distribution.
Type: string
Default: N/A
FrameLoss

Type: u64
Default: 0
FrameRate
do not use it.
Type: double
Default: 0
FrameSize
Frame size.
Type: double
Default: 0
FrameSizeType
Frame size type.

Type: string
Default: 0
IntendedLoad
Type: double
Default: 0
Ipv4AvgJitter

Type: double
Default: 0
Ipv4AvgLatency

Type: double
Default: 0
Ipv4FrameLoss

Type: u64
Default: 0
2174
Read-Only Attribute
Description
Ipv4IntendedLoad

Type: double
Default: 0
Ipv4MaxJitter

Type: double
Default: 0
Ipv4MaxLatency

Type: double
Default: 0
Ipv4MinJitter

Type: double
Default: 0
Ipv4MinLatency

Type: double
Default: 0
Ipv4OfferedLoad

Type: double
Default: 0
Ipv4RxFrameCount

Type: u64
Default: 0
Ipv4TxFrameCount

Type: u64
Default: 0
Ipv4TxFrameRate

Type: double
Default: 0
Ipv6AvgJitter

Type: double
Default: 0
Ipv6AvgLatency

Type: double
Default: 0
Ipv6ExtensionHeader

Type: string
Default: N/A
Ipv6FrameLoss

Type: u64
Default: 0
Ipv6IntendedLoad

Type: double
Default: 0

Type: string
Default: N/A
Ipv6MaxJitter

Type: double
Default: 0
Ipv6MaxLatency

Type: double
Default: 0
2175
Read-Only Attribute
Description
Ipv6MinJitter

Type: double
Default: 0
Ipv6MinLatency

Type: double
Default: 0
Ipv6OfferedLoad

Type: double
Default: 0
Ipv6RxFrameCount

Type: u64
Default: 0
Ipv6TxFrameCount

Type: u64
Default: 0
Ipv6TxFrameRate

Type: double
Default: 0
IterationNum
do not use it.
Type: u8
Default: 0
LoadIterationNum

Type: u32
Default: 0
LoadResult
Load result.
Type: string
LoadSize
do not use it.
Traffic load value.
Type: double
Default: 0
LoadSizeType
Type: string
Default: 0
MaxJitter

Type: double
Default: 0
MaxLatency

Type: double
Default: 0

Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
2176
Read-Only Attribute
Description
MbpsLineRate
do not use it.
Type: double
Default: 0
MinJitter

Type: double
Default: 0
MinLatency

Type: double
Default: 0
OfferedLoad

Type: double
Default: 0
OtherFrameCount

Type: u64
Default: 0
OutOfSeqCount

Type: u64
Default: 0

Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE

PauseFrameCount
Type: u64
Default: 0
PercentLoss

Type: double
Default: 0
PfcFrameCount

Type: u64
Default: 0
PortHandle
Port handle.
Type: handle
Default: 0
Profile
Profile name.
Type: string
Result
Type: string
Default: Failed
do not use it.
Type: u64
Default: 0
RxFrameCount

Type: u64
Default: 0
2177
Read-Only Attribute
Description
RxNonSigFrameCount
do not use it.
Type: u64
Default: 0
RxSigFrameCount
do not use it.
Type: u64
Default: 0
SearchKey

Type: string
Default: N/A
StreamBlock
Stream block.
Type: string
StreamBlockHandle

Type: handle
Default: 0
Throughput

Type: double
Default: 0
ThroughputRate
do not use it.
Throughput rate.
Type: double
Default: 0

Type: string
Default: N/A
TrialNum

Type: u8
Default: 0
TxBitRate
Tx bit rate.
Type: double
Default: 0
TxFrameCount

Type: u64
Default: 0
TxFrameRate

Type: double
Default: 0
TxMbpsLoad

Type: double
Default: 0
TxOctetCount

Type: u64
Default: 0
TxPort
Transmitting port.
Type: string
2178
Rfc2544AsymmetricThroughputStreamGroupResult
Read-Only Attribute
Description
TxSigFrameCount
do not use it.
Type: u64
Default: 0
Rfc2544AsymmetricThroughputStreamGroupResult
Description:

Parents: Project
Result children (automatically created): Rfc2544AsymmetricThroughputStreamResult
Rfc2544AsymmetricThroughputStreamGroupResult Writable Attributes

Rfc2544AsymmetricThroughputStreamGroupResult Read-Only Attributes

Read-Only Attribute
Description
Duration

Type: double
Default: 0
iMIX distribution.
Type: string
Default: N/A
FrameSize
Frame size.
Type: u64
Default: 0
FrameSizeType
Frame size type.

Type: string
Default: N/A
InterFrameOverHead

Type: u32
Default: 20
IterationNum

Type: u32
Default: 0
Rfc2544AsymmetricThroughputStreamResult
Description:

Parents: Rfc2544AsymmetricThroughputStreamGroupResult
2179
Rfc2544Back2BackPerCoexistenceRatioResult
Rfc2544AsymmetricThroughputStreamResult Writable Attributes

Rfc2544AsymmetricThroughputStreamResult Read-Only Attributes

Read-Only Attribute
Description
LoadPassed
Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
All the frames for the configured load value were received successfully.
FALSE All the frames for the configured load value were not received successfully.
LoadResult
Load result.
Type: string
Default: Failed
Result
Type: string
Default: Failed
RxFirstArrivalTime
First arrival time of the received frames.

Type: double
Default: 0
RxFrameCount

Type: u64
Default: 0
RxLastArrivalTime
Last arrival time of the received frames.

Type: double
Default: 0
Source Emulated Device handle.

Type: u64
Default: 0
StreamBlockHnd

Type: u64
Default: 0
TxFrameCount

Type: u64
Default: 0
TxOctetCount

Type: u64
Default: 0
Description:

Parents: Project
Relations:
2180
Side name
(Type)
Relative
Description
ResultParent
(ResultChild)
Rfc2544Back2BackPerCoexistenceRatioResult Writable Attributes

Rfc2544Back2BackPerCoexistenceRatioResult Read-Only Attributes

Read-Only Attribute
Description
AvgJitter
Type: double
Default: 0
AvgLatency
Type: double
Default: 0
BurstSize
Number test frames sent in one burst in one iteration of the test.
Type: u64
Default: 0
ChecksumErrorCount

Type: u64
Default: 0
ConfiguredFrameSize

Type: double
Default: 0
DuplicateFrameCount
Type: u64
Default: 0
DurationInSec

Type: double
Default: 0
ExpectedFrameCount

Type: u64
Default: 0
FcsErrorFrameCount
Type: u64
Default: 0
FloodCount
not use it.
Type: u64
Default: 0
FloodedFrameCount
Type: u64
Default: 0
ForwardingRate
Measured, average forwarding rate of the Device Under Test (DUT) in frames per second (fps) during the test.
Type: double
Default: 0
iMIX distribution.
Type: string
Default: N/A
2181
Read-Only Attribute
Description
FrameLoss
Frame loss.
Type: u64
Default: 0
FrameRate
not use it.
Type: double
Default: 0
FrameSize
Frame size.
Type: double
Default: 0
FrameSizeType
Frame size iteration mode.

Type: string
Default: 0
IntendedLoad
Number of frames per second that the application attempts to transmit to a DUT/SUT for forwarding to a specified
output interface or interfaces.
Type: double
Default: 0
IterationNum
not use it.
Iteration number.
Type: u8
Default: 0
LoadSize
not use it.
Traffic load.
Type: double
Default: 0
LoadSizeType
Type: string
Default: 0
MaxJitter
Type: double
Default: 0
MaxLatency
Type: double
Default: 0
MbpsLineRate
not use it.
Type: double
Default: 0
MinJitter
Type: double
Default: 0
MinLatency
Type: double
Default: 0
OfferedLoad

Type: double
Default: 0
OtherFrameCount

Type: u64
Default: 0
2182
Read-Only Attribute
Description
OutOfSeqCount
Type: u64
Default: 0
PauseFrameCount
Type: u64
Default: 0
PercentLoss

Type: double
Default: 0
PfcFrameCount

Type: u64
Default: 0
not use it.
Type: u64
Default: 0
RxFrameCount
Received frame count.

Type: u64
Default: 0
RxNonSigFrameCount
not use it.
Type: u64
Default: 0
RxSigFrameCount
not use it.
Type: u64
Default: 0
SearchKey

Type: string
Default: N/A

Type: string
Default: N/A
TrialNum

Type: u8
Default: 0
TxFrameCount
Transmitted frame count.

Type: u64
Default: 0
TxFrameRate

Type: double
Default: 0
TxMbpsLoad

Type: double
Default: 0
TxSigFrameCount
not use it.
Type: u64
Default: 0
2183
Rfc2544Back2BackPerFrameSizeResult
Description:

Parents: Project
Relations:
Side name
(Type)
Relative
Description
ResultParent
(ResultChild)
Rfc2544Back2BackPerFrameSizeResult Writable Attributes

Rfc2544Back2BackPerFrameSizeResult Read-Only Attributes

Read-Only Attribute
Description
AvgJitter
Type: double
Default: 0
AvgLatency
Type: double
Default: 0
BurstSize
Type: u64
Default: 0
ChecksumErrorCount

Type: u64
Default: 0
ConfiguredFrameSize

Type: double
Default: 0
DuplicateFrameCount
Type: u64
Default: 0
DurationInSec

Type: double
Default: 0
ExpectedFrameCount

Type: u64
Default: 0
FcsErrorFrameCount
Type: u64
Default: 0
FloodCount
not use it.
Type: u64
Default: 0
2184
Read-Only Attribute
Description
FloodedFrameCount
Type: u64
Default: 0
ForwardingRate
Type: double
Default: 0
iMIX distribution.
Type: string
Default: N/A
FrameLoss
Frame loss.
Type: u64
Default: 0
FrameRate
not use it.
Type: double
Default: 0
FrameSize
Frame size.
Type: double
Default: 0
FrameSizeType
Frame size iteration mode.

Type: string
Default: 0
IntendedLoad
Type: double
Default: 0
IterationNum
not use it.
Iteration number.
Type: u8
Default: 0
LoadSize
not use it.
Traffic load.
Type: double
Default: 0
LoadSizeType
Type: string
Default: 0
MaxJitter
Type: double
Default: 0
MaxLatency
Type: double
Default: 0
MbpsLineRate
not use it.
Type: double
Default: 0
MinJitter
Type: double
Default: 0
2185
Read-Only Attribute
Description
MinLatency
Type: double
Default: 0
OfferedLoad

Type: double
Default: 0
OtherFrameCount

Type: u64
Default: 0
OutOfSeqCount
Type: u64
Default: 0
PauseFrameCount
Type: u64
Default: 0
PercentLoss

Type: double
Default: 0
PfcFrameCount

Type: u64
Default: 0
not use it.
Type: u64
Default: 0
RxFrameCount

Type: u64
Default: 0
RxNonSigFrameCount
not use it.
Type: u64
Default: 0
RxSigFrameCount
not use it.
Type: u64
Default: 0
SearchKey

Type: string
Default: N/A

Type: string
Default: N/A
TrialNum

Type: u8
Default: 0
TxFrameCount

Type: u64
Default: 0
2186
Rfc2544Back2BackPerIterationResult
Read-Only Attribute
Description
TxFrameRate

Type: double
Default: 0
TxMbpsLoad

Type: double
Default: 0
TxSigFrameCount
not use it.
Type: u64
Default: 0
Description:

Parents: Project
Relations:
Side name
(Type)
Relative
Description
ResultParent
(ResultChild)
Rfc2544Back2BackPerIterationResult Writable Attributes

Rfc2544Back2BackPerIterationResult Read-Only Attributes

Read-Only Attribute
Description
AvgJitter
Type: double
Default: 0
AvgLatency
Type: double
Default: 0
BurstSize
Number of test frames sent in one burst in one iteration of the test.
Type: u64
Default: 0
ChecksumErrorCount

Type: u64
Default: 0
ConfiguredFrameSize

Type: double
Default: 0
2187
Read-Only Attribute
Description
DuplicateFrameCount
Type: u64
Default: 0
DurationInSec

Type: double
Default: 0
ExpectedFrameCount

Type: u64
Default: 0
FcsErrorFrameCount
Type: u64
Default: 0
FloodCount
not use it.
Type: u64
Default: 0
FloodedFrameCount
Type: u64
Default: 0
ForwardingRate
Type: double
Default: 0
Specifies the name of the iMIX distribution when frame size type is iMIX.
Type: string
Default: N/A
FrameLoss
Frame loss.
Type: u64
Default: 0
FrameRate
not use it.
Type: double
Default: 0
FrameSize
Average frame size being transmitted.

Type: double
Default: 0
FrameSizeType
Specifies the frame size type. Can be Fixed, Random, or iMIX.

Type: string
Default: 0
IntendedLoad
Type: double
Default: 0
IterationNum
not use it.
Iteration number.
Type: u8
Default: 0
2188
Read-Only Attribute
Description
LoadSize
not use it.
Traffic load.
Type: double
Default: 0
LoadSizeType
Type: string
Default: 0
MaxJitter
Type: double
Default: 0
MaxLatency
Type: double
Default: 0
MbpsLineRate
not use it.
Type: double
Default: 0
MinJitter
Type: double
Default: 0
MinLatency
Type: double
Default: 0
OfferedLoad

Type: double
Default: 0
OtherFrameCount

Type: u64
Default: 0
OutOfSeqCount
Type: u64
Default: 0
PauseFrameCount
Type: u64
Default: 0
PercentLoss

Type: double
Default: 0
PfcFrameCount

Type: u64
Default: 0
not use it.
Type: u64
Default: 0
RxFrameCount

Type: u64
Default: 0
2189
Rfc2544Back2BackPerLoadResult
Read-Only Attribute
Description
RxNonSigFrameCount
not use it.
Type: u64
Default: 0
RxSigFrameCount
not use it.
Type: u64
Default: 0
SearchKey

Type: string
Default: N/A

Type: string
Default: N/A
TrialNum

Type: u8
Default: 0
TxFrameCount

Type: u64
Default: 0
TxFrameRate

Type: double
Default: 0
TxMbpsLoad

Type: double
Default: 0
TxSigFrameCount
not use it.
Type: u64
Default: 0
Description:

Parents: Project
Relations:
Side name
(Type)
Relative
Description
ResultParent
(ResultChild)
Rfc2544Back2BackPerLoadResult Writable Attributes

2190
Rfc2544Back2BackPerLoadResult Read-Only Attributes

Read-Only Attribute
Description
AvgJitter

Type: double
Default: 0
AvgLatency
Average latency (in microseconds).

Type: double
Default: 0
BurstSize
Type: u64
Default: 0
ChecksumErrorCount

Type: u64
Default: 0
ConfiguredFrameSize

Type: double
Default: 0
DuplicateFrameCount
Type: u64
Default: 0
DurationInSec
Duration in secs for which the RFC 2544 Back to Back frames test was run.
Type: double
Default: 0
ExpectedFrameCount

Type: u64
Default: 0
FcsErrorFrameCount
Type: u64
Default: 0
FloodCount
not use it.
Type: u64
Default: 0
FloodedFrameCount
Type: u64
Default: 0
ForwardingRate
Type: double
Default: 0
iMIX distribution.
Type: string
Default: N/A
FrameLoss
Frame loss.
Type: u64
Default: 0
FrameRate
not use it.
Number of frames transmitted during the last one-second interval.
Type: double
Default: 0
2191
Read-Only Attribute
Description
FrameSize
Frame size.
Type: double
Default: 0
FrameSizeType
Type of frame size. RANDOM, FIXED, IMIX.

Type: string
Default: 0
IntendedLoad
Type: double
Default: 0
IterationNum
not use it.
Iteration number.
Type: u8
Default: 0
LoadSize
not use it.
Traffic load.
Type: double
Default: 0
LoadSizeType
Load size type (fixed or random).

Type: string
Default: 0
MaxJitter

Type: double
Default: 0
MaxLatency
Maximum latency (in microseconds).

Type: double
Default: 0
MbpsLineRate
not use it.
Type: double
Default: 0
MinJitter

Type: double
Default: 0
MinLatency
Minimum latency (in microseconds).

Type: double
Default: 0
OfferedLoad

Type: double
Default: 0
OtherFrameCount

Type: u64
Default: 0
OutOfSeqCount

Type: u64
Default: 0
PauseFrameCount
Type: u64
Default: 0
2192
Rfc2544Back2BackTestResult
Read-Only Attribute
Description
PercentLoss

Type: double
Default: 0
PfcFrameCount

Type: u64
Default: 0
not use it.
Type: u64
Default: 0
RxFrameCount

Type: u64
Default: 0
RxNonSigFrameCount
not use it.
Type: u64
Default: 0
RxSigFrameCount
not use it.
Type: u64
Default: 0
SearchKey

Type: string
Default: N/A

Type: string
Default: N/A
TrialNum

Type: u8
Default: 0
TxFrameCount

Type: u64
Default: 0
TxFrameRate

Type: double
Default: 0
TxMbpsLoad

Type: double
Default: 0
TxSigFrameCount
not use it.
Type: u64
Default: 0
Description:
2193

Parents: Project
Relations:
Side name
(Type)
Relative
Description
ResultParent
(ResultChild)
Rfc2544BackToBackFramesConfig, Rfc2544FrameLossConfig,
Rfc2544LatencyConfig, Rfc2544ThroughputConfig

object.
Rfc2544Back2BackTestResult Writable Attributes

Rfc2544Back2BackTestResult Read-Only Attributes

Read-Only Attribute
Description
BurstSize
Type: u64
Default: 0
ChecksumErrorCount

Type: u64
Default: 0
ConfiguredFrameSize

Type: double
Default: 0
DuplicateFrameCount
Type: u64
Default: 0
ExpectedFrameCount

Type: u64
Default: 0
FcsErrorFrameCount
Type: u64
Default: 0
FloodCount
not use it.
Type: u64
Default: 0
FloodedFrameCount
Type: u64
Default: 0
Type: string
Default: N/A
FrameLoss
Type: u64
Default: 0
FrameRate
not use it.
Type: double
Default: 0
2194
Read-Only Attribute
Description
FrameSize

Type: double
Default: 0
FrameSizeType

Type: string
Default: 0
IntendedLoad
Type: double
Default: 0
IterationTotal
Total number of iterations.

Type: u8
Default: 0
LoadSize
not use it.
Traffic load.
Type: double
Default: 0
LoadSizeType
Type: string
Default: 0
OfferedLoad

Type: double
Default: 0
OtherFrameCount

Type: u64
Default: 0
PauseFrameCount
Type: u64
Default: 0
PercentLoss

Type: double
Default: 0
PfcFrameCount

Type: u64
Default: 0
not use it.
Type: u64
Default: 0
RxFrameCount

Type: u64
Default: 0
RxNonSigFrameCount
not use it.
Type: u64
Default: 0
RxSigFrameCount
not use it.
Type: u64
Default: 0
2195
Rfc2544BackToBackFramesConfig
Read-Only Attribute
Description
TotalFrameLoss
Total frames lost.

Type: u64
Default: 0
TxFrameCount

Type: u64
Default: 0
TxFrameRate

Type: double
Default: 0
TxSigFrameCount
not use it.
Type: u64
Default: 0
Description:
Back-to-back test measures the buffering capability of the DUT/SUT by sending bursts of traffic at the maximum frame rate (line rate) and measuring the
longest burst size (in number of packets) at which no packets are dropped.

Parents: AccessConcentratorGenParams, Project, Rfc2544Back2BackTestResult, Rfc2544FrameLossTestResult, Rfc2544LatencyTestResult,
Rfc2544ThroughputTestResult
Children: BenchmarkEthernet10GigPortConfig, Rfc2544BackToBackFramesProfile
Relations:
Side name
(Type)
Relative
(BenchmarkingTestCaseRootCommand)
Description
Sequencer test config.
GroupType
GroupType, GroupType
Type of side group.
Relation describing the binding to the traffic

descriptor group.
Rfc2544BackToBackFramesConfig Writable Attributes

Writable Attribute
Description
Active, Name
CustomFrameSizeList
User defined list of frame sizes.

Type: u16
Default: 0
CustomLoadList
List of user defined load values.

Type: double
Default: 0
Delay after transmission in seconds.

Type: u16
Default: 15
Range: 1 - 3600
2196
Writable Attribute
Description
DurationAcceptableFrameLoss
Finest adjustment possible, in frame loss percentage, for the duration of transmitted frames from iteration to iteration.
Type: double
Default: 0.0
Range: 0 - 100.0
DurationBursts

Type: u32
Default: 1000
Range: 1 - 16777215
DurationMode
Type: enum
Default: SECONDS
Possible Values:
Value
Description
SECONDS Set duration mode to time in seconds.
BURSTS
Set duration mode to number of frames per transmission burst.
DurationResolutionAsBursts
Finest adjustment possible, in number of frames, for the duration of transmitted frames from iteration to iteration.
Type: u32
Default: 100
Range: 1 - 16777215
DurationResolutionAsSeconds
Finest adjustment possible, in number of seconds, for the duration of transmitted frames from iteration to iteration.
Type: double
Default: 0.0001
Range: 0.000064 - 5184000
DurationSeconds

Type: u32
Default: 100
Range: 1 - 5184000
Enable Detailed Result collection.

Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
Deletes the detailed result iteration database file at the end of the test.
FALSE Retains the detailed result iteration database file at the end of the test.
EnableExposedInternalCommands
Whether to display the expanded sequence of component commands of the benchmarking test being configured.
Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
Display the sequence of component commands of the benchmarking test being configured.
FALSE Display the monolithic sequencer command for the benchmarking test being configured.
EnableFrameSizeOnTest
Whether to use the test frame size value.

Type: bool
Default: TRUE
Possible Values:
Value Description
TRUE
Use the test frame size.
FALSE Do not use the test frame size.
2197
Writable Attribute
Description
EnableJitterMeasurement
Allow measuring min, maximum and average jitter values. This is done by running the test in 'Jitter' analyzer result
view mode.
Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
Measures minimum, maximum and average jitter values.
FALSE Does not measure minimum, maximum and average jitter values.
EnableLearning
Whether to enable learning mode.

Type: bool
Default: TRUE
Possible Values:
Value Description
TRUE
Enable learning mode.
FALSE Disable learning mode.

Port starting times will be staggered as specified by StaggerStartDelay.

Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
FALSE Port starting times will not be staggered.

EnableTrafficVerification
Boolean to control whether to add verification commands to the test sequence.

Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
Add commands to verify traffic forwarding to the test sequence.
FALSE Do not add commands to verify traffic forwarding to the test sequence.
FrameSizeEnd
Maximum frame size when using Step mode for incrementing the frame size. This attribute is ignored if
FrameSizeIterationMode is set to RANDOM or CUSTOM.
Type: u16
Default: 256
Range: 47 - 16383
Mode for adjusting the frame size from iteration to iteration.

Type: enum
Default: CUSTOM
Possible Values:
Value
Description
RANDOM Random mode. The frame size is randomly chosen within the range set by RandomMinFrameSize and
RandomMaxFrameSize.
STEP
Step mode. The frame size increases by FrameSizeStep with each test iteration, beginning with
FrameSizeStart and increasing to FrameSizeEnd.
CUSTOM Custom mode. CustomFrameSizeList specifies the frame sizes.

IMIX
iMIX mode. List of iMIX distributions are specified.
NONE
No frame size is specified. Will use the frame size(s) of selected stream block(s).
FrameSizeStart
Starting frame size when using Step mode for incrementing the frame size. This attribute is ignored if
Type: u16
Default: 128
Range: 47 - 16383
FrameSizeStep
Step value for incrementing the frame size for Step mode from FrameSizeStart to FrameSizeEnd. This attribute is
ignored if FrameSizeIterationMode is set to RANDOM or CUSTOM.
Type: u16
Default: 128
Range: 1 - 16383
2198
Writable Attribute
Description
List of iMIX distribution handles.

Type: handle
Default: 0
ImixDistributionString
iMIX distribution string. For display purposes only.

Type: string
L2DelayBeforeLearning
Delay before learning in seconds.

Type: u16
Default: 2
Range: 0 - 3600
L2LearningFrameRate
Layer 2 learning rate for the test in frames per second.

Type: u32
Default: 1000
Range: 1 - 14880952
Number of ping packets to send to the layer 2 destination address.

Type: u16
Default: 5
Range: 1 - 100
Delay before L3 learning.

Type: u16
Default: 2
Range: 0 - 3600
L3EnableCyclicAddrResolution
Whether to enable Layer 3 cyclic address resolution.

Type: bool
Default: TRUE
Possible Values:
Value Description
TRUE
Enable Layer 3 cyclic address resolution.
FALSE Cyclic address resolution is not enabled.

L3Rate
L3 learning rate.
Type: u32
Default: 1000
L3RetryCount
Number of Layer 3 retry attempts allowed.

Type: u16
Default: 5
Range: 1 - 100
LatencyType
Device latency type.

Type: enum
Default: LILO
Possible Values:
Value Description
LILO
Last-In Last-Out latency.
LIFO
Last-In First-Out latency (store-and-forward devices).
FIFO First-In First-Out latency (bit forwarding devices).

LearningFreqMode
Learning frequency.
Type: enum
Default: LEARN_ONCE
Possible Values:
Value
Description
LEARN_ONCE
Learn once.
LEARN_EVERY_TRIAL
Learn every trial.
LEARN_EVERY_FRAME_SIZE Learn for every new frame size.

LEARN_EVERY_ITERATION
Learn every iteration.
2199
Writable Attribute
Description
LearningMode
Learning mode.
Type: enum
Default: L3_LEARNING
Possible Values:
Value
Description
L2_LEARNING Layer 2 learning mode.
LoadEnd
When using Step mode for load on the ports, the maximum load for each port. This attribute is ignored if LoadType
is set to RANDOM or CUSTOM.
Type: double
Default: 50
LoadStart
When using Step mode for load on the ports, the starting load for each port. This attribute is ignored if LoadType is
set to RANDOM or CUSTOM.
Type: double
Default: 10
LoadStep
Step value for incrementing the load for Step mode from LoadStart to LoadEnd. This attribute is ignored if LoadType
Type: double
Default: 10
Range: 0.001 - 100000000000.0
LoadType
Mode for adjusting the load from iteration to iteration.

Type: enum
Default: CUSTOM
Possible Values:
Value
Description
RANDOM Random load type. The load rate is randomly chosen within the range set by RandomMinLoad and
RandomMaxLoad.
STEP
Step load type. The load increases by LoadStep with each test iteration, beginning with LoadStart and
increasing to LoadEnd.
CUSTOM Custom mode. CustomLoadList specifies the load rates.

LoadUnits
Type: enum
Possible Values:
Value
Description
PERCENT_LINE_RATE
FRAMES_PER_SECOND
Frames per second.
INTER_BURST_GAP
Inter burst gap.

KILOBITS_PER_SECOND
BITS_PER_SECOND
Bits per second.
NumOfTrials
Number of times the test repeats with its initial configuration. Each trial is based on the same parameter values.
Within a trial, certain parameter values vary with each iteration, according to the test methodology and setup. At the
start of the next trial, these parameters revert to their initial values.
Type: u16
Default: 50
Range: 1 - 60
ProfileConfigGroupType
Profile group type.

Type: string
2200
Writable Attribute
Description
ProfileConfigMode
Profile configuration mode.

Type: enum
Default: MANUAL
Possible Values:
Value
Description
MANUAL
User configures the profile.
PER_PORT
One profile per port.
PER_SIDE
One profile per side.
PER_GROUP One profile per group.

RandomMaxFrameSize
When using Random mode for FrameSizeIterationMode, the maximum frame size. This attribute is ignored if
FrameSizeIterationMode is set to STEP or CUSTOM.
Type: u16
Default: 256
Range: 47 - 16383
RandomMaxLoad
is set to STEP or CUSTOM.
Type: double
Default: 50
RandomMinFrameSize
When using Random mode for FrameSizeIterationMode, the minimum frame size. This attribute is ignored if
Type: u16
Default: 128
Range: 47 - 16383
RandomMinLoad
Type: double
Default: 10
StaggerStartDelay
Delay between starting successive ports, in milliseconds. Ignored when EnablePauseBeforeTraffic is FALSE.
Type: u16
Default: 0
Range: 0 - 65535
ThroughputRatePercent
Throughput rate in percentage.

Type: double
Default: 100.0
TrafficStartDelay
Traffic start delay in seconds.

Type: double
Default: 2
Range: 0.005 - 3600
TrafficStartDelayMode
When to begin the traffic start delay.

Type: enum
Default: AFTER_TEST
Possible Values:
Value
Description
AFTER_TEST
Start traffic after test begins.
AFTER_USER_RESPONSE Start traffic after user response.

TrafficVerificationAbortOnFail
Boolean to specify test behavior when traffic verification fails.

Type: bool
Default: TRUE
Possible Values:
Value Description
TRUE
Abort the test and set the sequencer status mode to FAIL if traffic verification is not successful.
FALSE Do nothing. Test continues without interruption.
2201
Rfc2544BackToBackFramesProfile
Writable Attribute
Description
Specifies when to perform traffic verification during the test.

Type: enum
Default: VERIFY_EVERY_ITERATION
Possible Values:
Value
Description
VERIFY_EVERY_TRIAL
Verify traffic forwarding at the beginning of every trial.
VERIFY_EVERY_FRAME_SIZE Verify traffic forwarding after changing the frame size.

VERIFY_EVERY_ITERATION
Verify traffic forwarding at the beginning of every iteration.
Specifies the number of frames to use for traffic verification.

Type: u16
Default: 100
Range: 1 - 32767
Specifies the traffic rate in frames per second to use for traffic verification.
Type: u32
Default: 1000
Range: 1 - 14880952
UseExistingStreamBlocks
Enables or disables the use of existing pre-configured stream blocks for the test.
Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
Use existing stream blocks for the test.
FALSE Allow the application to generate new stream blocks to be used for the test.
UseThroughputRates
Specifies that the test will use rates derived from the throughput test. Applicable only for asymmetric tests only.
Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
Test will use rates derived from the throughput test.
FALSE Test will use user-defined rates.
Rfc2544BackToBackFramesConfig Read-Only Attributes

Rfc2544BackToBackFramesProfile
Description:
Profile that specifies frame sizes for RFC 2544 ToBackFrames test.

Parents: Rfc2544BackToBackFramesConfig
Automatically-created children: Rfc2544ProfileRate
Relations:
Side name
(Type)
Relative
Description
StreamBlocks
(StreamBlockBinding)
StreamBlock
A link to the streamblocks assigned to the profile.
2202
Rfc2544FrameLossConfig
Rfc2544BackToBackFramesProfile Writable Attributes

Writable Attribute
Description
Active, Name
LoadSpecMode
Mode used to specify load for this profile.

Type: enum
Default: PER_PORT
Possible Values:
Value
Description
PER_PORT
Load specified is the total load per port.
PER_STREAMBLOCK Load specified is the total load for each stream block.
LoadUnits
Type: enum
Possible Values:
Value
Description
PERCENT_LINE_RATE
FRAMES_PER_SECOND
Frames per second.
ProfileRateMode
KILOBITS_PER_SECOND
BITS_PER_SECOND
Bits per second.
Profile load usage.

Type: enum
Default: PER_TEST
Possible Values:
Value
Description
PER_TEST
One load profile for all frame sizes.
PER_FRAME_SIZE One load profile for each frame size.
Rfc2544BackToBackFramesProfile Read-Only Attributes

Description:
This test determines the frame loss ratio of a DUT/SUT throughout a range of loads (transmission rates) and frame sizes. This test characterizes the performance
of a DUT/SUT under heavily loaded states, by measuring the ratio of packets that are not forwarded due to lack of resources.

Children: BenchmarkEthernet10GigPortConfig, Rfc2544FrameLossProfile
Relations:
Side name
(Type)
Relative
GroupType
Description
2203
Type of side group.
Side name
(Type)
Relative
Description
Relation describing the binding with the Traffic

Descriptor Group.
Rfc2544FrameLossConfig Writable Attributes

Writable Attribute
Description
Active, Name
CustomFrameSizeList
List of user-defined custom frame sizes.

Type: u16
Default: 0
CustomLoadList
Custom loads used in the test.

Type: double
Default: 0

Type: u16
Default: 15
Range: 1 - 3600
DurationBursts

Type: u32
Default: 1000
Range: 1 - 16777215
DurationMode
Type: enum
Default: SECONDS
Possible Values:
Value
Description
BURSTS
DurationSeconds

Type: u32
Default: 100
Range: 1 - 5184000
Whether Detailed Results Collection is enabled or disabled.

Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
Enable Detailed Results Collection.
FALSE Disable Detailed Results Collection.

Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
2204
Writable Attribute
Description
Indicates whether to use the test frame size value.

Type: bool
Default: TRUE
Possible Values:
Value Description
TRUE

Whether to enable or disable jitter measurements.

Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
Test is run in 'Jitter' analyzer result view mode.
FALSE Default analyzer result view mode for the test is used.
EnableLearning

Type: bool
Default: TRUE
Possible Values:
Value Description
TRUE

EnableLoadLoopShortCircuit
Halt load iteration loop after multiple PASS iterations.

Type: bool
Default: TRUE
Possible Values:
Value Description
TRUE
Enabled.
FALSE Disabled.

Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE


Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
FrameSizeEnd
Type: u16
Default: 256
Range: 47 - 16383
2205
Writable Attribute
Description

Type: enum
Default: CUSTOM
Possible Values:
Value
Description
RandomMaxFrameSize.
STEP

IMIX
iMIX mode.
NONE
Frame size mode not specified.
FrameSizeStart
Type: u16
Default: 128
Range: 47 - 16383
FrameSizeStep
Type: u16
Default: 128
Range: 1 - 16383
List of iMIX distributions.

Type: handle
Default: 0

Type: string

Type: u16
Default: 2
Range: 0 - 3600
L2LearningFrameRate

Type: u32
Default: 1000
Range: 1 - 14880952
Number of Ping packets to send to the layer 2 destination address.

Type: u16
Default: 5
Range: 1 - 100

Type: u16
Default: 2
Range: 0 - 3600

Type: bool
Default: TRUE
Possible Values:
Value Description
TRUE

L3Rate
Rate to send ARP requests.

Type: u32
Default: 1000
2206
Writable Attribute
Description
L3RetryCount

Type: u16
Default: 5
Range: 1 - 100
LatencyType

Type: enum
Default: LILO
Possible Values:
Value Description
LILO
LIFO

LearningFreqMode
Learning frequency.
Type: enum
Default: LEARN_ONCE
Possible Values:
Value
Description
LEARN_ONCE
Learn once.
LEARN_EVERY_TRIAL
Learn every trial.

LearningMode
Learn for every iteration.
Learning mode.
Type: enum
Possible Values:
Value
Description
LoadEnd
Type: double
Default: 10
LoadStart
Type: double
Default: 100
LoadStep
Type: double
Default: 10
Range: 0.001 - 100000000000.0
LoadType

Type: enum
Default: STEP
Possible Values:
Value
Description
RANDOM Random load type. The load size is randomly chosen within the range set by RandomMinLoad and
RandomMaxLoad.
STEP
CUSTOM Custom mode. CustomLoadList specifies the load sizes.
2207
Writable Attribute
Description
LoadUnits
Type: enum
Possible Values:
Value
Description
PERCENT_LINE_RATE
FRAMES_PER_SECOND
Frames per second.
INTER_BURST_GAP
Load expressed by inter-burst gap.

KILOBITS_PER_SECOND
BITS_PER_SECOND
Bits per second.
NumOfTrials
Type: u16
Default: 20
Range: 1 - 60
PassLoadLoopCount
Number of load loops passed.

Type: u16
Default: 2
Range: 1 - 65535
Group type used to assign profiles.

Type: string
ProfileConfigMode
Mode used to specify the mode used for creating profiles.

Type: enum
Default: MANUAL
Possible Values:
Value
Description
MANUAL
User configures profiles.
PER_PORT
PER_SIDE

RandomMaxFrameSize
When using Random mode for setting frame sizes, the maximum frame size. This attribute is ignored if
Type: u16
Default: 256
Range: 47 - 16383
RandomMaxLoad
Type: double
Default: 50
RandomMinFrameSize
When using Random mode for setting frame sizes, the minimum frame size. This attribute is ignored if
Type: u16
Default: 128
Range: 47 - 16383
RandomMinLoad
Type: double
Default: 10
StaggerStartDelay
Type: u16
Default: 0
Range: 0 - 65535
2208
Writable Attribute
Description
Percentage of throughput rate to use.

Type: double
Default: 100.0
TrafficStartDelay

Type: double
Default: 2
Range: 0.005 - 3600

Type: enum
Default: AFTER_TEST
Possible Values:
Value
Description
AFTER_TEST


Type: bool
Default: TRUE
Possible Values:
Value Description
TRUE


Type: enum
Possible Values:
Value
Description
VERIFY_EVERY_TRIAL


Type: u16
Default: 100
Range: 1 - 32767
Type: u32
Default: 1000
Range: 1 - 14880952
Whether to use existing stream blocks.

Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
Use existing stream blocks.
FALSE Does not use existing stream blocks.

UseThroughputRates
Specifies that the test will use rates derived from the throughput test.
Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
Test uses rates derived from the throughput test.
FALSE Test does not use rates derived from the throughput test.
2209
Rfc2544FrameLossPerCoexistenceRatioResult
Rfc2544FrameLossConfig Read-Only Attributes

Description:
Result object.

Parents: Project
Relations:
Side name
(Type)
Relative
Description
ResultParent
(ResultChild)
Rfc2544FrameLossPerCoexistenceRatioResult Writable Attributes

Rfc2544FrameLossPerCoexistenceRatioResult Read-Only Attributes

Read-Only Attribute
Description
AvgJitter
Type: double
Default: 0
AvgLatency
Type: double
Default: 0
BurstSize

Type: u64
Default: 0
ChecksumErrorCount

Type: u64
Default: 0
ConfiguredFrameSize

Type: double
Default: 0
DuplicateFrameCount
Type: u64
Default: 0
ExpectedFrameCount

Type: u64
Default: 0
FcsErrorFrameCount
Type: u64
Default: 0
2210
Read-Only Attribute
Description
FloodCount
do not use it.
Type: u64
Default: 0
FloodedFrameCount
Type: u64
Default: 0
ForwardingRate
Type: double
Default: 0
iMIX distribution.
Type: string
Default: N/A
FrameLoss
Type: u64
Default: 0
FrameRate
do not use it.
Type: double
Default: 0
FrameSize
Frame size.
Type: double
Default: 0
FrameSizeType
Frame size type.

Type: string
Default: 0
IntendedLoad
Type: double
Default: 0
Ipv4AvgJitter

Type: double
Default: 0
Ipv4AvgLatency

Type: double
Default: 0
Ipv4FrameLoss

Type: u64
Default: 0
Ipv4IntendedLoad

Type: double
Default: 0
Ipv4MaxJitter

Type: double
Default: 0
Ipv4MaxLatency

Type: double
Default: 0
2211
Read-Only Attribute
Description
Ipv4MinJitter

Type: double
Default: 0
Ipv4MinLatency

Type: double
Default: 0
Ipv4OfferedLoad

Type: double
Default: 0
Ipv4RxFrameCount

Type: u64
Default: 0
Ipv4TxFrameCount

Type: u64
Default: 0
Ipv4TxFrameRate

Type: double
Default: 0
Ipv6AvgJitter

Type: double
Default: 0
Ipv6AvgLatency

Type: double
Default: 0
Ipv6ExtensionHeader

Type: string
Default: N/A
Ipv6FrameLoss

Type: u64
Default: 0
Ipv6IntendedLoad

Type: double
Default: 0

Type: string
Default: N/A
Ipv6MaxJitter

Type: double
Default: 0
Ipv6MaxLatency

Type: double
Default: 0
Ipv6MinJitter

Type: double
Default: 0
Ipv6MinLatency

Type: double
Default: 0
Ipv6OfferedLoad

Type: double
Default: 0
2212
Read-Only Attribute
Description
Ipv6RxFrameCount

Type: u64
Default: 0
Ipv6TxFrameCount

Type: u64
Default: 0
Ipv6TxFrameRate

Type: double
Default: 0
IterationNum
do not use it.
Iteration number.
Type: u8
Default: 0
LoadSize
do not use it.
Traffic load.
Type: double
Default: 0
LoadSizeType
Load size type.

Type: string
Default: 0
MaxJitter
Largest jitter value calculated from all measured jitter values in microseconds.
Type: double
Default: 0
MaxLatency
Type: double
Default: 0
MbpsLineRate
do not use it.
Type: double
Default: 0
MinJitter
Type: double
Default: 0
MinLatency
Type: double
Default: 0
OfferedLoad

Type: double
Default: 0
OtherFrameCount

Type: u64
Default: 0
OutOfSeqCount

Type: u64
Default: 0
PauseFrameCount
Type: u64
Default: 0
2213
Rfc2544FrameLossPerFrameSizeResult
Read-Only Attribute
Description
PercentLoss

Type: double
Default: 0
PfcFrameCount

Type: u64
Default: 0
do not use it.
Type: u64
Default: 0
RxFrameCount

Type: u64
Default: 0
RxNonSigFrameCount
do not use it.
Type: u64
Default: 0
RxSigFrameCount
do not use it.
Type: u64
Default: 0
SearchKey

Type: string
Default: N/A

Type: string
Default: N/A
TrialNum

Type: u8
Default: 0
TxFrameCount

Type: u64
Default: 0
TxFrameRate

Type: double
Default: 0
TxMbpsLoad

Type: double
Default: 0
TxSigFrameCount
do not use it.
Type: u64
Default: 0
Description:
2214

Parents: Project
Relations:
Side name
(Type)
Relative
Description
ResultParent
(ResultChild)
Rfc2544FrameLossPerFrameSizeResult Writable Attributes

Rfc2544FrameLossPerFrameSizeResult Read-Only Attributes

Read-Only Attribute
Description
AvgJitter
Type: double
Default: 0
AvgLatency
Type: double
Default: 0
BurstSize

Type: u64
Default: 0
ChecksumErrorCount

Type: u64
Default: 0
ConfiguredFrameSize

Type: double
Default: 0
DuplicateFrameCount
Type: u64
Default: 0
ExpectedFrameCount

Type: u64
Default: 0
FcsErrorFrameCount
Type: u64
Default: 0
FloodCount
do not use it.
Type: u64
Default: 0
FloodedFrameCount
Type: u64
Default: 0
ForwardingRate
test.
Type: double
Default: 0
2215
Read-Only Attribute
Description
iMIX distribution.
Type: string
Default: N/A
FrameLoss
Frame loss.
Type: u64
Default: 0
FrameRate
do not use it.
Type: double
Default: 0
FrameSize
Frame size.
Type: double
Default: 0
FrameSizeType
Frame size type.

Type: string
Default: 0
IntendedLoad
Type: double
Default: 0
Ipv4AvgJitter

Type: double
Default: 0
Ipv4AvgLatency

Type: double
Default: 0
Ipv4FrameLoss

Type: u64
Default: 0
Ipv4IntendedLoad

Type: double
Default: 0
Ipv4MaxJitter

Type: double
Default: 0
Ipv4MaxLatency

Type: double
Default: 0
Ipv4MinJitter

Type: double
Default: 0
Ipv4MinLatency

Type: double
Default: 0
Ipv4OfferedLoad

Type: double
Default: 0
Ipv4RxFrameCount

Type: u64
Default: 0
2216
Read-Only Attribute
Description
Ipv4TxFrameCount

Type: u64
Default: 0
Ipv4TxFrameRate

Type: double
Default: 0
Ipv6AvgJitter

Type: double
Default: 0
Ipv6AvgLatency

Type: double
Default: 0
Ipv6ExtensionHeader

Type: string
Default: N/A
Ipv6FrameLoss

Type: u64
Default: 0
Ipv6IntendedLoad

Type: double
Default: 0

Type: string
Default: N/A
Ipv6MaxJitter

Type: double
Default: 0
Ipv6MaxLatency

Type: double
Default: 0
Ipv6MinJitter

Type: double
Default: 0
Ipv6MinLatency

Type: double
Default: 0
Ipv6OfferedLoad

Type: double
Default: 0
Ipv6RxFrameCount

Type: u64
Default: 0
Ipv6TxFrameCount

Type: u64
Default: 0
Ipv6TxFrameRate

Type: double
Default: 0
2217
Read-Only Attribute
Description
IterationNum
do not use it.
Iteration number.
Type: u8
Default: 0
LoadSize
do not use it.
Traffic load.
Type: double
Default: 0
LoadSizeType
Type: string
Default: 0
MaxJitter
Type: double
Default: 0
MaxLatency
Type: double
Default: 0
MbpsLineRate
do not use it.
Type: double
Default: 0
MinJitter
Type: double
Default: 0
MinLatency
Type: double
Default: 0
OfferedLoad

Type: double
Default: 0
OtherFrameCount

Type: u64
Default: 0
OutOfSeqCount
Type: u64
Default: 0
PauseFrameCount
Type: u64
Default: 0
PercentLoss

Type: double
Default: 0
PfcFrameCount

Type: u64
Default: 0
do not use it.
Type: u64
Default: 0
2218
Rfc2544FrameLossPerIpv6ExtensionHeaderResult
Read-Only Attribute
Description
RxFrameCount

Type: u64
Default: 0
RxNonSigFrameCount
do not use it.
Type: u64
Default: 0
RxSigFrameCount
do not use it.
Type: u64
Default: 0
SearchKey

Type: string
Default: N/A

Type: string
Default: N/A
TrialNum

Type: u8
Default: 0
TxFrameCount

Type: u64
Default: 0
TxFrameRate

Type: double
Default: 0
TxMbpsLoad

Type: double
Default: 0
TxSigFrameCount
do not use it.
Type: u64
Default: 0
Description:
Result object.

Parents: Project
Relations:
Side name
(Type)
Relative
Description
ResultParent
(ResultChild)
2219
Rfc2544FrameLossPerIpv6ExtensionHeaderResult Writable Attributes

Rfc2544FrameLossPerIpv6ExtensionHeaderResult Read-Only Attributes

Read-Only Attribute
Description
AvgJitter
Type: double
Default: 0
AvgLatency
Type: double
Default: 0
BurstSize

Type: u64
Default: 0
ChecksumErrorCount

Type: u64
Default: 0
ConfiguredFrameSize

Type: double
Default: 0
DuplicateFrameCount
Type: u64
Default: 0
ExpectedFrameCount

Type: u64
Default: 0
FcsErrorFrameCount
Type: u64
Default: 0
FloodCount
do not use it.
Type: u64
Default: 0
FloodedFrameCount
Type: u64
Default: 0
ForwardingRate
Type: double
Default: 0
iMIX distribution.
Type: string
Default: N/A
FrameLoss
Type: u64
Default: 0
FrameRate
do not use it.
Type: double
Default: 0
2220
Read-Only Attribute
Description
FrameSize
Frame size.
Type: double
Default: 0
FrameSizeType
Frame size type.

Type: string
Default: 0
IntendedLoad
Type: double
Default: 0
Ipv4AvgJitter

Type: double
Default: 0
Ipv4AvgLatency

Type: double
Default: 0
Ipv4FrameLoss

Type: u64
Default: 0
Ipv4IntendedLoad

Type: double
Default: 0
Ipv4MaxJitter

Type: double
Default: 0
Ipv4MaxLatency

Type: double
Default: 0
Ipv4MinJitter

Type: double
Default: 0
Ipv4MinLatency

Type: double
Default: 0
Ipv4OfferedLoad

Type: double
Default: 0
Ipv4RxFrameCount

Type: u64
Default: 0
Ipv4TxFrameCount

Type: u64
Default: 0
Ipv4TxFrameRate

Type: double
Default: 0
Ipv6AvgJitter

Type: double
Default: 0
2221
Read-Only Attribute
Description
Ipv6AvgLatency

Type: double
Default: 0
Ipv6ExtensionHeader

Type: string
Default: N/A
Ipv6FrameLoss

Type: u64
Default: 0
Ipv6IntendedLoad

Type: double
Default: 0

Type: string
Default: N/A
Ipv6MaxJitter

Type: double
Default: 0
Ipv6MaxLatency

Type: double
Default: 0
Ipv6MinJitter

Type: double
Default: 0
Ipv6MinLatency

Type: double
Default: 0
Ipv6OfferedLoad

Type: double
Default: 0
Ipv6RxFrameCount

Type: u64
Default: 0
Ipv6TxFrameCount

Type: u64
Default: 0
Ipv6TxFrameRate

Type: double
Default: 0
IterationNum
do not use it.
Iteration number.
Type: u8
Default: 0
LoadSize
do not use it.
Traffic load.
Type: double
Default: 0
LoadSizeType
Load size type.

Type: string
Default: 0
2222
Read-Only Attribute
Description
MaxJitter
Type: double
Default: 0
MaxLatency
Type: double
Default: 0
MbpsLineRate
do not use it.
Type: double
Default: 0
MinJitter
Type: double
Default: 0
MinLatency
Type: double
Default: 0
OfferedLoad

Type: double
Default: 0
OtherFrameCount

Type: u64
Default: 0
OutOfSeqCount

Type: u64
Default: 0
PauseFrameCount
Type: u64
Default: 0
PercentLoss

Type: double
Default: 0
PfcFrameCount

Type: u64
Default: 0
do not use it.
Type: u64
Default: 0
RxFrameCount

Type: u64
Default: 0
RxNonSigFrameCount
do not use it.
Type: u64
Default: 0
RxSigFrameCount
do not use it.
Type: u64
Default: 0
2223
Rfc2544FrameLossPerIterationResult
Read-Only Attribute
Description
SearchKey

Type: string
Default: N/A

Type: string
Default: N/A
TrialNum

Type: u8
Default: 0
TxFrameCount

Type: u64
Default: 0
TxFrameRate

Type: double
Default: 0
TxMbpsLoad

Type: double
Default: 0
TxSigFrameCount
do not use it.
Type: u64
Default: 0
Description:

Parents: Project
Relations:
Side name
(Type)
Relative
Description
ResultParent
(ResultChild)
Rfc2544FrameLossPerIterationResult Writable Attributes

Rfc2544FrameLossPerIterationResult Read-Only Attributes

Read-Only Attribute
Description
AvgJitter
Type: double
Default: 0
AvgLatency
Type: double
Default: 0
2224
Read-Only Attribute
Description
BurstSize

Type: u64
Default: 0
ChecksumErrorCount

Type: u64
Default: 0
ConfiguredFrameSize

Type: double
Default: 0
DuplicateFrameCount
Type: u64
Default: 0
ExpectedFrameCount

Type: u64
Default: 0
FcsErrorFrameCount
Type: u64
Default: 0
FloodCount
do not use it.
Type: u64
Default: 0
FloodedFrameCount
Type: u64
Default: 0
ForwardingRate
test.
Type: double
Default: 0
Type: string
Default: N/A
FrameLoss
Frame loss.
Type: u64
Default: 0
FrameRate
do not use it.
Type: double
Default: 0
FrameSize
Frame size.
Type: double
Default: 0
FrameSizeType

Type: string
Default: 0
IntendedLoad
Type: double
Default: 0
2225
Read-Only Attribute
Description
Ipv4AvgJitter

Type: double
Default: 0
Ipv4AvgLatency

Type: double
Default: 0
Ipv4FrameLoss

Type: u64
Default: 0
Ipv4IntendedLoad

Type: double
Default: 0
Ipv4MaxJitter

Type: double
Default: 0
Ipv4MaxLatency

Type: double
Default: 0
Ipv4MinJitter

Type: double
Default: 0
Ipv4MinLatency

Type: double
Default: 0
Ipv4OfferedLoad

Type: double
Default: 0
Ipv4RxFrameCount

Type: u64
Default: 0
Ipv4TxFrameCount

Type: u64
Default: 0
Ipv4TxFrameRate

Type: double
Default: 0
Ipv6AvgJitter

Type: double
Default: 0
Ipv6AvgLatency

Type: double
Default: 0
Ipv6ExtensionHeader

Type: string
Default: N/A
Ipv6FrameLoss

Type: u64
Default: 0
Ipv6IntendedLoad

Type: double
Default: 0
2226
Read-Only Attribute
Description

Type: string
Default: N/A
Ipv6MaxJitter

Type: double
Default: 0
Ipv6MaxLatency

Type: double
Default: 0
Ipv6MinJitter

Type: double
Default: 0
Ipv6MinLatency

Type: double
Default: 0
Ipv6OfferedLoad

Type: double
Default: 0
Ipv6RxFrameCount

Type: u64
Default: 0
Ipv6TxFrameCount

Type: u64
Default: 0
Ipv6TxFrameRate

Type: double
Default: 0
IterationNum
do not use it.
Iteration number.
Type: u8
Default: 0
LoadSize
do not use it.
Traffic load.
Type: double
Default: 0
LoadSizeType
Type: string
Default: 0
MaxJitter
Type: double
Default: 0
MaxLatency
Type: double
Default: 0
MbpsLineRate
do not use it.
Type: double
Default: 0
2227
Read-Only Attribute
Description
MinJitter
Type: double
Default: 0
MinLatency
Type: double
Default: 0
OfferedLoad

Type: double
Default: 0
OtherFrameCount

Type: u64
Default: 0
OutOfSeqCount
Type: u64
Default: 0
PauseFrameCount
Type: u64
Default: 0
PercentLoss

Type: double
Default: 0
PfcFrameCount

Type: u64
Default: 0
do not use it.
Type: u64
Default: 0
RxFrameCount

Type: u64
Default: 0
RxNonSigFrameCount
do not use it.
Type: u64
Default: 0
RxSigFrameCount
do not use it.
Type: u64
Default: 0
SearchKey

Type: string
Default: N/A

Type: string
Default: N/A
TrialNum

Type: u8
Default: 0
2228
Rfc2544FrameLossPerLoadResult
Read-Only Attribute
Description
TxFrameCount

Type: u64
Default: 0
TxFrameRate

Type: double
Default: 0
TxMbpsLoad

Type: double
Default: 0
TxSigFrameCount
do not use it.
Type: u64
Default: 0
Description:

Parents: Project
Relations:
Side name
(Type)
Relative
Description
ResultParent
(ResultChild)
Rfc2544FrameLossPerLoadResult Writable Attributes

Rfc2544FrameLossPerLoadResult Read-Only Attributes

Read-Only Attribute
Description
AvgJitter

Type: double
Default: 0
AvgLatency

Type: double
Default: 0
BurstSize

Type: u64
Default: 0
ChecksumErrorCount

Type: u64
Default: 0
ConfiguredFrameSize

Type: double
Default: 0
2229
Read-Only Attribute
Description
DuplicateFrameCount
Type: u64
Default: 0
ExpectedFrameCount

Type: u64
Default: 0
FcsErrorFrameCount
Type: u64
Default: 0
FloodCount
do not use it.
Type: u64
Default: 0
FloodedFrameCount
Type: u64
Default: 0
ForwardingRate
test.
Type: double
Default: 0
iMIX distribution.
Type: string
Default: N/A
FrameLoss
Frame loss.
Type: u64
Default: 0
FrameRate
do not use it.
Type: double
Default: 0
FrameSize
Frame size.
Type: double
Default: 0
FrameSizeType
Frame size type.

Type: string
Default: 0
IntendedLoad
Type: double
Default: 0
Ipv4AvgJitter

Type: double
Default: 0
Ipv4AvgLatency

Type: double
Default: 0
Ipv4FrameLoss

Type: u64
Default: 0
2230
Read-Only Attribute
Description
Ipv4IntendedLoad

Type: double
Default: 0
Ipv4MaxJitter

Type: double
Default: 0
Ipv4MaxLatency

Type: double
Default: 0
Ipv4MinJitter

Type: double
Default: 0
Ipv4MinLatency

Type: double
Default: 0
Ipv4OfferedLoad

Type: double
Default: 0
Ipv4RxFrameCount

Type: u64
Default: 0
Ipv4TxFrameCount

Type: u64
Default: 0
Ipv4TxFrameRate

Type: double
Default: 0
Ipv6AvgJitter

Type: double
Default: 0
Ipv6AvgLatency

Type: double
Default: 0
Ipv6ExtensionHeader

Type: string
Default: N/A
Ipv6FrameLoss

Type: u64
Default: 0
Ipv6IntendedLoad

Type: double
Default: 0

Type: string
Default: N/A
Ipv6MaxJitter

Type: double
Default: 0
Ipv6MaxLatency

Type: double
Default: 0
2231
Read-Only Attribute
Description
Ipv6MinJitter

Type: double
Default: 0
Ipv6MinLatency

Type: double
Default: 0
Ipv6OfferedLoad

Type: double
Default: 0
Ipv6RxFrameCount

Type: u64
Default: 0
Ipv6TxFrameCount

Type: u64
Default: 0
Ipv6TxFrameRate

Type: double
Default: 0
IterationNum
do not use it.
Iteration number.
Type: u8
Default: 0
LoadSize
do not use it.
Traffic load.
Type: double
Default: 0
LoadSizeType
Load size type.

Type: string
Default: 0
MaxJitter

Type: double
Default: 0
MaxLatency

Type: double
Default: 0
MbpsLineRate
do not use it.
Type: double
Default: 0
MinJitter

Type: double
Default: 0
MinLatency

Type: double
Default: 0
OfferedLoad

Type: double
Default: 0
2232
Read-Only Attribute
Description
OtherFrameCount

Type: u64
Default: 0
OutOfSeqCount

Type: u64
Default: 0
PauseFrameCount
Type: u64
Default: 0
PercentLoss

Type: double
Default: 0
PfcFrameCount

Type: u64
Default: 0
do not use it.
Type: u64
Default: 0
RxFrameCount

Type: u64
Default: 0
RxNonSigFrameCount
do not use it.
Type: u64
Default: 0
RxSigFrameCount
do not use it.
Type: u64
Default: 0
SearchKey

Type: string
Default: N/A

Type: string
Default: N/A
TrialNum

Type: u8
Default: 0
TxFrameCount

Type: u64
Default: 0
TxFrameRate

Type: double
Default: 0
TxMbpsLoad

Type: double
Default: 0
2233
Rfc2544FrameLossProfile
Read-Only Attribute
Description
TxSigFrameCount
do not use it.
Type: u64
Default: 0
Rfc2544FrameLossProfile
Description:
Defines parameters that override parameters in the Config object for the streamblocks that are associated with it.

Parents: Rfc2544FrameLossConfig
Relations:
Side name
(Type)
Relative
Description
StreamBlocks
StreamBlock
Rfc2544FrameLossProfile Writable Attributes

Writable Attribute
Description
Active, Name
LoadSpecMode

Type: enum
Default: PER_PORT
Possible Values:
Value
Description
PER_PORT
PER_STREAMBLOCK Load specified is the total load for each streamblock.

LoadUnits
Type: enum
Possible Values:
Value
Description
PERCENT_LINE_RATE
Load expressed in a percentage.
FRAMES_PER_SECOND
Load expressed in frames per second.
MEGABITS_PER_SECOND Load expressed by megabits per second.
ProfileRateMode
KILOBITS_PER_SECOND
Load expressed by kilobits per second.
BITS_PER_SECOND
Load expressed by bits per second.
Profile load usage.

Type: enum
Default: PER_TEST
Possible Values:
Value
Description
PER_TEST
2234
Rfc2544FrameLossTestResult
Rfc2544FrameLossProfile Read-Only Attributes

Description:

Parents: Project
Relations:
Side name
(Type)
Relative
Description
ResultParent
(ResultChild)

object.
Rfc2544FrameLossTestResult Writable Attributes

Rfc2544FrameLossTestResult Read-Only Attributes

Read-Only Attribute
Description
BurstSize

Type: u64
Default: 0
ChecksumErrorCount

Type: u64
Default: 0
ConfiguredFrameSize

Type: double
Default: 0
DuplicateFrameCount
Type: u64
Default: 0
ExpectedFrameCount

Type: u64
Default: 0
FcsErrorFrameCount
Type: u64
Default: 0
FloodCount
not use it.
Type: u64
Default: 0
FloodedFrameCount
Type: u64
Default: 0
2235
Read-Only Attribute
Description
Type: string
Default: N/A
FrameLoss
Type: u64
Default: 0
FrameRate
not use it.
Type: double
Default: 0
FrameSize
Frame size.
Type: double
Default: 0
FrameSizeType

Type: string
Default: 0
IntendedLoad
Type: double
Default: 0
IterationTotal

Type: u8
Default: 0
LoadSize
not use it.
Traffic load.
Type: double
Default: 0
LoadSizeType
Type: string
Default: 0
OfferedLoad

Type: double
Default: 0
OtherFrameCount

Type: u64
Default: 0
PauseFrameCount
Type: u64
Default: 0
PercentLoss

Type: double
Default: 0
PfcFrameCount

Type: u64
Default: 0
not use it.
Type: u64
Default: 0
2236
Rfc2544LatencyConfig
Read-Only Attribute
Description
RxFrameCount

Type: u64
Default: 0
RxNonSigFrameCount
not use it.
Type: u64
Default: 0
RxSigFrameCount
not use it.
Type: u64
Default: 0
TotalFrameLoss
Total frames lost.

Type: u64
Default: 0
TxFrameCount

Type: u64
Default: 0
TxFrameRate

Type: double
Default: 0
TxSigFrameCount
not use it.
Type: u64
Default: 0
Description:
This test measures the minimum, maximum, and average latency of the DUT/SUT through a range of frame sizes and loads (rates).

Children: BenchmarkEthernet10GigPortConfig, Rfc2544LatencyProfile
Relations:
Side name
(Type)
Relative
Description
GroupType
Type of side group.
Relation describing the binding to the traffic

descriptor group.
2237
Rfc2544LatencyConfig Writable Attributes

Writable Attribute
Description
Active, Name
CustomFrameSizeList
Frame sizes in custom mode. This attribute is ignored if FrameSizeIterationMode is set to RANDOM or STEP or IMIX.
Type: u16
Default: 0
CustomLoadList

Type: double
Default: 0

Type: u16
Default: 15
Range: 1 - 3600
DurationBursts

Type: u32
Default: 1000
Range: 1 - 16777215
DurationMode
Type: enum
Default: SECONDS
Possible Values:
Value
Description
BURSTS
DurationSeconds

Type: u32
Default: 60
Range: 1 - 5184000
Enable collection of detailed results.

Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
Whether to use the test frame size value.

Type: bool
Default: TRUE
Possible Values:
Value Description
TRUE
2238
Writable Attribute
Description
view mode.
Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
EnableLearning

Type: bool
Default: TRUE
Possible Values:
Value Description
TRUE

If enabled, port starting times will be staggered as specified by StaggerStartDelay.

Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE


Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
FrameSizeEnd
FrameSizeIterationMode is set to RANDOM or CUSTOM or IMIX.
Type: u16
Default: 256
Range: 47 - 16383

Type: enum
Default: CUSTOM
Possible Values:
Value
Description
RandomMaxFrameSize.
STEP

IMIX
iMIX mode.
NONE
FrameSizeStart
Type: u16
Default: 128
Range: 47 - 16383
FrameSizeStep
ignored if FrameSizeIterationMode is set to RANDOM or CUSTOM or IMIX.
Type: u16
Default: 128
Range: 1 - 16383
2239
Writable Attribute
Description
iMIX distribution List. This attribute is ignored if FrameSizeIterationMode is set to RANDOM or CUSTOM or STEP.
Type: handle
Default: 0

Type: string

Type: u16
Default: 2
Range: 0 - 3600
L2LearningFrameRate

Type: u32
Default: 1000
Range: 1 - 14880952
Number of Ping packets to send to the Layer 2 destination address.

Type: u16
Default: 5
Range: 1 - 100
Delay before L3 learning.

Type: u16
Default: 2
Range: 0 - 3600

Type: bool
Default: TRUE
Possible Values:
Value Description
TRUE

L3Rate
L3 learning rate.
Type: u32
Default: 1000
L3RetryCount

Type: u16
Default: 5
Range: 1 - 100
List of latency distribution buckets.

Type: s64
Default: 2
Range: 1 - 4294967296
LatencyType

Type: enum
Default: LILO
Possible Values:
Value Description
LILO
LIFO
2240
Writable Attribute
Description
LearningFreqMode
Learning frequency.
Type: enum
Default: LEARN_ONCE
Possible Values:
Value
Description
LEARN_ONCE
Learn once.
LEARN_EVERY_TRIAL
Learn every trial.

LearningMode
Learning mode.
Type: enum
Possible Values:
Value
Description
LoadEnd
Type: double
Default: 50
LoadStart
Type: double
Default: 10
LoadStep
Type: double
Default: 10
Range: 0.001 - 100000000000.0
LoadType

Type: enum
Default: STEP
Possible Values:
Value
Description
RandomMaxLoad.
STEP

LoadUnits
Type: enum
Possible Values:
Value
Description
PERCENT_LINE_RATE
FRAMES_PER_SECOND
Frames per second.
INTER_BURST_GAP
Inter burst gap.

KILOBITS_PER_SECOND
BITS_PER_SECOND
Bits per second.
2241
Writable Attribute
Description
NumOfTrials
Type: u16
Default: 1
Range: 1 - 60

Type: string
ProfileConfigMode
Profile configuration mode.

Type: enum
Default: MANUAL
Possible Values:
Value
Description
MANUAL
PER_PORT
PER_SIDE

RandomMaxFrameSize
When using Random mode for frame sizes, the maximum frame size. This attribute is ignored if FrameSizeIterationMode
is set to STEP or CUSTOM or IMIX.
Type: u16
Default: 256
Range: 47 - 16383
RandomMaxLoad
Type: double
Default: 50
RandomMinFrameSize
FrameSizeIterationMode is set to STEP or CUSTOM or IMIX.
Type: u16
Default: 128
Range: 47 - 16383
RandomMinLoad
Type: double
Default: 10
StaggerStartDelay
Type: u16
Default: 0
Range: 0 - 65535
Throughput rate percentage to use. Applicable only for asymmetric tests only.
Type: double
Default: 100.0
TrafficStartDelay

Type: double
Default: 2
Range: 0.005 - 3600

Type: enum
Default: AFTER_TEST
Possible Values:
Value
Description
AFTER_TEST
2242
Rfc2544LatencyPerCoexistenceRatioResult
Writable Attribute
Description

Type: bool
Default: TRUE
Possible Values:
Value Description
TRUE


Type: enum
Possible Values:
Value
Description
VERIFY_EVERY_TRIAL


Type: u16
Default: 100
Range: 1 - 32767
Type: u32
Default: 1000
Range: 1 - 14880952
Enables or disables the use of existing pre-configured stream blocks for the test.
Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
Use existing stream blocks for the test.
FALSE Allow the application to generate new stream blocks to be used for the test.
UseThroughputRates
Specifies that the test will use rates derived from the throughput test. Applicable only for asymmetric tests only.
Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
Test will use rates derived from the throughput test.
FALSE Test will use user defined rates.
Rfc2544LatencyConfig Read-Only Attributes

Description:
Result object used at end of test. Cannot subscribe to this object.

Parents: Project
Relations:
2243
Side name
(Type)
Relative
Description
ResultParent
(ResultChild)
Rfc2544LatencyPerCoexistenceRatioResult Writable Attributes

Rfc2544LatencyPerCoexistenceRatioResult Read-Only Attributes

Read-Only Attribute
Description
AvgJitter
Type: double
Default: 0
AvgLatency
Type: double
Default: 0
BurstSize

Type: u64
Default: 0
ChecksumErrorCount

Type: u64
Default: 0
ConfiguredFrameSize

Type: double
Default: 0
DuplicateFrameCount
Type: u64
Default: 0
ExpectedFrameCount

Type: u64
Default: 0
FcsErrorFrameCount
Type: u64
Default: 0
FloodCount
do not use it.
Type: u64
Default: 0
FloodedFrameCount
Type: u64
Default: 0
ForwardingRate
Type: double
Default: 0
iMIX distribution.
Type: string
Default: N/A
2244
Read-Only Attribute
Description
FrameLoss
Type: u64
Default: 0
FrameRate
do not use it.
Type: double
Default: 0
FrameSize
Frame size.
Type: double
Default: 0
FrameSizeType
Frame size type.

Type: string
Default: 0
HistBin10Count
Histogram Bucket 10 count.

Type: u64
Default: 0
HistBin11Count

Type: u64
Default: 0
HistBin12Count

Type: u64
Default: 0
HistBin13Count

Type: u64
Default: 0
HistBin14Count

Type: u64
Default: 0
HistBin15Count

Type: u64
Default: 0
HistBin16Count

Type: u64
Default: 0
HistBin1Count

Type: u64
Default: 0
HistBin2Count

Type: u64
Default: 0
HistBin3Count

Type: u64
Default: 0
HistBin4Count

Type: u64
Default: 0
HistBin5Count

Type: u64
Default: 0
2245
Read-Only Attribute
Description
HistBin6Count

Type: u64
Default: 0
HistBin7Count

Type: u64
Default: 0
HistBin8Count

Type: u64
Default: 0
HistBin9Count

Type: u64
Default: 0
IntendedLoad
Type: double
Default: 0
Ipv4AvgJitter

Type: double
Default: 0
Ipv4AvgLatency

Type: double
Default: 0
Ipv4FrameLoss

Type: u64
Default: 0
Ipv4IntendedLoad

Type: double
Default: 0
Ipv4MaxJitter

Type: double
Default: 0
Ipv4MaxLatency

Type: double
Default: 0
Ipv4MinJitter

Type: double
Default: 0
Ipv4MinLatency

Type: double
Default: 0
Ipv4OfferedLoad

Type: double
Default: 0
Ipv4RxFrameCount

Type: u64
Default: 0
Ipv4TxFrameCount

Type: u64
Default: 0
2246
Read-Only Attribute
Description
Ipv4TxFrameRate

Type: double
Default: 0
Ipv6AvgJitter

Type: double
Default: 0
Ipv6AvgLatency

Type: double
Default: 0
Ipv6ExtensionHeader

Type: string
Default: N/A
Ipv6FrameLoss

Type: u64
Default: 0
Ipv6IntendedLoad

Type: double
Default: 0

Type: string
Default: N/A
Ipv6MaxJitter

Type: double
Default: 0
Ipv6MaxLatency

Type: double
Default: 0
Ipv6MinJitter

Type: double
Default: 0
Ipv6MinLatency

Type: double
Default: 0
Ipv6OfferedLoad

Type: double
Default: 0
Ipv6RxFrameCount

Type: u64
Default: 0
Ipv6TxFrameCount

Type: u64
Default: 0
Ipv6TxFrameRate

Type: double
Default: 0
IterationNum
do not use it.
Iteration number.
Type: u8
Default: 0
2247
Read-Only Attribute
Description
LoadSize
do not use it.
Traffic load.
Type: double
Default: 0
LoadSizeType
Load size type.

Type: string
Default: 0
MaxJitter
Type: double
Default: 0
MaxLatency
Type: double
Default: 0
MbpsLineRate
do not use it.
Type: double
Default: 0
MinJitter
Type: double
Default: 0
MinLatency
Type: double
Default: 0
OfferedLoad

Type: double
Default: 0
OtherFrameCount

Type: u64
Default: 0
OutOfSeqCount

Type: u64
Default: 0
PauseFrameCount
Type: u64
Default: 0
PercentLoss

Type: double
Default: 0
PfcFrameCount

Type: u64
Default: 0
do not use it.
Type: u64
Default: 0
RxFrameCount

Type: u64
Default: 0
2248
Rfc2544LatencyPerFrameSizeResult
Read-Only Attribute
Description
RxNonSigFrameCount
do not use it.
Type: u64
Default: 0
RxSigFrameCount
do not use it.
Type: u64
Default: 0
SearchKey

Type: string
Default: N/A

Type: string
Default: N/A
TrialNum

Type: u8
Default: 0
TxFrameCount

Type: u64
Default: 0
TxFrameRate

Type: double
Default: 0
TxMbpsLoad

Type: double
Default: 0
TxSigFrameCount
do not use it.
Type: u64
Default: 0
Description:

Parents: Project
Relations:
Side name
(Type)
Relative
Description
ResultParent
(ResultChild)
Rfc2544LatencyPerFrameSizeResult Writable Attributes

2249
Rfc2544LatencyPerFrameSizeResult Read-Only Attributes

Read-Only Attribute
Description
AvgJitter

Type: double
Default: 0
AvgLatency

Type: double
Default: 0
BurstSize

Type: u64
Default: 0
ChecksumErrorCount

Type: u64
Default: 0
ConfiguredFrameSize

Type: double
Default: 0
DuplicateFrameCount
Type: u64
Default: 0
ExpectedFrameCount

Type: u64
Default: 0
FcsErrorFrameCount
Type: u64
Default: 0
FloodCount
do not use it.
Type: u64
Default: 0
FloodedFrameCount
Type: u64
Default: 0
ForwardingRate
test.
Type: double
Default: 0
iMIX distribution.
Type: string
Default: N/A
FrameLoss
Type: u64
Default: 0
FrameRate
do not use it.
Type: double
Default: 0
FrameSize
Frame size.
Type: double
Default: 0
2250
Read-Only Attribute
Description
FrameSizeType
Frame size type.

Type: string
Default: 0
HistBin10Count

Type: u64
Default: 0
HistBin11Count

Type: u64
Default: 0
HistBin12Count

Type: u64
Default: 0
HistBin13Count

Type: u64
Default: 0
HistBin14Count

Type: u64
Default: 0
HistBin15Count

Type: u64
Default: 0
HistBin16Count

Type: u64
Default: 0
HistBin1Count
Histogram bucket 1.
Type: u64
Default: 0
HistBin2Count
Histogram bucket 2.
Type: u64
Default: 0
HistBin3Count
Histogram bucket 3.
Type: u64
Default: 0
HistBin4Count
Histogram bucket 4.
Type: u64
Default: 0
HistBin5Count
Histogram bucket 5.
Type: u64
Default: 0
HistBin6Count
Histogram bucket 6.
Type: u64
Default: 0
HistBin7Count
Histogram bucket 7.
Type: u64
Default: 0
HistBin8Count
Histogram bucket 8.
Type: u64
Default: 0
HistBin9Count
Histogram bucket 9.
Type: u64
Default: 0
2251
Read-Only Attribute
Description
IntendedLoad
Type: double
Default: 0
Ipv4AvgJitter

Type: double
Default: 0
Ipv4AvgLatency

Type: double
Default: 0
Ipv4FrameLoss

Type: u64
Default: 0
Ipv4IntendedLoad

Type: double
Default: 0
Ipv4MaxJitter

Type: double
Default: 0
Ipv4MaxLatency

Type: double
Default: 0
Ipv4MinJitter

Type: double
Default: 0
Ipv4MinLatency

Type: double
Default: 0
Ipv4OfferedLoad

Type: double
Default: 0
Ipv4RxFrameCount

Type: u64
Default: 0
Ipv4TxFrameCount

Type: u64
Default: 0
Ipv4TxFrameRate

Type: double
Default: 0
Ipv6AvgJitter

Type: double
Default: 0
Ipv6AvgLatency

Type: double
Default: 0
Ipv6ExtensionHeader

Type: string
Default: N/A
2252
Read-Only Attribute
Description
Ipv6FrameLoss

Type: u64
Default: 0
Ipv6IntendedLoad

Type: double
Default: 0

Type: string
Default: N/A
Ipv6MaxJitter

Type: double
Default: 0
Ipv6MaxLatency

Type: double
Default: 0
Ipv6MinJitter

Type: double
Default: 0
Ipv6MinLatency

Type: double
Default: 0
Ipv6OfferedLoad

Type: double
Default: 0
Ipv6RxFrameCount

Type: u64
Default: 0
Ipv6TxFrameCount

Type: u64
Default: 0
Ipv6TxFrameRate

Type: double
Default: 0
IterationNum
do not use it.
Iteration number.
Type: u8
Default: 0
LoadSize
do not use it.
Traffic load.
Type: double
Default: 0
LoadSizeType
Type: string
Default: 0
MaxJitter

Type: double
Default: 0
MaxLatency

Type: double
Default: 0
2253
Read-Only Attribute
Description
MbpsLineRate
do not use it.
Type: double
Default: 0
MinJitter

Type: double
Default: 0
MinLatency

Type: double
Default: 0
OfferedLoad

Type: double
Default: 0
OtherFrameCount

Type: u64
Default: 0
OutOfSeqCount
Type: u64
Default: 0
PauseFrameCount
Type: u64
Default: 0
PercentLoss

Type: double
Default: 0
PfcFrameCount

Type: u64
Default: 0
do not use it.
Type: u64
Default: 0
RxFrameCount

Type: u64
Default: 0
RxNonSigFrameCount
do not use it.
Type: u64
Default: 0
RxSigFrameCount
do not use it.
Type: u64
Default: 0
SearchKey

Type: string
Default: N/A

Type: string
Default: N/A
2254
Rfc2544LatencyPerIpv6ExtensionHeaderResult
Read-Only Attribute
Description
TrialNum

Type: u8
Default: 0
TxFrameCount

Type: u64
Default: 0
TxFrameRate

Type: double
Default: 0
TxMbpsLoad

Type: double
Default: 0
TxSigFrameCount
do not use it.
Type: u64
Default: 0
Description:
Result object.

Parents: Project
Relations:
Side name
(Type)
Relative
Description
ResultParent
(ResultChild)
Rfc2544LatencyPerIpv6ExtensionHeaderResult Writable Attributes

Rfc2544LatencyPerIpv6ExtensionHeaderResult Read-Only Attributes

Read-Only Attribute
Description
AvgJitter
Type: double
Default: 0
AvgLatency
Type: double
Default: 0
BurstSize

Type: u64
Default: 0
ChecksumErrorCount

Type: u64
Default: 0
2255
Read-Only Attribute
Description
ConfiguredFrameSize

Type: double
Default: 0
DuplicateFrameCount
Type: u64
Default: 0
ExpectedFrameCount

Type: u64
Default: 0
FcsErrorFrameCount
Type: u64
Default: 0
FloodCount
do not use it.
Type: u64
Default: 0
FloodedFrameCount
Type: u64
Default: 0
ForwardingRate
Type: double
Default: 0
iMIX distribution.
Type: string
Default: N/A
FrameLoss
Type: u64
Default: 0
FrameRate
do not use it.
Type: double
Default: 0
FrameSize
Frame size.
Type: double
Default: 0
FrameSizeType
Frame size type.

Type: string
Default: 0
HistBin10Count

Type: u64
Default: 0
HistBin11Count

Type: u64
Default: 0
HistBin12Count

Type: u64
Default: 0
2256
Read-Only Attribute
Description
HistBin13Count

Type: u64
Default: 0
HistBin14Count

Type: u64
Default: 0
HistBin15Count

Type: u64
Default: 0
HistBin16Count

Type: u64
Default: 0
HistBin1Count
Histogram bucket 1.
Type: u64
Default: 0
HistBin2Count
Histogram bucket 2.
Type: u64
Default: 0
HistBin3Count
Histogram bucket 3.
Type: u64
Default: 0
HistBin4Count
Histogram bucket 4.
Type: u64
Default: 0
HistBin5Count
Histogram bucket 5.
Type: u64
Default: 0
HistBin6Count
Histogram bucket 6.
Type: u64
Default: 0
HistBin7Count
Histogram bucket 7.
Type: u64
Default: 0
HistBin8Count
Histogram bucket 8.
Type: u64
Default: 0
HistBin9Count
Histogram bucket 9.
Type: u64
Default: 0
IntendedLoad
Type: double
Default: 0
Ipv4AvgJitter

Type: double
Default: 0
Ipv4AvgLatency

Type: double
Default: 0
2257
Read-Only Attribute
Description
Ipv4FrameLoss

Type: u64
Default: 0
Ipv4IntendedLoad

Type: double
Default: 0
Ipv4MaxJitter

Type: double
Default: 0
Ipv4MaxLatency

Type: double
Default: 0
Ipv4MinJitter

Type: double
Default: 0
Ipv4MinLatency

Type: double
Default: 0
Ipv4OfferedLoad

Type: double
Default: 0
Ipv4RxFrameCount

Type: u64
Default: 0
Ipv4TxFrameCount

Type: u64
Default: 0
Ipv4TxFrameRate

Type: double
Default: 0
Ipv6AvgJitter

Type: double
Default: 0
Ipv6AvgLatency

Type: double
Default: 0
Ipv6ExtensionHeader

Type: string
Default: N/A
Ipv6FrameLoss

Type: u64
Default: 0
Ipv6IntendedLoad

Type: double
Default: 0

Type: string
Default: N/A
Ipv6MaxJitter

Type: double
Default: 0
2258
Read-Only Attribute
Description
Ipv6MaxLatency

Type: double
Default: 0
Ipv6MinJitter

Type: double
Default: 0
Ipv6MinLatency

Type: double
Default: 0
Ipv6OfferedLoad

Type: double
Default: 0
Ipv6RxFrameCount

Type: u64
Default: 0
Ipv6TxFrameCount

Type: u64
Default: 0
Ipv6TxFrameRate

Type: double
Default: 0
IterationNum
do not use it.
Iteration number.
Type: u8
Default: 0
LoadSize
do not use it.
Traffic load value.
Type: double
Default: 0
LoadSizeType
Load size type.

Type: string
Default: 0
MaxJitter
Type: double
Default: 0
MaxLatency
Type: double
Default: 0
MbpsLineRate
do not use it.
Type: double
Default: 0
MinJitter
Type: double
Default: 0
MinLatency
Type: double
Default: 0
2259
Read-Only Attribute
Description
OfferedLoad

Type: double
Default: 0
OtherFrameCount

Type: u64
Default: 0
OutOfSeqCount

Type: u64
Default: 0
PauseFrameCount
Type: u64
Default: 0
PercentLoss

Type: double
Default: 0
PfcFrameCount

Type: u64
Default: 0
do not use it.
Type: u64
Default: 0
RxFrameCount

Type: u64
Default: 0
RxNonSigFrameCount
do not use it.
Type: u64
Default: 0
RxSigFrameCount
do not use it.
Type: u64
Default: 0
SearchKey

Type: string
Default: N/A

Type: string
Default: N/A
TrialNum

Type: u8
Default: 0
TxFrameCount

Type: u64
Default: 0
TxFrameRate

Type: double
Default: 0
2260
Rfc2544LatencyPerIterationResult
Read-Only Attribute
Description
TxMbpsLoad

Type: double
Default: 0
TxSigFrameCount
do not use it.
Type: u64
Default: 0
Description:

Parents: Project
Relations:
Side name
(Type)
Relative
Description
ResultParent
(ResultChild)
Rfc2544LatencyPerIterationResult Writable Attributes

Rfc2544LatencyPerIterationResult Read-Only Attributes

Read-Only Attribute
Description
AvgJitter

Type: double
Default: 0
AvgLatency

Type: double
Default: 0
BurstSize

Type: u64
Default: 0
ChecksumErrorCount

Type: u64
Default: 0
ConfiguredFrameSize

Type: double
Default: 0
DuplicateFrameCount
Type: u64
Default: 0
2261
Read-Only Attribute
Description
ExpectedFrameCount

Type: u64
Default: 0
FcsErrorFrameCount
Type: u64
Default: 0
FloodCount
do not use it.
Type: u64
Default: 0
FloodedFrameCount
Type: u64
Default: 0
ForwardingRate
test.
Type: double
Default: 0
Type: string
Default: N/A
FrameLoss
Type: u64
Default: 0
FrameRate
do not use it.
Type: double
Default: 0
FrameSize
Frame size.
Type: double
Default: 0
FrameSizeType
Frame size type.

Type: string
Default: 0
HistBin10Count

Type: u64
Default: 0
HistBin11Count

Type: u64
Default: 0
HistBin12Count

Type: u64
Default: 0
HistBin13Count

Type: u64
Default: 0
HistBin14Count

Type: u64
Default: 0
HistBin15Count

Type: u64
Default: 0
2262
Read-Only Attribute
Description
HistBin16Count

Type: u64
Default: 0
HistBin1Count
Histogram bucket 1.
Type: u64
Default: 0
HistBin2Count
Histogram bucket 2.
Type: u64
Default: 0
HistBin3Count
Histogram bucket 3.
Type: u64
Default: 0
HistBin4Count
Histogram bucket 4.
Type: u64
Default: 0
HistBin5Count
Histogram bucket 5.
Type: u64
Default: 0
HistBin6Count
Histogram bucket 6.
Type: u64
Default: 0
HistBin7Count
Histogram bucket 7.
Type: u64
Default: 0
HistBin8Count
Histogram bucket 8.
Type: u64
Default: 0
HistBin9Count
Histogram bucket 9.
Type: u64
Default: 0
IntendedLoad
Type: double
Default: 0
Ipv4AvgJitter

Type: double
Default: 0
Ipv4AvgLatency

Type: double
Default: 0
Ipv4FrameLoss

Type: u64
Default: 0
Ipv4IntendedLoad

Type: double
Default: 0
Ipv4MaxJitter

Type: double
Default: 0
2263
Read-Only Attribute
Description
Ipv4MaxLatency

Type: double
Default: 0
Ipv4MinJitter

Type: double
Default: 0
Ipv4MinLatency

Type: double
Default: 0
Ipv4OfferedLoad

Type: double
Default: 0
Ipv4RxFrameCount

Type: u64
Default: 0
Ipv4TxFrameCount

Type: u64
Default: 0
Ipv4TxFrameRate

Type: double
Default: 0
Ipv6AvgJitter

Type: double
Default: 0
Ipv6AvgLatency

Type: double
Default: 0
Ipv6ExtensionHeader

Type: string
Default: N/A
Ipv6FrameLoss

Type: u64
Default: 0
Ipv6IntendedLoad

Type: double
Default: 0

Type: string
Default: N/A
Ipv6MaxJitter

Type: double
Default: 0
Ipv6MaxLatency

Type: double
Default: 0
Ipv6MinJitter

Type: double
Default: 0
Ipv6MinLatency

Type: double
Default: 0
2264
Read-Only Attribute
Description
Ipv6OfferedLoad

Type: double
Default: 0
Ipv6RxFrameCount

Type: u64
Default: 0
Ipv6TxFrameCount

Type: u64
Default: 0
Ipv6TxFrameRate

Type: double
Default: 0
IterationNum
do not use it.
Iteration number.
Type: u8
Default: 0
LoadSize
do not use it.
Traffic load value.
Type: double
Default: 0
LoadSizeType
Type: string
Default: 0
MaxJitter

Type: double
Default: 0
MaxLatency

Type: double
Default: 0
MbpsLineRate
do not use it.
Type: double
Default: 0
MinJitter

Type: double
Default: 0
MinLatency

Type: double
Default: 0
OfferedLoad

Type: double
Default: 0
OtherFrameCount

Type: u64
Default: 0
OutOfSeqCount
Type: u64
Default: 0
2265
Read-Only Attribute
Description
PauseFrameCount
Type: u64
Default: 0
PercentLoss

Type: double
Default: 0
PfcFrameCount

Type: u64
Default: 0
do not use it.
Type: u64
Default: 0
RxFrameCount

Type: u64
Default: 0
RxNonSigFrameCount
do not use it.
Type: u64
Default: 0
RxSigFrameCount
do not use it.
Type: u64
Default: 0
SearchKey

Type: string
Default: N/A

Type: string
Default: N/A
TrialNum

Type: u8
Default: 0
TxFrameCount

Type: u64
Default: 0
TxFrameRate

Type: double
Default: 0
TxMbpsLoad

Type: double
Default: 0
TxSigFrameCount
do not use it.
Type: u64
Default: 0
2266
Rfc2544LatencyPerLoadResult
Description:

Parents: Project
Relations:
Side name
(Type)
Relative
Description
ResultParent
(ResultChild)
Rfc2544LatencyPerLoadResult Writable Attributes

Rfc2544LatencyPerLoadResult Read-Only Attributes

Read-Only Attribute
Description
AvgJitter

Type: double
Default: 0
AvgLatency

Type: double
Default: 0
BurstSize

Type: u64
Default: 0
ChecksumErrorCount

Type: u64
Default: 0
ConfiguredFrameSize

Type: double
Default: 0
DuplicateFrameCount
Type: u64
Default: 0
ExpectedFrameCount

Type: u64
Default: 0
FcsErrorFrameCount
Type: u64
Default: 0
FloodCount

you do not use it.
Type: u64
Default: 0
FloodedFrameCount
Type: u64
Default: 0
2267
Read-Only Attribute
Description
ForwardingRate
test.
Type: double
Default: 0
iMIX distribution.
Type: string
Default: N/A
FrameLoss
Type: u64
Default: 0
FrameRate

you do not use it.
Type: double
Default: 0
FrameSize
Frame size.
Type: double
Default: 0
FrameSizeType
Frame size type.

Type: string
Default: 0
HistBin10Count

Type: u64
Default: 0
HistBin11Count

Type: u64
Default: 0
HistBin12Count

Type: u64
Default: 0
HistBin13Count

Type: u64
Default: 0
HistBin14Count

Type: u64
Default: 0
HistBin15Count

Type: u64
Default: 0
HistBin16Count

Type: u64
Default: 0
HistBin1Count
Histogram bucket 1.
Type: u64
Default: 0
HistBin2Count
Histogram bucket 2.
Type: u64
Default: 0
HistBin3Count
Histogram bucket 3.
Type: u64
Default: 0
2268
Read-Only Attribute
Description
HistBin4Count
Histogram bucket 4.
Type: u64
Default: 0
HistBin5Count
Histogram bucket 5.
Type: u64
Default: 0
HistBin6Count
Histogram bucket 6.
Type: u64
Default: 0
HistBin7Count
Histogram bucket 7.
Type: u64
Default: 0
HistBin8Count
Histogram bucket 8.
Type: u64
Default: 0
HistBin9Count
Histogram bucket 9.
Type: u64
Default: 0
IntendedLoad
Type: double
Default: 0
Ipv4AvgJitter

Type: double
Default: 0
Ipv4AvgLatency

Type: double
Default: 0
Ipv4FrameLoss

Type: u64
Default: 0
Ipv4IntendedLoad

Type: double
Default: 0
Ipv4MaxJitter

Type: double
Default: 0
Ipv4MaxLatency

Type: double
Default: 0
Ipv4MinJitter

Type: double
Default: 0
Ipv4MinLatency

Type: double
Default: 0
Ipv4OfferedLoad

Type: double
Default: 0
2269
Read-Only Attribute
Description
Ipv4RxFrameCount

Type: u64
Default: 0
Ipv4TxFrameCount

Type: u64
Default: 0
Ipv4TxFrameRate

Type: double
Default: 0
Ipv6AvgJitter

Type: double
Default: 0
Ipv6AvgLatency

Type: double
Default: 0
Ipv6ExtensionHeader

Type: string
Default: N/A
Ipv6FrameLoss

Type: u64
Default: 0
Ipv6IntendedLoad

Type: double
Default: 0

Type: string
Default: N/A
Ipv6MaxJitter

Type: double
Default: 0
Ipv6MaxLatency

Type: double
Default: 0
Ipv6MinJitter

Type: double
Default: 0
Ipv6MinLatency

Type: double
Default: 0
Ipv6OfferedLoad

Type: double
Default: 0
Ipv6RxFrameCount

Type: u64
Default: 0
Ipv6TxFrameCount

Type: u64
Default: 0
Ipv6TxFrameRate

Type: double
Default: 0
2270
Read-Only Attribute
Description
IterationNum

you do not use it.
Iteration number.
Type: u8
Default: 0
LoadSize

you do not use it.
Traffic load.
Type: double
Default: 0
LoadSizeType
Load size type.

Type: string
Default: 0
MaxJitter

Type: double
Default: 0
MaxLatency

Type: double
Default: 0
MbpsLineRate

you do not use it.
Type: double
Default: 0
MinJitter

Type: double
Default: 0
MinLatency

Type: double
Default: 0
OfferedLoad

Type: double
Default: 0
OtherFrameCount

Type: u64
Default: 0
OutOfSeqCount

Type: u64
Default: 0
PauseFrameCount
Type: u64
Default: 0
PercentLoss

Type: double
Default: 0
PfcFrameCount

Type: u64
Default: 0

you do not use it.
Type: u64
Default: 0
2271
Rfc2544LatencyProfile
Read-Only Attribute
Description
RxFrameCount

Type: u64
Default: 0
RxNonSigFrameCount

you do not use it.
Type: u64
Default: 0
RxSigFrameCount

you do not use it.
Type: u64
Default: 0
SearchKey

Type: string
Default: N/A

Type: string
Default: N/A
TrialNum

Type: u8
Default: 0
TxFrameCount

Type: u64
Default: 0
TxFrameRate

Type: double
Default: 0
TxMbpsLoad

Type: double
Default: 0
TxSigFrameCount

you do not use it.
Type: u64
Default: 0
Rfc2544LatencyProfile
Description:
Defines Latency parameters for asymmetric test configurations. These parameters override parameters in the Config object for the streamblocks that are
associated with it.

Parents: Rfc2544LatencyConfig
Relations:
Side name
(Type)
Relative
Description
StreamBlocks
StreamBlock
2272
Rfc2544LatencyTestResult
Rfc2544LatencyProfile Writable Attributes

Writable Attribute
Description
Active, Name
LoadSpecMode

Type: enum
Default: PER_PORT
Possible Values:
Value
Description
PER_PORT
PER_STREAMBLOCK Load specified is the total load for each stream block.
LoadUnits
Type: enum
Possible Values:
Value
Description
PERCENT_LINE_RATE
FRAMES_PER_SECOND
frames per second.
MEGABITS_PER_SECOND megabits per second.
ProfileRateMode
KILOBITS_PER_SECOND
kilobits per second.
BITS_PER_SECOND
bits per second.
Profile load usage.

Type: enum
Default: PER_TEST
Possible Values:
Value
Description
PER_TEST
Rfc2544LatencyProfile Read-Only Attributes

Description:

Parents: Project
Relations:
Side name
(Type)
Relative
Description
ResultParent
(ResultChild)

object.
Rfc2544LatencyTestResult Writable Attributes

2273
Rfc2544LatencyTestResult Read-Only Attributes

Read-Only Attribute
Description
AvgJitter

Type: double
Default: 0
AvgLatency

Type: double
Default: 0
BurstSize

Type: u64
Default: 0
ChecksumErrorCount

Type: u64
Default: 0
ConfiguredFrameSize

Type: double
Default: 0
DuplicateFrameCount
Type: u64
Default: 0
ExpectedFrameCount

Type: u64
Default: 0
FcsErrorFrameCount
Type: u64
Default: 0
FloodCount
do not use it.
Type: u64
Default: 0
FloodedFrameCount
Type: u64
Default: 0
Type: string
Default: N/A
FrameLoss
Type: u64
Default: 0
FrameRate
do not use it.
Type: double
Default: 0
FrameSize
Frame size.
Type: double
Default: 0
FrameSizeType

Type: string
Default: 0
2274
Read-Only Attribute
Description
HistBin10Count

Type: u64
Default: 0
HistBin11Count

Type: u64
Default: 0
HistBin12Count

Type: u64
Default: 0
HistBin13Count

Type: u64
Default: 0
HistBin14Count

Type: u64
Default: 0
HistBin15Count

Type: u64
Default: 0
HistBin16Count

Type: u64
Default: 0
HistBin1Count
Histogram bucket 1.
Type: u64
Default: 0
HistBin2Count
Histogram bucket 2.
Type: u64
Default: 0
HistBin3Count
Histogram bucket 3.
Type: u64
Default: 0
HistBin4Count
Histogram bucket 4.
Type: u64
Default: 0
HistBin5Count
Histogram bucket 5.
Type: u64
Default: 0
HistBin6Count
Histogram bucket 6.
Type: u64
Default: 0
HistBin7Count
Histogram bucket 7.
Type: u64
Default: 0
HistBin8Count
Histogram bucket 8.
Type: u64
Default: 0
HistBin9Count
Histogram bucket 9.
Type: u64
Default: 0
2275
Read-Only Attribute
Description
IntendedLoad
Type: double
Default: 0
IterationTotal

Type: u8
Default: 0
LoadSize
do not use it.
Traffic load value.
Type: double
Default: 0
LoadSizeType
Type: string
Default: 0
MaxJitter

Type: double
Default: 0
MaxLatency

Type: double
Default: 0
MinJitter

Type: double
Default: 0
MinLatency

Type: double
Default: 0
OfferedLoad

Type: double
Default: 0
OtherFrameCount

Type: u64
Default: 0
PauseFrameCount
Type: u64
Default: 0
PercentLoss

Type: double
Default: 0
PfcFrameCount

Type: u64
Default: 0
do not use it.
Type: u64
Default: 0
RxFrameCount

Type: u64
Default: 0
2276
Rfc2544ProfileRate
Read-Only Attribute
Description
RxNonSigFrameCount
do not use it.
Type: u64
Default: 0
RxSigFrameCount
do not use it.
Type: u64
Default: 0
TotalFrameLoss
Total number of frames expected, but not received, for the current test.
Type: u64
Default: 0
TxFrameCount

Type: u64
Default: 0
TxFrameRate

Type: double
Default: 0
TxSigFrameCount
do not use it.
Type: u64
Default: 0
Rfc2544ProfileRate
Description:
Defines rate parameters for a frame size or for the entire test. The Nth frame size corresponds to the Nth profile rate.

Automatically created from: Rfc2544BackToBackFramesProfile, Rfc2544FrameLossProfile, Rfc2544LatencyProfile
Rfc2544ProfileRate Writable Attributes

Writable Attribute
Description
Active, Name
CustomLoadList
Custom loads used in the test.

Type: double
Default: 0
Type: handle
Default: 0
FrameSize
Frame size.
Type: u16
Default: 0
Range: 0 - 16383
LoadEnd
Stop load.
Type: double
Default: 10
2277
Rfc2544SetupBackToBackTestCommand
Writable Attribute
Description
LoadStart
Start load.
Type: double
Default: 100
LoadStep
Step load.
Type: double
Default: 10
RandomMaxLoad
Maximum load at any point during the test.

Type: double
Default: 50
RandomMinLoad
Minimum load at any point during the test.

Type: double
Default: 10
Rfc2544ProfileRate Read-Only Attributes

Description:
Set up RFC 2544 back-to-back test.

Parents: Sequencer
Relations:
Side name
(Type)
Relative
Description
TestCaseConfig
(BenchmarkingTestCaseConfig)
DcbTestConfig, Rfc2544BackToBackFramesConfig,
Rfc2544FrameLossConfig, Rfc2544LatencyConfig, Rfc2544ThroughputConfig,
Rfc2889AddrCachingCapacityConfig, Rfc2889AddrLearningRateConfig,
Rfc2889BroadcastFrameForwardingConfig,
Rfc2889BroadcastFrameLatencyConfig, Rfc2889CongestionControlConfig,
Rfc2889ErroredFramesFilteringConfig, Rfc2889ForwardingConfig,
Rfc2889ForwardPressureConfig, Rfc2889MaxForwardingRateConfig,
Rfc3918Config
Benchmarking test case config

used to set up test command.
Parent command.
Rfc2544SetupBackToBackTestCommand Writable Attributes

Writable Attribute
Description
DstDeviceList

Type: handle
Default: 0
Duration

Type: double
Default: 60
Range: 1 - 16777215
2278
Writable Attribute
Description
DurationMode
Type: enum
Default: SECONDS
Possible Values:
Value
Description
BURSTS
EnableBidirectionalTraffic
Whether traffic is bidirectional.

Type: bool
Default: TRUE
Possible Values:
Value Description
TRUE
Traffic is bidirectional.
FALSE Traffic is unidirectional (one-way).


Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
FALSE Test is not run in 'Jitter' analyzer result view mode. The default analyzer result view mode for the test is
used.
FrameSizeDistributionList

Type: handle
Default: 0
FrameSizeList
Frame size list.

Type: u16
Default: 0
Range: 47 - 16383
LatencyType
Determines how latency results are calculated and displayed.

Type: enum
Default: LILO
Possible Values:
Value Description
LILO
Last In Last Out mode.
LIFO
Last In First Out mode.
FIFO First In First Out mode.

LearningFreqMode
Learning frequency.
Type: enum
Default: LEARN_ONCE
Possible Values:
Value
Description
NONE
No learning.
LEARN_ONCE
Learn once per test.
LEARN_EVERY_TRIAL
Learn every trial.
LEARN_EVERY_FRAME_SIZE Learn every frame size.

2279
Writable Attribute
Description
LearningMode
Learning mode.
Type: enum
Default: AUTO
Possible Values:
Value
Description
AUTO
Automatic learning mode.
NONE
No learning.

LoadList

Type: double
Default: 0
Range: 0.000001 - 100000.0
LoadUnits
Type: enum
Possible Values:
Value
Description
PERCENT_LINE_RATE
FRAMES_PER_SECOND

KILOBITS_PER_SECOND
BITS_PER_SECOND
NumOfTrials
Number of trials.
Type: u16
Default: 1
Range: 1 - 60
SrcDeviceList
Source device list.

Type: handle
Default: 0
TrafficList
Traffic list.
Type: handle
Default: 0
TrafficPattern
Traffic pattern type.

Type: enum
Default: MESH
Possible Values:
Value
Description
PAIR
Source and destination pair.
MESH
Mesh traffic topology.
BACKBONE Traffic on a backbone.


Type: bool
Default: TRUE
Possible Values:
Value Description
TRUE
2280
Rfc2544SetupFrameLossTestCommand
Writable Attribute
Description

Type: enum
Default: NONE
Possible Values:
Value
Description
NONE
No verification.
VERIFY_EVERY_TRIAL


Type: u32
Default: 100
Range: 1 - 32767
Type: u32
Default: 1000
Range: 1 - 14880952
Rfc2544SetupBackToBackTestCommand Read-Only Attributes

Description:
Set up RFC 2544 frame loss test.

Parents: Sequencer
Relations:
Side name
(Type)
Relative
Description
TestCaseConfig
Rfc3918Config

Parent command.
Rfc2544SetupFrameLossTestCommand Writable Attributes

Writable Attribute
Description
DstDeviceList

Type: handle
Default: 0
2281
Writable Attribute
Description
Duration

Type: double
Default: 60
Range: 1 - 16777215
DurationMode
Type: enum
Default: SECONDS
Possible Values:
Value
Description
BURSTS

Type: bool
Default: TRUE
Possible Values:
Value Description
TRUE


Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
used.

Type: handle
Default: 0
FrameSizeList
Frame size list.

Type: u16
Default: 0
Range: 47 - 16383
LatencyType

Type: enum
Default: LILO
Possible Values:
Value Description
LILO
LIFO

LearningFreqMode
Learning frequency.
Type: enum
Default: LEARN_ONCE
Possible Values:
Value
Description
NONE
No learning.
LEARN_ONCE
LEARN_EVERY_TRIAL
Learn every trial.

2282
Writable Attribute
Description
LearningMode
Learning mode.
Type: enum
Default: AUTO
Possible Values:
Value
Description
AUTO
NONE
No learning.

LoadList

Type: double
Default: 0
Range: 0.000001 - 100000.0
LoadUnits
Type: enum
Possible Values:
Value
Description
PERCENT_LINE_RATE
FRAMES_PER_SECOND

KILOBITS_PER_SECOND
BITS_PER_SECOND
NumOfTrials
Number of trials.
Type: u16
Default: 1
Range: 1 - 60
SrcDeviceList
Source device list.

Type: handle
Default: 0
TrafficList
Traffic list.
Type: handle
Default: 0
TrafficPattern

Type: enum
Default: MESH
Possible Values:
Value
Description
PAIR
MESH


Type: bool
Default: TRUE
Possible Values:
Value Description
TRUE
2283
Rfc2544SetupLatencyTestCommand
Writable Attribute
Description
Traffic verification frequency.

Type: enum
Default: NONE
Possible Values:
Value
Description
NONE
No verification.
VERIFY_EVERY_TRIAL


Type: u32
Default: 100
Range: 1 - 32767
Type: u32
Default: 1000
Range: 1 - 14880952
Rfc2544SetupFrameLossTestCommand Read-Only Attributes

Description:
Set up RFC 2544 latency test.

Parents: Sequencer
Relations:
Side name
(Type)
Relative
Description
TestCaseConfig
Rfc3918Config

Parent command.
Rfc2544SetupLatencyTestCommand Writable Attributes

Writable Attribute
Description
DstDeviceList

Type: handle
Default: 0
2284
Writable Attribute
Description
Duration

Type: double
Default: 60
Range: 1 - 16777215
DurationMode
Type: enum
Default: SECONDS
Possible Values:
Value
Description
BURSTS

Type: bool
Default: TRUE
Possible Values:
Value Description
TRUE


Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
used.

Type: handle
Default: 0
FrameSizeList
Frame size list.

Type: u16
Default: 0
Range: 47 - 16383
LatencyType

Type: enum
Default: LILO
Possible Values:
Value Description
LILO
LIFO

LearningFreqMode
Learning frequency.
Type: enum
Default: LEARN_ONCE
Possible Values:
Value
Description
NONE
No learning.
LEARN_ONCE
LEARN_EVERY_TRIAL
Learn every trial.

2285
Writable Attribute
Description
LearningMode
Learning mode.
Type: enum
Default: AUTO
Possible Values:
Value
Description
AUTO
NONE
No learning.

LoadList

Type: double
Default: 0
Range: 0.000001 - 100000.0
LoadUnits
Type: enum
Possible Values:
Value
Description
PERCENT_LINE_RATE
FRAMES_PER_SECOND

KILOBITS_PER_SECOND
BITS_PER_SECOND
NumOfTrials
Number of trials.
Type: u16
Default: 1
Range: 1 - 60
SrcDeviceList
Source device list.

Type: handle
Default: 0
TrafficList
Traffic list.
Type: handle
Default: 0
TrafficPattern

Type: enum
Default: MESH
Possible Values:
Value
Description
PAIR
MESH


Type: bool
Default: TRUE
Possible Values:
Value Description
TRUE
2286
Rfc2544SetupThroughputTestCommand
Writable Attribute
Description

Type: enum
Default: NONE
Possible Values:
Value
Description
NONE
No verification.
VERIFY_EVERY_TRIAL


Type: u32
Default: 100
Range: 1 - 32767
Type: u32
Default: 1000
Range: 1 - 14880952
Rfc2544SetupLatencyTestCommand Read-Only Attributes

Description:
Set up RFC 2544 throughput test.

Parents: Sequencer
Relations:
Side name
(Type)
Relative
Description
TestCaseConfig
Rfc3918Config

Parent command.
Rfc2544SetupThroughputTestCommand Writable Attributes

Writable Attribute
Description
AcceptableFrameLoss
Maximum percentage of frames that can be lost during an iteration in order for the iteration to be considered successful.
Type: double
Default: 0
Range: 0.0 - 100.0
2287
Writable Attribute
Description
Backoff
Rate at which the load decreases after the DUT fails at the current load. Applicable when SearchMode is BINARY or
COMBO.
Type: double
Default: 50.0
Range: 0.001 - 99.999
DstDeviceList

Type: handle
Default: 0
Duration

Type: double
Default: 60
Range: 1 - 16777215
DurationMode
Type: enum
Default: SECONDS
Possible Values:
Value
Description
BURSTS

Type: bool
Default: TRUE
Possible Values:
Value Description
TRUE
FALSE Traffic is unidirectional.


Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
FALSE Default analyzer result view mode for the test is used.
EnableMaxLatencyThreshold
Whether the search algorithm uses the maximum latency per stream to determine the throughput.
Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
Search uses the maximum latency to determine the throughput.
FALSE Search does not use the maximum latency to determine the throughput.
EnableOutOfSeqThreshold
Whether the search algorithm uses the out-of-sequence frame count per stream to determine the throughput.
Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
Search uses the out-of-sequence frame count to determine the throughput.
FALSE Search does not use the out-of-sequence frame count to determine the throughput.

Type: handle
Default: 0
FrameSizeList
Frame size list.

Type: u16
Default: 0
Range: 47 - 16383
2288
Writable Attribute
Description
LatencyType
Latency type for different devices.

Type: enum
Default: LILO
Possible Values:
Value Description
FIFO First in, first out (bit forwarding devices).
LearningFreqMode
LIFO
Last in, first out (store-and-forward devices).
LILO
Last in, last out.
Learning frequency type.

Type: enum
Default: LEARN_ONCE
Possible Values:
Value
Description
NONE
No learning.
LEARN_ONCE
Learn once.
LEARN_EVERY_TRIAL
Learn every trial.

LearningMode
Learning mode.
Type: enum
Default: AUTO
Possible Values:
Value
Description
AUTO
NONE
No learning.

LoadUnits
Type: enum
Possible Values:
Value
Description
PERCENT_LINE_RATE Percentage of the line rate.
MaxLatencyThreshold
Maximum latency per stream that can be reached during an iteration in order for the iteration to be considered successful.
Type: double
Default: 30
Range: 0.01 - 4294967295.0
NumOfTrials
Number of trials.
Type: u16
Default: 1
Range: 1 - 60
OutOfSeqThreshold
Maximum out-of-sequence frames per stream that can be received during an iteration in order for the iteration to be
considered successful.
Type: u32
Default: 0
Range: 0 - 2147483647
RateInitial
If SearchMode is set to BINARY, the load rate at the beginning of the test. This attribute is ignored if SearchMode is
set to STEP.
Type: double
Default: 99.0
Range: 0.001 - 100.0
2289
Writable Attribute
Description
RateLowerLimit
Lowest transmission rate at which the application will send traffic during any test iteration, as a percentage of the total
wire rate.
Type: double
Default: 1.0
Range: 0.001 - 100.0
RateStep
If SearchMode is set to STEP, the amount the load increases from iteration to iteration. This attribute is ignored if
SearchMode is set to BINARY.
Type: double
Default: 10.0
Range: 0.001 - 100.0
RateUpperLimit
Maximum rate at which Spirent TestCenter will send traffic during the test,as a percentage of the total wire rate.
Type: double
Default: 100.0
Range: 0.001 - 100.0
Resolution
Finest adjustment possible for the load from iteration to iteration. If the required adjustment to the current load for the
next iteration is less than the resolution, the search stops. Applicable when SearchMode is BINARY or COMBO.
Type: double
Default: 1.0
Range: 0.001 - 100.0
SearchMode
Mode used to find the throughput rate.

Type: enum
Default: BINARY
Possible Values:
Value
Description
BINARY Test searches for the throughput value by using a binary search algorithm.
STEP
Test load increases with each iteration by the percentage specified by step load.
COMBO Mode begins in Step mode, then changes to Binary mode when the step adjustment causes failure.
SrcDeviceList
Source device list.

Type: handle
Default: 0
TrafficList
Traffic list.
Type: handle
Default: 0
TrafficPattern

Type: enum
Default: MESH
Possible Values:
Value
Description
PAIR
MESH


Type: bool
Default: TRUE
Possible Values:
Value Description
TRUE
2290
Writable Attribute
Description

Type: enum
Default: NONE
Possible Values:
Value
Description
NONE
No verification.
VERIFY_EVERY_TRIAL


Type: u32
Default: 100
Range: 1 - 32767
Type: u32
Default: 1000
Range: 1 - 14880952
Rfc2544SetupThroughputTestCommand Read-Only Attributes

Description:
This test determines the maximum forwarding rate at which the DUT/SUT can forward traffic without frame loss (or with a user-specified acceptable frame
loss).

Children: BenchmarkEthernet10GigPortConfig, Rfc2544ThroughputProfile, TimeToTestConfig
Relations:
Side name
(Type)
Relative
Description
GroupType
Type of side group.
Relation describing the binding to the Traffic

Descriptor Group.
Rfc2544ThroughputConfig Writable Attributes

Writable Attribute
Description
Active, Name
AcceptableFrameLoss
Type: double
Default: 0
Range: 0.0 - 100.0
2291
Writable Attribute
Description
AsymmetricTrafficBackoffMode
Determines how the rates will be backed off.

Type: enum
Default: FAILED_RATES
Possible Values:
Value
Description
ALL_RATES
Back off all rates.
FAILED_RATES Back off failed rates.

Backoff
Rate at which the load decreases after the DUT fails at the current load. Applicable when SearchMode is BINARY
or COMBO.
Type: double
Default: 50
Range: 0.001 - 99.999
CustomFrameSizeList
List of custom frame sizes to iterate.

Type: u16
Default: 0
Delay provides additional time to transmit test frames during one test iteration and allows all frames to be transmitted.
Type: u16
Default: 15
Range: 1 - 3600
DurationBursts

Type: u32
Default: 1000
Range: 1 - 16777215
DurationMode
Type: enum
Default: SECONDS
Possible Values:
Value
Description
BURSTS
DurationSeconds

Type: u32
Default: 60
Range: 1 - 5184000
Collect Detailed Results.

Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
Enable Collection of Detailed Results.
FALSE Disable Collection of Detailed Results.

Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
Displays the sequence of component commands of the benchmarking test being configured.
FALSE Displays the monolithic sequencer command for the benchmarking test being configured.
2292
Writable Attribute
Description
Whether to use frame size on test.

Type: bool
Default: TRUE
Possible Values:
Value Description
TRUE
Use frame size on test.
FALSE Do not use frame size on test.


Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
used.
EnableLearning
Whether to enable or disable L2L3 learning.

Type: bool
Default: TRUE
Possible Values:
Value Description
TRUE
Enable learning.
FALSE Disable learning.

Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
Whether the search algorithm uses the out-of-sequence frame count per stream to determine the throughput.
Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
Search uses the out-of-sequence frame count to determine the throughput.
FALSE Search does not use the out-of-sequence frame count to determine the throughput.
Whether to pause before starting.

Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
A breakpoint is inserted in the sequence requiring user intervention in order to continue the traffic start.
FALSE No breakpoint is inserted and flow continues as normal.


Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
2293
Writable Attribute
Description
FrameSizeEnd
Type: u16
Default: 256
Range: 47 - 16383

Type: enum
Default: CUSTOM
Possible Values:
Value
Description
RandomMaxFrameSize.
STEP

IMIX
iMIX mode.
NONE
FrameSizeStart
Type: u16
Default: 128
Range: 47 - 16383
FrameSizeStep
Type: u16
Default: 128
Range: 1 - 16383
IgnoreMinMaxLimits
Whether the search stops at the specified RateLowerLimit or RateUpperLimit value, or whether it continues beyond
those limits if an acceptable load has not yet been found.
Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
Continues beyond minimum and maximum limits to find acceptable load.
FALSE Search stops at the RateLowerLimit or RateUpperLimit value.

List of iMIX distributions to iterate.

Type: handle
Default: 0
For display purposes only.

Type: string
Delay in seconds before address resolution begins.

Type: u16
Default: 2
Range: 0 - 3600
L2LearningFrameRate
Rate at which learning frames are sent to the DUT/SUT during the learning phase of the test.
Type: u32
Default: 1000
Range: 1 - 14880952
Number of learning retries if transmission errors, learning verification errors, or link errors occur.
Type: u16
Default: 5
Range: 1 - 100
2294
Writable Attribute
Description
Delay in seconds before address resolution begins.

Type: u16
Default: 2
Range: 0 - 3600

Type: bool
Default: TRUE
Possible Values:
Value Description
TRUE
FALSE Disable cyclic address resolution.

L3Rate
Rate to send ARP requests.

Type: u32
Default: 1000
L3RetryCount

Type: u16
Default: 5
Range: 1 - 100
LatencyType

Type: enum
Default: LILO
Possible Values:
Value Description
LILO
LIFO

LearningFreqMode
Learning frequency.
Type: enum
Default: LEARN_ONCE
Possible Values:
Value
Description
LEARN_ONCE
Learning occurs only once per test.
LEARN_EVERY_TRIAL
Learning occurs on every trial.
LEARN_EVERY_FRAME_SIZE Learning occurs for every frame size.

LearningMode
Learning occurs for every iteration.
Learning mode.
Type: enum
Possible Values:
Value
Description
MaxLatencyThreshold
Maximum latency per stream that can be reached during an iteration in order for the iteration to be considered
successful.
Type: double
Default: 30
Range: 0.01 - 4294967295.0
NumOfTrials
Number of trials to run.

Type: u16
Default: 1
Range: 1 - 60
2295
Writable Attribute
Description
OutOfSeqThreshold
Maximum out-of-sequence frames per stream that can be received during an iteration in order for the iteration to be
considered successful.
Type: u32
Default: 0
Range: 0 - 2147483647

Type: string
ProfileConfigMode
Mode used to specify the mode used for creating profiles.

Type: enum
Default: MANUAL
Possible Values:
Value
Description
MANUAL
PER_PORT
PER_SIDE

RandomMaxFrameSize
Type: u16
Default: 256
Range: 47 - 16383
RandomMinFrameSize
Type: u16
Default: 128
Range: 47 - 16383
RateInitial
set to STEP.
Type: double
Default: 10
Range: 0.001 - 100.0
RateLowerLimit
If SearchMode is set to STEP, the starting load rate for each port. This attribute is ignored if SearchMode is set to
BINARY.
Type: double
Default: 1
Range: 0.001 - 100.0
RateStep
Type: double
Default: 10
Range: 0.001 - 100.0
RateUpperLimit
If SearchMode is set to STEP, the maximum load rate for each port. This attribute is ignored if SearchMode is set to
BINARY.
Type: double
Default: 100
Range: 0.001 - 100.0
Resolution
Finest adjustment possible for the load from iteration to iteration. If the required adjustment to the current load for
the next iteration is less than the resolution, the search stops. Applicable when SearchMode is BINARY or COMBO.
Type: double
Default: 1
Range: 0.001 - 100.0
2296
Writable Attribute
Description
SearchMode
Mode used to vary the load.

Type: enum
Default: BINARY
Possible Values:
Value
Description
BINARY Binary mode. The test searches for the throughput value using a binary search algorithm.
STEP
Step mode. The test load increases with each iteration as set by RateStep.
COMBO Combo mode. The test begins in step mode and then switches to binary mode when an iteration fails.
StaggerStartDelay
Delay (milliseconds) between the start of transmission of test traffic by individual ports.
Type: u16
Default: 0
Range: 0 - 65535
TrafficStartDelay
Provides additional time to transmit test frames during one test iteration and allows all frames to be transmitted.
Type: double
Default: 2
Range: 0.005 - 3600
Mode for traffic start delay.

Type: enum
Default: AFTER_TEST
Possible Values:
Value
Description
AFTER_TEST
After the test.
AFTER_USER_RESPONSE After the user response.


Type: bool
Default: TRUE
Possible Values:
Value Description
TRUE


Type: enum
Possible Values:
Value
Description
VERIFY_EVERY_TRIAL


Type: u16
Default: 100
Range: 1 - 32767
Type: u32
Default: 1000
Range: 1 - 14880952
Use Existing Stream Blocks.

Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
Uses existing stream blocks for the test.
FALSE Automatically generates new stream blocks for the test.
2297
Rfc2544ThroughputPerCoexistenceRatioResult
Rfc2544ThroughputConfig Read-Only Attributes

Description:
Result object.

Parents: Project
Relations:
Side name
(Type)
Relative
Description
ResultParent
(ResultChild)
Rfc2544ThroughputPerCoexistenceRatioResult Writable Attributes

Rfc2544ThroughputPerCoexistenceRatioResult Read-Only Attributes

Read-Only Attribute
Description
AvgJitter
Type: double
Default: 0
AvgLatency
Type: double
Default: 0
BurstSize

Type: u64
Default: 0
ChecksumErrorCount

Type: u64
Default: 0
ConfiguredFrameSize

Type: double
Default: 0
DuplicateFrameCount
Type: u64
Default: 0
DurationInSec

Type: double
Default: 0
ExpectedFrameCount

Type: u64
Default: 0
2298
Read-Only Attribute
Description
FcsErrorFrameCount
Type: u64
Default: 0
FloodCount
do not use it.
Type: u64
Default: 0
FloodedFrameCount
Type: u64
Default: 0
ForwardingRate
Type: double
Default: 0
iMIX distribution.
Type: string
Default: N/A
FrameLoss
Type: u64
Default: 0
FrameRate
do not use it.
Type: double
Default: 0
FrameSize
Frame size.
Type: double
Default: 0
FrameSizeType
Frame size type.

Type: string
Default: 0
IntendedLoad
Type: double
Default: 0
Ipv4AvgJitter

Type: double
Default: 0
Ipv4AvgLatency

Type: double
Default: 0
Ipv4FrameLoss

Type: u64
Default: 0
Ipv4IntendedLoad

Type: double
Default: 0
Ipv4MaxJitter

Type: double
Default: 0
2299
Read-Only Attribute
Description
Ipv4MaxLatency

Type: double
Default: 0
Ipv4MinJitter

Type: double
Default: 0
Ipv4MinLatency

Type: double
Default: 0
Ipv4OfferedLoad

Type: double
Default: 0
Ipv4RxFrameCount

Type: u64
Default: 0
Ipv4TxFrameCount

Type: u64
Default: 0
Ipv4TxFrameRate

Type: double
Default: 0
Ipv6AvgJitter

Type: double
Default: 0
Ipv6AvgLatency

Type: double
Default: 0
Ipv6ExtensionHeader

Type: string
Default: N/A
Ipv6FrameLoss

Type: u64
Default: 0
Ipv6IntendedLoad

Type: double
Default: 0

Type: string
Default: N/A
Ipv6MaxJitter

Type: double
Default: 0
Ipv6MaxLatency

Type: double
Default: 0
Ipv6MinJitter

Type: double
Default: 0
Ipv6MinLatency

Type: double
Default: 0
2300
Read-Only Attribute
Description
Ipv6OfferedLoad

Type: double
Default: 0
Ipv6RxFrameCount

Type: u64
Default: 0
Ipv6TxFrameCount

Type: u64
Default: 0
Ipv6TxFrameRate

Type: double
Default: 0
IterationNum
do not use it.
Iteration number.
Type: u8
Default: 0
LoadSize
do not use it.
Traffic Load.
Type: double
Default: 0
LoadSizeType
Load size type.

Type: string
Default: 0
MaxJitter
Type: double
Default: 0
MaxLatency
Type: double
Default: 0

Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE

MbpsLineRate
do not use it.
Type: double
Default: 0
MinJitter
Type: double
Default: 0
MinLatency
Type: double
Default: 0
OfferedLoad

Type: double
Default: 0
2301
Read-Only Attribute
Description
OtherFrameCount

Type: u64
Default: 0
OutOfSeqCount

Type: u64
Default: 0

Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE

PauseFrameCount
Type: u64
Default: 0
PercentLoss

Type: double
Default: 0
PfcFrameCount

Type: u64
Default: 0
Result
Type: string
Default: Failed
do not use it.
Type: u64
Default: 0
RxFrameCount

Type: u64
Default: 0
RxNonSigFrameCount
do not use it.
Type: u64
Default: 0
RxSigFrameCount
do not use it.
Type: u64
Default: 0
SearchKey

Type: string
Default: N/A
Throughput

Type: double
Default: 0
ThroughputRate
do not use it.
Throughput rate.
Type: double
Default: 0
2302
Rfc2544ThroughputPerFrameSizeResult
Read-Only Attribute
Description

Type: string
Default: N/A
TrialNum

Type: u8
Default: 0
TxFrameCount

Type: u64
Default: 0
TxFrameRate

Type: double
Default: 0
TxMbpsLoad

Type: double
Default: 0
TxSigFrameCount
do not use it.
Type: u64
Default: 0
Description:

Parents: Project
Relations:
Side name
(Type)
Relative
Description
ResultParent
(ResultChild)
Rfc2544ThroughputPerFrameSizeResult Writable Attributes

Rfc2544ThroughputPerFrameSizeResult Read-Only Attributes

Read-Only Attribute
Description
AvgJitter
Type: double
Default: 0
AvgLatency
Type: double
Default: 0
BurstSize

Type: u64
Default: 0
2303
Read-Only Attribute
Description
ChecksumErrorCount

Type: u64
Default: 0
ConfiguredFrameSize

Type: double
Default: 0
DuplicateFrameCount
Type: u64
Default: 0
DurationInSec

Type: double
Default: 0
ExpectedFrameCount

Type: u64
Default: 0
FcsErrorFrameCount
Type: u64
Default: 0
FloodCount
do not use it.
Type: u64
Default: 0
FloodedFrameCount
Type: u64
Default: 0
ForwardingRate
Type: double
Default: 0
iMIX distribution.
Type: string
Default: N/A
FrameLoss
Frame loss.
Type: u64
Default: 0
FrameRate
do not use it.
Type: double
Default: 0
FrameSize
Frame size.
Type: double
Default: 0
FrameSizeType
Frame size type.

Type: string
Default: 0
IntendedLoad
Intended load rate.

Type: double
Default: 0
2304
Read-Only Attribute
Description
Ipv4AvgJitter

Type: double
Default: 0
Ipv4AvgLatency

Type: double
Default: 0
Ipv4FrameLoss

Type: u64
Default: 0
Ipv4IntendedLoad

Type: double
Default: 0
Ipv4MaxJitter

Type: double
Default: 0
Ipv4MaxLatency

Type: double
Default: 0
Ipv4MinJitter

Type: double
Default: 0
Ipv4MinLatency

Type: double
Default: 0
Ipv4OfferedLoad

Type: double
Default: 0
Ipv4RxFrameCount

Type: u64
Default: 0
Ipv4TxFrameCount

Type: u64
Default: 0
Ipv4TxFrameRate

Type: double
Default: 0
Ipv6AvgJitter

Type: double
Default: 0
Ipv6AvgLatency

Type: double
Default: 0
Ipv6ExtensionHeader

Type: string
Default: N/A
Ipv6FrameLoss

Type: u64
Default: 0
Ipv6IntendedLoad

Type: double
Default: 0
2305
Read-Only Attribute
Description

Type: string
Default: N/A
Ipv6MaxJitter

Type: double
Default: 0
Ipv6MaxLatency

Type: double
Default: 0
Ipv6MinJitter

Type: double
Default: 0
Ipv6MinLatency

Type: double
Default: 0
Ipv6OfferedLoad

Type: double
Default: 0
Ipv6RxFrameCount

Type: u64
Default: 0
Ipv6TxFrameCount

Type: u64
Default: 0
Ipv6TxFrameRate

Type: double
Default: 0
IterationNum
do not use it.
Iteration number.
Type: u8
Default: 0
LoadSize
do not use it.
Traffic load value.
Type: double
Default: 0
LoadSizeType
Type: string
Default: 0
MaxJitter
Type: double
Default: 0
MaxLatency
Type: double
Default: 0

Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
2306
Read-Only Attribute
Description
MbpsLineRate
do not use it.
Type: double
Default: 0
MinJitter
Type: double
Default: 0
MinLatency
Type: double
Default: 0
OfferedLoad

Type: double
Default: 0
OtherFrameCount

Type: u64
Default: 0
OutOfSeqCount
Type: u64
Default: 0

Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE

PauseFrameCount
Type: u64
Default: 0
PercentLoss

Type: double
Default: 0
PfcFrameCount

Type: u64
Default: 0
Result
Type: string
Default: Failed
do not use it.
Type: u64
Default: 0
RxFrameCount

Type: u64
Default: 0
RxNonSigFrameCount
do not use it.
Type: u64
Default: 0
2307
Rfc2544ThroughputPerFrameSizeResultByPort
Read-Only Attribute
Description
RxSigFrameCount
do not use it.
Type: u64
Default: 0
SearchKey

Type: string
Default: N/A
Throughput

Type: double
Default: 0
ThroughputRate
do not use it.
Throughput rate.
Type: double
Default: 0

Type: string
Default: N/A
TrialNum

Type: u8
Default: 0
TxFrameCount

Type: u64
Default: 0
TxFrameRate

Type: double
Default: 0
TxMbpsLoad

Type: double
Default: 0
TxSigFrameCount
do not use it.
Type: u64
Default: 0
Rfc2544ThroughputPerFrameSizeResultByPort
Description:
RFC 2544 throughput per frame size result by port.
Rfc2544ThroughputPerFrameSizeResultByPort Writable Attributes

2308
Rfc2544ThroughputPerIpv6ExtensionHeaderResult
Rfc2544ThroughputPerFrameSizeResultByPort Read-Only Attributes

Read-Only Attribute
Description
FrameRate
Offered load (OLoad) in frames per second.

Type: double
Default: 0
MbpsLineRate

Type: double
Default: 0
PortHnd
Internal reference for this port.

Type: u32
Default: 0
PortName
Name of the port.

Type: string
Description:

Parents: Project
Relations:
Side name
(Type)
Relative
Description
ResultParent
(ResultChild)
Rfc2544ThroughputPerIpv6ExtensionHeaderResult Writable Attributes

Rfc2544ThroughputPerIpv6ExtensionHeaderResult Read-Only Attributes

Read-Only Attribute
Description
AvgJitter
Type: double
Default: 0
AvgLatency
Type: double
Default: 0
BurstSize

Type: u64
Default: 0
ChecksumErrorCount

Type: u64
Default: 0
2309
Read-Only Attribute
Description
ConfiguredFrameSize

Type: double
Default: 0
DuplicateFrameCount
Type: u64
Default: 0
DurationInSec

Type: double
Default: 0
ExpectedFrameCount

Type: u64
Default: 0
FcsErrorFrameCount
Type: u64
Default: 0
FloodCount
do not use it.
Type: u64
Default: 0
FloodedFrameCount
Type: u64
Default: 0
ForwardingRate
Type: double
Default: 0
iMIX distribution.
Type: string
Default: N/A
FrameLoss
Type: u64
Default: 0
FrameRate
do not use it.
Type: double
Default: 0
FrameSize
Frame size.
Type: double
Default: 0
FrameSizeType
Frame size type.

Type: string
Default: 0
IntendedLoad
Type: double
Default: 0
Ipv4AvgJitter

Type: double
Default: 0
2310
Read-Only Attribute
Description
Ipv4AvgLatency

Type: double
Default: 0
Ipv4FrameLoss

Type: u64
Default: 0
Ipv4IntendedLoad

Type: double
Default: 0
Ipv4MaxJitter

Type: double
Default: 0
Ipv4MaxLatency

Type: double
Default: 0
Ipv4MinJitter

Type: double
Default: 0
Ipv4MinLatency

Type: double
Default: 0
Ipv4OfferedLoad

Type: double
Default: 0
Ipv4RxFrameCount

Type: u64
Default: 0
Ipv4TxFrameCount

Type: u64
Default: 0
Ipv4TxFrameRate

Type: double
Default: 0
Ipv6AvgJitter

Type: double
Default: 0
Ipv6AvgLatency

Type: double
Default: 0
Ipv6ExtensionHeader

Type: string
Default: N/A
Ipv6FrameLoss

Type: u64
Default: 0
Ipv6IntendedLoad

Type: double
Default: 0

Type: string
Default: N/A
2311
Read-Only Attribute
Description
Ipv6MaxJitter

Type: double
Default: 0
Ipv6MaxLatency

Type: double
Default: 0
Ipv6MinJitter

Type: double
Default: 0
Ipv6MinLatency

Type: double
Default: 0
Ipv6OfferedLoad

Type: double
Default: 0
Ipv6RxFrameCount

Type: u64
Default: 0
Ipv6TxFrameCount

Type: u64
Default: 0
Ipv6TxFrameRate

Type: double
Default: 0
IterationNum
do not use it.
Iteration number.
Type: u8
Default: 0
LoadSize
do not use it.
Traffic load value.
Type: double
Default: 0
LoadSizeType
Load size type.

Type: string
Default: 0
MaxJitter
Type: double
Default: 0
MaxLatency
Type: double
Default: 0

Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
FALSE Maximum latency threshold has been exceeded.
2312
Read-Only Attribute
Description
MbpsLineRate
do not use it.
Offered Load (OLoad) in megabits per second.
Type: double
Default: 0
MinJitter
Type: double
Default: 0
MinLatency
Type: double
Default: 0
OfferedLoad

Type: double
Default: 0
OtherFrameCount

Type: u64
Default: 0
OutOfSeqCount

Type: u64
Default: 0

Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
FALSE Out of sequence frames threshold has been exceeded.

PauseFrameCount
Type: u64
Default: 0
PercentLoss

Type: double
Default: 0
PfcFrameCount

Type: u64
Default: 0
Result
Type: string
Default: Failed
do not use it.
Type: u64
Default: 0
RxFrameCount

Type: u64
Default: 0
RxNonSigFrameCount
do not use it.
Type: u64
Default: 0
2313
Rfc2544ThroughputPerIterationResult
Read-Only Attribute
Description
RxSigFrameCount
do not use it.
Type: u64
Default: 0
SearchKey

Type: string
Default: N/A
Throughput

Type: double
Default: 0
ThroughputRate
do not use it.
Throughput rate.
Type: double
Default: 0

Type: string
Default: N/A
TrialNum

Type: u8
Default: 0
TxFrameCount

Type: u64
Default: 0
TxFrameRate

Type: double
Default: 0
TxMbpsLoad

Type: double
Default: 0
TxSigFrameCount
do not use it.
Type: u64
Default: 0
Description:

Parents: Project
Relations:
Side name
(Type)
Relative
Description
ResultParent
(ResultChild)
2314
Rfc2544ThroughputPerIterationResult Writable Attributes

Rfc2544ThroughputPerIterationResult Read-Only Attributes

Read-Only Attribute
Description
AvgJitter
Type: double
Default: 0
AvgLatency
Type: double
Default: 0
BurstSize

Type: u64
Default: 0
ChecksumErrorCount

Type: u64
Default: 0
ConfiguredFrameSize

Type: double
Default: 0
DuplicateFrameCount
Type: u64
Default: 0
DurationInSec

Type: double
Default: 0
ExpectedFrameCount

Type: u64
Default: 0
FcsErrorFrameCount
Type: u64
Default: 0
FloodCount
do not use it.
Type: u64
Default: 0
FloodedFrameCount
Type: u64
Default: 0
ForwardingRate
Type: double
Default: 0
Type: string
Default: N/A
FrameLoss
Frame loss.
Type: u64
Default: 0
2315
Read-Only Attribute
Description
FrameRate
do not use it.
Type: double
Default: 0
FrameSize
Frame size.
Type: double
Default: 0
FrameSizeType

Type: string
Default: 0
IntendedLoad
Intended load rate.

Type: double
Default: 0
Ipv4AvgJitter

Type: double
Default: 0
Ipv4AvgLatency

Type: double
Default: 0
Ipv4FrameLoss

Type: u64
Default: 0
Ipv4IntendedLoad

Type: double
Default: 0
Ipv4MaxJitter

Type: double
Default: 0
Ipv4MaxLatency

Type: double
Default: 0
Ipv4MinJitter

Type: double
Default: 0
Ipv4MinLatency

Type: double
Default: 0
Ipv4OfferedLoad

Type: double
Default: 0
Ipv4RxFrameCount

Type: u64
Default: 0
Ipv4TxFrameCount

Type: u64
Default: 0
Ipv4TxFrameRate

Type: double
Default: 0
2316
Read-Only Attribute
Description
Ipv6AvgJitter

Type: double
Default: 0
Ipv6AvgLatency

Type: double
Default: 0
Ipv6ExtensionHeader

Type: string
Default: N/A
Ipv6FrameLoss

Type: u64
Default: 0
Ipv6IntendedLoad

Type: double
Default: 0

Type: string
Default: N/A
Ipv6MaxJitter

Type: double
Default: 0
Ipv6MaxLatency

Type: double
Default: 0
Ipv6MinJitter

Type: double
Default: 0
Ipv6MinLatency

Type: double
Default: 0
Ipv6OfferedLoad

Type: double
Default: 0
Ipv6RxFrameCount

Type: u64
Default: 0
Ipv6TxFrameCount

Type: u64
Default: 0
Ipv6TxFrameRate

Type: double
Default: 0
IterationNum
do not use it.
Iteration number.
Type: u8
Default: 0
LoadSize
do not use it.
Traffic load value.
Type: double
Default: 0
2317
Read-Only Attribute
Description
LoadSizeType
Type: string
Default: 0
MaxJitter
Type: double
Default: 0
MaxLatency
Type: double
Default: 0

Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE

MbpsLineRate
do not use it.
Offered Load (OLoad) in megabits per second.
Type: double
Default: 0
MinJitter
Type: double
Default: 0
MinLatency
Type: double
Default: 0
OfferedLoad

Type: double
Default: 0
OtherFrameCount

Type: u64
Default: 0
OutOfSeqCount
Type: u64
Default: 0

Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE

PauseFrameCount
Type: u64
Default: 0
PercentLoss

Type: double
Default: 0
PfcFrameCount

Type: u64
Default: 0
2318
Read-Only Attribute
Description
Result
Type: string
Default: Failed
do not use it.
Type: u64
Default: 0
RxFrameCount

Type: u64
Default: 0
RxNonSigFrameCount
do not use it.
Type: u64
Default: 0
RxSigFrameCount
do not use it.
Type: u64
Default: 0
SearchKey

Type: string
Default: N/A
Throughput

Type: double
Default: 0
ThroughputRate
do not use it.
Throughput rate.
Type: double
Default: 0

Type: string
Default: N/A
TrialNum

Type: u8
Default: 0
TxFrameCount

Type: u64
Default: 0
TxFrameRate

Type: double
Default: 0
TxMbpsLoad

Type: double
Default: 0
TxSigFrameCount
do not use it.
Type: u64
Default: 0
2319
Rfc2544ThroughputPerLoadResult
Description:

Parents: Project
Relations:
Side name
(Type)
Relative
Description
ResultParent
(ResultChild)
Rfc2544ThroughputPerLoadResult Writable Attributes

Rfc2544ThroughputPerLoadResult Read-Only Attributes

Read-Only Attribute
Description
AvgJitter

Type: double
Default: 0
AvgLatency

Type: double
Default: 0
BurstSize

Type: u64
Default: 0
ChecksumErrorCount

Type: u64
Default: 0
ConfiguredFrameSize

Type: double
Default: 0
DuplicateFrameCount
Type: u64
Default: 0
DurationInSec

Type: double
Default: 0
ExpectedFrameCount

Type: u64
Default: 0
FcsErrorFrameCount
Type: u64
Default: 0
FloodCount
do not use it.
Type: u64
Default: 0
2320
Read-Only Attribute
Description
FloodedFrameCount
Type: u64
Default: 0
ForwardingRate
Type: double
Default: 0
iMIX distribution.
Type: string
Default: N/A
FrameLoss
Frame loss.
Type: u64
Default: 0
FrameRate
do not use it.
Type: double
Default: 0
FrameSize
Frame size.
Type: double
Default: 0
FrameSizeType
Frame size type.

Type: string
Default: 0
IntendedLoad
Type: double
Default: 0
Ipv4AvgJitter

Type: double
Default: 0
Ipv4AvgLatency

Type: double
Default: 0
Ipv4FrameLoss

Type: u64
Default: 0
Ipv4IntendedLoad

Type: double
Default: 0
Ipv4MaxJitter

Type: double
Default: 0
Ipv4MaxLatency

Type: double
Default: 0
Ipv4MinJitter

Type: double
Default: 0
Ipv4MinLatency

Type: double
Default: 0
2321
Read-Only Attribute
Description
Ipv4OfferedLoad

Type: double
Default: 0
Ipv4RxFrameCount

Type: u64
Default: 0
Ipv4TxFrameCount

Type: u64
Default: 0
Ipv4TxFrameRate

Type: double
Default: 0
Ipv6AvgJitter

Type: double
Default: 0
Ipv6AvgLatency

Type: double
Default: 0
Ipv6ExtensionHeader

Type: string
Default: N/A
Ipv6FrameLoss

Type: u64
Default: 0
Ipv6IntendedLoad

Type: double
Default: 0

Type: string
Default: N/A
Ipv6MaxJitter

Type: double
Default: 0
Ipv6MaxLatency

Type: double
Default: 0
Ipv6MinJitter

Type: double
Default: 0
Ipv6MinLatency

Type: double
Default: 0
Ipv6OfferedLoad

Type: double
Default: 0
Ipv6RxFrameCount

Type: u64
Default: 0
Ipv6TxFrameCount

Type: u64
Default: 0
2322
Read-Only Attribute
Description
Ipv6TxFrameRate

Type: double
Default: 0
IterationNum
do not use it.
Iteration number.
Type: u8
Default: 0
LoadSize
do not use it.
Traffic load value.
Type: double
Default: 0
LoadSizeType
Type: string
Default: 0
MaxJitter

Type: double
Default: 0
MaxLatency

Type: double
Default: 0

Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE

MbpsLineRate
do not use it.
Type: double
Default: 0
MinJitter

Type: double
Default: 0
MinLatency

Type: double
Default: 0
OfferedLoad

Type: double
Default: 0
OtherFrameCount

Type: u64
Default: 0
OutOfSeqCount
Number of out of sequence frames received.

Type: u64
Default: 0
2323
Read-Only Attribute
Description

Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE

PauseFrameCount
Type: u64
Default: 0
PercentLoss

Type: double
Default: 0
PfcFrameCount

Type: u64
Default: 0
Result
Type: string
Default: Failed
do not use it.
Type: u64
Default: 0
RxFrameCount

Type: u64
Default: 0
RxNonSigFrameCount
do not use it.
Type: u64
Default: 0
RxSigFrameCount
do not use it.
Type: u64
Default: 0
SearchKey

Type: string
Default: N/A
Throughput

Type: double
Default: 0
ThroughputRate
do not use it.
Throughput rate.
Type: double
Default: 0

Type: string
Default: N/A
TrialNum

Type: u8
Default: 0
2324
Rfc2544ThroughputPerLoadResultByPort
Read-Only Attribute
Description
TxFrameCount

Type: u64
Default: 0
TxFrameRate

Type: double
Default: 0
TxMbpsLoad

Type: double
Default: 0
TxSigFrameCount
do not use it.
Type: u64
Default: 0
Rfc2544ThroughputPerLoadResultByPort
Description:
RFC 2544 throughput per load result by port.
Rfc2544ThroughputPerLoadResultByPort Writable Attributes

Rfc2544ThroughputPerLoadResultByPort Read-Only Attributes

Read-Only Attribute
Description
FrameRate
Offered load (OLoad) in frames per second.

Type: double
Default: 0
MbpsLineRate

Type: double
Default: 0
PortHnd
Internal reference for this port.

Type: u32
Default: 0
PortName
Name of the port.

Type: string
Rfc2544ThroughputProfile
Description:
Defines throughput parameters for asymmetric test configurations. These parameters override parameters in the Config object for the streamblocks that are
associated with it.
2325

Parents: Rfc2544ThroughputConfig
Relations:
Side name
(Type)
Relative
Description
StreamBlocks
StreamBlock
Streamblocks assigned to the profile.
Rfc2544ThroughputProfile Writable Attributes

Writable Attribute
Description
Active, Name
AcceptableFrameLoss
Maximum frame loss you want Spirent TestCenter to allow before stopping the test. This value represents the aggregate
loss from all flows averaged across each all ports in the test.
Type: double
Default: 0
Range: 0.0 - 100.0
Backoff
Percentage by which the transmission rate will be lowered if the test fails at the current rate.
Type: double
Default: 50
Range: 0.001 - 99.999
Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
Search algorithm uses the maximum latency per stream to determine the throughput.
FALSE Search algorithm does not use the maximum latency per stream to determine the throughput.
Select this field to enable the Out of Sequence Threshold field.

Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
Enable the Out of Sequence Threshold field.
FALSE Disable the Out of Sequence Threshold field.

IgnoreMinMaxLimits
Enable the application to automatically define a Min Rate /Max Rate range that successfully yields throughput.
Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
Continue beyond minimum or maximum.
FALSE Restricted between minimum and maximum.

LoadSpecMode

Type: enum
Default: PER_PORT
Possible Values:
Value
Description
PER_PORT
Total load per port.
PER_STREAMBLOCK Total load for each streamblock.
2326
Writable Attribute
Description
LoadUnits
Type: enum
Possible Values:
Value
Description
PERCENT_LINE_RATE
FRAMES_PER_SECOND

KILOBITS_PER_SECOND
BITS_PER_SECOND
MaxLatencyThreshold
Maximum (in uSec) of all the average latencies determined on each receive port in the test. If the threshold is reached,
then the test iteration fails.
Type: double
Default: 30
Range: 0.01 - 4294967295.0
OutOfSeqThreshold
Number of out-of-order frames on each receive port that, if exceeded,will cause the test iteration to fail.
Type: u32
Default: 0
Range: 0 - 2147483647
RateInitial
Transmission rate for the first iteration of the test. This is a percentage of the full wire rate.
Type: double
Default: 10
RateLowerLimit
wire rate.
Type: double
Default: 1
RateStep
Percent by which Spirent TestCenter will increase the current transmission rate, as a percentage of the total wire rate.
The transmission rate increases until the maximum rate is reached, even if there is frame loss.
Type: double
Default: 10
RateUpperLimit
Type: double
Default: 100
Resolution
Minimum allowable delta between the highest passed transmission rate and the lowest failed transmission rate.
Type: double
Default: 1
Range: 0.001 - 100.0
SearchMode

Type: enum
Default: BINARY
Possible Values:
Value
Description
STEP
Rfc2544ThroughputProfile Read-Only Attributes

2327
Description:

Parents: Project
Relations:
Side name
(Type)
Relative
Description
ResultParent
(ResultChild)

object.
Rfc2544ThroughputTestResult Writable Attributes

Rfc2544ThroughputTestResult Read-Only Attributes

Read-Only Attribute
Description
BurstSize

Type: u64
Default: 0
ChecksumErrorCount

Type: u64
Default: 0
ConfiguredFrameSize

Type: double
Default: 0
DuplicateFrameCount
Type: u64
Default: 0
ExpectedFrameCount

Type: u64
Default: 0
FcsErrorFrameCount
Type: u64
Default: 0
FloodCount
do not use it.
Type: u64
Default: 0
FloodedFrameCount
Type: u64
Default: 0
ForwardingRate
Type: double
Default: 0
Type: string
Default: N/A
2328
Read-Only Attribute
Description
FrameLoss
Type: u64
Default: 0
FrameRate
do not use it.
Type: double
Default: 0
FrameSize
Frame size.
Type: double
Default: 0
FrameSizeType

Type: string
Default: 0
IntendedLoad
Intended load rate.

Type: double
Default: 0
IterationTotal

Type: u8
Default: 0
LoadSize
do not use it.
Traffic load value.
Type: double
Default: 0
LoadSizeType
Type: string
Default: 0

Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE

OfferedLoad

Type: double
Default: 0
OtherFrameCount

Type: u64
Default: 0

Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE

PauseFrameCount
Type: u64
Default: 0
2329
Rfc2544TrafficGroupPerIterationResult
Read-Only Attribute
Description
PercentLoss

Type: double
Default: 0
PfcFrameCount

Type: u64
Default: 0
do not use it.
Type: u64
Default: 0
RxFrameCount

Type: u64
Default: 0
RxNonSigFrameCount
do not use it.
Type: u64
Default: 0
RxSigFrameCount
do not use it.
Type: u64
Default: 0
ThroughputRate
Throughput rate.
Type: double
Default: 0
TotalFrameLoss
Total frame loss.

Type: u64
Default: 0
TxFrameCount

Type: u64
Default: 0
TxFrameRate

Type: double
Default: 0
TxSigFrameCount
do not use it.
Type: u64
Default: 0
Description:
RFC 2544 Traffic group per iteration result object.Used in the end of test result database. You cannot subscribe to this object to get results.

2330

Rfc2544TrafficGroupPerIterationResult Writable Attributes

Rfc2544TrafficGroupPerIterationResult Read-Only Attributes

Read-Only Attribute
Description
AvgInterarrivalTime
Average interarrival time in microseconds.

Type: double
Default: 0
AvgJitter
Average jitter in microseconds.

Type: double
Default: 0
AvgLatency
Average latency in microseconds.

Type: double
Default: 0
BurstSize
Burst size.
Type: u32
Default: 0
DroppedFrameCount

Type: u64
Default: 0
DroppedFramePct

Type: double
Default: 0
DuplicateFrameCount

Type: u64
Default: 0

Type: u64
Default: 0
FcsErrorFrameCount
Number of frames received with FCS errors.

Type: u64
Default: 0
ForwardingRate
Rate at which frames are received in fps.

Type: double
Default: 0
Type: string
Default: N/A
FrameSizeType
Frame size type.

Type: string
Default: N/A
Average configured frame size.

Type: double
Default: 0
IntendedLoad
Intended load in percentage.

Type: double
Default: 0
2331
Read-Only Attribute
Description
IntendedMbpsLoad
Intended load in Mbps.

Type: double
Default: 0
LateFrameCount
Number of frame received late.

Type: u64
Default: 0
MaxInterarrivalTime
Maximum interarrival time in microseconds.

Type: double
Default: 0
MaxJitter
Maximum jitter in microseconds.

Type: double
Default: 0
MaxLatency
Maximum latency in microseconds.

Type: double
Default: 0
MbpsForwardingRate
Rate at which frames are received in Mbps.

Type: double
Default: 0
MinInterarrivalTime
Minimum interarrival time in microseconds.

Type: double
Default: 0
MinJitter
Minimum jitter in microseconds.

Type: double
Default: 0
MinLatency
Minimum latency in microseconds.

Type: double
Default: 0
OfferedAvgFrameSize
Average transmitted frame size.

Type: double
Default: 0
OfferedLoad
Offered load.
Type: double
Default: 0
OfferedMbpsLoad
Offered load in Mbps.

Type: double
Default: 0
OutSeqFrameCount

Type: u64
Default: 0
PrbsBitErrorCount
Number of frames received with PRBS bit errors.

Type: u64
Default: 0
ReorderedFrameCount
Number of reordered frames received.

Type: u64
Default: 0
RxFrameCount

Type: u64
Default: 0
SearchKey

Type: string
Default: 0
2332
Rfc2544TrafficGroupWeightConfig
Read-Only Attribute
Description
TrafficGroupName
Traffic group name.

Traffic group name.
Type: string
Default: 0
TrialNum
Trial number.
Type: u8
Default: 0
TxFrameCount

Type: u64
Default: 0
TxFrameRate
Rate at which frames are transmitted in fps.

Type: double
Default: 0
Rfc2544TrafficGroupWeightConfig
Description:
RFC 2544 traffic group weight configuration.

Relations:
Side name
(Type)
Relative
Description
TrafficGroup
(Rfc2544TrafficGroupBinding)
TrafficGroup
Traffic group.
Rfc2544TrafficGroupWeightConfig Writable Attributes

Writable Attribute
Description
Active, Name
WeightList
Traffic weight list.

Type: u64
Default: 0
Rfc2544TrafficGroupWeightConfig Read-Only Attributes

Rfc2889AddrCachingCapacityConfig
Description:
Configuration object for RFC 2889 Address Caching Capacity Test.

Parents: Project
Children: BenchmarkEthernet10GigPortConfig
2333
Relations:
Side name
(Type)
Relative
Description
Relation describing the binding to the Traffic Descriptor

Group.
Rfc2889AddrCachingCapacityConfig Writable Attributes

Writable Attribute
Description
Active, Name
AgingTime
Aging timer value in the DUT/SUT. It removes MAC addresses from the cache when this timer expires. The Aging
Time value must be set high enough for the test to complete, based on the values for initial and minimum number
of addresses. A warning is sent if the Aging Time value is too low.
Type: u16
Default: 15
Range: 1 - 3600
CustomFrameSizeList

Type: u16
Default: 0

Type: u16
Default: 15
Range: 1 - 3600

Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
Whether to use the frame size specified in the test-level attributes.

Type: bool
Default: TRUE
Possible Values:
Value Description
TRUE
Use test-level frame size.
FALSE Do not use test-level frame size.

view mode.
Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
2334
Writable Attribute
Description
EnableLearning

Type: bool
Default: TRUE
Possible Values:
Value Description
TRUE


Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
FALSE No breakpoint is inserted in the sequence.


Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
ExternalProcessCommand
Command to run an user specified external process.

Type: string
FrameSize
use it.
Frame size.
Type: u16
Default: 64
Range: 64 - 16383
FrameSizeEnd
Type: u16
Default: 256
Range: 64 - 16383

Type: enum
Default: CUSTOM
Possible Values:
Value
Description
RandomMaxFrameSize.
STEP

FrameSizeStart
Type: u16
Default: 128
Range: 64 - 16383
FrameSizeStep
Type: u16
Default: 128
Range: 1 - 16383
2335
Writable Attribute
Description
InitialNumAddrs
Number of addresses to be sent to the DUT/SUT in the first iteration.

Type: u32
Default: 20480
Range: 1 - 16777215
Time in seconds prior to the commencement of training.

Type: u16
Default: 2
Range: 0 - 3600
L2LearningFrameRate
Layer 2 learning rate in frames per second for the test. This value must be greater than AgingTime.
Type: u32
Default: 1000
Range: 1 - 14880952
Type: u16
Default: 5
Range: 1 - 100
Delay in seconds before performing L3 Learning.

Type: u16
Default: 2
Range: 0 - 3600
LatencyType

Type: enum
Default: LILO
Possible Values:
Value Description
LILO
Last in, last out.
LIFO

LearningFreqMode
Learning frequency.
Type: enum
Default: LEARN_ONCE
Possible Values:
Value
Description
LEARN_ONCE
LEARN_EVERY_TRIAL
Learn every trial.
LEARN_EVERY_FRAME_SIZE Learn every frame size iteration.

LearningRate
Number of learning frames per second.

Type: u32
Default: 1000
Range: 1 - 14880952
MaxNumAddrs
Highest number of addresses to be sent to the DUT/SUT.

Type: u32
Default: 65536
Range: 1 - 16777216
MinNumAddrs
Lowest number of addresses to be sent to the DUT/SUT.

Type: u32
Default: 1
Range: 1 - 16777216
NumOfTrials
Number of times the test repeats with its initial configuration.

Each trial is based on the same parameter values. Within a trial, certain parameter values vary with each iteration,
according to the test methodology and setup. At the start of the next trial, these parameters revert to their initial
values.
Type: u16
Default: 1
Range: 1 - 60
2336
Writable Attribute
Description
RandomMaxFrameSize
Type: u16
Default: 256
Range: 64 - 16383
RandomMinFrameSize
Type: u16
Default: 128
Range: 64 - 16383
Resolution
Finest adjustment possible, in number of addresses, from iteration to iteration.

Type: u32
Default: 2
Range: 1 - 16777216
RunExternalProcessBeforeTraffic
Allows user to run an external process before generating and transmitting traffic.
Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
Run an user specified external process.
FALSE No external process is run.

StaggerStartDelay
Delay between starting successive ports, in milliseconds.

Type: u16
Default: 0
Range: 0 - 65535
TrafficStartDelay

Type: double
Default: 2
Range: 0.005 - 3600

Type: enum
Default: AFTER_TEST
Possible Values:
Value
Description
AFTER_TEST


Type: bool
Default: TRUE
Possible Values:
Value Description
TRUE


Type: enum
Possible Values:
Value
Description
VERIFY_EVERY_TRIAL


Type: u16
Default: 100
Range: 1 - 32767
2337
Rfc2889AddrCachingPerAddrResult
Writable Attribute
Description
Type: u32
Default: 1000
Range: 1 - 14880952
Rfc2889AddrCachingCapacityConfig Read-Only Attributes

Description:

Parents: Project
Relations:
Side name
(Type)
Relative
Description
ResultParent
(ResultChild)
Rfc2889AddrCachingPerAddrResult Writable Attributes

Rfc2889AddrCachingPerAddrResult Read-Only Attributes

Read-Only Attribute
Description
AddrCount
Address count.
Type: u64
Default: 0
BurstSize

Type: u64
Default: 0
ChecksumErrorCount

Type: u64
Default: 0
ConfiguredFrameSize

Type: double
Default: 0
DuplicateFrameCount
Type: u64
Default: 0
ExpectedFrameCount
Number of frames expected to be transmitted.

Type: u64
Default: 0
FcsErrorFrameCount
Type: u64
Default: 0
2338
Read-Only Attribute
Description
FloodCount
not use it.
Number of frames flooded.
Type: u64
Default: 0
FloodedFrameCount
Type: u64
Default: 0
Type: string
Default: N/A
FrameLoss

Type: u64
Default: 0
FrameRate
not use it.
Type: double
Default: 0
FrameSize

Type: double
Default: 0
FrameSizeType

Type: string
Default: 0
IntendedLoad
Type: double
Default: 0
IterationNum
not use it.
Iteration number.
Type: u8
Default: 0
LoadSize
not use it.
Traffic load.
Type: double
Default: 0
LoadSizeType
Type: string
Default: 0
OfferedLoad

Type: double
Default: 0
OtherFrameCount

Type: u64
Default: 0
2339
Read-Only Attribute
Description
Passed
Indicates whether a test passed or failed.

Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
Test passed.
FALSE Test failed.

PauseFrameCount
Type: u64
Default: 0
PercentLearn
Percentage of addresses learned.

Type: double
Default: 0
PercentLoss

Type: double
Default: 0
PfcFrameCount

Type: u64
Default: 0
not use it.
Type: u64
Default: 0
RxFrameCount

Type: u64
Default: 0
RxNonSigFrameCount
not use it.
Number of non-signature frames received.
Type: u64
Default: 0
RxSigFrameCount
not use it.
Type: u64
Default: 0
TrialNum

Type: u8
Default: 0
TxFrameCount
Total number of frames being transmitted.

Type: u64
Default: 0
TxFrameRate

Type: double
Default: 0
TxSigFrameCount
not use it.
Number of Spirent signature frames transmitted.
Type: u64
Default: 0
2340
Rfc2889AddrCachingPerFrameSizeResult
Description:
RFC 2889 address caching result for each frame size.

Parents: Project
Relations:
Side name
(Type)
Relative
Description
ResultParent
(ResultChild)
Rfc2889AddrCachingPerFrameSizeResult Writable Attributes

Rfc2889AddrCachingPerFrameSizeResult Read-Only Attributes

Read-Only Attribute
Description
AddrCount
Type: u64
Default: 0
BurstSize

Type: u64
Default: 0
ChecksumErrorCount

Type: u64
Default: 0
ConfiguredFrameSize
User configured frame size to be transmitted.

Type: double
Default: 0
DuplicateFrameCount
Type: u64
Default: 0
ExpectedFrameCount

Type: u64
Default: 0
FcsErrorFrameCount
Type: u64
Default: 0
FloodCount
not use it.
Type: u64
Default: 0
FloodedFrameCount
Type: u64
Default: 0
Type: string
Default: N/A
2341
Read-Only Attribute
Description
FrameLoss

Type: u64
Default: 0
FrameRate
not use it.
Type: double
Default: 0
FrameSize

Type: double
Default: 0
FrameSizeType

Type: string
Default: 0
IntendedLoad
Type: double
Default: 0
IterationNum
not use it.
Number of iterations.
Type: u8
Default: 0
LoadSize
not use it.
Traffic load.
Type: double
Default: 0
LoadSizeType
Type: string
Default: 0
OfferedLoad

Type: double
Default: 0
OtherFrameCount

Type: u64
Default: 0
Passed
Pass or fail
Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
Pass
FALSE Fail
PauseFrameCount
Type: u64
Default: 0
PercentLearn

Type: double
Default: 0
PercentLoss

Type: double
Default: 0
2342
Rfc2889AddrCachingPerIterationResult
Read-Only Attribute
Description
PfcFrameCount

Type: u64
Default: 0
not use it.
Type: u64
Default: 0
RxFrameCount

Type: u64
Default: 0
RxNonSigFrameCount
not use it.
Type: u64
Default: 0
RxSigFrameCount
not use it.
Type: u64
Default: 0
TrialNum
Number of trials
Type: u8
Default: 0
TxFrameCount

Type: u64
Default: 0
TxFrameRate

Type: double
Default: 0
TxSigFrameCount
not use it.
Type: u64
Default: 0
Description:

Parents: Project
Relations:
Side name
(Type)
Relative
Description
ResultParent
(ResultChild)
Rfc2889AddrCachingPerIterationResult Writable Attributes

2343
Rfc2889AddrCachingPerIterationResult Read-Only Attributes

Read-Only Attribute
Description
AddrCount
Address count.
Type: u64
Default: 0
BurstSize

Type: u64
Default: 0
ChecksumErrorCount

Type: u64
Default: 0
ConfiguredFrameSize

Type: double
Default: 0
DuplicateFrameCount
Type: u64
Default: 0
ExpectedFrameCount

Type: u64
Default: 0
FcsErrorFrameCount
Type: u64
Default: 0
FloodCount
not use it.
Type: u64
Default: 0
FloodedFrameCount
Type: u64
Default: 0
Type: string
Default: N/A
FrameLoss

Type: u64
Default: 0
FrameRate
not use it.
Type: double
Default: 0
FrameSize

Type: double
Default: 0
FrameSizeType

Type: string
Default: 0
IntendedLoad
Type: double
Default: 0
2344
Read-Only Attribute
Description
IterationNum
not use it.
Iteration number.
Type: u8
Default: 0
LoadSize
not use it.
Traffic load.
Type: double
Default: 0
LoadSizeType
Type: string
Default: 0
OfferedLoad

Type: double
Default: 0
OtherFrameCount

Type: u64
Default: 0
Passed
Indicates whether a test passed or failed.

Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
Test passed.
FALSE Test failed.

PauseFrameCount
Type: u64
Default: 0
PercentLearn
Percentage of the addresses learnt.

Type: double
Default: 0
PercentLoss

Type: double
Default: 0
PfcFrameCount

Type: u64
Default: 0
not use it.
Type: u64
Default: 0
RxFrameCount

Type: u64
Default: 0
RxNonSigFrameCount
not use it.
Type: u64
Default: 0
2345
Rfc2889AddrCachingPerPortResult
Read-Only Attribute
Description
RxSigFrameCount
not use it.
Type: u64
Default: 0
TrialNum

Type: u8
Default: 0
TxFrameCount

Type: u64
Default: 0
TxFrameRate

Type: double
Default: 0
TxSigFrameCount
not use it.
Type: u64
Default: 0
Description:

Parents: Project
Relations:
Side name
(Type)
Relative
Description
ResultParent
(ResultChild)
Rfc2889AddrCachingPerPortResult Writable Attributes

Rfc2889AddrCachingPerPortResult Read-Only Attributes

Read-Only Attribute
Description
AddrCount
Address count.
Type: u64
Default: 0
BurstSize

Type: u64
Default: 0
ChecksumErrorCount

Type: u64
Default: 0
2346
Read-Only Attribute
Description
ConfiguredFrameSize

Type: double
Default: 0
DuplicateFrameCount
Type: u64
Default: 0
ExpectedFrameCount

Type: u64
Default: 0
FcsErrorFrameCount
Type: u64
Default: 0
FloodCount
not use it.
Type: u64
Default: 0
FloodedFrameCount
Type: u64
Default: 0
Type: string
Default: N/A
FrameLoss

Type: u64
Default: 0
FrameRate
not use it.
Type: double
Default: 0
FrameSize
Average frame size transmitted.

Type: double
Default: 0
FrameSizeType

Type: string
Default: 0
IntendedLoad
Type: double
Default: 0
IterationNum
not use it.
Iteration number.
Type: u8
Default: 0
LoadSize
not use it.
Traffic load.
Type: double
Default: 0
2347
Read-Only Attribute
Description
LoadSizeType
Type: string
Default: 0
OfferedLoad

Type: double
Default: 0
OtherFrameCount

Type: u64
Default: 0
Passed
Indicates whether the test passed or failed.

Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
Test passed.
FALSE Test failed.

PauseFrameCount
Type: u64
Default: 0
PercentLearn

Type: double
Default: 0
PercentLoss

Type: double
Default: 0
PfcFrameCount

Type: u64
Default: 0
Port
Port name.
Type: string
Default: Test
PortType
Port type. That is, Tx, Rx, or monitor port.

Type: string
Default: -
not use it.
Type: u64
Default: 0
RxFrameCount

Type: u64
Default: 0
RxNonSigFrameCount
not use it.
Type: u64
Default: 0
RxSigFrameCount
not use it.
Type: u64
Default: 0
2348
Rfc2889AddrCachingTestResult
Read-Only Attribute
Description
TrialNum

Type: u8
Default: 0
TxFrameCount

Type: u64
Default: 0
TxFrameRate

Type: double
Default: 0
TxSigFrameCount
not use it.
Type: u64
Default: 0
Description:

Parents: Project
Relations:
Side name
(Type)
Relative
Description
ResultParent
(ResultChild)
Project
Rfc2889AddrCachingTestResult Writable Attributes

Rfc2889AddrCachingTestResult Read-Only Attributes

Read-Only Attribute
Description
BurstSize

Type: u64
Default: 0
CachingCapacity
Address caching capacity.

Type: u64
Default: 0
ChecksumErrorCount

Type: u64
Default: 0
ConfiguredFrameSize

Type: double
Default: 0
2349
Read-Only Attribute
Description
DuplicateFrameCount
Type: u64
Default: 0
ExpectedFrameCount

Type: u64
Default: 0
FcsErrorFrameCount
Type: u64
Default: 0
FloodCount
do not use it.
Type: u64
Default: 0
FloodedFrameCount
Type: u64
Default: 0
Type: string
Default: N/A
FrameLoss

Type: u64
Default: 0
FrameRate
do not use it.
Type: double
Default: 0
FrameSize

Type: double
Default: 0
FrameSizeType

Type: string
Default: 0
IntendedLoad
Type: double
Default: 0
IterationTotal

Type: u8
Default: 0
LoadSize
do not use it.
Traffic load.
Type: double
Default: 0
LoadSizeType
Type: string
Default: 0
OfferedLoad

Type: double
Default: 0
2350
Read-Only Attribute
Description
OtherFrameCount

Type: u64
Default: 0
Passed
Indicates if the test passed or not.

Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
Test passed.
FALSE Test failed.

PauseFrameCount
Type: u64
Default: 0
PercentLearn
Percentage of the addresses learned.

Type: double
Default: 0
PercentLoss

Type: double
Default: 0
PfcFrameCount

Type: u64
Default: 0
do not use it.
Type: u64
Default: 0
RxFrameCount

Type: u64
Default: 0
RxNonSigFrameCount
do not use it.
Type: u64
Default: 0
RxSigFrameCount
do not use it.
Type: u64
Default: 0
TxFrameCount

Type: u64
Default: 0
TxFrameRate

Type: double
Default: 0
TxSigFrameCount
do not use it.
Type: u64
Default: 0
2351
Rfc2889AddrLearningPerFrameSizeResult
Description:

Parents: Project
Relations:
Side name
(Type)
Relative
Description
ResultParent
(ResultChild)
Rfc2889AddrLearningPerFrameSizeResult Writable Attributes

Rfc2889AddrLearningPerFrameSizeResult Read-Only Attributes

Read-Only Attribute
Description
BurstSize

Type: u64
Default: 0
ChecksumErrorCount

Type: u64
Default: 0
ConfiguredFrameSize

Type: double
Default: 0
DuplicateFrameCount
Type: u64
Default: 0
ExpectedFrameCount

Type: u64
Default: 0
FcsErrorFrameCount
Type: u64
Default: 0
FloodCount
not use it.
Type: u64
Default: 0
FloodedFrameCount

Type: u64
Default: 0
Type: string
Default: N/A
FrameLoss

Type: u64
Default: 0
2352
Read-Only Attribute
Description
FrameRate
not use it.
Type: double
Default: 0
FrameSize

Type: double
Default: 0
FrameSizeType

Type: string
Default: 0
IntendedLoad
Type: double
Default: 0
IterationNum
not use it.
Number of the current iteration.
Type: u8
Default: 0
LearningRate

Type: u64
Default: 0
LoadSize
not use it.
Traffic load.
Type: double
Default: 0
LoadSizeType
Type: string
Default: 0
OfferedLoad

Type: double
Default: 0
OtherFrameCount

Type: u64
Default: 0
Passed

Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
Test passed.
FALSE Test failed.

PauseFrameCount
Type: u64
Default: 0
PercentLoss

Type: double
Default: 0
PfcFrameCount

Type: u64
Default: 0
2353
Rfc2889AddrLearningPerIterationResult
Read-Only Attribute
Description
not use it.
Type: u64
Default: 0
RxFrameCount

Type: u64
Default: 0
RxNonSigFrameCount
not use it.
Type: u64
Default: 0
RxSigFrameCount
not use it.
Type: u64
Default: 0
TrialNum

Type: u8
Default: 0
TxFrameCount

Type: u64
Default: 0
TxFrameRate

Type: double
Default: 0
TxSigFrameCount
not use it.
Type: u64
Default: 0
Description:

Parents: Project
Relations:
Side name
(Type)
Relative
Description
ResultParent
(ResultChild)
Rfc2889AddrLearningPerIterationResult Writable Attributes

2354
Rfc2889AddrLearningPerIterationResult Read-Only Attributes

Read-Only Attribute
Description
BurstSize

Type: u64
Default: 0
ChecksumErrorCount

Type: u64
Default: 0
ConfiguredFrameSize

Type: double
Default: 0
DuplicateFrameCount
Type: u64
Default: 0
ExpectedFrameCount

Type: u64
Default: 0
FcsErrorFrameCount
Type: u64
Default: 0
FloodCount
not use it.
Type: u64
Default: 0
FloodedFrameCount
Type: u64
Default: 0
Type: string
Default: N/A
FrameLoss

Type: u64
Default: 0
FrameRate
not use it.
Type: double
Default: 0
FrameSize

Type: double
Default: 0
FrameSizeType

Type: string
Default: 0
IntendedLoad
Type: double
Default: 0
2355
Read-Only Attribute
Description
IterationNum
not use it.
Iteration number.
Type: u8
Default: 0
LearningRate

Type: u64
Default: 0
LoadSize
not use it.
Traffic load.
Type: double
Default: 0
LoadSizeType
Type: string
Default: 0
OfferedLoad

Type: double
Default: 0
OtherFrameCount

Type: u64
Default: 0
Passed

Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
Test Passed.
FALSE Test failed.

PauseFrameCount
Type: u64
Default: 0
PercentLoss

Type: double
Default: 0
PfcFrameCount

Type: u64
Default: 0
not use it.
Type: u64
Default: 0
RxFrameCount

Type: u64
Default: 0
RxNonSigFrameCount
not use it.
Type: u64
Default: 0
2356
Rfc2889AddrLearningPerLearningRateResult
Read-Only Attribute
Description
RxSigFrameCount
not use it.
Type: u64
Default: 0
TrialNum

Type: u8
Default: 0
TxFrameCount

Type: u64
Default: 0
TxFrameRate

Type: double
Default: 0
TxSigFrameCount
not use it.
Type: u64
Default: 0
Description:

Parents: Project
Relations:
Side name
(Type)
Relative
Description
ResultParent
(ResultChild)
Rfc2889AddrLearningPerLearningRateResult Writable Attributes

Rfc2889AddrLearningPerLearningRateResult Read-Only Attributes

Read-Only Attribute
Description
BurstSize

Type: u64
Default: 0
ChecksumErrorCount

Type: u64
Default: 0
ConfiguredFrameSize

Type: double
Default: 0
2357
Read-Only Attribute
Description
DuplicateFrameCount
Type: u64
Default: 0
ExpectedFrameCount

Type: u64
Default: 0
FcsErrorFrameCount
Type: u64
Default: 0
FloodCount
not use it.
Type: u64
Default: 0
FloodedFrameCount
Type: u64
Default: 0
Type: string
Default: N/A
FrameLoss

Type: u64
Default: 0
FrameRate
not use it.
Type: double
Default: 0
FrameSize

Type: double
Default: 0
FrameSizeType

Type: string
Default: 0
IntendedLoad
Type: double
Default: 0
IterationNum
not use it.
Iteration number.
Type: u8
Default: 0
LearningRate

Type: u64
Default: 0
LoadSize
not use it.
Traffic load.
Type: double
Default: 0
2358
Read-Only Attribute
Description
LoadSizeType
Type: string
Default: 0
OfferedLoad

Type: double
Default: 0
OtherFrameCount

Type: u64
Default: 0
Passed

Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
Test passed.
FALSE Test failed.

PauseFrameCount
Type: u64
Default: 0
PercentLoss

Type: double
Default: 0
PfcFrameCount

Type: u64
Default: 0
not use it.
Type: u64
Default: 0
RxFrameCount

Type: u64
Default: 0
RxNonSigFrameCount
not use it.
Type: u64
Default: 0
RxSigFrameCount
not use it.
Type: u64
Default: 0
TrialNum

Type: u8
Default: 0
TxFrameCount

Type: u64
Default: 0
TxFrameRate

Type: double
Default: 0
2359
Rfc2889AddrLearningPerPortResult
Read-Only Attribute
Description
TxSigFrameCount
not use it.
Type: u64
Default: 0
Description:

Parents: Project
Relations:
Side name
(Type)
Relative
Description
ResultParent
(ResultChild)
Rfc2889AddrLearningPerPortResult Writable Attributes

Rfc2889AddrLearningPerPortResult Read-Only Attributes

Read-Only Attribute
Description
BurstSize

Type: u64
Default: 0
ChecksumErrorCount

Type: u64
Default: 0
ConfiguredFrameSize

Type: double
Default: 0
DuplicateFrameCount
Type: u64
Default: 0
ExpectedFrameCount

Type: u64
Default: 0
FcsErrorFrameCount
Type: u64
Default: 0
FloodCount
not use it.
Type: u64
Default: 0
2360
Read-Only Attribute
Description
FloodedFrameCount
Type: u64
Default: 0
Type: string
Default: N/A
FrameLoss

Type: u64
Default: 0
FrameRate
not use it.
Type: double
Default: 0
FrameSize

Type: double
Default: 0
FrameSizeType

Type: string
Default: 0
IntendedLoad
Type: double
Default: 0
IterationNum
not use it.
Iteration number.
Type: u8
Default: 0
LearningRate

Type: u64
Default: 0
LoadSize
not use it.
Traffic load.
Type: double
Default: 0
LoadSizeType
Type: string
Default: 0
OfferedLoad

Type: double
Default: 0
OtherFrameCount

Type: u64
Default: 0
Passed

Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
Test passed.
FALSE Test failed.
2361
Rfc2889AddrLearningRateConfig
Read-Only Attribute
Description
PauseFrameCount
Type: u64
Default: 0
PercentLoss

Type: double
Default: 0
PfcFrameCount

Type: u64
Default: 0
Port
Name of the port.

Type: string
Default: Test
PortType
Specifies the role of the port during a test.

Type: string
Default: -
not use it.
Type: u64
Default: 0
RxFrameCount

Type: u64
Default: 0
RxNonSigFrameCount
not use it.
Type: u64
Default: 0
RxSigFrameCount
not use it.
Type: u64
Default: 0
TrialNum

Type: u8
Default: 0
TxFrameCount

Type: u64
Default: 0
TxFrameRate

Type: double
Default: 0
TxSigFrameCount
not use it.
Type: u64
Default: 0
Description:
2362
Configuration object for the RFC 2889 Address Learning Rate test.

Parents: Project
Relations:
Side name
(Type)
Relative
Description

Group.
Rfc2889AddrLearningRateConfig Writable Attributes

Writable Attribute
Description
Active, Name
AgingTime
of addresses. A warning is sent if the Aging Time value is too low.
Type: u16
Default: 15
Range: 1 - 3600
CustomFrameSizeList

Type: u16
Default: 0

Type: u16
Default: 15
Range: 1 - 3600

Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE

Type: bool
Default: TRUE
Possible Values:
Value Description
TRUE
Use the test-level frame size.
FALSE Do not use the test-level frame size.
2363
Writable Attribute
Description
view mode.
Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
EnableLearning

Type: bool
Default: TRUE
Possible Values:
Value Description
TRUE


Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE


Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE

Type: string
FrameSize
use it.
Frame size.
Type: u16
Default: 64
Range: 64 - 16383
FrameSizeEnd
Type: u16
Default: 256
Range: 64 - 16383

Type: enum
Default: CUSTOM
Possible Values:
Value
Description
RandomMaxFrameSize.
STEP
2364
Writable Attribute
Description
FrameSizeStart
Type: u16
Default: 128
Range: 64 - 16383
FrameSizeStep
Type: u16
Default: 128
Range: 1 - 16383
InitialLearningRate
Learning rate (number of learning frames per second) at the start of the test.
Type: u32
Default: 1488
Range: 1 - 14880952

Type: u16
Default: 2
Range: 0 - 3600
L2LearningFrameRate
Layer 2 learning rate in frames per second for the test. This value must be greater than AgingTime.
Type: u32
Default: 1000
Range: 1 - 14880952
Type: u16
Default: 5
Range: 1 - 100

Type: u16
Default: 2
Range: 0 - 3600
LatencyType

Type: enum
Default: LILO
Possible Values:
Value Description
LILO
Last in, last out.
LIFO

LearningFreqMode
Learning frequency.
Type: enum
Default: LEARN_ONCE
Possible Values:
Value
Description
LEARN_ONCE
LEARN_EVERY_TRIAL
Learn every trial.

MacAddrCount
Number of MAC addresses to be sent from each transmitting test port.

Type: u32
Default: 1
Range: 1 - 16777216
MaxLearningRate
Highest permissible learning rate for the test. If this rate is reached, the test stops.
Type: u32
Default: 14880
Range: 1 - 14880952
2365
Writable Attribute
Description
MinLearningRate
Lowest permissible learning rate for the test. If this rate is reached, the test stops.
Type: u32
Default: 1488
Range: 1 - 14880952
NumOfTrials

values.
Type: u16
Default: 1
Range: 1 - 60
RandomMaxFrameSize
Type: u16
Default: 256
Range: 64 - 16383
RandomMinFrameSize
Type: u16
Default: 128
Range: 64 - 16383
Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE

StaggerStartDelay

Type: u16
Default: 0
Range: 0 - 65535
TrafficStartDelay

Type: double
Default: 2
Range: 0.005 - 3600

Type: enum
Default: AFTER_TEST
Possible Values:
Value
Description
AFTER_TEST


Type: bool
Default: TRUE
Possible Values:
Value Description
TRUE
2366
Rfc2889AddrLearningTestResult
Writable Attribute
Description

Type: enum
Possible Values:
Value
Description
VERIFY_EVERY_TRIAL


Type: u16
Default: 100
Range: 1 - 32767
Type: u32
Default: 1000
Range: 1 - 14880952
Rfc2889AddrLearningRateConfig Read-Only Attributes

Description:

Parents: Project
Relations:
Side name
(Type)
Relative
Description
ResultParent
(ResultChild)
Project
Rfc2889AddrLearningTestResult Writable Attributes

Rfc2889AddrLearningTestResult Read-Only Attributes

Read-Only Attribute
Description
BurstSize

Type: u64
Default: 0
ChecksumErrorCount

Type: u64
Default: 0
ConfiguredFrameSize

Type: double
Default: 0
2367
Read-Only Attribute
Description
DuplicateFrameCount
Type: u64
Default: 0
ExpectedFrameCount

Type: u64
Default: 0
FcsErrorFrameCount
Type: u64
Default: 0
FloodCount
do not use it.
Type: u64
Default: 0
FloodedFrameCount
Type: u64
Default: 0
Type: string
Default: N/A
FrameLoss

Type: u64
Default: 0
FrameRate
do not use it.
Type: double
Default: 0
FrameSize

Type: double
Default: 0
FrameSizeType

Type: string
Default: 0
IntendedLoad
Type: double
Default: 0
IterationTotal

Type: u8
Default: 0
LoadSize
do not use it.
Traffic load.
Type: double
Default: 0
LoadSizeType
Type: string
Default: 0
OfferedLoad

Type: double
Default: 0
2368
Read-Only Attribute
Description
OptimalLearningRate
Highest measure learning rate that was successful.

Type: u64
Default: 0
OtherFrameCount

Type: u64
Default: 0
Passed

Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
Test passed.
FALSE Test failed.

PauseFrameCount
Type: u64
Default: 0
PercentLoss

Type: double
Default: 0
PfcFrameCount

Type: u64
Default: 0
do not use it.
Type: u64
Default: 0
RxFrameCount

Type: u64
Default: 0
RxNonSigFrameCount
do not use it.
Type: u64
Default: 0
RxSigFrameCount
do not use it.
Type: u64
Default: 0
TxFrameCount

Type: u64
Default: 0
TxFrameRate

Type: double
Default: 0
TxSigFrameCount
do not use it.
Type: u64
Default: 0
2369
Rfc2889BroadcastFrameForwardingConfig
Description:
Configuration object for RFC 2889 Broadcast Frame Forwarding test.

Parents: Project
Relations:
Side name
(Type)
Relative
Description

Group.
Rfc2889BroadcastFrameForwardingConfig Writable Attributes

Writable Attribute
Description
Active, Name
AcceptableFrameLoss
Maximum frame loss you want Spirent TestCenter to allow before stopping the test. This value represents the
aggregate loss from all flows averaged across each all ports in the test.
Type: double
Default: 0
Range: 0.0 - 100.0
Backoff
Type: double
Default: 50
Range: 0.001 - 99.999
BurstSizeEnd
Final burst size when the burst size mode is set to STEP.
Type: u16
Default: 1
Range: 1 - 65535
Mode for adjusting the burst size over all iterations.

Type: enum
Default: STEP
Possible Values:
Value
Description
STEP
Burst size is adjusted in steps starting from BurstSizeStart up to and including BurstSizeEnd.
CUSTOM Burst size is adjusted as per a user specified list of burst sizes.
BurstSizeStart
Initial burst size when burst size mode is set to STEP.

Type: u16
Default: 1
Range: 1 - 65535
BurstSizeStep
Step value for the burst size when going from the initial burst size to final burst size over different iterations.
Type: u16
Default: 1
Range: 1 - 65535
CustomBurstSizeList
User defined list of burst sizes used when Burst size mode is set to CUSTOM.
Type: u16
Default: 0
Range: 1 - 65535
CustomFrameSizeList

Type: u16
Default: 0
2370
Writable Attribute
Description

Type: u16
Default: 15
Range: 1 - 3600
DurationBursts

Type: u32
Default: 1000
Range: 1 - 16777215
DurationMode
Type: enum
Default: SECONDS
Possible Values:
Value
Description
BURSTS
DurationSeconds

Type: u32
Default: 30
Range: 1 - 5184000

Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE

Type: bool
Default: TRUE
Possible Values:
Value Description
TRUE

view mode.
Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
2371
Writable Attribute
Description
EnableLearning

Type: bool
Default: TRUE
Possible Values:
Value Description
TRUE


Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE


Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE

Type: string
FrameSizeEnd
Type: u16
Default: 256
Range: 64 - 16383

Type: enum
Default: CUSTOM
Possible Values:
Value
Description
RandomMaxFrameSize.
STEP

FrameSizeStart
Type: u16
Default: 128
Range: 64 - 16383
FrameSizeStep
Type: u16
Default: 128
Range: 1 - 16383
2372
Writable Attribute
Description
IgnoreMinMaxLimits
Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
Continue Beyond Min or Max.
FALSE Restricted between Min and Max.


Type: u16
Default: 2
Range: 0 - 3600
L2LearningFrameRate
Layer 2 learning rate in frames per second for the test.

Type: u32
Default: 1000
Range: 1 - 14880952
Type: u16
Default: 5
Range: 1 - 100

Type: u16
Default: 2
Range: 0 - 3600
LatencyType

Type: enum
Default: LILO
Possible Values:
Value Description
LILO
Last in, last out.
LIFO

LearningFreqMode
Learning frequency.
Type: enum
Default: LEARN_ONCE
Possible Values:
Value
Description
LEARN_ONCE
LEARN_EVERY_TRIAL
Learn every trial.

NumOfTrials

values.
Type: u16
Default: 1
Range: 1 - 60
RandomMaxFrameSize
Type: u16
Default: 256
Range: 64 - 16383
2373
Writable Attribute
Description
RandomMinFrameSize
Type: u16
Default: 128
Range: 64 - 16383
RateInitial
Type: double
Default: 10
Range: 0.001 - 100.0
RateLowerLimit
Lowest transmission rate at which the application will send traffic during any test iteration, as a percentage of the
total wire rate.
Type: double
Default: 1
Range: 0.001 - 100.0
RateStep
Percent by which Spirent TestCenter will increase the current transmission rate, as a percentage of the total wire
rate. The transmission rate increases until the maximum rate is reached, even if there is frame loss.
Type: double
Default: 10
Range: 0.001 - 100.0
RateUpperLimit
Type: double
Default: 100
Range: 0.001 - 100.0
Resolution
Type: double
Default: 1
Range: 0.001 - 100.0
Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE

SearchMode

Type: enum
Default: BINARY
Possible Values:
Value
Description
STEP
StaggerStartDelay

Type: u16
Default: 0
Range: 0 - 65535
TrafficStartDelay

Type: double
Default: 2
Range: 0.005 - 3600
2374
Rfc2889BroadcastFrameForwardingPerBurstSizeResult
Writable Attribute
Description

Type: enum
Default: AFTER_TEST
Possible Values:
Value
Description
AFTER_TEST


Type: bool
Default: TRUE
Possible Values:
Value Description
TRUE


Type: enum
Possible Values:
Value
Description
VERIFY_EVERY_TRIAL


Type: u16
Default: 100
Range: 1 - 32767
Type: u32
Default: 1000
Range: 1 - 14880952
Rfc2889BroadcastFrameForwardingConfig Read-Only Attributes

Description:

Parents: Project
Relations:
Side name
(Type)
Relative
Description
ResultParent
(ResultChild)
Rfc2889BroadcastFrameForwardingPerBurstSizeResult Writable Attributes

2375
Rfc2889BroadcastFrameForwardingPerBurstSizeResult Read-Only Attributes

Read-Only Attribute
Description
AvgJitter
Type: double
Default: 0
AvgLatency
Type: double
Default: 0
BurstSize
Type: u64
Default: 0
ChecksumErrorCount

Type: u64
Default: 0
ConfiguredFrameSize

Type: double
Default: 0
DuplicateFrameCount
Type: u64
Default: 0
ExpectedFrameCount

Type: u64
Default: 0
FcsErrorFrameCount
Type: u64
Default: 0
FloodCount
not use it.
Type: u64
Default: 0
FloodedFrameCount
Type: u64
Default: 0
ForwardingRate
Type: double
Default: 0
Type: string
Default: N/A
FrameLoss

Type: u64
Default: 0
FrameRate
not use it.
Type: double
Default: 0
FrameSize
Frame size.
Type: double
Default: 0
2376
Read-Only Attribute
Description
FrameSizeType
Frame size type.

Type: string
Default: 0
IntendedLoad
Type: double
Default: 0
IterationNum
not use it.
Iteration number.
Type: u8
Default: 0
LoadSize
not use it.
Traffic load.
Type: double
Default: 0
LoadSizeType
Type: string
Default: 0
MaxJitter
Type: double
Default: 0
MaxLatency
Type: double
Default: 0
MbpsLineRate
not use it.
Type: double
Default: 0
MinJitter
Type: double
Default: 0
MinLatency
Type: double
Default: 0
OfferedLoad

Type: double
Default: 0
OtherFrameCount

Type: u64
Default: 0
OutOfSeqCount
Type: u64
Default: 0
PauseFrameCount
Type: u64
Default: 0
PercentLoss

Type: double
Default: 0
2377
Rfc2889BroadcastFrameForwardingPerFrameSizeResult
Read-Only Attribute
Description
PfcFrameCount

Type: u64
Default: 0
Result
Type: string
Default: Failed
not use it.
Type: u64
Default: 0
RxFrameCount

Type: u64
Default: 0
RxNonSigFrameCount
not use it.
Type: u64
Default: 0
RxSigFrameCount
not use it.
Type: u64
Default: 0
Throughput
Throughput measured in frames per second.

Type: double
Default: 0
TrialNum

Type: u8
Default: 0
TxFrameCount

Type: u64
Default: 0
TxFrameRate

Type: double
Default: 0
TxMbpsLoad

Type: double
Default: 0
TxSigFrameCount
not use it.
Type: u64
Default: 0
Description:
2378
Parents: Project
Relations:
Side name
(Type)
Relative
Description
ResultParent
(ResultChild)
Rfc2889BroadcastFrameForwardingPerFrameSizeResult Writable Attributes

Rfc2889BroadcastFrameForwardingPerFrameSizeResult Read-Only Attributes

Read-Only Attribute
Description
AvgJitter
Type: double
Default: 0
AvgLatency
Type: double
Default: 0
BurstSize

Type: u64
Default: 0
ChecksumErrorCount

Type: u64
Default: 0
ConfiguredFrameSize

Type: double
Default: 0
DuplicateFrameCount
Type: u64
Default: 0
ExpectedFrameCount

Type: u64
Default: 0
FcsErrorFrameCount
Type: u64
Default: 0
FloodCount
not use it.
Type: u64
Default: 0
FloodedFrameCount
Type: u64
Default: 0
ForwardingRate
Type: double
Default: 0
Type: string
Default: N/A
2379
Read-Only Attribute
Description
FrameLoss

Type: u64
Default: 0
FrameRate
not use it.
Type: double
Default: 0
FrameSize
Frame size.
Type: double
Default: 0
FrameSizeType
Frame size type.

Type: string
Default: 0
IntendedLoad
Type: double
Default: 0
IterationNum
not use it.
Iteration number.
Type: u8
Default: 0
LoadSize
not use it.
Traffic load.
Type: double
Default: 0
LoadSizeType
Type: string
Default: 0
MaxJitter
Type: double
Default: 0
MaxLatency
Type: double
Default: 0
MbpsLineRate
not use it.
Type: double
Default: 0
MinJitter
Type: double
Default: 0
MinLatency
Type: double
Default: 0
OfferedLoad

Type: double
Default: 0
OtherFrameCount

Type: u64
Default: 0
2380
Read-Only Attribute
Description
OutOfSeqCount
Type: u64
Default: 0
PauseFrameCount
Type: u64
Default: 0
PercentLoss

Type: double
Default: 0
PfcFrameCount

Type: u64
Default: 0
Result
Type: string
Default: Failed
not use it.
Type: u64
Default: 0
RxFrameCount

Type: u64
Default: 0
RxNonSigFrameCount
not use it.
Type: u64
Default: 0
RxSigFrameCount
not use it.
Type: u64
Default: 0
Throughput

Type: double
Default: 0
TrialNum

Type: u8
Default: 0
TxFrameCount

Type: u64
Default: 0
TxFrameRate

Type: double
Default: 0
TxMbpsLoad

Type: double
Default: 0
TxSigFrameCount
not use it.
Type: u64
Default: 0
2381
Rfc2889BroadcastFrameForwardingPerIterationResult
Description:

Parents: Project
Relations:
Side name
(Type)
Relative
Description
ResultParent
(ResultChild)
Rfc2889BroadcastFrameForwardingPerIterationResult Writable Attributes

Rfc2889BroadcastFrameForwardingPerIterationResult Read-Only Attributes

Read-Only Attribute
Description
AvgJitter
Type: double
Default: 0
AvgLatency
Type: double
Default: 0
BurstSize

Type: u64
Default: 0
ChecksumErrorCount

Type: u64
Default: 0
ConfiguredFrameSize

Type: double
Default: 0
DuplicateFrameCount
Type: u64
Default: 0
ExpectedFrameCount

Type: u64
Default: 0
FcsErrorFrameCount
Type: u64
Default: 0
FloodCount
not use it.
Type: u64
Default: 0
FloodedFrameCount
Type: u64
Default: 0
2382
Read-Only Attribute
Description
ForwardingRate
Type: double
Default: 0
Type: string
Default: N/A
FrameLoss

Type: u64
Default: 0
FrameRate
not use it.
Type: double
Default: 0
FrameSize

Type: double
Default: 0
FrameSizeType

Type: string
Default: 0
IntendedLoad
Type: double
Default: 0
IterationNum
not use it.
Iteration number.
Type: u8
Default: 0
LoadSize
not use it.
Traffic load.
Type: double
Default: 0
LoadSizeType
Type: string
Default: 0
MaxJitter
Type: double
Default: 0
MaxLatency
Type: double
Default: 0
MbpsLineRate
not use it.
Type: double
Default: 0
MinJitter
Type: double
Default: 0
2383
Read-Only Attribute
Description
MinLatency
Type: double
Default: 0
OfferedLoad

Type: double
Default: 0
OtherFrameCount

Type: u64
Default: 0
OutOfSeqCount
Type: u64
Default: 0
PauseFrameCount
Type: u64
Default: 0
PercentLoss

Type: double
Default: 0
PfcFrameCount

Type: u64
Default: 0
Result
Type: string
Default: Failed
not use it.
Type: u64
Default: 0
RxFrameCount

Type: u64
Default: 0
RxNonSigFrameCount
not use it.
Type: u64
Default: 0
RxSigFrameCount
not use it.
Type: u64
Default: 0
Throughput

Type: double
Default: 0
TrialNum

Type: u8
Default: 0
TxFrameCount

Type: u64
Default: 0
2384
Rfc2889BroadcastFrameForwardingPerLoadResult
Read-Only Attribute
Description
TxFrameRate

Type: double
Default: 0
TxMbpsLoad

Type: double
Default: 0
TxSigFrameCount
not use it.
Type: u64
Default: 0
Description:

Parents: Project
Relations:
Side name
(Type)
Relative
Description
ResultParent
(ResultChild)
Rfc2889BroadcastFrameForwardingPerLoadResult Writable Attributes

Rfc2889BroadcastFrameForwardingPerLoadResult Read-Only Attributes

Read-Only Attribute
Description
AvgJitter

Type: double
Default: 0
AvgLatency
Type: double
Default: 0
BurstSize
Type: u64
Default: 0
ChecksumErrorCount

Type: u64
Default: 0
ConfiguredFrameSize

Type: double
Default: 0
2385
Read-Only Attribute
Description
DuplicateFrameCount
Type: u64
Default: 0
ExpectedFrameCount

Type: u64
Default: 0
FcsErrorFrameCount
Type: u64
Default: 0
FloodCount
not use it.
Type: u64
Default: 0
FloodedFrameCount
Type: u64
Default: 0
ForwardingRate
Type: double
Default: 0
Type: string
Default: N/A
FrameLoss

Type: u64
Default: 0
FrameRate
not use it.
Type: double
Default: 0
FrameSize
Frame size.
Type: double
Default: 0
FrameSizeType
Frame size type.

Type: string
Default: 0
IntendedLoad
Type: double
Default: 0
IterationNum
not use it.
Iteration number.
Type: u8
Default: 0
LoadSize
not use it.
Traffic load.
Type: double
Default: 0
2386
Read-Only Attribute
Description
LoadSizeType
Type: string
Default: 0
MaxJitter

Type: double
Default: 0
MaxLatency
Type: double
Default: 0
MbpsLineRate
not use it.
Type: double
Default: 0
MinJitter

Type: double
Default: 0
MinLatency
Type: double
Default: 0
OfferedLoad

Type: double
Default: 0
OtherFrameCount

Type: u64
Default: 0
OutOfSeqCount
Type: u64
Default: 0
PauseFrameCount
Type: u64
Default: 0
PercentLoss

Type: double
Default: 0
PfcFrameCount

Type: u64
Default: 0
Result
Type: string
Default: Failed
not use it.
Type: u64
Default: 0
RxFrameCount

Type: u64
Default: 0
2387
Rfc2889BroadcastFrameForwardingTestResult
Read-Only Attribute
Description
RxNonSigFrameCount
not use it.
Type: u64
Default: 0
RxSigFrameCount
not use it.
Type: u64
Default: 0
Throughput

Type: double
Default: 0
TrialNum

Type: u8
Default: 0
TxFrameCount

Type: u64
Default: 0
TxFrameRate

Type: double
Default: 0
TxMbpsLoad

Type: double
Default: 0
TxSigFrameCount
not use it.
Type: u64
Default: 0
Description:

Parents: Project
Relations:
Side name
(Type)
Relative
Description
ResultParent
(ResultChild)
Project
Rfc2889BroadcastFrameForwardingTestResult Writable Attributes

2388
Rfc2889BroadcastFrameForwardingTestResult Read-Only Attributes

Read-Only Attribute
Description
BurstSize

Type: u64
Default: 0
ChecksumErrorCount

Type: u64
Default: 0
ConfiguredFrameSize

Type: double
Default: 0
DuplicateFrameCount
Type: u64
Default: 0
ExpectedFrameCount

Type: u64
Default: 0
FcsErrorFrameCount
Type: u64
Default: 0
FloodCount
not use it.
Type: u64
Default: 0
FloodedFrameCount
Type: u64
Default: 0
ForwardingRate
Type: double
Default: 0
Type: string
Default: N/A
FrameLoss

Type: u64
Default: 0
FrameRate
not use it.
Type: double
Default: 0
FrameSize

Type: double
Default: 0
FrameSizeType

Type: string
Default: 0
IntendedLoad
Type: double
Default: 0
2389
Read-Only Attribute
Description
IterationTotal

Type: u8
Default: 0
LoadSize
not use it.
Traffic load.
Type: double
Default: 0
LoadSizeType
Type: string
Default: 0
OfferedLoad

Type: double
Default: 0
OtherFrameCount

Type: u64
Default: 0
PauseFrameCount
Type: u64
Default: 0
PercentLoss

Type: double
Default: 0
PfcFrameCount

Type: u64
Default: 0
not use it.
Type: u64
Default: 0
RxFrameCount

Type: u64
Default: 0
RxNonSigFrameCount
not use it.
Type: u64
Default: 0
RxSigFrameCount
not use it.
Type: u64
Default: 0
Throughput

Type: double
Default: 0
TxFrameCount

Type: u64
Default: 0
TxFrameRate

Type: double
Default: 0
2390
Rfc2889BroadcastFrameLatencyConfig
Read-Only Attribute
Description
TxSigFrameCount
not use it.
Type: u64
Default: 0
Description:
Configuration object for RFC 2889 Broadcast Frame Latency test.

Parents: Project
Relations:
Side name
(Type)
Relative
Description

Group.
Rfc2889BroadcastFrameLatencyConfig Writable Attributes

Writable Attribute
Description
Active, Name
CustomFrameSizeList

Type: u16
Default: 0

Type: u16
Default: 15
Range: 1 - 3600

Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
2391
Writable Attribute
Description

Type: bool
Default: TRUE
Possible Values:
Value Description
TRUE

view mode.
Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
EnableLearning

Type: bool
Default: TRUE
Possible Values:
Value Description
TRUE


Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE


Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE

Type: string
FrameSizeEnd
Type: u16
Default: 256
Range: 64 - 16383

Type: enum
Default: STEP
Possible Values:
Value
Description
RANDOM Random mode. The frame size is randomly chosen within the range set by RandomMinFrameSize
and RandomMaxFrameSize.
STEP
2392
Writable Attribute
Description
FrameSizeStart
Type: u16
Default: 128
Range: 64 - 16383
FrameSizeStep
Type: u16
Default: 128
Range: 1 - 16383

Type: u16
Default: 2
Range: 0 - 3600
L2LearningFrameRate

Type: u32
Default: 1000
Range: 1 - 14880952
Type: u16
Default: 5
Range: 1 - 100

Type: u16
Default: 2
Range: 0 - 3600
LatencyType

Type: enum
Default: LILO
Possible Values:
Value Description
LILO
Last in, last out.
LIFO

LearningFreqMode
Learning frequency.
Type: enum
Default: LEARN_ONCE
Possible Values:
Value
Description
LEARN_ONCE
LEARN_EVERY_TRIAL
Learn every trial.

NumOfTrials

values.
Type: u16
Default: 1
Range: 1 - 60
RandomMaxFrameSize
Type: u16
Default: 256
Range: 64 - 16383
2393
Writable Attribute
Description
RandomMinFrameSize
Type: u16
Default: 128
Range: 64 - 16383
Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
Run user specified external process.

StaggerStartDelay

Type: u16
Default: 0
Range: 0 - 65535
TrafficStartDelay

Type: double
Default: 2
Range: 0.005 - 3600

Type: enum
Default: AFTER_TEST
Possible Values:
Value
Description
AFTER_TEST


Type: bool
Default: TRUE
Possible Values:
Value Description
TRUE


Type: enum
Possible Values:
Value
Description
VERIFY_EVERY_TRIAL


Type: u16
Default: 100
Range: 1 - 32767
Type: u32
Default: 1000
Range: 1 - 14880952
Rfc2889BroadcastFrameLatencyConfig Read-Only Attributes

2394
Rfc2889BroadcastFrameLatencyPerFrameSizePerPortResult
Description:

Parents: Project
Relations:
Side name
(Type)
Relative
Description
ResultParent
(ResultChild)
Rfc2889BroadcastFrameLatencyPerFrameSizePerPortResult Writable Attributes

Rfc2889BroadcastFrameLatencyPerFrameSizePerPortResult Read-Only Attributes

Read-Only Attribute
Description
AvgJitter

Type: double
Default: 0
AvgLatency

Type: double
Default: 0
BurstSize

Type: u64
Default: 0
ChecksumErrorCount

Type: u64
Default: 0
ConfiguredFrameSize

Type: double
Default: 0
DuplicateFrameCount
Type: u64
Default: 0
ExpectedFrameCount

Type: u64
Default: 0
FcsErrorFrameCount
Type: u64
Default: 0
FloodCount
not use it.
Type: u64
Default: 0
FloodedFrameCount
Type: u64
Default: 0
2395
Read-Only Attribute
Description
ForwardingRate
Type: double
Default: 0
Type: string
Default: N/A
FrameLoss

Type: u64
Default: 0
FrameRate
not use it.
Type: double
Default: 0
FrameSize
Frame size.
Type: double
Default: 0
FrameSizeType
Frame size type.

Type: string
Default: 0
IntendedLoad
Type: double
Default: 0
IterationNum
not use it.
Iteration number.
Type: u8
Default: 0
LoadSize
not use it.
Traffic load.
Type: double
Default: 0
LoadSizeType
Type: string
Default: 0
MaxJitter

Type: double
Default: 0
MaxLatency

Type: double
Default: 0
MbpsLineRate
not use it.
Type: double
Default: 0
MinJitter

Type: double
Default: 0
MinLatency

Type: double
Default: 0
2396
Read-Only Attribute
Description
OfferedLoad

Type: double
Default: 0
OtherFrameCount

Type: u64
Default: 0
OutOfSeqCount
Type: u64
Default: 0
PauseFrameCount
Type: u64
Default: 0
PercentLoss

Type: double
Default: 0
PfcFrameCount

Type: u64
Default: 0
PortName
Port name.
Type: string
not use it.
Type: u64
Default: 0
RxFrameCount

Type: u64
Default: 0
RxNonSigFrameCount
not use it.
Type: u64
Default: 0
RxSigFrameCount
not use it.
Type: u64
Default: 0
TrialNum

Type: u8
Default: 0
TxFrameCount

Type: u64
Default: 0
TxFrameRate

Type: double
Default: 0
TxMbpsLoad

Type: double
Default: 0
2397
Rfc2889BroadcastFrameLatencyPerFrameSizeResult
Read-Only Attribute
Description
TxSigFrameCount
not use it.
Type: u64
Default: 0
Description:

Parents: Project
Relations:
Side name
(Type)
Relative
Description
ResultParent
(ResultChild)
Rfc2889BroadcastFrameLatencyPerFrameSizeResult Writable Attributes

Rfc2889BroadcastFrameLatencyPerFrameSizeResult Read-Only Attributes

Read-Only Attribute
Description
AvgJitter

Type: double
Default: 0
AvgLatency

Type: double
Default: 0
BurstSize

Type: u64
Default: 0
ChecksumErrorCount

Type: u64
Default: 0
ConfiguredFrameSize

Type: double
Default: 0
DuplicateFrameCount
Type: u64
Default: 0
ExpectedFrameCount

Type: u64
Default: 0
2398
Read-Only Attribute
Description
FcsErrorFrameCount
Type: u64
Default: 0
FloodCount
not use it.
Type: u64
Default: 0
FloodedFrameCount
Type: u64
Default: 0
ForwardingRate
Type: double
Default: 0
Type: string
Default: N/A
FrameLoss

Type: u64
Default: 0
FrameRate
not use it.
Type: double
Default: 0
FrameSize
Frame size.
Type: double
Default: 0
FrameSizeType
Frame size type.

Type: string
Default: 0
IntendedLoad
Type: double
Default: 0
IterationNum
not use it.
Iteration number.
Type: u8
Default: 0
LoadSize
not use it.
Traffic load.
Type: double
Default: 0
LoadSizeType
Type: string
Default: 0
MaxJitter

Type: double
Default: 0
MaxLatency

Type: double
Default: 0
2399
Read-Only Attribute
Description
MbpsLineRate
not use it.
Type: double
Default: 0
MinJitter

Type: double
Default: 0
MinLatency

Type: double
Default: 0
OfferedLoad

Type: double
Default: 0
OtherFrameCount

Type: u64
Default: 0
OutOfSeqCount
Type: u64
Default: 0
PauseFrameCount
Type: u64
Default: 0
PercentLoss

Type: double
Default: 0
PfcFrameCount

Type: u64
Default: 0
not use it.
Type: u64
Default: 0
RxFrameCount

Type: u64
Default: 0
RxNonSigFrameCount
not use it.
Type: u64
Default: 0
RxSigFrameCount
not use it.
Type: u64
Default: 0
TrialNum

Type: u8
Default: 0
TxFrameCount

Type: u64
Default: 0
2400
Rfc2889BroadcastFrameLatencyPerIterationResult
Read-Only Attribute
Description
TxFrameRate

Type: double
Default: 0
TxMbpsLoad

Type: double
Default: 0
TxSigFrameCount
not use it.
Type: u64
Default: 0
Description:

Parents: Project
Relations:
Side name
(Type)
Relative
Description
ResultParent
(ResultChild)
Rfc2889BroadcastFrameLatencyPerIterationResult Writable Attributes

Rfc2889BroadcastFrameLatencyPerIterationResult Read-Only Attributes

Read-Only Attribute
Description
AvgJitter

Type: double
Default: 0
AvgLatency

Type: double
Default: 0
BurstSize

Type: u64
Default: 0
ChecksumErrorCount

Type: u64
Default: 0
ConfiguredFrameSize

Type: double
Default: 0
2401
Read-Only Attribute
Description
DuplicateFrameCount
Type: u64
Default: 0
ExpectedFrameCount

Type: u64
Default: 0
FcsErrorFrameCount
Type: u64
Default: 0
FloodCount
not use it.
Type: u64
Default: 0
FloodedFrameCount
Type: u64
Default: 0
ForwardingRate
Type: double
Default: 0
Type: string
Default: N/A
FrameLoss

Type: u64
Default: 0
FrameRate
not use it.
Type: double
Default: 0
FrameSize

Type: double
Default: 0
FrameSizeType

Type: string
Default: 0
IntendedLoad
Type: double
Default: 0
IterationNum
not use it.
Iteration number.
Type: u8
Default: 0
LoadSize
not use it.
Traffic load.
Type: double
Default: 0
2402
Read-Only Attribute
Description
LoadSizeType
Type: string
Default: 0
MaxJitter

Type: double
Default: 0
MaxLatency

Type: double
Default: 0
MbpsLineRate
not use it.
Type: double
Default: 0
MinJitter

Type: double
Default: 0
MinLatency

Type: double
Default: 0
OfferedLoad

Type: double
Default: 0
OtherFrameCount

Type: u64
Default: 0
OutOfSeqCount
Type: u64
Default: 0
PauseFrameCount
Type: u64
Default: 0
PercentLoss

Type: double
Default: 0
PfcFrameCount

Type: u64
Default: 0
not use it.
Type: u64
Default: 0
RxFrameCount

Type: u64
Default: 0
RxNonSigFrameCount
not use it.
Type: u64
Default: 0
2403
Rfc2889BroadcastFrameLatencyTestResult
Read-Only Attribute
Description
RxSigFrameCount
not use it.
Type: u64
Default: 0
TrialNum

Type: u8
Default: 0
TxFrameCount

Type: u64
Default: 0
TxFrameRate

Type: double
Default: 0
TxMbpsLoad

Type: double
Default: 0
TxSigFrameCount
not use it.
Type: u64
Default: 0
Description:

Parents: Project
Relations:
Side name
(Type)
Relative
Description
ResultParent
(ResultChild)
Project
Rfc2889BroadcastFrameLatencyTestResult Writable Attributes

Rfc2889BroadcastFrameLatencyTestResult Read-Only Attributes

Read-Only Attribute
Description
AvgJitter

Type: double
Default: 0
AvgLatency

Type: double
Default: 0
2404
Read-Only Attribute
Description
BurstSize

Type: u64
Default: 0
ChecksumErrorCount

Type: u64
Default: 0
ConfiguredFrameSize

Type: double
Default: 0
DuplicateFrameCount
Type: u64
Default: 0
ExpectedFrameCount

Type: u64
Default: 0
FcsErrorFrameCount
Type: u64
Default: 0
FloodCount
do not use it.
Type: u64
Default: 0
FloodedFrameCount
Type: u64
Default: 0
Type: string
Default: N/A
FrameLoss

Type: u64
Default: 0
FrameRate
do not use it.
Type: double
Default: 0
FrameSize

Type: double
Default: 0
FrameSizeType

Type: string
Default: 0
IntendedLoad
Type: double
Default: 0
IterationTotal

Type: u8
Default: 0
2405
Read-Only Attribute
Description
LoadSize
do not use it.
Traffic load.
Type: double
Default: 0
LoadSizeType
Type: string
Default: 0
MaxJitter

Type: double
Default: 0
MaxLatency

Type: double
Default: 0
MinJitter

Type: double
Default: 0
MinLatency

Type: double
Default: 0
OfferedLoad

Type: double
Default: 0
OtherFrameCount

Type: u64
Default: 0
PauseFrameCount
Type: u64
Default: 0
PercentLoss

Type: double
Default: 0
PfcFrameCount

Type: u64
Default: 0
do not use it.
Type: u64
Default: 0
RxFrameCount

Type: u64
Default: 0
RxNonSigFrameCount
do not use it.
Type: u64
Default: 0
RxSigFrameCount
do not use it.
Type: u64
Default: 0
2406
Rfc2889CongestionControlConfig
Read-Only Attribute
Description
TxFrameCount

Type: u64
Default: 0
TxFrameRate

Type: double
Default: 0
TxSigFrameCount
do not use it.
Type: u64
Default: 0
Description:
Config for RFC 2889 Congestion Control test.

Parents: Project
Relations:
Side name
(Type)
Relative
Description

Group.
Rfc2889CongestionControlConfig Writable Attributes

Writable Attribute
Description
Active, Name
BurstSizeEnd
Type: u32
Default: 1
Range: 1 - 65535

Type: enum
Default: STEP
Possible Values:
Value
Description
STEP
BurstSizeStart

Type: u32
Default: 1
Range: 1 - 65535
BurstSizeStep
Type: u32
Default: 1
Range: 1 - 65535
2407
Writable Attribute
Description
CustomBurstSizeList
Type: u16
Default: 0
Range: 1 - 65535
CustomFrameSizeList

Type: u16
Default: 0
CustomLoadList

Type: double
Default: 0

Type: u16
Default: 15
Range: 1 - 3600
DurationBursts

Type: u32
Default: 1000
Range: 1 - 16777215
DurationMode
Type: enum
Default: SECONDS
Possible Values:
Value
Description
BURSTS
DurationSeconds

Type: u32
Default: 30
Range: 1 - 5184000

Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE

Type: bool
Default: TRUE
Possible Values:
Value Description
TRUE
2408
Writable Attribute
Description
view mode.
Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
EnableLearning

Type: bool
Default: TRUE
Possible Values:
Value Description
TRUE

Whether to pause before starting. If enabled, a breakpoint is inserted in the sequence requiring user intervention in
order to continue the traffic start.
Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE


Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
Command to run an external process.

Type: string
FrameSizeEnd
Type: u16
Default: 256
Range: 64 - 16383

Type: enum
Default: CUSTOM
Possible Values:
Value
Description
RandomMaxFrameSize.
STEP

FrameSizeStart
Type: u16
Default: 128
Range: 64 - 16383
2409
Writable Attribute
Description
FrameSizeStep
Type: u16
Default: 128
Range: 1 - 16383

Type: u16
Default: 2
Range: 0 - 3600
L2LearningFrameRate

Type: u32
Default: 1000
Range: 1 - 14880952
Type: u16
Default: 5
Range: 1 - 100

Type: u16
Default: 2
Range: 0 - 3600
LatencyType

Type: enum
Default: LILO
Possible Values:
Value Description
LILO
Last in, last out.
LIFO

LearningFreqMode
Learning frequency.
Type: enum
Default: LEARN_ONCE
Possible Values:
Value
Description
LEARN_ONCE
LEARN_EVERY_TRIAL
Learn every trial.

LoadEnd
Type: double
Default: 50
LoadStart
Type: double
Default: 10
LoadStep
Type: double
Default: 10
Range: 0.001 - 100000000000.0
2410
Writable Attribute
Description
LoadType

Type: enum
Default: CUSTOM
Possible Values:
Value
Description
RandomMaxLoad.
STEP

LoadUnits
Type: enum
Possible Values:
Value
Description
PERCENT_LINE_RATE
FRAMES_PER_SECOND
Frame per second.
INTER_BURST_GAP
Inter burst gap.

KILOBITS_PER_SECOND
BITS_PER_SECOND
Bits per second.
NumOfTrials

according to the test methodology and setup. At the start of the next trial, these parameters revert to their initial values.
Type: u16
Default: 1
Range: 1 - 60
RandomMaxFrameSize
Type: u16
Default: 256
Range: 64 - 16383
RandomMaxLoad
Type: double
Default: 50
RandomMinFrameSize
Type: u16
Default: 128
Range: 64 - 16383
RandomMinLoad
Type: double
Default: 10
Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
Runs user specified external process.

StaggerStartDelay

Type: u16
Default: 0
Range: 0 - 65535
2411
Rfc2889CongestionControlPerBurstSizeResult
Writable Attribute
Description
TrafficStartDelay

Type: double
Default: 2
Range: 0.005 - 3600

Type: enum
Default: AFTER_TEST
Possible Values:
Value
Description
AFTER_TEST


Type: bool
Default: TRUE
Possible Values:
Value Description
TRUE


Type: enum
Possible Values:
Value
Description
VERIFY_EVERY_TRIAL


Type: u16
Default: 100
Range: 1 - 32767
Type: u32
Default: 1000
Range: 1 - 14880952
Rfc2889CongestionControlConfig Read-Only Attributes

Description:

Parents: Project
Relations:
Side name
(Type)
Relative
Description
ResultParent
(ResultChild)
2412
Rfc2889CongestionControlPerBurstSizeResult Writable Attributes

Rfc2889CongestionControlPerBurstSizeResult Read-Only Attributes

Read-Only Attribute
Description
BackPressureExists
Value to indicate if Back Pressure exists. Back Pressure is any technique used by a DUT/SUT to attempt to avoid
frame loss by impeding external sources of traffic from transmitting frames to congested interfaces.
Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
Back Pressure exists.
FALSE Back Pressure does not exist.

BurstSize
Type: u64
Default: 0
ChecksumErrorCount

Type: u64
Default: 0
ConfiguredFrameSize

Type: double
Default: 0
DuplicateFrameCount
Type: u64
Default: 0
ExpectedFrameCount

Type: u64
Default: 0
FcsErrorFrameCount
Type: u64
Default: 0
FloodCount
not use it.
Type: u64
Default: 0
FloodedFrameCount
Type: u64
Default: 0
Type: string
Default: N/A
FrameLoss

Type: u64
Default: 0
FrameRate
not use it.
Type: double
Default: 0
2413
Read-Only Attribute
Description
FrameSize
Frame size.
Type: double
Default: 0
FrameSizeType
Frame size type.

Type: string
Default: 0
HolbExists
Value to indicate if Head of Line Blocking(HOLB) exists. Head of Line Blocking(HOLB) is frame loss or added
delay observed on an uncongested output interface whenever frames are received from an input interface which
is also attempting to forward frames to a congested output interface.
Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
Head of Line Blocking(HOLB) exists.
FALSE Head of Line Blocking(HOLB) is not detected.

IntendedLoad
Type: double
Default: 0
IterationNum
not use it.
Iteration number.
Type: u8
Default: 0
LoadSize
not use it.
Traffic load.
Type: double
Default: 0
LoadSizeType
Type: string
Default: 0
OfferedLoad

Type: double
Default: 0
OtherFrameCount

Type: u64
Default: 0
PauseFrameCount
Type: u64
Default: 0
PercentLoss

Type: double
Default: 0
PfcFrameCount

Type: u64
Default: 0
not use it.
Type: u64
Default: 0
2414
Rfc2889CongestionControlPerFrameSizeResult
Read-Only Attribute
Description
RxFrameCount

Type: u64
Default: 0
RxNonSigFrameCount
not use it.
Type: u64
Default: 0
RxSigFrameCount
not use it.
Type: u64
Default: 0
TrialNum

Type: u8
Default: 0
TxFrameCount

Type: u64
Default: 0
TxFrameRate

Type: double
Default: 0
TxSigFrameCount
not use it.
Type: u64
Default: 0
Description:

Parents: Project
Relations:
Side name
(Type)
Relative
Description
ResultParent
(ResultChild)
Rfc2889CongestionControlPerFrameSizeResult Writable Attributes

2415
Rfc2889CongestionControlPerFrameSizeResult Read-Only Attributes

Read-Only Attribute
Description
BackPressureExists
Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE

BurstSize

Type: u64
Default: 0
ChecksumErrorCount

Type: u64
Default: 0
ConfiguredFrameSize

Type: double
Default: 0
DuplicateFrameCount
Type: u64
Default: 0
ExpectedFrameCount

Type: u64
Default: 0
FcsErrorFrameCount
Type: u64
Default: 0
FloodCount
not use it.
Type: u64
Default: 0
FloodedFrameCount
Type: u64
Default: 0
Type: string
Default: N/A
FrameLoss

Type: u64
Default: 0
FrameRate
not use it.
Type: double
Default: 0
FrameSize
Frame size.
Type: double
Default: 0
FrameSizeType
Frame size type.

Type: string
Default: 0
2416
Read-Only Attribute
Description
HolbExists
Value to indicate if Head of Line Blocking (HOLB) exists. Head of Line Blocking(HOLB) is frame loss or added
Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
Head of Line Blocking (HOLB) exists.
FALSE Head of Line Blocking (HOLB) is not detected.

IntendedLoad
Type: double
Default: 0
IterationNum
not use it.
Iteration number.
Type: u8
Default: 0
LoadSize
not use it.
Traffic load.
Type: double
Default: 0
LoadSizeType
Type: string
Default: 0
OfferedLoad

Type: double
Default: 0
OtherFrameCount

Type: u64
Default: 0
PauseFrameCount
Type: u64
Default: 0
PercentLoss

Type: double
Default: 0
PfcFrameCount

Type: u64
Default: 0
not use it.
Type: u64
Default: 0
RxFrameCount

Type: u64
Default: 0
RxNonSigFrameCount
not use it.
Type: u64
Default: 0
2417
Rfc2889CongestionControlPerIterationResult
Read-Only Attribute
Description
RxSigFrameCount
not use it.
Type: u64
Default: 0
TrialNum

Type: u8
Default: 0
TxFrameCount

Type: u64
Default: 0
TxFrameRate

Type: double
Default: 0
TxSigFrameCount
not use it.
Type: u64
Default: 0
Description:
RFC 2889 congestion control test results.

Parents: Project
Relations:
Side name
(Type)
Relative
Description
ResultParent
(ResultChild)
Rfc2889CongestionControlPerIterationResult Writable Attributes

Rfc2889CongestionControlPerIterationResult Read-Only Attributes

Read-Only Attribute
Description
BackPressureExists
Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE

BurstSize
Type: u64
Default: 0
2418
Read-Only Attribute
Description
ChecksumErrorCount

Type: u64
Default: 0
ConfiguredFrameSize

Type: double
Default: 0
DuplicateFrameCount
Type: u64
Default: 0
ExpectedFrameCount

Type: u64
Default: 0
FcsErrorFrameCount
Type: u64
Default: 0
FloodCount
not use it.
Type: u64
Default: 0
FloodedFrameCount
Type: u64
Default: 0
Type: string
Default: N/A
FrameLoss

Type: u64
Default: 0
FrameRate
not use it.
Type: double
Default: 0
FrameSize
Frame size.
Type: double
Default: 0
FrameSizeType
Frame size type.

Type: string
Default: 0
HolbExists
Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE

IntendedLoad
Type: double
Default: 0
2419
Read-Only Attribute
Description
IterationNum
not use it.
Iteration number.
Type: u8
Default: 0
LoadSize
not use it.
Traffic load.
Type: double
Default: 0
LoadSizeType
Type: string
Default: 0
OfferedLoad

Type: double
Default: 0
OtherFrameCount

Type: u64
Default: 0
PauseFrameCount
Type: u64
Default: 0
PercentLoss

Type: double
Default: 0
PfcFrameCount

Type: u64
Default: 0
not use it.
Type: u64
Default: 0
RxFrameCount

Type: u64
Default: 0
RxNonSigFrameCount
not use it.
Type: u64
Default: 0
RxSigFrameCount
not use it.
Type: u64
Default: 0
TrialNum

Type: u8
Default: 0
TxFrameCount

Type: u64
Default: 0
2420
Rfc2889CongestionControlPerLoadResult
Read-Only Attribute
Description
TxFrameRate

Type: double
Default: 0
TxSigFrameCount
not use it.
Type: u64
Default: 0
Description:

Parents: Project
Relations:
Side name
(Type)
Relative
Description
ResultParent
(ResultChild)
Rfc2889CongestionControlPerLoadResult Writable Attributes

Rfc2889CongestionControlPerLoadResult Read-Only Attributes

Read-Only Attribute
Description
BackPressureExists
Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE

BurstSize
Type: u64
Default: 0
ChecksumErrorCount

Type: u64
Default: 0
ConfiguredFrameSize

Type: double
Default: 0
DuplicateFrameCount
Type: u64
Default: 0
2421
Read-Only Attribute
Description
ExpectedFrameCount

Type: u64
Default: 0
FcsErrorFrameCount
Type: u64
Default: 0
FloodCount
not use it.
Type: u64
Default: 0
FloodedFrameCount
Type: u64
Default: 0
Type: string
Default: N/A
FrameLoss

Type: u64
Default: 0
FrameRate
not use it.
Type: double
Default: 0
FrameSize
Frame size.
Type: double
Default: 0
FrameSizeType
Frame size type.

Type: string
Default: 0
HolbExists
Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE

IntendedLoad
Type: double
Default: 0
IterationNum
not use it.
Iteration number.
Type: u8
Default: 0
LoadSize
not use it.
Traffic load.
Type: double
Default: 0
2422
Read-Only Attribute
Description
LoadSizeType
Type: string
Default: 0
OfferedLoad

Type: double
Default: 0
OtherFrameCount

Type: u64
Default: 0
PauseFrameCount
Type: u64
Default: 0
PercentLoss

Type: double
Default: 0
PfcFrameCount

Type: u64
Default: 0
not use it.
Type: u64
Default: 0
RxFrameCount

Type: u64
Default: 0
RxNonSigFrameCount
not use it.
Type: u64
Default: 0
RxSigFrameCount
not use it.
Type: u64
Default: 0
TrialNum

Type: u8
Default: 0
TxFrameCount

Type: u64
Default: 0
TxFrameRate

Type: double
Default: 0
TxSigFrameCount
not use it.
Type: u64
Default: 0
2423
Rfc2889CongestionControlPerPortResult
Description:

Parents: Project
Relations:
Side name
(Type)
Relative
Description
ResultParent
(ResultChild)
Rfc2889CongestionControlPerPortResult Writable Attributes

Rfc2889CongestionControlPerPortResult Read-Only Attributes

Read-Only Attribute
Description
BackPressureExists
Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE

BurstSize
Type: u64
Default: 0
ChecksumErrorCount

Type: u64
Default: 0
ConfiguredFrameSize

Type: double
Default: 0
DuplicateFrameCount
Type: u64
Default: 0
ExpectedFrameCount

Type: u64
Default: 0
FcsErrorFrameCount
Type: u64
Default: 0
FloodCount
not use it.
Type: u64
Default: 0
FloodedFrameCount
Type: u64
Default: 0
2424
Read-Only Attribute
Description
Type: string
Default: N/A
FrameLoss

Type: u64
Default: 0
FrameRate
not use it.
Type: double
Default: 0
FrameSize
Frame size.
Type: double
Default: 0
FrameSizeType
Frame size type.

Type: string
Default: 0
HolbExists
Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE

IntendedLoad
Type: double
Default: 0
IterationNum
not use it.
Iteration number.
Type: u8
Default: 0
LoadSize
not use it.
Traffic load.
Type: double
Default: 0
LoadSizeType
Type: string
Default: 0
OfferedLoad

Type: double
Default: 0
OtherFrameCount

Type: u64
Default: 0
PauseFrameCount
Type: u64
Default: 0
2425
Rfc2889CongestionControlTestResult
Read-Only Attribute
Description
PercentLoss

Type: double
Default: 0
PfcFrameCount

Type: u64
Default: 0
PortName
Port name.
Type: string
PortType
Port type indicating whether it is a Tx, Rx, or a monitor port.

Type: string
Default: -
not use it.
Type: u64
Default: 0
RxFrameCount

Type: u64
Default: 0
RxNonSigFrameCount
not use it.
Type: u64
Default: 0
RxSigFrameCount
not use it.
Type: u64
Default: 0
TrialNum

Type: u8
Default: 0
TxFrameCount

Type: u64
Default: 0
TxFrameRate

Type: double
Default: 0
TxSigFrameCount
not use it.
Type: u64
Default: 0
Description:
2426
Parents: Project
Relations:
Side name
(Type)
Relative
Description
ResultParent
(ResultChild)
Project
Rfc2889CongestionControlTestResult Writable Attributes

Rfc2889CongestionControlTestResult Read-Only Attributes

Read-Only Attribute
Description
BackPressureExists
Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE

BurstSize

Type: u64
Default: 0
ChecksumErrorCount

Type: u64
Default: 0
ConfiguredFrameSize

Type: double
Default: 0
DuplicateFrameCount
Type: u64
Default: 0
ExpectedFrameCount

Type: u64
Default: 0
FcsErrorFrameCount
Type: u64
Default: 0
FloodCount
not use it.
Type: u64
Default: 0
FloodedFrameCount
Type: u64
Default: 0
Type: string
Default: N/A
FrameLoss

Type: u64
Default: 0
2427
Read-Only Attribute
Description
FrameRate
not use it.
Type: double
Default: 0
FrameSize

Type: double
Default: 0
FrameSizeType

Type: string
Default: 0
HolbExists
Value to indicate if Head of Line Blocking (HOLB) exists. Head of Line Blocking(HOLB) is frame loss or added
Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE

IntendedLoad
Type: double
Default: 0
IterationTotal

Type: u8
Default: 0
LoadSize
not use it.
Traffic load value.
Type: double
Default: 0
LoadSizeType
Type: string
Default: 0
OfferedLoad

Type: double
Default: 0
OtherFrameCount

Type: u64
Default: 0
PauseFrameCount
Type: u64
Default: 0
PercentLoss

Type: double
Default: 0
PfcFrameCount

Type: u64
Default: 0
2428
Rfc2889ErroredFramesFilteringConfig
Read-Only Attribute
Description
not use it.
Type: u64
Default: 0
RxFrameCount

Type: u64
Default: 0
RxNonSigFrameCount
not use it.
Type: u64
Default: 0
RxSigFrameCount
not use it.
Type: u64
Default: 0
TxFrameCount

Type: u64
Default: 0
TxFrameRate

Type: double
Default: 0
TxSigFrameCount
not use it.
Type: u64
Default: 0
Description:
Configuration object for RFC 2889 Errored Frames Filtering test.

Parents: Project
Relations:
Side name
(Type)
Relative
Description

Group.
Rfc2889ErroredFramesFilteringConfig Writable Attributes

Writable Attribute
Description
Active, Name
2429
Writable Attribute
Description
BurstSize
Type: u16
Default: 1
Range: 1 - 65535
Crc
CRC size.
Type: u16
Default: 64
Range: 64 - 10000
CustomLoadList

Type: double
Default: 0

Type: u16
Default: 15
Range: 1 - 3600
DurationBursts

Type: u32
Default: 1000
Range: 1 - 16777215
DurationMode
Type: enum
Default: SECONDS
Possible Values:
Value
Description
BURSTS
DurationSeconds

Type: u32
Default: 30
Range: 1 - 5184000
EnableCrc
Whether to enable or disable CRC.

Type: bool
Default: TRUE
Possible Values:
Value Description
TRUE
Enable CRC filtering.
FALSE Disable CRC filtering.


Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
2430
Writable Attribute
Description

Type: bool
Default: TRUE
Possible Values:
Value Description
TRUE

view mode.
Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
EnableLearning

Type: bool
Default: TRUE
Possible Values:
Value Description
TRUE

EnableOversize
Whether to enable or disable oversized frames filtering.

Type: bool
Default: TRUE
Possible Values:
Value Description
TRUE
Enable oversized frames filtering.
FALSE Disable oversized frames filtering.


Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE


Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
EnableUndersize
Whether to enable or disable undersized frames filtering.

Type: bool
Default: TRUE
Possible Values:
Value Description
TRUE
Enable undersized frames filtering.
FALSE Disable undersized frames filtering.


Type: string
2431
Writable Attribute
Description

Type: u16
Default: 2
Range: 0 - 3600
L2LearningFrameRate

Type: u32
Default: 1000
Range: 1 - 14880952
Type: u16
Default: 5
Range: 1 - 100

Type: u16
Default: 2
Range: 0 - 3600
LatencyType

Type: enum
Default: LILO
Possible Values:
Value Description
LILO
Last in, last out.
LIFO

LearningFreqMode
Learning frequency.
Type: enum
Default: LEARN_ONCE
Possible Values:
Value
Description
LEARN_ONCE
LEARN_EVERY_TRIAL
Learn every trial.

LoadEnd
Type: double
Default: 50
LoadStart
Type: double
Default: 10
LoadStep
Type: double
Default: 10
Range: 0.001 - 100000000000.0
2432
Writable Attribute
Description
LoadType

Type: enum
Default: STEP
Possible Values:
Value
Description
RandomMaxLoad.
STEP

LoadUnits
Type: enum
Possible Values:
Value
Description
PERCENT_LINE_RATE
FRAMES_PER_SECOND
Frames per second.
INTER_BURST_GAP
Inter burst gap.

KILOBITS_PER_SECOND
BITS_PER_SECOND
Bits per second.
MaxLegalFrameSize
Length threshold of the jumbo frame counter. Size includes CRC.

Type: s16
Default: 1518
NumOfTrials

Type: u16
Default: 1
Range: 1 - 60
Oversize
Oversized frame size.

Type: u16
Default: 1523
Range: 1519 - 16383
RandomMaxLoad
Type: double
Default: 50
RandomMinLoad
Type: double
Default: 10
Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE

StaggerStartDelay

Type: u16
Default: 0
Range: 0 - 65535
2433
Writable Attribute
Description
TrafficStartDelay

Type: double
Default: 2
Range: 0.005 - 3600

Type: enum
Default: AFTER_TEST
Possible Values:
Value
Description
AFTER_TEST


Type: bool
Default: TRUE
Possible Values:
Value Description
TRUE


Type: enum
Possible Values:
Value
Description
VERIFY_EVERY_TRIAL


Type: u16
Default: 100
Range: 1 - 32767
Type: u32
Default: 1000
Range: 1 - 14880952
Undersize
Undersized frame size.

Type: u8
Default: 63
Range: 40 - 63
WithSignature
Whether to insert or ignore Spirent signature for generated streamblocks.

Type: bool
Default: TRUE
Possible Values:
Value Description
TRUE
Insert Spirent signature for generated streamblocks.
FALSE Ignore Spirent signature for generated streamblocks.
Rfc2889ErroredFramesFilteringConfig Read-Only Attributes

2434
Rfc2889ErroredFramesFilteringPerErrorTypeResult
Description:

Parents: Project
Relations:
Side name
(Type)
Relative
Description
ResultParent
(ResultChild)
Rfc2889ErroredFramesFilteringPerErrorTypeResult Writable Attributes

Rfc2889ErroredFramesFilteringPerErrorTypeResult Read-Only Attributes

Read-Only Attribute
Description
BurstSize

Type: u64
Default: 0
ChecksumErrorCount

Type: u64
Default: 0
ConfiguredFrameSize

Type: double
Default: 0
CrcErrorCount
Number of frames received with CRC error.

Type: u64
Default: 0
DuplicateFrameCount
Type: u64
Default: 0
ErrorType
Error type.
Type: u64
Default: 0
ExpectedFrameCount

Type: u64
Default: 0
FcsErrorFrameCount
Type: u64
Default: 0
FloodCount
do not use it.
Type: u64
Default: 0
FloodedFrameCount
Type: u64
Default: 0
2435
Read-Only Attribute
Description
Type: string
Default: N/A
FrameLoss

Type: u64
Default: 0
FrameRate
do not use it.
Type: double
Default: 0
FrameSize

Type: double
Default: 0
FrameSizeType

Type: string
Default: 0
IntendedLoad
Type: double
Default: 0
IterationNum
do not use it.
Iteration number.
Type: u8
Default: 0
LoadSize
do not use it.
Traffic load.
Type: double
Default: 0
LoadSizeType
Type: string
Default: 0
OfferedLoad

Type: double
Default: 0
OtherFrameCount

Type: u64
Default: 0
OversizeCount
Number of over sized frames received.

Type: u64
Default: 0
Passed

Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
Test passed.
FALSE Test failed.

PauseFrameCount
Type: u64
Default: 0
2436
Rfc2889ErroredFramesFilteringPerIterationResult
Read-Only Attribute
Description
PercentLoss

Type: double
Default: 0
PfcFrameCount

Type: u64
Default: 0
do not use it.
Type: u64
Default: 0
RxFrameCount

Type: u64
Default: 0
RxNonSigFrameCount
do not use it.
Type: u64
Default: 0
RxSigFrameCount
do not use it.
Type: u64
Default: 0
TrialNum

Type: u8
Default: 0
TxFrameCount

Type: u64
Default: 0
TxFrameRate

Type: double
Default: 0
TxNonSigFrameCount
Number of non-signature frames transmitted.

Type: u64
Default: 0
TxSigFrameCount
do not use it.
Type: u64
Default: 0
UndersizeCount
Number of under sized frames received.

Type: u64
Default: 0
Description:
2437
Parents: Project
Relations:
Side name
(Type)
Relative
Description
ResultParent
(ResultChild)
Rfc2889ErroredFramesFilteringPerIterationResult Writable Attributes

Rfc2889ErroredFramesFilteringPerIterationResult Read-Only Attributes

Read-Only Attribute
Description
BurstSize

Type: u64
Default: 0
ChecksumErrorCount

Type: u64
Default: 0
ConfiguredFrameSize

Type: double
Default: 0
CrcErrorCount
Number of frames received with a CRC error.

Type: u64
Default: 0
DuplicateFrameCount
Type: u64
Default: 0
ErrorType
Specifies the type of error used for this test run. May be CRC, Oversize, or Undersize.
Type: u64
Default: 0
ExpectedFrameCount

Type: u64
Default: 0
FcsErrorFrameCount
Type: u64
Default: 0
FloodCount
not use it.
Type: u64
Default: 0
FloodedFrameCount
Type: u64
Default: 0
Type: string
Default: N/A
FrameLoss

Type: u64
Default: 0
2438
Read-Only Attribute
Description
FrameRate
not use it.
Type: double
Default: 0
FrameSize

Type: double
Default: 0
FrameSizeType

Type: string
Default: 0
IntendedLoad
Type: double
Default: 0
IterationNum
not use it.
Iteration number.
Type: u8
Default: 0
LoadSize
not use it.
Traffic load.
Type: double
Default: 0
LoadSizeType
Type: string
Default: 0
OfferedLoad

Type: double
Default: 0
OtherFrameCount

Type: u64
Default: 0
OversizeCount
Number of over sized frames received.

Type: u64
Default: 0
Passed

Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
Test passed.
FALSE Test failed.

PauseFrameCount
Type: u64
Default: 0
PercentLoss

Type: double
Default: 0
PfcFrameCount

Type: u64
Default: 0
2439
Rfc2889ErroredFramesFilteringPerLoadResult
Read-Only Attribute
Description
not use it.
Type: u64
Default: 0
RxFrameCount

Type: u64
Default: 0
RxNonSigFrameCount
not use it.
Type: u64
Default: 0
RxSigFrameCount
not use it.
Type: u64
Default: 0
TrialNum

Type: u8
Default: 0
TxFrameCount

Type: u64
Default: 0
TxFrameRate

Type: double
Default: 0
TxNonSigFrameCount
Total number of non-signature frames transmitted during a test.

Type: u64
Default: 0
TxSigFrameCount
not use it.
Type: u64
Default: 0
UndersizeCount

Type: u64
Default: 0
Description:

Parents: Project
Relations:
Side name
(Type)
Relative
Description
ResultParent
(ResultChild)
2440
Rfc2889ErroredFramesFilteringPerLoadResult Writable Attributes

Rfc2889ErroredFramesFilteringPerLoadResult Read-Only Attributes

Read-Only Attribute
Description
BurstSize

Type: u64
Default: 0
ChecksumErrorCount

Type: u64
Default: 0
ConfiguredFrameSize

Type: double
Default: 0
CrcErrorCount
Number of CRC errored frames received.

Type: u64
Default: 0
DuplicateFrameCount
Type: u64
Default: 0
ErrorType
Error type.
Type: u64
Default: 0
ExpectedFrameCount

Type: u64
Default: 0
FcsErrorFrameCount
Type: u64
Default: 0
FloodCount
do not use it.
Type: u64
Default: 0
FloodedFrameCount
Type: u64
Default: 0
Type: string
Default: N/A
FrameLoss

Type: u64
Default: 0
FrameRate
do not use it.
Type: double
Default: 0
FrameSize

Type: double
Default: 0
2441
Read-Only Attribute
Description
FrameSizeType

Type: string
Default: 0
IntendedLoad
Type: double
Default: 0
IterationNum
do not use it.
Iteration number.
Type: u8
Default: 0
LoadSize
do not use it.
Traffic load.
Type: double
Default: 0
LoadSizeType
Type: string
Default: 0
OfferedLoad

Type: double
Default: 0
OtherFrameCount

Type: u64
Default: 0
OversizeCount

Type: u64
Default: 0
Passed

Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
Test passed.
FALSE Test failed.

PauseFrameCount
Type: u64
Default: 0
PercentLoss

Type: double
Default: 0
PfcFrameCount

Type: u64
Default: 0
do not use it.
Type: u64
Default: 0
RxFrameCount

Type: u64
Default: 0
2442
Rfc2889ErroredFramesFilteringTestResult
Read-Only Attribute
Description
RxNonSigFrameCount
do not use it.
Type: u64
Default: 0
RxSigFrameCount
do not use it.
Type: u64
Default: 0
TrialNum

Type: u8
Default: 0
TxFrameCount

Type: u64
Default: 0
TxFrameRate

Type: double
Default: 0
TxNonSigFrameCount

Type: u64
Default: 0
TxSigFrameCount
do not use it.
Type: u64
Default: 0
UndersizeCount

Type: u64
Default: 0
Description:

Parents: Project
Relations:
Side name
(Type)
Relative
Description
ResultParent
(ResultChild)
Project
Rfc2889ErroredFramesFilteringTestResult Writable Attributes

2443
Rfc2889ErroredFramesFilteringTestResult Read-Only Attributes

Read-Only Attribute
Description
BurstSize

Type: u64
Default: 0
ChecksumErrorCount

Type: u64
Default: 0
ConfiguredFrameSize

Type: double
Default: 0
CrcErrorCount
Number of frames received with the CRC error.

Type: u64
Default: 0
DuplicateFrameCount
Type: u64
Default: 0
ExpectedFrameCount

Type: u64
Default: 0
FcsErrorFrameCount
Type: u64
Default: 0
FloodCount
do not use it.
Type: u64
Default: 0
FloodedFrameCount
Type: u64
Default: 0
Type: string
Default: N/A
FrameLoss

Type: u64
Default: 0
FrameRate
do not use it.
Type: double
Default: 0
FrameSize

Type: double
Default: 0
FrameSizeType

Type: string
Default: 0
IntendedLoad
Type: double
Default: 0
2444
Read-Only Attribute
Description
IterationTotal

Type: u8
Default: 0
LoadSize
do not use it.
Traffic load.
Type: double
Default: 0
LoadSizeType
Type: string
Default: 0
OfferedLoad

Type: double
Default: 0
OtherFrameCount

Type: u64
Default: 0
OversizeCount

Type: u64
Default: 0
Passed

Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
Test passed.
FALSE Test failed.

PauseFrameCount
Type: u64
Default: 0
PercentLoss

Type: double
Default: 0
PfcFrameCount

Type: u64
Default: 0
do not use it.
Type: u64
Default: 0
RxFrameCount

Type: u64
Default: 0
RxNonSigFrameCount
do not use it.
Type: u64
Default: 0
RxSigFrameCount
do not use it.
Type: u64
Default: 0
2445
Rfc2889ForwardingConfig
Read-Only Attribute
Description
TxFrameCount

Type: u64
Default: 0
TxFrameRate

Type: double
Default: 0
TxNonSigFrameCount

Type: u64
Default: 0
TxSigFrameCount
do not use it.
Type: u64
Default: 0
UndersizeCount

Type: u64
Default: 0
Description:
Configuration object for RFC 2889 Forwarding test.

Parents: Project
Relations:
Side name
(Type)
Relative
Description
Relation to describe the binding with the traffic descriptor

group.
Rfc2889ForwardingConfig Writable Attributes

Writable Attribute
Description
Active, Name
AcceptableFrameLoss
Type: double
Default: 0
Range: 0.0 - 100.0
Backoff
Type: double
Default: 50
Range: 0.001 - 99.999
BurstSizeEnd
Type: u16
Default: 1
Range: 1 - 65535
2446
Writable Attribute
Description

Type: enum
Default: STEP
Possible Values:
Value
Description
STEP
BurstSizeStart

Type: u16
Default: 1
Range: 1 - 65535
BurstSizeStep
Type: u16
Default: 1
Range: 1 - 65535
CustomBurstSizeList
Type: u16
Default: 0
Range: 1 - 65535
CustomFrameSizeList

Type: u16
Default: 0

Type: u16
Default: 15
Range: 1 - 3600
DurationBursts

Type: u32
Default: 1000
Range: 1 - 16777215
DurationMode
Type: enum
Default: SECONDS
Possible Values:
Value
Description
BURSTS
DurationSeconds

Type: u32
Default: 30
Range: 1 - 5184000

Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
2447
Writable Attribute
Description
Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE

Type: bool
Default: TRUE
Possible Values:
Value Description
TRUE

view mode.
Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
EnableLearning

Type: bool
Default: TRUE
Possible Values:
Value Description
TRUE


Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE


Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE

Type: string
FrameSizeEnd
Type: u16
Default: 256
Range: 64 - 16383
2448
Writable Attribute
Description

Type: enum
Default: CUSTOM
Possible Values:
Value
Description
RandomMaxFrameSize.
STEP

FrameSizeStart
Type: u16
Default: 128
Range: 64 - 16383
FrameSizeStep
Type: u16
Default: 128
Range: 1 - 16383
IgnoreMinMaxLimits
Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE


Type: u16
Default: 2
Range: 0 - 3600
L2LearningFrameRate

Type: u32
Default: 1000
Range: 1 - 14880952
Type: u16
Default: 5
Range: 1 - 100
Delay in seconds before L3 learning.

Type: u16
Default: 2
Range: 0 - 3600
LatencyType

Type: enum
Default: LILO
Possible Values:
Value Description
LILO
Last in, last out.
LIFO
2449
Writable Attribute
Description
LearningFreqMode
Learning frequency.
Type: enum
Default: LEARN_ONCE
Possible Values:
Value
Description
LEARN_ONCE
LEARN_EVERY_TRIAL
Learn every trial.

NumOfTrials

values.
Type: u16
Default: 1
Range: 1 - 60
RandomMaxFrameSize
When using Random Mode for FrameSizeIterationMode, the maximum frame size. This attribute is ignored if
Type: u16
Default: 256
Range: 64 - 16383
RandomMinFrameSize
Type: u16
Default: 128
Range: 64 - 16383
RateInitial
Type: double
Default: 10
Range: 0.001 - 100.0
RateLowerLimit
total wire rate.
Type: double
Default: 1
Range: 0.001 - 100.0
RateStep
Type: double
Default: 10
Range: 0.001 - 100.0
RateUpperLimit
Type: double
Default: 100
Range: 0.001 - 100.0
Resolution
Type: double
Default: 1
Range: 0.001 - 100.0
Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
Runs the user specified external process.
2450
Writable Attribute
Description
SearchMode

Type: enum
Default: BINARY
Possible Values:
Value
Description
STEP
StaggerStartDelay

Type: u16
Default: 0
Range: 0 - 65535
TrafficStartDelay

Type: double
Default: 2
Range: 0.005 - 3600

Type: enum
Default: AFTER_TEST
Possible Values:
Value
Description
AFTER_TEST


Type: bool
Default: TRUE
Possible Values:
Value Description
TRUE


Type: enum
Possible Values:
Value
Description
VERIFY_EVERY_TRIAL


Type: u16
Default: 100
Range: 1 - 32767
Type: u32
Default: 1000
Range: 1 - 14880952
Rfc2889ForwardingConfig Read-Only Attributes

2451
Rfc2889ForwardingPerBurstSizeResult
Description:

Parents: Project
Relations:
Side name
(Type)
Relative
Description
ResultParent
(ResultChild)
Rfc2889ForwardingPerBurstSizeResult Writable Attributes

Rfc2889ForwardingPerBurstSizeResult Read-Only Attributes

Read-Only Attribute
Description
AvgJitter
Type: double
Default: 0
AvgLatency
Type: double
Default: 0
BurstSize
Type: u64
Default: 0
ChecksumErrorCount

Type: u64
Default: 0
ConfiguredFrameSize

Type: double
Default: 0
DuplicateFrameCount
Type: u64
Default: 0
ExpectedFrameCount

Type: u64
Default: 0
FcsErrorFrameCount
Type: u64
Default: 0
FloodCount
not use it.
Type: u64
Default: 0
FloodedFrameCount
Type: u64
Default: 0
2452
Read-Only Attribute
Description
ForwardingRate
Type: double
Default: 0
Type: string
Default: N/A
FrameLoss

Type: u64
Default: 0
FrameRate
not use it.
Type: double
Default: 0
FrameSize
Frame size.
Type: double
Default: 0
FrameSizeType
Frame size type.

Type: string
Default: 0
IntendedLoad
Type: double
Default: 0
IterationNum
not use it.
Iteration number.
Type: u8
Default: 0
LoadSize
not use it.
Traffic load.
Type: double
Default: 0
LoadSizeType
Type: string
Default: 0
MaxJitter
Type: double
Default: 0
MaxLatency
Type: double
Default: 0
MbpsLineRate
not use it.
Type: double
Default: 0
MinJitter
Type: double
Default: 0
2453
Read-Only Attribute
Description
MinLatency
Type: double
Default: 0
OfferedLoad

Type: double
Default: 0
OtherFrameCount

Type: u64
Default: 0
OutOfSeqCount
Type: u64
Default: 0
PauseFrameCount
Type: u64
Default: 0
PercentLoss

Type: double
Default: 0
PfcFrameCount

Type: u64
Default: 0
Result
Type: string
Default: Failed
not use it.
Type: u64
Default: 0
RxFrameCount

Type: u64
Default: 0
RxNonSigFrameCount
not use it.
Type: u64
Default: 0
RxSigFrameCount
not use it.
Type: u64
Default: 0
Throughput

Type: double
Default: 0
TrialNum

Type: u8
Default: 0
TxFrameCount

Type: u64
Default: 0
2454
Rfc2889ForwardingPerFrameSizeResult
Read-Only Attribute
Description
TxFrameRate

Type: double
Default: 0
TxMbpsLoad

Type: double
Default: 0
TxSigFrameCount
not use it.
Type: u64
Default: 0
Description:

Parents: Project
Relations:
Side name
(Type)
Relative
Description
ResultParent
(ResultChild)
Rfc2889ForwardingPerFrameSizeResult Writable Attributes

Rfc2889ForwardingPerFrameSizeResult Read-Only Attributes

Read-Only Attribute
Description
AvgJitter
Type: double
Default: 0
AvgLatency
Type: double
Default: 0
BurstSize

Type: u64
Default: 0
ChecksumErrorCount

Type: u64
Default: 0
ConfiguredFrameSize

Type: double
Default: 0
2455
Read-Only Attribute
Description
DuplicateFrameCount
Type: u64
Default: 0
ExpectedFrameCount

Type: u64
Default: 0
FcsErrorFrameCount
Type: u64
Default: 0
FloodCount
not use it.
Type: u64
Default: 0
FloodedFrameCount
Type: u64
Default: 0
ForwardingRate
Type: double
Default: 0
Type: string
Default: N/A
FrameLoss

Type: u64
Default: 0
FrameRate
not use it.
Type: double
Default: 0
FrameSize
Frame size.
Type: double
Default: 0
FrameSizeType
Frame size type.

Type: string
Default: 0
IntendedLoad
Type: double
Default: 0
IterationNum
not use it.
Iteration number.
Type: u8
Default: 0
LoadSize
not use it.
Traffic load.
Type: double
Default: 0
2456
Read-Only Attribute
Description
LoadSizeType
Type: string
Default: 0
MaxJitter
Type: double
Default: 0
MaxLatency
Type: double
Default: 0
MbpsLineRate
not use it.
Type: double
Default: 0
MinJitter
Type: double
Default: 0
MinLatency
Type: double
Default: 0
OfferedLoad

Type: double
Default: 0
OtherFrameCount

Type: u64
Default: 0
OutOfSeqCount
Type: u64
Default: 0
PauseFrameCount
Type: u64
Default: 0
PercentLoss

Type: double
Default: 0
PfcFrameCount

Type: u64
Default: 0
Result
Type: string
Default: Failed
not use it.
Type: u64
Default: 0
RxFrameCount

Type: u64
Default: 0
2457
Rfc2889ForwardingPerIterationResult
Read-Only Attribute
Description
RxNonSigFrameCount
not use it.
Type: u64
Default: 0
RxSigFrameCount
not use it.
Type: u64
Default: 0
Throughput

Type: double
Default: 0
TrialNum

Type: u8
Default: 0
TxFrameCount

Type: u64
Default: 0
TxFrameRate

Type: double
Default: 0
TxMbpsLoad

Type: double
Default: 0
TxSigFrameCount
not use it.
Type: u64
Default: 0
Description:

Parents: Project
Relations:
Side name
(Type)
Relative
Description
ResultParent
(ResultChild)
Rfc2889ForwardingPerIterationResult Writable Attributes

2458
Rfc2889ForwardingPerIterationResult Read-Only Attributes

Read-Only Attribute
Description
AvgJitter
Type: double
Default: 0
AvgLatency
Type: double
Default: 0
BurstSize

Type: u64
Default: 0
ChecksumErrorCount

Type: u64
Default: 0
ConfiguredFrameSize

Type: double
Default: 0
DuplicateFrameCount
Type: u64
Default: 0
ExpectedFrameCount

Type: u64
Default: 0
FcsErrorFrameCount
Type: u64
Default: 0
FloodCount
not use it.
Type: u64
Default: 0
FloodedFrameCount
Type: u64
Default: 0
ForwardingRate
Type: double
Default: 0
Type: string
Default: N/A
FrameLoss

Type: u64
Default: 0
FrameRate
not use it.
Type: double
Default: 0
FrameSize
Average Tx frames size.

Type: double
Default: 0
2459
Read-Only Attribute
Description
FrameSizeType

Type: string
Default: 0
IntendedLoad
Type: double
Default: 0
IterationNum
not use it.
Iteration number.
Type: u8
Default: 0
LoadSize
not use it.
Traffic load.
Type: double
Default: 0
LoadSizeType
Type: string
Default: 0
MaxJitter
Type: double
Default: 0
MaxLatency
Type: double
Default: 0
MbpsLineRate
not use it.
Type: double
Default: 0
MinJitter
Type: double
Default: 0
MinLatency
Type: double
Default: 0
OfferedLoad

Type: double
Default: 0
OtherFrameCount

Type: u64
Default: 0
OutOfSeqCount
Type: u64
Default: 0
PauseFrameCount
Type: u64
Default: 0
PercentLoss

Type: double
Default: 0
2460
Rfc2889ForwardingPerLoadResult
Read-Only Attribute
Description
PfcFrameCount

Type: u64
Default: 0
Result
Type: string
Default: Failed
not use it.
Type: u64
Default: 0
RxFrameCount

Type: u64
Default: 0
RxNonSigFrameCount
not use it.
Type: u64
Default: 0
RxSigFrameCount
not use it.
Type: u64
Default: 0
Throughput

Type: double
Default: 0
TrialNum

Type: u8
Default: 0
TxFrameCount

Type: u64
Default: 0
TxFrameRate

Type: double
Default: 0
TxMbpsLoad

Type: double
Default: 0
TxSigFrameCount
not use it.
Type: u64
Default: 0
Description:
2461
Parents: Project
Relations:
Side name
(Type)
Relative
Description
ResultParent
(ResultChild)
Rfc2889ForwardingPerLoadResult Writable Attributes

Rfc2889ForwardingPerLoadResult Read-Only Attributes

Read-Only Attribute
Description
AvgJitter

Type: double
Default: 0
AvgLatency
Type: double
Default: 0
BurstSize
Type: u64
Default: 0
ChecksumErrorCount

Type: u64
Default: 0
ConfiguredFrameSize

Type: double
Default: 0
DuplicateFrameCount
Type: u64
Default: 0
ExpectedFrameCount

Type: u64
Default: 0
FcsErrorFrameCount
Type: u64
Default: 0
FloodCount
not use it.
Type: u64
Default: 0
FloodedFrameCount
Type: u64
Default: 0
ForwardingRate
Type: double
Default: 0
Type: string
Default: N/A
2462
Read-Only Attribute
Description
FrameLoss

Type: u64
Default: 0
FrameRate
not use it.
Type: double
Default: 0
FrameSize
Frame size.
Type: double
Default: 0
FrameSizeType
Frame size type.

Type: string
Default: 0
IntendedLoad
Type: double
Default: 0
IterationNum
not use it.
Iteration number.
Type: u8
Default: 0
LoadSize
not use it.
Traffic load.
Type: double
Default: 0
LoadSizeType
Type: string
Default: 0
MaxJitter

Type: double
Default: 0
MaxLatency
Type: double
Default: 0
MbpsLineRate
not use it.
Type: double
Default: 0
MinJitter

Type: double
Default: 0
MinLatency
Type: double
Default: 0
OfferedLoad

Type: double
Default: 0
OtherFrameCount

Type: u64
Default: 0
2463
Read-Only Attribute
Description
OutOfSeqCount
Type: u64
Default: 0
PauseFrameCount
Type: u64
Default: 0
PercentLoss

Type: double
Default: 0
PfcFrameCount

Type: u64
Default: 0
Result
Type: string
Default: Failed
not use it.
Type: u64
Default: 0
RxFrameCount

Type: u64
Default: 0
RxNonSigFrameCount
not use it.
Type: u64
Default: 0
RxSigFrameCount
not use it.
Type: u64
Default: 0
Throughput

Type: double
Default: 0
TrialNum

Type: u8
Default: 0
TxFrameCount

Type: u64
Default: 0
TxFrameRate

Type: double
Default: 0
TxMbpsLoad

Type: double
Default: 0
TxSigFrameCount
not use it.
Type: u64
Default: 0
2464
Rfc2889ForwardingTestResult
Description:

Parents: Project
Relations:
Side name
(Type)
Relative
Description
ResultParent
(ResultChild)
Project
Rfc2889ForwardingTestResult Writable Attributes

Rfc2889ForwardingTestResult Read-Only Attributes

Read-Only Attribute
Description
BurstSize

Type: u64
Default: 0
ChecksumErrorCount

Type: u64
Default: 0
ConfiguredFrameSize

Type: double
Default: 0
DuplicateFrameCount
Type: u64
Default: 0
ExpectedFrameCount

Type: u64
Default: 0
FcsErrorFrameCount
Type: u64
Default: 0
FloodCount
not use it.
Type: u64
Default: 0
FloodedFrameCount
Type: u64
Default: 0
ForwardingRate
Type: double
Default: 0
Type: string
Default: N/A
2465
Read-Only Attribute
Description
FrameLoss

Type: u64
Default: 0
FrameRate
not use it.
Type: double
Default: 0
FrameSize
Frame size.
Type: double
Default: 0
FrameSizeType

Type: string
Default: 0
IntendedLoad
Type: double
Default: 0
IterationTotal

Type: u8
Default: 0
LoadSize
not use it.
Traffic load.
Type: double
Default: 0
LoadSizeType
Type: string
Default: 0
OfferedLoad

Type: double
Default: 0
OtherFrameCount

Type: u64
Default: 0
PauseFrameCount
Type: u64
Default: 0
PercentLoss

Type: double
Default: 0
PfcFrameCount

Type: u64
Default: 0
not use it.
Type: u64
Default: 0
RxFrameCount

Type: u64
Default: 0
2466
Rfc2889ForwardPressureConfig
Read-Only Attribute
Description
RxNonSigFrameCount
not use it.
Type: u64
Default: 0
RxSigFrameCount
not use it.
Type: u64
Default: 0
Throughput

Type: double
Default: 0
TxFrameCount

Type: u64
Default: 0
TxFrameRate

Type: double
Default: 0
TxSigFrameCount
not use it.
Type: u64
Default: 0
Description:
Configuration object for RFC 2889 Forward Pressure Test.

Parents: Project
Relations:
Side name
(Type)
Relative
Description

Group.
Rfc2889ForwardPressureConfig Writable Attributes

Writable Attribute
Description
Active, Name
CustomFrameSizeList

Type: u16
Default: 0

Type: u16
Default: 15
Range: 1 - 3600
2467
Writable Attribute
Description
DurationBursts

Type: u32
Default: 1000
Range: 1 - 16777215
DurationMode
Type: enum
Default: SECONDS
Possible Values:
Value
Description
BURSTS
DurationSeconds

Type: u32
Default: 30
Range: 1 - 5184000

Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE

Type: bool
Default: TRUE
Possible Values:
Value Description
TRUE

view mode.
Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
EnableLearning

Type: bool
Default: TRUE
Possible Values:
Value Description
TRUE
2468
Writable Attribute
Description

Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE


Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
Command to run the user specified external process.

Type: string
FrameSizeEnd
Type: u16
Default: 256
Range: 64 - 16383

Type: enum
Default: CUSTOM
Possible Values:
Value
Description
RANDOM Random mode. The frame size is randomly chosen within the range set by RandomMinFrameSize
and RandomMaxFrameSize.
STEP

FrameSizeStart
Type: u16
Default: 128
Range: 64 - 16383
FrameSizeStep
Type: u16
Default: 128
Range: 1 - 16383
InterFrameGap
Inter-frame gap in number of bytes.

Type: u32
Default: 11
Range: 0 - 11

Type: u16
Default: 2
Range: 0 - 3600
L2LearningFrameRate

Type: u32
Default: 1000
Range: 1 - 14880952
2469
Writable Attribute
Description
Type: u16
Default: 5
Range: 1 - 100

Type: u16
Default: 2
Range: 0 - 3600
LatencyType

Type: enum
Default: LILO
Possible Values:
Value Description
LILO
Last in, last out.
LIFO

LearningFreqMode
Learning frequency.
Type: enum
Default: LEARN_ONCE
Possible Values:
Value
Description
LEARN_ONCE
LEARN_EVERY_TRIAL
Learn every trial.

NumOfTrials

values.
Type: u16
Default: 1
Range: 1 - 60
RandomMaxFrameSize
Type: u16
Default: 256
Range: 64 - 16383
RandomMinFrameSize
Type: u16
Default: 128
Range: 64 - 16383
Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE

StaggerStartDelay

Type: u16
Default: 0
Range: 0 - 65535
2470
Rfc2889ForwardPressurePerFrameSizeResult
Writable Attribute
Description
TrafficStartDelay

Type: double
Default: 2
Range: 0.005 - 3600

Type: enum
Default: AFTER_TEST
Possible Values:
Value
Description
AFTER_TEST


Type: bool
Default: TRUE
Possible Values:
Value Description
TRUE


Type: enum
Possible Values:
Value
Description
VERIFY_EVERY_TRIAL


Type: u16
Default: 100
Range: 1 - 32767
Type: u32
Default: 1000
Range: 1 - 14880952
Rfc2889ForwardPressureConfig Read-Only Attributes

Description:

Parents: Project
Relations:
Side name
(Type)
Relative
Description
ResultParent
(ResultChild)
2471
Rfc2889ForwardPressurePerFrameSizeResult Writable Attributes

Rfc2889ForwardPressurePerFrameSizeResult Read-Only Attributes

Read-Only Attribute
Description
AvgJitter

Type: double
Default: 0
AvgLatency
Type: double
Default: 0
BurstSize

Type: u64
Default: 0
ChecksumErrorCount

Type: u64
Default: 0
ConfiguredFrameSize

Type: double
Default: 0
DuplicateFrameCount
Type: u64
Default: 0
ExpectedFrameCount

Type: u64
Default: 0
FcsErrorFrameCount
Type: u64
Default: 0
FloodCount
not use it.
Type: u64
Default: 0
FloodedFrameCount
Type: u64
Default: 0
ForwardingRate
Type: double
Default: 0
Type: string
Default: N/A
FrameLoss

Type: u64
Default: 0
FrameRate
not use it.
Type: double
Default: 0
2472
Read-Only Attribute
Description
FrameSize
Frame size.
Type: double
Default: 0
FrameSizeType
Frame size type.

Type: string
Default: 0
IntendedLoad
Type: double
Default: 0
InterFrameGap
Inter frame gap in number of bytes.

Type: u32
Default: 12
IterationNum
not use it.
Iteration number.
Type: u8
Default: 0
LoadSize
not use it.
Traffic load.
Type: double
Default: 0
LoadSizeType
Type: string
Default: 0
MaxJitter

Type: double
Default: 0
MaxLatency
Type: double
Default: 0
MbpsLineRate
not use it.
Type: double
Default: 0
MinJitter

Type: double
Default: 0
MinLatency
Type: double
Default: 0
OfferedLoad

Type: double
Default: 0
OtherFrameCount

Type: u64
Default: 0
OutOfSeqCount
Type: u64
Default: 0
2473
Rfc2889ForwardPressurePerIterationResult
Read-Only Attribute
Description
PauseFrameCount
Type: u64
Default: 0
PercentLoss

Type: double
Default: 0
PfcFrameCount

Type: u64
Default: 0
not use it.
Type: u64
Default: 0
RxFrameCount

Type: u64
Default: 0
RxNonSigFrameCount
not use it.
Type: u64
Default: 0
RxSigFrameCount
not use it.
Type: u64
Default: 0
TrialNum

Type: u8
Default: 0
TxFrameCount

Type: u64
Default: 0
TxFrameRate

Type: double
Default: 0
TxMbpsLoad

Type: double
Default: 0
TxSigFrameCount
not use it.
Type: u64
Default: 0
Description:
2474
Parents: Project
Relations:
Side name
(Type)
Relative
Description
ResultParent
(ResultChild)
Rfc2889ForwardPressurePerIterationResult Writable Attributes

Rfc2889ForwardPressurePerIterationResult Read-Only Attributes

Read-Only Attribute
Description
AvgJitter
Type: double
Default: 0
AvgLatency
Type: double
Default: 0
BurstSize

Type: u64
Default: 0
ChecksumErrorCount

Type: u64
Default: 0
ConfiguredFrameSize

Type: double
Default: 0
DuplicateFrameCount
Type: u64
Default: 0
ExpectedFrameCount

Type: u64
Default: 0
FcsErrorFrameCount
Type: u64
Default: 0
FloodCount
not use it.
Type: u64
Default: 0
FloodedFrameCount
Type: u64
Default: 0
ForwardingRate
Type: double
Default: 0
Type: string
Default: N/A
2475
Read-Only Attribute
Description
FrameLoss

Type: u64
Default: 0
FrameRate
not use it.
Type: double
Default: 0
FrameSize

Type: double
Default: 0
FrameSizeType

Type: string
Default: 0
IntendedLoad
Type: double
Default: 0
InterFrameGap

Type: u32
Default: 12
IterationNum
not use it.
Iteration number.
Type: u8
Default: 0
LoadSize
not use it.
Traffic load.
Type: double
Default: 0
LoadSizeType
Type: string
Default: 0
MaxJitter
Type: double
Default: 0
MaxLatency
Type: double
Default: 0
MbpsLineRate
not use it.
Type: double
Default: 0
MinJitter
Type: double
Default: 0
MinLatency
Type: double
Default: 0
OfferedLoad

Type: double
Default: 0
2476
Read-Only Attribute
Description
OtherFrameCount

Type: u64
Default: 0
OutOfSeqCount
Type: u64
Default: 0
PauseFrameCount
Type: u64
Default: 0
PercentLoss

Type: double
Default: 0
PfcFrameCount

Type: u64
Default: 0
not use it.
Type: u64
Default: 0
RxFrameCount

Type: u64
Default: 0
RxNonSigFrameCount
not use it.
Type: u64
Default: 0
RxSigFrameCount
not use it.
Type: u64
Default: 0
TrialNum

Type: u8
Default: 0
TxFrameCount

Type: u64
Default: 0
TxFrameRate

Type: double
Default: 0
TxMbpsLoad

Type: double
Default: 0
TxSigFrameCount
not use it.
Type: u64
Default: 0
2477
Rfc2889ForwardPressureTestResult
Description:

Parents: Project
Relations:
Side name
(Type)
Relative
Description
ResultParent
(ResultChild)
Project
Rfc2889ForwardPressureTestResult Writable Attributes

Rfc2889ForwardPressureTestResult Read-Only Attributes

Read-Only Attribute
Description
BurstSize

Type: u64
Default: 0
ChecksumErrorCount

Type: u64
Default: 0
ConfiguredFrameSize

Type: double
Default: 0
DuplicateFrameCount
Type: u64
Default: 0
ExpectedFrameCount

Type: u64
Default: 0
FcsErrorFrameCount
Type: u64
Default: 0
FloodCount
not use it.
Type: u64
Default: 0
FloodedFrameCount
Type: u64
Default: 0
ForwardingRate
Type: double
Default: 0
Type: string
Default: N/A
2478
Read-Only Attribute
Description
FrameLoss

Type: u64
Default: 0
FrameRate
not use it.
Type: double
Default: 0
FrameSize

Type: double
Default: 0
FrameSizeType

Type: string
Default: 0
IntendedLoad
Type: double
Default: 0
InterFrameGap

Type: u32
Default: 12
IterationTotal

Type: u8
Default: 0
LoadSize
not use it.
Traffic load.
Type: double
Default: 0
LoadSizeType
Type: string
Default: 0
OfferedLoad

Type: double
Default: 0
OtherFrameCount

Type: u64
Default: 0
PauseFrameCount
Type: u64
Default: 0
PercentLoss

Type: double
Default: 0
PfcFrameCount

Type: u64
Default: 0
not use it.
Type: u64
Default: 0
2479
Rfc2889MaxForwardingRateConfig
Read-Only Attribute
Description
RxFrameCount

Type: u64
Default: 0
RxNonSigFrameCount
not use it.
Type: u64
Default: 0
RxSigFrameCount
not use it.
Type: u64
Default: 0
TxFrameCount

Type: u64
Default: 0
TxFrameRate

Type: double
Default: 0
TxSigFrameCount
not use it.
Type: u64
Default: 0
Description:
Configuration object for RFC 2889 Maximum Forwarding Test.

Parents: Project
Relations:
Side name
(Type)
Relative
Description

Group.
Rfc2889MaxForwardingRateConfig Writable Attributes

Writable Attribute
Description
Active, Name
BurstSizeEnd
Type: u16
Default: 1
Range: 1 - 65535
2480
Writable Attribute
Description

Type: enum
Default: STEP
Possible Values:
Value
Description
STEP
BurstSizeStart

Type: u16
Default: 1
Range: 1 - 65535
BurstSizeStep
Type: u16
Default: 1
Range: 1 - 65535
CustomBurstSizeList
Type: u16
Default: 0
Range: 1 - 65535
CustomFrameSizeList

Type: u16
Default: 0
CustomLoadList

Type: double
Default: 0
Range: 0.001 - 100000000000.0

Type: u16
Default: 15
Range: 1 - 3600
DurationBursts

Type: u32
Default: 1000
Range: 1 - 16777215
DurationMode
Type: enum
Default: SECONDS
Possible Values:
Value
Description
BURSTS
DurationSeconds

Type: u32
Default: 30
Range: 1 - 5184000

Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
2481
Writable Attribute
Description
Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE

Type: bool
Default: TRUE
Possible Values:
Value Description
TRUE

view mode.
Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
EnableLearning

Type: bool
Default: TRUE
Possible Values:
Value Description
TRUE


Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE


Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
Command to run the user specified process.

Type: string
FrameSizeEnd
Type: u16
Default: 256
Range: 64 - 16383
2482
Writable Attribute
Description

Type: enum
Default: CUSTOM
Possible Values:
Value
Description
RandomMaxFrameSize.
STEP

FrameSizeStart
Type: u16
Default: 128
Range: 64 - 16383
FrameSizeStep
Type: u16
Default: 128
Range: 1 - 16383

Type: u16
Default: 2
Range: 0 - 3600
L2LearningFrameRate

Type: u32
Default: 1000
Range: 1 - 14880952
Type: u16
Default: 5
Range: 1 - 100

Type: u16
Default: 2
Range: 0 - 3600
LatencyType

Type: enum
Default: LILO
Possible Values:
Value Description
LILO
Last in, last out.
LIFO

LearningFreqMode
Learning frequency.
Type: enum
Default: LEARN_ONCE
Possible Values:
Value
Description
LEARN_ONCE
LEARN_EVERY_TRIAL
Learn every trial.

2483
Writable Attribute
Description
LoadEnd
Type: double
Default: 50
LoadStart
Type: double
Default: 10
LoadStep
Type: double
Default: 10
Range: 0.001 - 100000000000.0
LoadType

Type: enum
Default: STEP
Possible Values:
Value
Description
STEP

LoadUnits
Type: enum
Possible Values:
Value
Description
PERCENT_LINE_RATE
FRAMES_PER_SECOND
Frames per second.
INTER_BURST_GAP
Inter burst gap.

KILOBITS_PER_SECOND
BITS_PER_SECOND
Bits per second.
NumOfTrials

Type: u16
Default: 1
Range: 1 - 60
RandomMaxFrameSize
Type: u16
Default: 256
Range: 64 - 16383
RandomMinFrameSize
Type: u16
Default: 128
Range: 64 - 16383
Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
Run the user specified external process.
2484
Rfc2889MaxForwardingRatePerBurstSizeResult
Writable Attribute
Description
StaggerStartDelay

Type: u16
Default: 0
Range: 0 - 65535
TrafficStartDelay

Type: double
Default: 2
Range: 0.005 - 3600

Type: enum
Default: AFTER_TEST
Possible Values:
Value
Description
AFTER_TEST


Type: bool
Default: TRUE
Possible Values:
Value Description
TRUE


Type: enum
Possible Values:
Value
Description
VERIFY_EVERY_TRIAL


Type: u16
Default: 100
Range: 1 - 32767
Type: u32
Default: 1000
Range: 1 - 14880952
Rfc2889MaxForwardingRateConfig Read-Only Attributes

Description:

Parents: Project
Relations:
2485
Side name
(Type)
Relative
Description
ResultParent
(ResultChild)
Rfc2889MaxForwardingRatePerBurstSizeResult Writable Attributes

Rfc2889MaxForwardingRatePerBurstSizeResult Read-Only Attributes

Read-Only Attribute
Description
AvgJitter
Type: double
Default: 0
AvgLatency
Type: double
Default: 0
BurstSize
Type: u64
Default: 0
ChecksumErrorCount

Type: u64
Default: 0
ConfiguredFrameSize

Type: double
Default: 0
DuplicateFrameCount
Type: u64
Default: 0
ExpectedFrameCount

Type: u64
Default: 0
FcsErrorFrameCount
Type: u64
Default: 0
FloodCount
not use it.
Type: u64
Default: 0
FloodedFrameCount
Type: u64
Default: 0
ForwardingRate
Type: double
Default: 0
Type: string
Default: N/A
2486
Read-Only Attribute
Description
FrameLoss

Type: u64
Default: 0
FrameRate
not use it.
Type: double
Default: 0
FrameSize
Frame size.
Type: double
Default: 0
FrameSizeType
Frame size type.

Type: string
Default: 0
IntendedLoad
Type: double
Default: 0
IterationNum
not use it.
Iteration number.
Type: u8
Default: 0
LoadSize
not use it.
Load size.
Type: double
Default: 0
LoadSizeType
Type: string
Default: 0
MaxJitter
Type: double
Default: 0
MaxLatency
Type: double
Default: 0
MbpsLineRate
not use it.
Type: double
Default: 0
MinJitter
Type: double
Default: 0
MinLatency
Type: double
Default: 0
OfferedLoad

Type: double
Default: 0
OtherFrameCount

Type: u64
Default: 0
2487
Read-Only Attribute
Description
OutOfSeqCount
Type: u64
Default: 0
PauseFrameCount
Type: u64
Default: 0
PercentLoss

Type: double
Default: 0
PfcFrameCount

Type: u64
Default: 0
Result
Type: string
Default: Failed
not use it.
Type: u64
Default: 0
RxFrameCount

Type: u64
Default: 0
RxNonSigFrameCount
not use it.
Type: u64
Default: 0
RxSigFrameCount
not use it.
Type: u64
Default: 0
Throughput

Type: double
Default: 0
TrialNum

Type: u8
Default: 0
TxFrameCount

Type: u64
Default: 0
TxFrameRate

Type: double
Default: 0
TxMbpsLoad

Type: double
Default: 0
TxSigFrameCount
not use it.
Type: u64
Default: 0
2488
Rfc2889MaxForwardingRatePerFrameSizeResult
Description:

Parents: Project
Relations:
Side name
(Type)
Relative
Description
ResultParent
(ResultChild)
Rfc2889MaxForwardingRatePerFrameSizeResult Writable Attributes

Rfc2889MaxForwardingRatePerFrameSizeResult Read-Only Attributes

Read-Only Attribute
Description
AvgJitter
Type: double
Default: 0
AvgLatency
Type: double
Default: 0
BurstSize
Type: u64
Default: 0
ChecksumErrorCount

Type: u64
Default: 0
ConfiguredFrameSize

Type: double
Default: 0
DuplicateFrameCount
Type: u64
Default: 0
ExpectedFrameCount

Type: u64
Default: 0
FcsErrorFrameCount
Type: u64
Default: 0
FloodCount
not use it.
Type: u64
Default: 0
FloodedFrameCount
Type: u64
Default: 0
2489
Read-Only Attribute
Description
ForwardingRate
Type: double
Default: 0
Type: string
Default: N/A
FrameLoss

Type: u64
Default: 0
FrameRate
not use it.
Type: double
Default: 0
FrameSize
Frame size.
Type: double
Default: 0
FrameSizeType
Frame size type.

Type: string
Default: 0
IntendedLoad
Type: double
Default: 0
IterationNum
not use it.
Iteration number.
Type: u8
Default: 0
LoadSize
not use it.
Load size.
Type: double
Default: 0
LoadSizeType
Type: string
Default: 0
MaxJitter
Type: double
Default: 0
MaxLatency
Type: double
Default: 0
MbpsLineRate
not use it.
Type: double
Default: 0
MinJitter
Type: double
Default: 0
2490
Read-Only Attribute
Description
MinLatency
Type: double
Default: 0
OfferedLoad

Type: double
Default: 0
OtherFrameCount

Type: u64
Default: 0
OutOfSeqCount
Type: u64
Default: 0
PauseFrameCount
Type: u64
Default: 0
PercentLoss

Type: double
Default: 0
PfcFrameCount

Type: u64
Default: 0
Result
Type: string
Default: Failed
not use it.
Type: u64
Default: 0
RxFrameCount

Type: u64
Default: 0
RxNonSigFrameCount
not use it.
Type: u64
Default: 0
RxSigFrameCount
not use it.
Type: u64
Default: 0
Throughput

Type: double
Default: 0
TrialNum

Type: u8
Default: 0
TxFrameCount

Type: u64
Default: 0
2491
Rfc2889MaxForwardingRatePerIterationResult
Read-Only Attribute
Description
TxFrameRate

Type: double
Default: 0
TxMbpsLoad

Type: double
Default: 0
TxSigFrameCount
not use it.
Type: u64
Default: 0
Description:

Parents: Project
Relations:
Side name
(Type)
Relative
Description
ResultParent
(ResultChild)
Rfc2889MaxForwardingRatePerIterationResult Writable Attributes

Rfc2889MaxForwardingRatePerIterationResult Read-Only Attributes

Read-Only Attribute
Description
AvgJitter
Type: double
Default: 0
AvgLatency
Type: double
Default: 0
BurstSize
Type: u64
Default: 0
ChecksumErrorCount

Type: u64
Default: 0
ConfiguredFrameSize

Type: double
Default: 0
2492
Read-Only Attribute
Description
DuplicateFrameCount
Type: u64
Default: 0
ExpectedFrameCount

Type: u64
Default: 0
FcsErrorFrameCount
Type: u64
Default: 0
FloodCount
not use it.
Type: u64
Default: 0
FloodedFrameCount
Type: u64
Default: 0
ForwardingRate
Type: double
Default: 0
Type: string
Default: N/A
FrameLoss

Type: u64
Default: 0
FrameRate
not use it.
Type: double
Default: 0
FrameSize
Frame size.
Type: double
Default: 0
FrameSizeType

Type: string
Default: 0
IntendedLoad
Type: double
Default: 0
IterationNum
not use it.
Iteration number.
Type: u8
Default: 0
LoadSize
not use it.
Load size.
Type: double
Default: 0
2493
Read-Only Attribute
Description
LoadSizeType
Type: string
Default: 0
MaxJitter
Type: double
Default: 0
MaxLatency
Type: double
Default: 0
MbpsLineRate
not use it.
Type: double
Default: 0
MinJitter
Type: double
Default: 0
MinLatency
Type: double
Default: 0
OfferedLoad

Type: double
Default: 0
OtherFrameCount

Type: u64
Default: 0
OutOfSeqCount
Type: u64
Default: 0
PauseFrameCount
Type: u64
Default: 0
PercentLoss

Type: double
Default: 0
PfcFrameCount

Type: u64
Default: 0
Result
Type: string
Default: Failed
not use it.
Type: u64
Default: 0
RxFrameCount

Type: u64
Default: 0
2494
Rfc2889MaxForwardingRatePerLoadResult
Read-Only Attribute
Description
RxNonSigFrameCount
not use it.
Type: u64
Default: 0
RxSigFrameCount
not use it.
Type: u64
Default: 0
Throughput

Type: double
Default: 0
TrialNum

Type: u8
Default: 0
TxFrameCount

Type: u64
Default: 0
TxFrameRate

Type: double
Default: 0
TxMbpsLoad

Type: double
Default: 0
TxSigFrameCount
not use it.
Type: u64
Default: 0
Description:

Parents: Project
Relations:
Side name
(Type)
Relative
Description
ResultParent
(ResultChild)
Rfc2889MaxForwardingRatePerLoadResult Writable Attributes

2495
Rfc2889MaxForwardingRatePerLoadResult Read-Only Attributes

Read-Only Attribute
Description
AvgJitter

Type: double
Default: 0
AvgLatency
Type: double
Default: 0
BurstSize
Type: u64
Default: 0
ChecksumErrorCount

Type: u64
Default: 0
ConfiguredFrameSize

Type: double
Default: 0
DuplicateFrameCount
Type: u64
Default: 0
ExpectedFrameCount

Type: u64
Default: 0
FcsErrorFrameCount
Type: u64
Default: 0
FloodCount
not use it.
Type: u64
Default: 0
FloodedFrameCount
Type: u64
Default: 0
ForwardingRate
Type: double
Default: 0
Type: string
Default: N/A
FrameLoss

Type: u64
Default: 0
FrameRate
not use it.
Type: double
Default: 0
FrameSize
Frame size.
Type: double
Default: 0
2496
Read-Only Attribute
Description
FrameSizeType
Frame size type.

Type: string
Default: 0
IntendedLoad
Type: double
Default: 0
IterationNum
not use it.
Iteration number.
Type: u8
Default: 0
LoadSize
not use it.
Load size.
Type: double
Default: 0
LoadSizeType
Type: string
Default: 0
MaxJitter

Type: double
Default: 0
MaxLatency
Type: double
Default: 0
MbpsLineRate
not use it.
Type: double
Default: 0
MinJitter

Type: double
Default: 0
MinLatency
Type: double
Default: 0
OfferedLoad

Type: double
Default: 0
OtherFrameCount

Type: u64
Default: 0
OutOfSeqCount
Type: u64
Default: 0
PauseFrameCount
Type: u64
Default: 0
PercentLoss

Type: double
Default: 0
2497
Rfc2889MaxForwardingRateTestResult
Read-Only Attribute
Description
PfcFrameCount

Type: u64
Default: 0
Result
Type: string
Default: Failed
not use it.
Type: u64
Default: 0
RxFrameCount

Type: u64
Default: 0
RxNonSigFrameCount
not use it.
Type: u64
Default: 0
RxSigFrameCount
not use it.
Type: u64
Default: 0
Throughput

Type: double
Default: 0
TrialNum

Type: u8
Default: 0
TxFrameCount

Type: u64
Default: 0
TxFrameRate

Type: double
Default: 0
TxMbpsLoad

Type: double
Default: 0
TxSigFrameCount
not use it.
Type: u64
Default: 0
Description:
2498
Parents: Project
Relations:
Side name
(Type)
Relative
Description
ResultParent
(ResultChild)
Project
Rfc2889MaxForwardingRateTestResult Writable Attributes

Rfc2889MaxForwardingRateTestResult Read-Only Attributes

Read-Only Attribute
Description
BurstSize
Type: u64
Default: 0
ChecksumErrorCount

Type: u64
Default: 0
ConfiguredFrameSize

Type: double
Default: 0
DuplicateFrameCount
Type: u64
Default: 0
ExpectedFrameCount
Number of expected transmitted frame count.

Type: u64
Default: 0
FcsErrorFrameCount
Type: u64
Default: 0
FloodCount
not use it.
Number of flooded frames.
Type: u64
Default: 0
FloodedFrameCount
Type: u64
Default: 0
ForwardingRate
Type: double
Default: 0
Type: string
Default: N/A
FrameLoss
Frame loss.
Type: u64
Default: 0
2499
Read-Only Attribute
Description
FrameRate
not use it.
Type: double
Default: 0
FrameSize
Frame size.
Type: double
Default: 0
FrameSizeType

Type: string
Default: 0
IntendedLoad
Type: double
Default: 0
IterationTotal

Type: u8
Default: 0
LoadSize
not use it.
Load size.
Type: double
Default: 0
LoadSizeType
Type: string
Default: 0
OfferedLoad

Type: double
Default: 0
OtherFrameCount

Type: u64
Default: 0
Passed
Indicates if the iteration passed or failed.

Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
Iteration passed.
FALSE Iteration failed.

PauseFrameCount
Type: u64
Default: 0
PercentLoss

Type: double
Default: 0
PfcFrameCount

Type: u64
Default: 0
not use it.
Number of expected received frame count.
Type: u64
Default: 0
2500
Rfc2889SetupAddressCachingCapacityTestCommand
Read-Only Attribute
Description
RxFrameCount

Type: u64
Default: 0
RxNonSigFrameCount
not use it.
Type: u64
Default: 0
RxSigFrameCount
not use it.
Type: u64
Default: 0
Throughput
Throughput measured in frames per seconds.

Type: double
Default: 0
TxFrameCount

Type: u64
Default: 0
TxFrameRate

Type: double
Default: 0
TxSigFrameCount
not use it.
Type: u64
Default: 0
Description:
Set up RFC 2889 address caching capacity test.

Parents: Sequencer
Relations:
Side name
(Type)
Relative
Description
TestCaseConfig
Rfc3918Config

Parent command.
2501
Rfc2889SetupAddressCachingCapacityTestCommand Writable Attributes

Writable Attribute
Description
AgingTime
of Addresses. A warning is sent if the Aging Time value is too low.
Type: u16
Default: 15
Range: 1 - 3600
DstDeviceList

Type: handle
Default: 0
FrameSize
Frame size.
Type: u16
Default: 64
Range: 47 - 16383
InitialNumAddrs
Number of addresses to be sent to the DUT/SUT in the first iteration.

Type: u32
Default: 20480
Range: 1 - 16777215
LatencyType

Type: enum
Default: LILO
Possible Values:
Value Description
LILO
LIFO

LearningFreqMode
Learning frequency.
Type: enum
Default: LEARN_ONCE
Possible Values:
Value
Description
NONE
No learning.
LEARN_ONCE
LEARN_EVERY_TRIAL
Learn every trial.

LearningRate

Type: u32
Default: 1000
Range: 1 - 14880952
MaxNumAddrs
Highest number of addresses to be sent to the DUT/SUT.

Type: u32
Default: 65536
Range: 1 - 16777216
MinNumAddrs
Lowest number of addresses to be sent to the DUT/SUT.

Type: u32
Default: 1
Range: 1 - 16777216
MonitorPortList
List of ports acting as monitor ports for test.

Type: handle
Default: 0
2502
Rfc2889SetupAddressLearningRateTestCommand
Writable Attribute
Description
NumOfTrials
Number of trials.
Type: u16
Default: 1
Range: 1 - 60
Resolution
Finest adjustment possible, in number of addresses, from iteration to iteration.

Type: u32
Default: 2
Range: 1 - 16777216
SrcDeviceList
Source device list.

Type: handle
Default: 0

Type: bool
Default: TRUE
Possible Values:
Value Description
TRUE


Type: enum
Default: NONE
Possible Values:
Value
Description
NONE
No verification.
VERIFY_EVERY_TRIAL


Type: u32
Default: 100
Range: 1 - 32767
Type: u32
Default: 1000
Range: 1 - 14880952
Rfc2889SetupAddressCachingCapacityTestCommand Read-Only Attributes

Description:
Set up RFC 2889 address learning rate test.

Parents: Sequencer
Relations:
2503
Side name
(Type)
Relative
Description
TestCaseConfig
Rfc3918Config

Parent command.
Rfc2889SetupAddressLearningRateTestCommand Writable Attributes

Writable Attribute
Description
AgingTime
of Addresses. A warning is sent if the Aging Time value is too low.
Type: u16
Default: 15
Range: 1 - 3600
DstDeviceList

Type: handle
Default: 0
FrameSize
Frame size.
Type: u16
Default: 64
Range: 47 - 16383
InitialLearningRate
Learning rate (number of learning frames per second) at the start of the test.
Type: u32
Default: 1488
Range: 1 - 14880952
LatencyType

Type: enum
Default: LILO
Possible Values:
Value Description
LILO
LIFO

LearningFreqMode
Learning frequency.
Type: enum
Default: LEARN_ONCE
Possible Values:
Value
Description
NONE
No learning.
LEARN_ONCE
LEARN_EVERY_TRIAL
Learn every trial.

MacAddrCount
Number of MAC addresses to be sent from each transmitting test port.

Type: u32
Default: 1
Range: 1 - 16777216
2504
Rfc2889SetupBroadcastFrameForwardingTestCommand
Writable Attribute
Description
MaxLearningRate
Highest permissible learning rate for the test. If this rate is reached, the test stops.
Type: u32
Default: 14880
Range: 1 - 14880952
MinLearningRate
Lowest permissible learning rate for the test. If this rate is reached, the test stops.
Type: u32
Default: 1488
Range: 1 - 14880952
MonitorPortList

Type: handle
Default: 0
NumOfTrials
Number of trials.
Type: u16
Default: 1
Range: 1 - 60
SrcDeviceList
Source device list.

Type: handle
Default: 0

Type: bool
Default: TRUE
Possible Values:
Value Description
TRUE


Type: enum
Default: NONE
Possible Values:
Value
Description
NONE
No verification.
VERIFY_EVERY_TRIAL


Type: u32
Default: 100
Range: 1 - 32767
Type: u32
Default: 1000
Range: 1 - 14880952
Rfc2889SetupAddressLearningRateTestCommand Read-Only Attributes

Description:
Set up RFC 2889 broadcast frame forwarding test.
2505

Parents: Sequencer
Relations:
Side name
(Type)
Relative
Description
TestCaseConfig
Rfc3918Config

Parent command.
Rfc2889SetupBroadcastFrameForwardingTestCommand Writable Attributes

Writable Attribute
Description
AcceptableFrameLoss
Type: double
Default: 0
Range: 0.0 - 100.0
Backoff
COMBO.
Type: double
Default: 50.0
Range: 0.001 - 99.999
BurstSizeList
Burst size list.

Type: u16
Default: 0
Range: 1 - 65535
DstDeviceList

Type: handle
Default: 0
Duration

Type: double
Default: 60
Range: 1 - 16777215
DurationMode
Type: enum
Default: SECONDS
Possible Values:
Value
Description
BURSTS

Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
FALSE Test is not run in 'Jitter' analyzer result view mode. The default analyzer result view mode for the test is used.
2506
Writable Attribute
Description
FrameSizeList
Frame size list.

Type: u16
Default: 0
Range: 47 - 16383
LatencyType

Type: enum
Default: LILO
Possible Values:
Value Description
LILO
LIFO

LearningFreqMode
Learning frequency.
Type: enum
Default: LEARN_ONCE
Possible Values:
Value
Description
NONE
No learning.
LEARN_ONCE
LEARN_EVERY_TRIAL
Learn every trial.

NumOfTrials
Number of trials.
Type: u16
Default: 1
Range: 1 - 60
RateInitial
set to STEP.
Type: double
Default: 10
Range: 0.001 - 100.0
RateLowerLimit
wire rate.
Type: double
Default: 1
Range: 0.001 - 100.0
RateStep
Type: double
Default: 10
Range: 0.001 - 100.0
RateUpperLimit
Type: double
Default: 100
Range: 0.001 - 100.0
Resolution
Type: double
Default: 1
Range: 0.001 - 100.0
2507
Rfc2889SetupBroadcastFrameLatencyTestCommand
Writable Attribute
Description
SearchMode

Type: enum
Default: BINARY
Possible Values:
Value
Description
STEP
SrcDeviceList
Source device list.

Type: handle
Default: 0

Type: bool
Default: TRUE
Possible Values:
Value Description
TRUE


Type: enum
Default: NONE
Possible Values:
Value
Description
NONE
No verification.
VERIFY_EVERY_TRIAL


Type: u32
Default: 100
Range: 1 - 32767
Type: u32
Default: 1000
Range: 1 - 14880952
Rfc2889SetupBroadcastFrameForwardingTestCommand Read-Only Attributes

Description:
Set up RFC 2889 broadcast frame latency test.

Parents: Sequencer
Relations:
2508
Side name
(Type)
Relative
Description
TestCaseConfig
Rfc3918Config

Parent command.
Rfc2889SetupBroadcastFrameLatencyTestCommand Writable Attributes

Writable Attribute
Description
DstDeviceList

Type: handle
Default: 0
FrameSizeList
Frame size list.

Type: u16
Default: 0
Range: 47 - 16383
LatencyType

Type: enum
Default: LILO
Possible Values:
Value Description
LILO
LIFO

LearningFreqMode
Learning frequency.
Type: enum
Default: LEARN_ONCE
Possible Values:
Value
Description
NONE
No learning.
LEARN_ONCE
LEARN_EVERY_TRIAL
Learn every trial.

NumOfTrials
Number of trials.
Type: u16
Default: 1
Range: 1 - 60
SrcDeviceList
Source device list.

Type: handle
Default: 0

Type: bool
Default: TRUE
Possible Values:
Value Description
TRUE
2509
Rfc2889SetupCongestionControlTestCommand
Writable Attribute
Description

Type: enum
Default: NONE
Possible Values:
Value
Description
NONE
No verification.
VERIFY_EVERY_TRIAL


Type: u32
Default: 100
Range: 1 - 32767

Type: u32
Default: 1000
Range: 1 - 14880952
Rfc2889SetupBroadcastFrameLatencyTestCommand Read-Only Attributes

Description:
Set up RFC 2889 congestion control test.

Parents: Sequencer
Relations:
Side name
(Type)
Relative
Description
TestCaseConfig
Rfc3918Config

Parent command.
Rfc2889SetupCongestionControlTestCommand Writable Attributes

Writable Attribute
Description
BurstSizeList
Burst size list.

Type: u16
Default: 0
Range: 1 - 65535
2510
Writable Attribute
Description
DstDeviceList

Type: handle
Default: 0
Duration

Type: double
Default: 60
Range: 1 - 16777215
DurationMode
Type: enum
Default: SECONDS
Possible Values:
Value
Description
BURSTS
FrameSizeList
Frame size list.

Type: u16
Default: 0
Range: 47 - 16383
LatencyType

Type: enum
Default: LILO
Possible Values:
Value Description
LILO
LIFO

LearningFreqMode
Learning frequency.
Type: enum
Default: LEARN_ONCE
Possible Values:
Value
Description
NONE
No learning.
LEARN_ONCE
LEARN_EVERY_TRIAL
Learn every trial.

LoadList

Type: double
Default: 0
Range: 0.000001 - 100000.0
LoadUnits
Type: enum
Possible Values:
Value
Description
PERCENT_LINE_RATE
FRAMES_PER_SECOND
NumOfTrials
KILOBITS_PER_SECOND
BITS_PER_SECOND
Number of trials.
Type: u16
Default: 1
Range: 1 - 60
2511
Rfc2889SetupErroredFramesFilteringTestCommand
Writable Attribute
Description
SrcDeviceList
Source device list.

Type: handle
Default: 0

Type: bool
Default: TRUE
Possible Values:
Value Description
TRUE


Type: enum
Default: NONE
Possible Values:
Value
Description
NONE
No verification.
VERIFY_EVERY_TRIAL


Type: u32
Default: 100
Range: 1 - 32767

Type: u32
Default: 1000
Range: 1 - 14880952
Rfc2889SetupCongestionControlTestCommand Read-Only Attributes

Description:
Set up RFC 2889 errored frames filtering test.

Parents: Sequencer
Relations:
Side name
(Type)
Relative
Description
TestCaseConfig
Rfc3918Config

2512
Side name
(Type)
Relative
Description
Parent command.
Rfc2889SetupErroredFramesFilteringTestCommand Writable Attributes

Writable Attribute
Description
BurstSize
Burst size.
Type: u16
Default: 1
Range: 1 - 65535
Crc
CRC size.
Type: u16
Default: 64
Range: 64 - 10000
DstDeviceList

Type: handle
Default: 0
Duration

Type: double
Default: 60
Range: 1 - 16777215
DurationMode
Type: enum
Default: SECONDS
Possible Values:
Value
Description
BURSTS
EnableCrc
Whether to enable or disable CRC.

Type: bool
Default: TRUE
Possible Values:
Value Description
TRUE
Enable CRC filtering.
FALSE Disable CRC filtering.

EnableOversize
Whether to enable or disable oversized frames filtering.

Type: bool
Default: TRUE
Possible Values:
Value Description
TRUE
Enable oversized frames filtering.
FALSE Disable oversized frames filtering.

EnableUndersize
Whether to enable or disable undersized frames filtering.

Type: bool
Default: TRUE
Possible Values:
Value Description
TRUE
Enable undersized frames filtering.
FALSE Disable undersized frames filtering.
2513
Writable Attribute
Description
LatencyType

Type: enum
Default: LILO
Possible Values:
Value Description
LILO
LIFO

LearningFreqMode
Learning frequency.
Type: enum
Default: LEARN_ONCE
Possible Values:
Value
Description
NONE
No learning.
LEARN_ONCE
LEARN_EVERY_TRIAL
Learn every trial.

LoadList

Type: double
Default: 0
Range: 0.000001 - 100000.0
LoadUnits
Type: enum
Possible Values:
Value
Description
PERCENT_LINE_RATE
FRAMES_PER_SECOND

KILOBITS_PER_SECOND
BITS_PER_SECOND
MaxLegalFrameSize
Length threshold of the jumbo frame counter. Size includes CRC.

Type: s16
Default: 1518
NumOfTrials
Number of trials.
Type: u16
Default: 1
Range: 1 - 60
Oversize
Oversized frame size.

Type: u16
Default: 1523
Range: 1519 - 16383
SrcDeviceList
Source device list.

Type: handle
Default: 0
2514
Rfc2889SetupForwardingTestCommand
Writable Attribute
Description
TrafficPattern

Type: enum
Default: MESH
Possible Values:
Value
Description
PAIR
MESH


Type: bool
Default: TRUE
Possible Values:
Value Description
TRUE


Type: enum
Default: NONE
Possible Values:
Value
Description
NONE
No verification.
VERIFY_EVERY_TRIAL


Type: u32
Default: 100
Range: 1 - 32767

Type: u32
Default: 1000
Range: 1 - 14880952
Undersize
Undersized frame size.

Type: u8
Default: 63
Range: 40 - 63
Rfc2889SetupErroredFramesFilteringTestCommand Read-Only Attributes

Description:
Set up RFC 2889 forwarding test.

Parents: Sequencer
Relations:
2515
Side name
(Type)
Relative
Description
TestCaseConfig
Rfc3918Config

Parent command.
Rfc2889SetupForwardingTestCommand Writable Attributes

Writable Attribute
Description
AcceptableFrameLoss
Type: double
Default: 0
Range: 0.0 - 100.0
Backoff
COMBO.
Type: double
Default: 50.0
Range: 0.001 - 99.999
DstDeviceList

Type: handle
Default: 0
Duration

Type: double
Default: 60
Range: 1 - 16777215
DurationMode
Type: enum
Default: SECONDS
Possible Values:
Value
Description
BURSTS

Type: bool
Default: TRUE
Possible Values:
Value Description
TRUE


Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
used.
2516
Writable Attribute
Description
FrameSizeList
Frame size list.

Type: u16
Default: 0
Range: 47 - 16383
LatencyType

Type: enum
Default: LILO
Possible Values:
Value Description
LILO
LIFO

LearningFreqMode
Learning frequency.
Type: enum
Default: LEARN_ONCE
Possible Values:
Value
Description
NONE
No learning.
LEARN_ONCE
LEARN_EVERY_TRIAL
Learn every trial.

MonitorPortList

Type: handle
Default: 0
NumOfTrials
Number of trials.
Type: u16
Default: 1
Range: 1 - 60
RateInitial
set to STEP.
Type: double
Default: 10
Range: 0.001 - 100.0
RateLowerLimit
wire rate.
Type: double
Default: 1
Range: 0.001 - 100.0
RateStep
Type: double
Default: 10
Range: 0.001 - 100.0
RateUpperLimit
Type: double
Default: 100
Range: 0.001 - 100.0
Resolution
Type: double
Default: 1
Range: 0.001 - 100.0
2517
Rfc2889SetupForwardPressureTestCommand
Writable Attribute
Description
SearchMode

Type: enum
Default: BINARY
Possible Values:
Value
Description
STEP
SrcDeviceList
Source device list.

Type: handle
Default: 0
TrafficPattern

Type: enum
Default: MESH
Possible Values:
Value
Description
PAIR
MESH


Type: bool
Default: TRUE
Possible Values:
Value Description
TRUE


Type: enum
Default: NONE
Possible Values:
Value
Description
NONE
No verification.
VERIFY_EVERY_TRIAL


Type: u32
Default: 100
Range: 1 - 32767
Type: u32
Default: 1000
Range: 1 - 14880952
Rfc2889SetupForwardingTestCommand Read-Only Attributes

Description:
2518
Set up RFC 2889 forwarding test.

Parents: Sequencer
Relations:
Side name
(Type)
Relative
Description
TestCaseConfig
Rfc3918Config

Parent command.
Rfc2889SetupForwardPressureTestCommand Writable Attributes

Writable Attribute
Description
DstDeviceList

Type: handle
Default: 0
Duration

Type: double
Default: 60
Range: 1 - 16777215
DurationMode
Type: enum
Default: SECONDS
Possible Values:
Value
Description
BURSTS

Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
used.
FrameSizeList
Frame size list.

Type: u16
Default: 0
Range: 47 - 16383
InterFrameGap
Inter-frame gap in number of bytes.

Type: u32
Default: 11
Range: 0 - 11
2519
Writable Attribute
Description
LatencyType

Type: enum
Default: LILO
Possible Values:
Value Description
LILO
LIFO

LearningFreqMode
Learning frequency.
Type: enum
Default: LEARN_ONCE
Possible Values:
Value
Description
NONE
No learning.
LEARN_ONCE
LEARN_EVERY_TRIAL
Learn every trial.

NumOfTrials
Number of trials.
Type: u16
Default: 1
Range: 1 - 60
SrcDeviceList
Source device list.

Type: handle
Default: 0
TrafficPattern

Type: enum
Default: MESH
Possible Values:
Value
Description
PAIR
MESH


Type: bool
Default: TRUE
Possible Values:
Value Description
TRUE


Type: enum
Default: NONE
Possible Values:
Value
Description
NONE
No verification.
VERIFY_EVERY_TRIAL


Type: u32
Default: 100
Range: 1 - 32767
2520
Rfc2889SetupMaxForwardingRateTestCommand
Writable Attribute
Description
Type: u32
Default: 1000
Range: 1 - 14880952
Rfc2889SetupForwardPressureTestCommand Read-Only Attributes

Description:
Set up RFC 2889 max forwarding rate test.

Parents: Sequencer
Relations:
Side name
(Type)
Relative
Description
TestCaseConfig
Rfc3918Config

Parent command.
Rfc2889SetupMaxForwardingRateTestCommand Writable Attributes

Writable Attribute
Description
BurstSizeList
Burst size list.

Type: u16
Default: 0
Range: 1 - 65535
DstDeviceList

Type: handle
Default: 0
Duration

Type: double
Default: 60
Range: 1 - 16777215
DurationMode
Type: enum
Default: SECONDS
Possible Values:
Value
Description
BURSTS
2521
Writable Attribute
Description

Type: bool
Default: TRUE
Possible Values:
Value Description
TRUE


Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
used.
FrameSizeList
Frame size list.

Type: u16
Default: 0
Range: 47 - 16383
LatencyType

Type: enum
Default: LILO
Possible Values:
Value Description
LILO
LIFO

LearningFreqMode
Learning frequency.
Type: enum
Default: LEARN_ONCE
Possible Values:
Value
Description
NONE
No learning.
LEARN_ONCE
LEARN_EVERY_TRIAL
Learn every trial.

LoadList

Type: double
Default: 0
Range: 0.000001 - 100000.0
LoadUnits
Type: enum
Possible Values:
Value
Description
PERCENT_LINE_RATE
FRAMES_PER_SECOND

KILOBITS_PER_SECOND
BITS_PER_SECOND
2522
Rfc3918AggregatedMulticastThroughputPerIterationResult
Writable Attribute
Description
NumOfTrials
Number of trials.
Type: u16
Default: 1
Range: 1 - 60
SrcDeviceList
Source device list.

Type: handle
Default: 0
TrafficPattern

Type: enum
Default: MESH
Possible Values:
Value
Description
PAIR
MESH


Type: bool
Default: TRUE
Possible Values:
Value Description
TRUE


Type: enum
Default: NONE
Possible Values:
Value
Description
NONE
No verification.
VERIFY_EVERY_TRIAL


Type: u32
Default: 100
Range: 1 - 32767
Type: u32
Default: 1000
Range: 1 - 14880952
Rfc2889SetupMaxForwardingRateTestCommand Read-Only Attributes

Description:

2523
Rfc3918AggregatedMulticastThroughputPerIterationResult Writable Attributes

Rfc3918AggregatedMulticastThroughputPerIterationResult Read-Only Attributes

Read-Only Attribute
Description
AvgJitter

Type: double
Default: 0
AvgLatency

Type: double
Default: 0
ChecksumErrorCount
Number of frames received with checksum error.

Type: u64
Default: 0
DroppedFrameCount

Type: u64
Default: 0
DroppedFramePct

Type: double
Default: 0
DuplicateFrameCount

Type: u64
Default: 0
DurationInSec

Type: double
Default: 0

Type: u64
Default: 0
FcsErrorFrameCount
Number of frames received with the FCS error.

Type: u64
Default: 0
FloodedFrameCount

Type: u64
Default: 0
ForwardingRate
Number of frames per second that a device can be observed to successfully transmit to the correct
destination interface in response to a specified offered load.
Type: double
Default: 0
MaxJitter

Type: double
Default: 0
MaxLatency

Type: double
Default: 0

Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
2524
Read-Only Attribute
Description
MinJitter

Type: double
Default: 0
MinLatency

Type: double
Default: 0
MulticastAvgFrameSize
Multicast average frame size.

Type: double
Default: 0
MulticastEgressPortCount
Number of multicast egress ports.

Type: u32
Default: 0
MulticastGroupCount
Number of multicast groups.

Type: u32
Default: 0
MulticastImixDistribution
Multicast iMIX distribution.

Type: string
Default: N/A
MulticastIntendedLoad
Number of frames per second that the application attempts to transmit to a DUT/SUT for forwarding to
specified multicast output interfaces.
Type: double
Default: 0
MulticastOfferedLoad
Offered load.
Type: double
Default: 0
MulticastRxGroupCount
Number of Rx multicast group counts.

Type: u32
Default: 0
OtherFrameCount
Number of other frames.

Type: u64
Default: 0
OutOfSequenceThresholdExceeded
Whether the out of sequence frames have exceeded the threshold.

Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
Out of sequence frames have exceeded the threshold value.
FALSE Out of sequence frames are within the threshold value.

OutSeqFrameCount

Type: u64
Default: 0
PauseFrameCount
Number of Pause frames received.

Type: u64
Default: 0
PfcFrameCount

Type: u64
Default: 0
RxFrameCount

Type: u64
Default: 0
2525
Rfc3918AggregatedMulticastThroughputTestCaseConfig
Read-Only Attribute
Description
TrialNum
Trial number.
Type: u8
Default: 0
TxFrameCount

Type: u64
Default: 0
TxFrameRate

Type: double
Default: 0
Description:
Configuration object for RFC 3918 Aggregated Multicast Throughput test.

Parents: Rfc3918Config
Relations:
Side name
(Type)
Relative
Description
Rfc3918AggregatedMulticastThroughputTestCaseConfig Writable Attributes

Writable Attribute
Description
Active, Name
AcceptableFrameLoss
Type: double
Default: 0
Range: 0 - 100
Backoff
Type: double
Default: 50
Range: 0.001 - 99.999
Custom list of multicast group counts.

Type: u32
Default: 0
Range: 1 - 32768
DistributionType
How multicast groups are distributed amongst endpoints.

Type: enum
Default: EVEN
Possible Values:
Value
Description
EVEN
2526
Writable Attribute
Description
Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
EnableOutOfSequenceThreshold
Whether to enable out of sequence threshold.

Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
Enable out of sequence threshold.
FALSE Disable out of sequence threshold.

FixedGroupCount
Fixed group count size.

Type: u32
Default: 100
Range: 1 - 32768
GroupCountEnd
Last group count to use when stepping.

Type: u32
Default: 100
Range: 2 - 32768
GroupCountStart
First group count to use when stepping.

Type: u32
Default: 10
Range: 1 - 32767
GroupCountStep
Group count step to use when stepping.

Type: u32
Default: 10
Range: 1 - 32768
GroupCountType
Method for iterating multicast group counts.

Type: enum
Default: CUSTOM
Possible Values:
Value
Description
FIXED
Use Fixed multicast group count.
STEP
Step multicast group count values.
CUSTOM Use multicast group count values from custom list.

RANDOM Use random multicast group count values.
IgnoreMinMaxLimits
Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE

MaxLatencyThreshold
Maximum (in uSec) of all the average latencies determined on each receive port in the test. If the threshold is
reached, then the test iteration fails.
Type: double
Default: 30.0
Range: 0.01 - 4294967295.0
OutOfSequenceThreshold
Maximum number of out of sequence packets for an iteration to be considered a pass.

Type: u32
Default: 0
Range: 0 - 2147483647
2527
Rfc3918Config
Writable Attribute
Description
RandomMaxGroupCount
Upper bound when using random group counts.

Type: u32
Default: 1000
Range: 1 - 32768
RandomMinGroupCount
Lower bound when using random group counts.

Type: u32
Default: 1
Range: 1 - 32768
RateInitial
Type: double
Default: 100
Range: 0.001 - 100
RateLowerLimit
total wire rate.
Type: double
Default: 10
Range: 0.001 - 100
RateStep
Type: double
Default: 10
Range: 0.001 - 100
RateUpperLimit
Type: double
Default: 100
Range: 0.001 - 100
Resolution
Type: double
Default: 1
Range: 0.001 - 100
SearchMode

Type: enum
Default: BINARY
Possible Values:
Value
Description
STEP
Rfc3918AggregatedMulticastThroughputTestCaseConfig Read-Only Attributes

Rfc3918Config
Description:
Configuration object for RFC 3918 tests.

Parents: Project
Children: BenchmarkEthernet10GigPortConfig, Rfc3918AggregatedMulticastThroughputTestCaseConfig, Rfc3918JoinLeaveLatencyTestCaseConfig,
Rfc3918MixedClassThroughputTestCaseConfig, Rfc3918MulticastForwardingLatencyTestCaseConfig, Rfc3918MulticastGroupCapacityTestCaseConfig,
Rfc3918ScaledGroupForwardingTestCaseConfig
2528
Rfc3918Config
Relations:
Side name
(Type)
Relative
Description
MulticastDstDevice
(MulticastDstBinding)
EmulatedDevice
Relation from Rfc3918Config to multicast destination endpoints.
MulticastGroups
Relation from Rfc3918Config to associated multicast groups.
MonitorPorts
(MulticastMonitorPortBinding)
Port
Relation from Rfc3918Config to monitor ports.
MulticastSrcDevice
(MulticastSrcBinding)
EmulatedDevice
Relation from Rfc3918Config to multicast source endpoints.
MulticastStreamBlocks
(MulticastStreamBlockBinding)
StreamBlock
Relation from Rfc3918Config to associated multicast

streamblocks.
Rfc3918Config Writable Attributes

Writable Attribute
Description
Active, Name
CustomMulticastFrameSizeList
Custom list of multicast frame sizes.

Type: u16
Default: 0
Range: 47 - 16383
CustomMulticastImixList

Type: handle
Default: 0
DelayBeforeLearning
do not use it.
This property is deprecated.
Type: u16
Default: 2
Range: 0 - 3600
Duration

Type: u32
Default: 60
Range: 1 - 5184000
DurationMode
Duration mode for each transmitted stream. Whether to measure test duration in seconds or number of
frames.
Type: enum
Default: SECONDS
Possible Values:
Value
Description
BURSTS
FixedMulticastFrameSize
Fixed frame size for multicast.

Type: u16
Default: 128
Range: 47 - 16383
IpTos
IP ToS Value.
Type: u8
Default: 0
Ipv6FlowLabel
IPv6 Flow Label.

Type: u32
Default: 0
Range: 0 - 1048575
2529
Rfc3918Config
Writable Attribute
Description
L2LearningFrameRate
Rate at which learning frames are sent to the DUT/SUT during the learning phase of the test.
Type: u32
Default: 1000
Range: 1 - 14880952
L2LearningFrameSize
L2 learning frame size if FrameSize is fixed.

Type: u16
Default: 128
Range: 64 - 16383
L2LearningFrameSizeMode
How to determine L2 learning frame size.

Type: enum
Possible Values:
Value
Description
SAME_AS_STREAM L2 learning frame size is the same as the test streams.
FIXED
L2 learning frame size will use a user defined fixed size.
Type: u16
Default: 5
Range: 1 - 100
L3LearningEnableCyclicAddrResolution
Whether to perform cyclic address resolution or not.

Type: bool
Default: TRUE
Possible Values:
Value Description
TRUE
Perform cyclic address resolution.
FALSE Do not perform cyclic address resolution.

L3LearningRate
Maximum rate of L3 learning requests.

Type: u32
Default: 1000
Range: 1 - 14880952
L3LearningRetryCount
Maximum number of retries for L3 learning.

Type: u16
Default: 5
Range: 1 - 100
L4DstPortBase
Base L4 destination port.

Type: u16
Default: 7
L4DstPortCount
Number of different L4 dst ports.

Type: u16
Default: 0
L4DstPortStep
Step value for subsequent L4 destination ports.

Type: u16
Default: 1
L4HeaderType
L4 Header.
Type: enum
Default: UDP
Possible Values:
Value Description
NONE No L4 header.
L4SrcPortBase
TCP
TCP
UDP
UDP
Base L4 source port.

Type: u16
Default: 7
2530
Rfc3918Config
Writable Attribute
Description
L4SrcPortCount
Number of different L4 source ports.

Type: u16
Default: 0
L4SrcPortStep
Step value for subsequent L4 ports.

Type: u16
Default: 1
L4UseRandomPorts
Whether to use random L4 ports.

Type: bool
Default: TRUE
Possible Values:
Value Description
TRUE
Use random L4 ports.
FALSE Do not use random L4 ports.

LatencyType
Method for latency measurements.

Type: enum
Default: FIFO
Possible Values:
Value Description
LearningFreqMode
FILO
First in, last out.
LIFO
LILO
Last in, last out.
Learning frequency.
Type: enum
Default: LEARN_EVERY_TOPOLOGY_CHANGE
Possible Values:
Value
Description
NONE
Never perform learning.
LEARN_EVERY_TOPOLOGY_CHANGE Learn on every topology change.
MulticastClientVersion
LEARN_EVERY_FRAME_SIZE
Learn on every frame size iteration.
Protocol to use for multicast clients.

Type: enum
Default: IGMP_V3
Possible Values:
Value
Description
IGMP_V1 IGMP, version 1.
MulticastFrameSizeEnd
MLD_V1
MLD, version 1.
MLD_V2
MLD, version 2.
Final multicast frame size used when stepping.

Type: u16
Default: 1518
Range: 48 - 16383
2531
Rfc3918Config
Writable Attribute
Description
MulticastFrameSizeMode
Method used to adjust multicast frame size.

Type: enum
Default: CUSTOM
Possible Values:
Value
Description
FIXED
Fixed multicast frame size.
STEP
Step multicast frame size.
CUSTOM Use values in custom multicast frame size list.

IMIX
Use iMIX frame size values in custom multicast iMIX list.
RANDOM Use random multicast frame size values.

MulticastFrameSizeStart
Initial multicast frame size used when stepping.

Type: u16
Default: 128
Range: 47 - 16382
MulticastFrameSizeStep
Multicast step frame size used when stepping.

Type: u16
Default: 128
Range: 1 - 16383
MulticastGroupBaseIpAddr
Base IP address for multicast group block.

Type: ip
Default: 225.0.0.1
MulticastGroupBaseIpStep
Step value between IPv4 Multicast Group Blocks (if necessary).

Type: ip
Default: 0.1.0.0
MulticastGroupBaseIpv6Addr
Base IPv6 address for multicast group block.

Type: ipv6
Default: ff1e::1
MulticastGroupBaseIpv6Step
Step value between IPv6 Multicast Group Blocks (if necessary).

Type: ipv6
Default: 0:0:0:1::0
MulticastGroupIncrement
Step value for subsequent groups.

Type: u32
Default: 1
Range: 1 - 4294967295
MulticastJoinGroupDelay
DUT group join processing delay.

Type: u32
Default: 15
Range: 0 - 2147483647
MulticastLeaveGroupDelay
DUT group leave processing delay.

Type: u32
Default: 15
Range: 0 - 2147483647
MulticastMsgTxRate
Per port Tx rate for multicast messages.

Type: u32
Default: 1000
NumOfTrials
Number of trial iterations.

Type: u16
Default: 1
Range: 1 - 60
RandomMaxMulticastFrameSize
Upper bound for random multicast frame sizes.

Type: u16
Default: 1518
Range: 47 - 16383
2532
Rfc3918JoinLeaveLatencyPerIterationResult
Writable Attribute
Description
RandomMinMulticastFrameSize
Lower bound for random multicast frame sizes.

Type: u16
Default: 128
Range: 47 - 16382
ResultsCollectionDelay
Interval in seconds between test stop and result collection.

Type: u32
Default: 15
Range: 0 - 2147483647
TestStartDelay
Delay before starting test.

Type: u16
Default: 2
Range: 0 - 3600

Type: bool
Default: TRUE
Possible Values:
Value Description
TRUE

When to perform traffic verification during the test.

Type: enum
Default: NONE
Possible Values:
Value
Description
NONE
Do not perform traffic verification.
VERIFY_EVERY_TOPOLOGY_CHANGE Verify traffic forwarding after the topology changes.

VERIFY_EVERY_FRAME_SIZE
Verify traffic forwarding after changing the frame size.

Type: u32
Default: 100
Range: 1 - 32767
Type: u32
Default: 1000
Range: 1 - 14880952
Ttl
Time To Live.
Type: u8
Default: 10
VlanPriority
Sets the VLAN priority for multicast traffic (if VLANs are present).
Type: u8
Default: 0
Range: 0 - 7
Rfc3918Config Read-Only Attributes

Description:
2533

Rfc3918JoinLeaveLatencyPerIterationResult Writable Attributes

Rfc3918JoinLeaveLatencyPerIterationResult Read-Only Attributes

Read-Only Attribute
Description
AvgJoinLatency
Average join latency in microseconds.

Type: double
Default: null
AvgLeaveLatency
Average leave latency in microseconds.

Type: double
Default: null
ChecksumErrorCount
Number of frames received with a checksum error.

Type: u64
Default: 0
DroppedFrameCount

Type: u64
Default: 0
DroppedFramePct

Type: double
Default: 0
DuplicateFrameCount

Type: u64
Default: 0
DuplicateJoins
Boolean that indicates whether any joins in the test were duplicates, for example, the same group was
subscribed to twice on one port.
Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
Duplicate joins were detected.
FALSE Duplicate joins were not detected.

DurationInSec

Type: double
Default: 0

Type: u64
Default: 0
FailedJoins
Boolean that indicates whether any joins failed to successfully subscribe to groups during the test.
Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
Failed joins were detected.
FALSE No failed joins were detected.

FcsErrorFrameCount
Number of frames received with an FCS error.

Type: u64
Default: 0
2534
Read-Only Attribute
Description
FloodedFrameCount

Type: u64
Default: 0
MaxJoinLatency
Maximum join latency in microseconds.

Type: double
Default: null
MaxLeaveLatency
Maximum leave latency in microseconds.

Type: double
Default: null
MinJoinLatency
Minimum join latency in microseconds.

Type: double
Default: null
MinLeaveLatency
Minimum leave latency in microseconds.

Type: double
Default: null
Average frame size for multicast traffic.

Type: double
Default: 0
Number of egress ports for multicast traffic.

Type: u32
Default: 0
MulticastGroupCount

Type: u32
Default: 0
iMIX distribution for multicast traffic.

Type: string
Default: N/A
Number of frames per second that the application attempts to transmit to a DUT/SUT for forwarding to
a specified output interface or interfaces.
Type: double
Default: 0
Offered load for multicast traffic.

Type: double
Default: 0
Number of Rx multicast groups.

Type: u32
Default: 0
OtherFrameCount

Type: u64
Default: 0
PauseFrameCount

Type: u64
Default: 0
PfcFrameCount

Type: u64
Default: 0
RxFrameCount

Type: u64
Default: 0
2535
Rfc3918JoinLeaveLatencyTestCaseConfig
Read-Only Attribute
Description
TrialNum
Trial number.
Type: u8
Default: 0
TxFrameCount

Type: u64
Default: 0
TxFrameRate

Type: double
Default: 0
Description:
Configuration for RFC 3918 Join Leave Latency Test.

Relations:
Side name
(Type)
Relative
Description
Rfc3918JoinLeaveLatencyTestCaseConfig Writable Attributes

Writable Attribute
Description
Active, Name

Type: u32
Default: 0
Range: 1 - 32768
CustomLoadList

Type: double
Default: 0
DistributionType

Type: enum
Default: EVEN
Possible Values:
Value
Description
EVEN

FixedGroupCount

Type: u32
Default: 100
Range: 1 - 32768
FixedLoad
Specified the fixed load size.

Type: double
Default: 10
2536
Writable Attribute
Description
GroupCountEnd

Type: u32
Default: 100
Range: 2 - 32768
GroupCountStart

Type: u32
Default: 10
Range: 1 - 32767
GroupCountStep

Type: u32
Default: 10
Range: 1 - 32768
GroupCountType

Type: enum
Default: CUSTOM
Possible Values:
Value
Description
FIXED
STEP

LoadEnd
Type: double
Default: 50
LoadStart
Type: double
Default: 10
LoadStep
Type: double
Default: 10
Range: 0.001 - 100000000000.0
LoadType

Type: enum
Default: STEP
Possible Values:
Value
Description
FIXED
Fixed load type. A fixed load specified by FixedLoad is applied for each iteration.
STEP

RandomMaxLoad.
2537
Rfc3918MixedClassThroughputPerIterationResult
Writable Attribute
Description
LoadUnits
Type: enum
Possible Values:
Value
Description
PERCENT_LINE_RATE
FRAMES_PER_SECOND
Frames per second.
INTER_BURST_GAP
Inter burst gap.

KILOBITS_PER_SECOND
BITS_PER_SECOND
Bits per second.
MulticastJoinTxDelay
Delay between generator start and join messages.

Type: u32
Default: 10
Range: 0 - 3600
MulticastLeaveTxDelay
Delay between joins and leaves.

Type: u32
Default: 10
Range: 0 - 3600
RandomMaxGroupCount

Type: u32
Default: 1000
Range: 1 - 32768
RandomMaxLoad
Type: double
Default: 50
RandomMinGroupCount

Type: u32
Default: 1
Range: 1 - 32768
RandomMinLoad
Type: double
Default: 10
Rfc3918JoinLeaveLatencyTestCaseConfig Read-Only Attributes

Description:

Rfc3918MixedClassThroughputPerIterationResult Writable Attributes

2538
Rfc3918MixedClassThroughputPerIterationResult Read-Only Attributes

Read-Only Attribute
Description
AvgJitter

Type: double
Default: 0
AvgLatency

Type: double
Default: 0
ChecksumErrorCount

Type: u64
Default: 0
DroppedFrameCount

Type: u64
Default: 0
DroppedFramePct

Type: double
Default: 0
DuplicateFrameCount
Number of duplicate frames.

Type: u64
Default: 0
DurationInSec

Type: double
Default: 0

Type: u64
Default: 0
FcsErrorFrameCount
Number of frames received with FCS error.

Type: u64
Default: 0
FloodedFrameCount

Type: u64
Default: 0
ForwardingRate
Type: double
Default: 0
MaxJitter

Type: double
Default: 0
MaxLatency

Type: double
Default: 0

Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE

MinJitter

Type: double
Default: 0
2539
Read-Only Attribute
Description
MinLatency

Type: double
Default: 0
MixedClassIntendedLoad
Number of frames per second that the application attempts to transmit to a DUT/SUT for forwarding
to a specified output interface or interfaces.
Type: double
Default: 0
MixedClassOfferedLoad
Mixed class offered load.

Type: double
Default: 0
Average multicast frame size.

Type: double
Default: 0

Type: u32
Default: 0
MulticastGroupCount

Type: u32
Default: 0

Type: string
Default: N/A
to specified multicast output interfaces.
Type: double
Default: 0
Offered load.
Type: double
Default: 0

Type: u32
Default: 0
MulticastTxFrameCount

Type: u64
Default: 0
MulticastTxFrameRate
Multicast Tx frame rate.

Type: double
Default: 0
MulticastUnicastRatio
Multicast to unicast ratio.

Type: string
Default: 1:1
OtherFrameCount

Type: u64
Default: 0
OutOfSequenceThresholdExceeded
Whether the out of sequence frames have exceeded the threshold.

Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
Out of sequence frames have exceeded the threshold value.
FALSE Out of sequence frames have not exceeded the threshold value.
2540
Rfc3918MixedClassThroughputTestCaseConfig
Read-Only Attribute
Description
OutSeqFrameCount
Type: u64
Default: 0
PauseFrameCount
Number of pause frames.

Type: u64
Default: 0
PfcFrameCount

Type: u64
Default: 0
RxFrameCount

Type: u64
Default: 0
TrialNum
Trial iteration.
Type: u8
Default: 0
TxFrameCount

Type: u64
Default: 0
TxFrameRate

Type: double
Default: 0
UnicastAvgFrameSize
Unicast average frame size.

Type: double
Default: 0
UnicastImixDistribution
Unicast iMIX distribution.

Type: string
Default: N/A
UnicastIntendedLoad
to a specified unicast output interface.
Type: double
Default: 0
UnicastOfferedLoad
Unicast offered load.

Type: double
Default: 0
UnicastTxFrameCount

Type: u64
Default: 0
UnicastTxFrameRate
Unicast Tx frame rate.

Type: double
Default: 0
Description:
Configuration object for RFC 3918 Mixed Class Throughput test.

Relations:
2541
Side name
(Type)
Relative
Description
UnicastStreamBlocks
(UnicastStreamBlockBinding)
StreamBlock
Link to unicast streamblocks to use in test.
Rfc3918MixedClassThroughputTestCaseConfig Writable Attributes

Writable Attribute
Description
Active, Name
AcceptableFrameLoss
Maximum frame loss you want Spirent TestCenter to allow before stopping the test. This value represents
the aggregate loss from all flows averaged across each all ports in the test.
Type: double
Default: 0
Range: 0 - 100
Backoff
Type: double
Default: 50
Range: 0.001 - 99.999

Type: u32
Default: 0
Range: 1 - 32768
CustomMulticastTrafficPercentageList
List of multicast traffic percentages.

Type: double
Default: 0
Range: 0 - 100
CustomUnicastFrameSizeList
Custom list of unicast frame sizes.

Type: u16
Default: 0
Range: 47 - 16383
CustomUnicastImixList

Type: handle
Default: 0
DistributionType

Type: enum
Default: EVEN
Possible Values:
Value
Description
EVEN

Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
2542
Writable Attribute
Description
EnableOutOfSequenceThreshold
Whether to enable out of sequence threshold.

Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
Enable out of sequence threshold.
FALSE Disable out of sequence threshold.

FixedGroupCount

Type: u32
Default: 100
Range: 1 - 32768
FixedMulticastTrafficPercentage
Fixed percentage for multicast traffic.

Type: double
Default: 10.0
Range: 0 - 100
FixedUnicastFrameSize
Fixed unicast frame size.

Type: u16
Default: 128
Range: 47 - 16382
GroupCountEnd

Type: u32
Default: 100
Range: 2 - 32768
GroupCountStart

Type: u32
Default: 10
Range: 1 - 32767
GroupCountStep

Type: u32
Default: 10
Range: 1 - 32768
GroupCountType

Type: enum
Default: CUSTOM
Possible Values:
Value
Description
FIXED
STEP

IgnoreMinMaxLimits
Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE

MaxLatencyThreshold
Maximum (in uSec) of all the average latencies determined on each receive port in the test. If the threshold
is reached, then the test iteration fails.
Type: double
Default: 30.0
Range: 0.01 - 4294967295.0
2543
Writable Attribute
Description
MulticastTrafficPercentageEnd
Final multicast traffic percentage when stepping.

Type: double
Default: 90
Range: 0 - 100
MulticastTrafficPercentageMode
Method to use for iterating the multicast percentage.

Type: enum
Default: FIXED
Possible Values:
Value
Description
FIXED
Use fixed percentage.
STEP
Use step mode for multicast percentage.
CUSTOM Use a custom list.

RANDOM Use random percentage.
MulticastTrafficPercentageStart
Initial multicast traffic percentage when stepping.

Type: double
Default: 10
Range: 0 - 100
MulticastTrafficPercentageStep
Multicast traffic step percentage when stepping.

Type: double
Default: 10
Range: 0.001 - 100
OutOfSequenceThreshold
Maximum number of out of sequence packets for an iteration to be considered a pass.

Type: u32
Default: 0
Range: 0 - 2147483647
RandomMaxGroupCount

Type: u32
Default: 1000
Range: 1 - 32768
RandomMaxMulticastTrafficPercentage
Upper bound for random multicast traffic percentage.

Type: double
Default: 100
Range: 0.001 - 100
RandomMaxUnicastFrameSize
Upper bound for random unicast frame sizes.

Type: u16
Default: 1518
Range: 48 - 16383
RandomMinGroupCount

Type: u32
Default: 1
Range: 1 - 32768
RandomMinMulticastTrafficPercentage
Lower bound for random multicast traffic percentage.

Type: double
Default: 1
Range: 0.001 - 100
RandomMinUnicastFrameSize
Lower bound for random unicast frame sizes.

Type: u16
Default: 128
Range: 47 - 16382
RateInitial
Type: double
Default: 100
Range: 0.001 - 100
2544
Writable Attribute
Description
RateLowerLimit
Lowest transmission rate at which the application will send traffic during any test iteration, as a percentage
of the total wire rate.
Type: double
Default: 10
Range: 0.001 - 100
RateStep
Percent by which Spirent TestCenter will increase the current transmission rate, as a percentage of the
total wire rate. The transmission rate increases until the maximum rate is reached, even if there is frame
loss.
Type: double
Default: 10
Range: 0.001 - 100
RateUpperLimit
Maximum rate at which Spirent TestCenter will send traffic during the test,as a percentage of the total wire
rate.
Type: double
Default: 100
Range: 0.001 - 100
Resolution
Finest adjustment possible, in number of frames, for the duration of transmitted frames from iteration to
iteration.
Type: double
Default: 1
Range: 0.001 - 100
SearchMode

Type: enum
Default: BINARY
Possible Values:
Value
Description
STEP
COMBO Mode begins in Step mode, then changes to Binary mode when the step adjustment causes
failure.
UnicastFrameSizeEnd
Final unicast frame size used when stepping.

Type: u16
Default: 1518
Range: 48 - 16383
UnicastFrameSizeMode
Method used to adjust unicast frame size.

Type: enum
Default: CUSTOM
Possible Values:
Value
Description
FIXED
Use a fixed frame size.
STEP
Use frame sizes in step starting from an initial value till a final value in steps of the step value.
CUSTOM Use a custom frame size list.

IMIX
Use a list of iMIX distributions.
RANDOM Use random frame sizes.

UnicastFrameSizeStart
Initial unicast frame size used when stepping.

Type: u16
Default: 128
Range: 47 - 16382
UnicastFrameSizeStep
Unicast frame size step used when stepping.

Type: u16
Default: 128
Range: 1 - 16383
2545
Rfc3918MulticastForwardingLatencyPerIterationResult
Writable Attribute
Description
UseSameFrameSizeForMulticastAndUnicast
Whether multicast and unicast should use the same frame size.
Type: bool
Default: TRUE
Possible Values:
Value Description
TRUE
Multicast and unicast should use the same frame size.
FALSE Multicast and unicast should use different frame sizes.
Rfc3918MixedClassThroughputTestCaseConfig Read-Only Attributes

Description:

Rfc3918MulticastForwardingLatencyPerIterationResult Writable Attributes

Rfc3918MulticastForwardingLatencyPerIterationResult Read-Only Attributes

Read-Only Attribute
Description
AvgLatency

Type: double
Default: 0
ChecksumErrorCount

Type: u64
Default: 0
DroppedFrameCount

Type: u64
Default: 0
DroppedFramePct

Type: double
Default: 0
DuplicateFrameCount

Type: u64
Default: 0
DurationInSec

Type: double
Default: 0
Number of Rx frames expected to be received.

Type: u64
Default: 0
2546
Read-Only Attribute
Description
FcsErrorFrameCount

Type: u64
Default: 0
FloodedFrameCount
Number of flooded frames received.

Type: u64
Default: 0
HistBin10Count

Type: u64
Default: 0
HistBin10Label
Latency Range (us) for Bucket 10.

Type: string
Default: N/A
HistBin11Count

Type: u64
Default: 0
HistBin11Label

Type: string
Default: N/A
HistBin12Count

Type: u64
Default: 0
HistBin12Label

Type: string
Default: N/A
HistBin13Count

Type: u64
Default: 0
HistBin13Label

Type: string
Default: N/A
HistBin14Count

Type: u64
Default: 0
HistBin14Label

Type: string
Default: N/A
HistBin15Count

Type: u64
Default: 0
HistBin15Label

Type: string
Default: N/A
HistBin16Count

Type: u64
Default: 0
HistBin16Label

Type: string
Default: N/A
HistBin1Count
Histogram bucket 1.
Type: u64
Default: 0
2547
Read-Only Attribute
Description
HistBin1Label

Type: string
Default: N/A
HistBin2Count
Histogram bucket 2.
Type: u64
Default: 0
HistBin2Label

Type: string
Default: N/A
HistBin3Count
Histogram bucket 3.
Type: u64
Default: 0
HistBin3Label

Type: string
Default: N/A
HistBin4Count
Histogram bucket 4.
Type: u64
Default: 0
HistBin4Label

Type: string
Default: N/A
HistBin5Count
Histogram bucket 5.
Type: u64
Default: 0
HistBin5Label

Type: string
Default: N/A
HistBin6Count
Histogram bucket 6.
Type: u64
Default: 0
HistBin6Label

Type: string
Default: N/A
HistBin7Count
Histogram bucket 7.
Type: u64
Default: 0
HistBin7Label

Type: string
Default: N/A
HistBin8Count
Histogram bucket 8.
Type: u64
Default: 0
HistBin8Label

Type: string
Default: N/A
HistBin9Count
Histogram bucket 9.
Type: u64
Default: 0
HistBin9Label

Type: string
Default: N/A
2548
Read-Only Attribute
Description
MaxLatency

Type: double
Default: 0
MinLatency

Type: double
Default: 0
Average frame size for multicast traffic.

Type: double
Default: 0
Number of egress ports for multicast traffic.

Type: u32
Default: 0
MulticastGroupCount

Type: u32
Default: 0
iMIX distribution for multicast traffic.

Type: string
Default: N/A
to specified multicast interfaces.
Type: double
Default: 0
Offered load for multicast traffic.

Type: double
Default: 0
Number of Rx groups receiving multicast traffic.

Type: u32
Default: 0
OtherFrameCount
Number of other frames received.

Type: u64
Default: 0
PauseFrameCount
Number of pause frames received.

Type: u64
Default: 0
PfcFrameCount

Type: u64
Default: 0
RxFrameCount

Type: u64
Default: 0
TrialNum
Trial number.
Type: u8
Default: 0
TxFrameCount

Type: u64
Default: 0
TxFrameRate

Type: double
Default: 0
2549
Rfc3918MulticastForwardingLatencyTestCaseConfig
Description:
Configuration object for RFC 3918 Multicast Forwarding Latency Test.

Relations:
Side name
(Type)
Relative
Description
Rfc3918MulticastForwardingLatencyTestCaseConfig Writable Attributes

Writable Attribute
Description
Active, Name

Type: u32
Default: 0
Range: 1 - 32768
CustomLoadList

Type: double
Default: 0
DistributionType

Type: enum
Default: EVEN
Possible Values:
Value
Description
EVEN

FixedGroupCount

Type: u32
Default: 100
Range: 1 - 32768
FixedLoad
Fixed load size.

Type: double
Default: 10
GroupCountEnd

Type: u32
Default: 100
Range: 2 - 32768
GroupCountStart

Type: u32
Default: 10
Range: 1 - 32767
GroupCountStep

Type: u32
Default: 10
Range: 1 - 32768
2550
Writable Attribute
Description
GroupCountType

Type: enum
Default: CUSTOM
Possible Values:
Value
Description
FIXED
STEP

LatencyBucketCalibrationDuration
Duration for Automatic Latency Calculation.

Type: double
Default: 10.0
Range: 1.0 - 900.0
LatencyBucketCalibrationMode
Latency Histogram Bucket Calibration Mode.

Type: enum
Default: AUTOMATIC
Possible Values:
Value
Description
AUTOMATIC AUTOMATIC.
MANUAL
LatencyBucketDistributionMode
MANUAL.
Sets latency bucket distribution mode.

Type: enum
Default: EXPONENTIAL
Possible Values:
Value
Description
EXPONENTIAL Exponential bucket distribution.
LINEAR
Linear bucket distribution.
LoadEnd
Type: double
Default: 50
LoadStart
When using Step mode for load on the ports, the starting load for each port. This attribute is ignored if LoadType
Type: double
Default: 10
LoadStep
Type: double
Default: 10
Range: 0.001 - 100000000000.0
LoadType

Type: enum
Default: STEP
Possible Values:
Value
Description
FIXED
STEP
Step load type. The load increases by LoadStep with each test iteration, beginning with LoadStart
and increasing to LoadEnd.

RandomMaxLoad.
2551
Rfc3918MulticastGroupCapacityPerIterationResult
Writable Attribute
Description
LoadUnits
Type: enum
Possible Values:
Value
Description
PERCENT_LINE_RATE
FRAMES_PER_SECOND
Frames per second.
INTER_BURST_GAP
Inter burst gap.

KILOBITS_PER_SECOND
BITS_PER_SECOND
Bits per second.
MaxExpectedLatencyValue
Expected maximal latency value.

Type: double
Default: 16384.0
Range: 0.35 - 2147483647.0
MinExpectedLatencyValue
Expected minimal latency value.

Type: double
Default: 4.0
Range: 0.03 - 1073741823.0
RandomMaxGroupCount

Type: u32
Default: 1000
Range: 1 - 32768
RandomMaxLoad
When using Random mode for load on the ports, the maximum load for each port. This attribute is ignored if
LoadType is set to STEP or CUSTOM.
Type: double
Default: 50
RandomMinGroupCount

Type: u32
Default: 1
Range: 1 - 32768
RandomMinLoad
When using Random mode for load on the ports, the minimum load for each port. This attribute is ignored if
LoadType is set to STEP or CUSTOM.
Type: double
Default: 10
Rfc3918MulticastForwardingLatencyTestCaseConfig Read-Only Attributes

Description:

Rfc3918MulticastGroupCapacityPerIterationResult Writable Attributes

2552
Rfc3918MulticastGroupCapacityPerIterationResult Read-Only Attributes

Read-Only Attribute
Description
AvgJitter

Type: double
Default: 0
AvgLatency

Type: double
Default: 0
ChecksumErrorCount

Type: u64
Default: 0
DroppedFrameCount

Type: u64
Default: 0
DroppedFramePct

Type: double
Default: 0
DuplicateFrameCount

Type: u64
Default: 0
DurationInSec

Type: double
Default: 0

Type: u64
Default: 0
FcsErrorFrameCount

Type: u64
Default: 0
FloodedFrameCount
Number of flooded frame count.

Type: u64
Default: 0
ForwardingRate
Type: double
Default: 0
MaxJitter

Type: double
Default: 0
MaxLatency

Type: double
Default: 0
MinJitter

Type: double
Default: 0
MinLatency

Type: double
Default: 0
Multicast average frame size.

Type: double
Default: 0
2553
Read-Only Attribute
Description

Type: u32
Default: 0
MulticastEgressPortNoFramesRxGroupCount
Total number of groups with zero received frames on all egress ports.
Type: u64
Default: 0
MulticastGroupCount

Type: u32
Default: 0

Type: string
Default: N/A
Type: double
Default: 0
Offered load.
Type: double
Default: 0

Type: u32
Default: 0
OtherFrameCount
Other frame count.

Type: u64
Default: 0
OutSeqFrameCount

Type: u64
Default: 0
PauseFrameCount

Type: u64
Default: 0
PfcFrameCount

Type: u64
Default: 0
RxFrameCount

Type: u64
Default: 0
TrialNum
Trial number.
Type: u8
Default: 0
TxFrameCount

Type: u64
Default: 0
TxFrameRate

Type: double
Default: 0
2554
Rfc3918MulticastGroupCapacityTestCaseConfig
Description:
Configuration object for RFC 3918 Multicast Group Capacity Test.

Relations:
Side name
(Type)
Relative
Description
Rfc3918MulticastGroupCapacityTestCaseConfig Writable Attributes

Writable Attribute
Description
Active, Name
CustomLoadList

Type: double
Default: 0
DistributionType

Type: enum
Default: EVEN
Possible Values:
Value
Description
EVEN

FixedLoad
Fixed load size.

Type: double
Default: 10
GroupSearchBackoff
Backoff percent for binary search.

Type: double
Default: 50.0
Range: 0.001 - 99.999
GroupSearchInitial
Initial group count for binary search.

Type: u32
Default: 10
Range: 1 - 32768
GroupSearchLowerLimit
Lower limit for group search.

Type: u32
Default: 10
Range: 1 - 32767
GroupSearchMode
Mode for the group search.

Type: enum
Default: STEP
Possible Values:
Value
Description
BINARY Binary search.
STEP
Step search.
COMBO Step + Binary search.

GroupSearchResolution
Resolution of search.
Type: u32
Default: 10
Range: 1 - 1000
2555
Writable Attribute
Description
GroupSearchStep
Group count step for step search.

Type: u32
Default: 10
Range: 1 - 32768
GroupSearchUpperLimit
Upper limit for group search.

Type: u32
Default: 100
Range: 2 - 32768
LoadEnd
Type: double
Default: 50
LoadStart
Type: double
Default: 10
LoadStep
Type: double
Default: 10
Range: 0.001 - 100000000000.0
LoadType

Type: enum
Default: FIXED
Possible Values:
Value
Description
FIXED
STEP

RandomMaxLoad.
LoadUnits
Type: enum
Possible Values:
Value
Description
PERCENT_LINE_RATE
FRAMES_PER_SECOND
Frames per second.
INTER_BURST_GAP
Inter burst gap.

KILOBITS_PER_SECOND
BITS_PER_SECOND
Bits per second.
RandomMaxLoad
Type: double
Default: 50
RandomMinLoad
Type: double
Default: 10
Rfc3918MulticastGroupCapacityTestCaseConfig Read-Only Attributes

2556
Description:

Rfc3918ScaledGroupForwardingPerIterationResult Writable Attributes

Rfc3918ScaledGroupForwardingPerIterationResult Read-Only Attributes

Read-Only Attribute
Description
AvgJitter

Type: double
Default: 0
AvgLatency

Type: double
Default: 0
ChecksumErrorCount

Type: u64
Default: 0
DroppedFrameCount

Type: u64
Default: 0
DroppedFramePct

Type: double
Default: 0
DuplicateFrameCount

Type: u64
Default: 0
DurationInSec

Type: double
Default: 0

Type: u64
Default: 0
FcsErrorFrameCount
Number of FCS errored frames received.

Type: u64
Default: 0
FloodedFrameCount

Type: u64
Default: 0
ForwardingRate
Type: double
Default: 0
MaxJitter

Type: double
Default: 0
MaxLatency

Type: double
Default: 0
2557
Read-Only Attribute
Description
MinJitter

Type: double
Default: 0
MinLatency

Type: double
Default: 0
Average multicast frame size.

Type: double
Default: 0

Type: u32
Default: 0
MulticastGroupCount

Type: u32
Default: 0
iMIX distribution.
Type: string
Default: N/A
Type: double
Default: 0
Offered load.
Type: double
Default: 0

Type: u32
Default: 0
OtherFrameCount

Type: u64
Default: 0
OutSeqFrameCount

Type: u64
Default: 0
PauseFrameCount

Type: u64
Default: 0
PfcFrameCount

Type: u64
Default: 0
RxFrameCount

Type: u64
Default: 0
TrialNum
Trial number.
Type: u8
Default: 0
TxFrameCount

Type: u64
Default: 0
2558
Read-Only Attribute
Description
TxFrameRate

Type: double
Default: 0
Description:
Configuration object for RFC 3918 Scaled Group Forwarding Test.

Relations:
Side name
(Type)
Relative
Description
Rfc3918ScaledGroupForwardingTestCaseConfig Writable Attributes

Writable Attribute
Description
Active, Name

Type: u32
Default: 0
Range: 1 - 32768
CustomLoadList

Type: double
Default: 0
DistributionType

Type: enum
Default: EVEN
Possible Values:
Value
Description
EVEN

FixedGroupCount

Type: u32
Default: 100
Range: 1 - 32768
FixedLoad
Fixed load size.

Type: double
Default: 10
GroupCountEnd

Type: u32
Default: 100
Range: 2 - 32768
2559
Writable Attribute
Description
GroupCountStart

Type: u32
Default: 10
Range: 1 - 32767
GroupCountStep

Type: u32
Default: 10
Range: 1 - 32768
GroupCountType

Type: enum
Default: CUSTOM
Possible Values:
Value
Description
FIXED
STEP

LoadEnd
Type: double
Default: 50
LoadStart
Type: double
Default: 10
LoadStep
Type: double
Default: 10
Range: 0.001 - 100000000000.0
LoadType

Type: enum
Default: STEP
Possible Values:
Value
Description
FIXED
STEP

RandomMaxLoad.
LoadUnits
Type: enum
Possible Values:
Value
Description
PERCENT_LINE_RATE
FRAMES_PER_SECOND
Frames per second.
INTER_BURST_GAP
Inter burst gap.

KILOBITS_PER_SECOND
BITS_PER_SECOND
Bits per second.
2560
Rfc3918SetupAggregatedMulticastThroughputTestCommand
Writable Attribute
Description
RandomMaxGroupCount

Type: u32
Default: 1000
Range: 1 - 32768
RandomMaxLoad
Type: double
Default: 50
RandomMinGroupCount

Type: u32
Default: 1
Range: 1 - 32768
RandomMinLoad
Type: double
Default: 10
Rfc3918ScaledGroupForwardingTestCaseConfig Read-Only Attributes

Description:
Set up RFC 3918 aggregated multicast throughput test.

Parents: Sequencer
Relations:
Side name
(Type)
Relative
Description
TestCaseConfig
Rfc3918Config

Parent command.
Rfc3918SetupAggregatedMulticastThroughputTestCommand Writable Attributes

Writable Attribute
Description
AcceptableFrameLoss
Maximum percentage of frames that can be lost during an iteration in order for the iteration to be considered
successful.
Type: double
Default: 0
Range: 0.0 - 100.0
2561
Writable Attribute
Description
Backoff
Rate at which the load decreases after the DUT fails at the current load. Applicable when SearchMode is BINARY
or COMBO.
Type: double
Default: 50.0
Range: 0.001 - 99.999
DstDeviceList

Type: handle
Default: 0
Duration

Type: double
Default: 60
Range: 1 - 16777215
DurationMode
Type: enum
Default: SECONDS
Possible Values:
Value
Description
BURSTS
Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE

Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE

LatencyType

Type: enum
Default: LILO
Possible Values:
Value Description
LILO
LIFO

LearningFreqMode
Learning frequency.
Type: enum
Possible Values:
Value
Description
NONE
No learning.
LEARN_EVERY_TOPOLOGY_CHANGE Learn every traffic change.

Learn every frame size.
2562
Writable Attribute
Description
LoadUnits
Type: enum
Possible Values:
Value
Description
MaxLatencyThreshold
Maximum (in uSec) of all the average latencies determined on each receive port in the test. If the threshold is
reached, then the test iteration fails.
Type: double
Default: 30
Range: 0.01 - 4294967295.0
MonitorPortList

Type: handle
Default: 0

Type: enum
Default: IGMP_V2
Possible Values:
Value
Description
MLD_V1
MLD, version 1.
MLD_V2
MLD, version 2.
MulticastFrameSizeDistributionList

Type: handle
Default: 0
MulticastFrameSizeList
Frame size list.

Type: u16
Default: 0
Range: 47 - 16383
MulticastGroupCountList
Multicast group count list.

Type: u32
Default: 0
Range: 1 - 32768
MulticastGroupIpAddrBase
IP Multicast group base address.

Type: ip
Default: 225.0.0.1
MulticastGroupIpAddrPortStep
IP Multicast group port step value.

Type: ip
Default: 0.1.0.0
MulticastGroupIpAddrStep
IP Multicast address step.

Type: u32
Default: 2
Range: 1 - 4294967295
MulticastGroupIpv6AddrBase
IPv6 Multicast group base address.

Type: ipv6
Default: ff1e::1
MulticastGroupIpv6AddrPortStep
IPv6 Multicast group port step value.

Type: ipv6
Default: 0:0:0:1::0
2563
Writable Attribute
Description
MulticastGroupIpv6AddrStep
IPv6 Multicast group step value.

Type: u32
Default: 2
Range: 1 - 4294967295
MulticastTrafficList
Traffic list.
Type: handle
Default: 0
MulticastTrafficPattern

Type: enum
Default: BACKBONE
Possible Values:
Value
Description
MESH

NumOfTrials
Number of trials.
Type: u16
Default: 1
Range: 1 - 60
OutOfSeqThreshold
Out of sequence frames threshold.

Type: u32
Default: 0
Range: 0 - 2147483647
RateInitial
If SearchMode is set to BINARY, the load rate at the beginning of the test. This attribute is ignored if SearchMode
is set to STEP.
Type: double
Default: 99.0
Range: 0.001 - 100.0
RateLowerLimit
total wire rate.
Type: double
Default: 1.0
Range: 0.001 - 100.0
RateStep
If SearchMode is set to STEP, the amount the load increases from iteration to iteration. This attribute is ignored
if SearchMode is set to BINARY.
Type: double
Default: 10.0
Range: 0.001 - 100.0
RateUpperLimit
Type: double
Default: 100.0
Range: 0.001 - 100.0
Resolution
Type: double
Default: 1.0
Range: 0.001 - 100.0
SearchMode

Type: enum
Default: BINARY
Possible Values:
Value
Description
STEP
2564
Rfc3918SetupJoinLeaveLatencyTestCommand
Writable Attribute
Description
SrcDeviceList
Source device list.

Type: handle
Default: 0

Type: bool
Default: TRUE
Possible Values:
Value Description
TRUE


Type: enum
Default: NONE
Possible Values:
Value
Description
NONE
No verification.
VERIFY_EVERY_TRIAL


Type: u32
Default: 100
Range: 1 - 32767
Type: u32
Default: 1000
Range: 1 - 14880952
Rfc3918SetupAggregatedMulticastThroughputTestCommand Read-Only Attributes

Description:
Set up RFC 3918 join leave latency test.

Parents: Sequencer
Relations:
Side name
(Type)
Relative
Description
TestCaseConfig
Rfc3918Config

2565
Side name
(Type)
Relative
Description
Parent command.
Rfc3918SetupJoinLeaveLatencyTestCommand Writable Attributes

Writable Attribute
Description
DstDeviceList

Type: handle
Default: 0
LatencyType

Type: enum
Default: LILO
Possible Values:
Value Description
LILO
LIFO

LearningFreqMode
Learning frequency.
Type: enum
Possible Values:
Value
Description
NONE
No learning.

MonitorPortList

Type: handle
Default: 0

Type: enum
Default: IGMP_V2
Possible Values:
Value
Description
MLD_V1
MLD, version 1.
MLD_V2
MLD, version 2.

Type: handle
Default: 0
Multicast frame size list.

Type: u16
Default: 0
Range: 47 - 16383

Type: u32
Default: 0
Range: 1 - 32768
2566
Writable Attribute
Description

Type: ip
Default: 225.0.0.1

Type: ip
Default: 0.1.0.0

Type: u32
Default: 2
Range: 1 - 4294967295

Type: ipv6
Default: ff1e::1

Type: ipv6
Default: 0:0:0:1::0

Type: u32
Default: 2
Range: 1 - 4294967295
MulticastLoadList

Type: double
Default: 0
Range: 0.000001 - 100000.0
MulticastLoadUnits
Multicast load units.

Type: enum
Possible Values:
Value
Description
PERCENT_LINE_RATE
FRAMES_PER_SECOND

KILOBITS_PER_SECOND
BITS_PER_SECOND
Traffic list.
Type: handle
Default: 0

Type: enum
Default: BACKBONE
Possible Values:
Value
Description
MESH

NumOfTrials
Number of trials.
Type: u16
Default: 1
Range: 1 - 60
SrcDeviceList
Source device list.

Type: handle
Default: 0
2567
Rfc3918SetupMixedClassThroughputTestCommand
Writable Attribute
Description

Type: bool
Default: TRUE
Possible Values:
Value Description
TRUE


Type: enum
Default: NONE
Possible Values:
Value
Description
NONE
No verification.
VERIFY_EVERY_TRIAL


Type: u32
Default: 100
Range: 1 - 32767
Type: u32
Default: 1000
Range: 1 - 14880952
Rfc3918SetupJoinLeaveLatencyTestCommand Read-Only Attributes

Description:
Set up RFC 3918 mixed class throughput test.

Parents: Sequencer
Relations:
Side name
(Type)
Relative
Description
TestCaseConfig
Rfc3918Config

Parent command.
2568
Rfc3918SetupMixedClassThroughputTestCommand Writable Attributes

Writable Attribute
Description
AcceptableFrameLoss
Maximum percentage of frames that can be lost during an iteration in order for the iteration to be considered
successful.
Type: double
Default: 0
Range: 0.0 - 100.0
Backoff
Rate at which the load decreases after the DUT fails at the current load. Applicable when SearchMode is
BINARY or COMBO.
Type: double
Default: 50.0
Range: 0.001 - 99.999
DstDeviceList

Type: handle
Default: 0
Duration

Type: double
Default: 60
Range: 1 - 16777215
DurationMode
Duration mode for each transmitted stream. Whether to measure test duration in seconds or number of
frames.
Type: enum
Default: SECONDS
Possible Values:
Value
Description
BURSTS
Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE

Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE

EnableUnicastBidirectionalTraffic
Whether unicast traffic should be transmitted bidirectionally.

Type: bool
Default: TRUE
Possible Values:
Value Description
TRUE
Unicast traffic will be transmitted bidirectionally.
FALSE Unicast traffic will be transmitted unidirectionally.
2569
Writable Attribute
Description
LatencyType

Type: enum
Default: LILO
Possible Values:
Value Description
LILO
LIFO

LearningFreqMode
Learning frequency.
Type: enum
Possible Values:
Value
Description
NONE
No learning.
LoadUnits
Type: enum
Possible Values:
Value
Description
MaxLatencyThreshold
Maximum (in uSec) of all the average latencies determined on each receive port in the test. If the threshold
is reached, then the test iteration fails.
Type: double
Default: 30
Range: 0.01 - 4294967295.0
MonitorPortList

Type: handle
Default: 0

Type: enum
Default: IGMP_V2
Possible Values:
Value
Description
MLD_V1
MLD, version 1.
MLD_V2
MLD, version 2.

Type: handle
Default: 0

Type: u16
Default: 0
Range: 47 - 16383

Type: u32
Default: 0
Range: 1 - 32768
2570
Writable Attribute
Description

Type: ip
Default: 225.0.0.1

Type: ip
Default: 0.1.0.0

Type: u32
Default: 2
Range: 1 - 4294967295

Type: ipv6
Default: ff1e::1

Type: ipv6
Default: 0:0:0:1::0

Type: u32
Default: 2
Range: 1 - 4294967295
Traffic list.
Type: handle
Default: 0

Type: enum
Default: BACKBONE
Possible Values:
Value
Description
MESH

MulticastTrafficPercentageList
List of multicast traffic percentages.

Type: double
Default: 0
Range: 0.0 - 100.0
NumOfTrials
Number of trials.
Type: u16
Default: 1
Range: 1 - 60
OutOfSeqThreshold
Maximum out-of-sequence frames per stream that can be received during an iteration in order for the
iteration to be considered successful.
Type: u32
Default: 0
Range: 0 - 2147483647
RateInitial
If SearchMode is set to BINARY, the load rate at the beginning of the test. This attribute is ignored if
SearchMode is set to STEP.
Type: double
Default: 99.0
Range: 0.001 - 100.0
RateLowerLimit
Lowest transmission rate at which the application will send traffic during any test iteration, as a percentage
of the total wire rate.
Type: double
Default: 1.0
Range: 0.001 - 100.0
2571
Writable Attribute
Description
RateStep
If SearchMode is set to STEP, the amount the load increases from iteration to iteration. This attribute is
ignored if SearchMode is set to BINARY.
Type: double
Default: 10.0
Range: 0.001 - 100.0
RateUpperLimit
Maximum rate at which Spirent TestCenter will send traffic during the test,as a percentage of the total wire
rate.
Type: double
Default: 100.0
Range: 0.001 - 100.0
Resolution
Finest adjustment possible, in number of frames, for the duration of transmitted frames from iteration to
iteration.
Type: double
Default: 1.0
Range: 0.001 - 100.0
SearchMode

Type: enum
Default: BINARY
Possible Values:
Value
Description
STEP
COMBO Mode begins in Step mode, then changes to Binary mode when the step adjustment causes
failure.
SrcDeviceList
Source device list.

Type: handle
Default: 0

Type: bool
Default: TRUE
Possible Values:
Value Description
TRUE


Type: enum
Default: NONE
Possible Values:
Value
Description
NONE
No verification.
VERIFY_EVERY_TRIAL


Type: u32
Default: 100
Range: 1 - 32767
Type: u32
Default: 1000
Range: 1 - 14880952
UnicastFrameSizeDistributionList

Type: handle
Default: 0
2572
Rfc3918SetupMulticastForwardingLatencyTestCommand
Writable Attribute
Description
UnicastFrameSizeList
Unicast frame size list.

Type: u16
Default: 0
Range: 47 - 16383
UnicastTrafficList
Traffic list.
Type: handle
Default: 0
UseSameFrameSizeForMulticastAndUnicast
Whether multicast and unicast should use the same frame size.
Type: bool
Default: TRUE
Possible Values:
Value Description
TRUE
Multicast and unicast should use the same frame size.
FALSE Multicast and unicast should use different frame sizes.
Rfc3918SetupMixedClassThroughputTestCommand Read-Only Attributes

Description:
Set up RFC 3918 multicast forwarding latency test.

Parents: Sequencer
Relations:
Side name
(Type)
Relative
Description
TestCaseConfig
Rfc3918Config

Parent command.
Rfc3918SetupMulticastForwardingLatencyTestCommand Writable Attributes

Writable Attribute
Description
DstDeviceList

Type: handle
Default: 0
Duration

Type: double
Default: 60
Range: 1 - 16777215
2573
Writable Attribute
Description
DurationMode
Type: enum
Default: SECONDS
Possible Values:
Value
Description
BURSTS
LatencyBucketDistributionMode
Sets latency bucket distribution mode.

Type: enum
Default: EXPONENTIAL
Possible Values:
Value
Description
EXPONENTIAL Exponential bucket distribution.
LINEAR
LatencyType
Linear bucket distribution.

Type: enum
Default: LILO
Possible Values:
Value Description
LILO
LIFO

LearningFreqMode
Learning frequency.
Type: enum
Possible Values:
Value
Description
NONE
No learning.

MonitorPortList

Type: handle
Default: 0

Type: enum
Default: IGMP_V2
Possible Values:
Value
Description
MLD_V1
MLD, version 1.
MLD_V2
MLD, version 2.

Type: handle
Default: 0

Type: u16
Default: 0
Range: 47 - 16383
2574
Writable Attribute
Description

Type: u32
Default: 0
Range: 1 - 32768

Type: ip
Default: 225.0.0.1

Type: ip
Default: 0.1.0.0

Type: u32
Default: 2
Range: 1 - 4294967295

Type: ipv6
Default: ff1e::1

Type: ipv6
Default: 0:0:0:1::0

Type: u32
Default: 2
Range: 1 - 4294967295
MulticastLoadList

Type: double
Default: 0
Range: 0.000001 - 100000.0
MulticastLoadUnits

Type: enum
Possible Values:
Value
Description
PERCENT_LINE_RATE
FRAMES_PER_SECOND

KILOBITS_PER_SECOND
BITS_PER_SECOND
Traffic list.
Type: handle
Default: 0

Type: enum
Default: BACKBONE
Possible Values:
Value
Description
MESH

NumOfTrials
Number of trials.
Type: u16
Default: 1
Range: 1 - 60
2575
Rfc3918SetupMulticastGroupCapacityTestCommand
Writable Attribute
Description
SrcDeviceList
Source device list.

Type: handle
Default: 0

Type: bool
Default: TRUE
Possible Values:
Value Description
TRUE


Type: enum
Default: NONE
Possible Values:
Value
Description
NONE
No verification.
VERIFY_EVERY_TRIAL


Type: u32
Default: 100
Range: 1 - 32767
Type: u32
Default: 1000
Range: 1 - 14880952
Rfc3918SetupMulticastForwardingLatencyTestCommand Read-Only Attributes

Description:
Set up RFC 3918 multicast group capacity test.

Parents: Sequencer
Relations:
Side name
(Type)
Relative
Description
TestCaseConfig
Rfc3918Config

2576
Side name
(Type)
Relative
Description
Parent command.
Rfc3918SetupMulticastGroupCapacityTestCommand Writable Attributes

Writable Attribute
Description
Backoff
Rate at which the load decreases after the DUT fails at the current load. Applicable when SearchMode is
BINARY or COMBO.
Type: double
Default: 50.0
Range: 0.001 - 99.999
DstDeviceList

Type: handle
Default: 0
Duration

Type: double
Default: 60
Range: 1 - 16777215
DurationMode
Type: enum
Default: SECONDS
Possible Values:
Value
Description
BURSTS
GroupSearchInitial
Initial group count for binary search.

Type: u32
Default: 10
Range: 1 - 32768
GroupSearchLowerLimit
Lower limit for group search.

Type: u32
Default: 10
Range: 1 - 32768
GroupSearchMode
Mode for the group search.

Type: enum
Default: STEP
Possible Values:
Value
Description
BINARY Binary search.
STEP
Step search.
COMBO Step + Binary search.

GroupSearchStep
Group count step for step search.

Type: u32
Default: 10
Range: 1 - 32768
GroupSearchUpperLimit
Upper limit for group search.

Type: u32
Default: 100
Range: 2 - 32768
2577
Writable Attribute
Description
LatencyType

Type: enum
Default: LILO
Possible Values:
Value Description
LILO
LIFO

LearningFreqMode
Learning frequency.
Type: enum
Possible Values:
Value
Description
NONE
No learning.

MonitorPortList

Type: handle
Default: 0

Type: enum
Default: IGMP_V2
Possible Values:
Value
Description
MLD_V1
MLD, version 1.
MLD_V2
MLD, version 2.

Type: handle
Default: 0

Type: u16
Default: 0
Range: 47 - 16383

Type: ip
Default: 225.0.0.1

Type: ip
Default: 0.1.0.0

Type: u32
Default: 2
Range: 1 - 4294967295

Type: ipv6
Default: ff1e::1

Type: ipv6
Default: 0:0:0:1::0
2578
Writable Attribute
Description

Type: u32
Default: 2
Range: 1 - 4294967295
MulticastLoadList

Type: double
Default: 0
Range: 0.000001 - 100000.0
MulticastLoadUnits

Type: enum
Possible Values:
Value
Description
PERCENT_LINE_RATE
FRAMES_PER_SECOND

KILOBITS_PER_SECOND
BITS_PER_SECOND
Traffic list.
Type: handle
Default: 0

Type: enum
Default: BACKBONE
Possible Values:
Value
Description
MESH

NumOfTrials
Number of trials.
Type: u16
Default: 1
Range: 1 - 60
Resolution
Finest adjustment possible for the load from iteration to iteration. If the required adjustment to the current load
for the next iteration is less than the resolution, the search stops. Applicable when SearchMode is BINARY or
COMBO.
Type: u32
Default: 10
Range: 1 - 1000
SrcDeviceList
Source device list.

Type: handle
Default: 0

Type: bool
Default: TRUE
Possible Values:
Value Description
TRUE
2579
Rfc3918SetupScaledGroupForwardingTestCommand
Writable Attribute
Description

Type: enum
Default: NONE
Possible Values:
Value
Description
NONE
No verification.
VERIFY_EVERY_TRIAL


Type: u32
Default: 100
Range: 1 - 32767
Type: u32
Default: 1000
Range: 1 - 14880952
Rfc3918SetupMulticastGroupCapacityTestCommand Read-Only Attributes

Description:
Set up RFC 3918 multicast forwarding test.

Parents: Sequencer
Relations:
Side name
(Type)
Relative
Description
TestCaseConfig
Rfc3918Config

Parent command.
Rfc3918SetupScaledGroupForwardingTestCommand Writable Attributes

Writable Attribute
Description
DstDeviceList

Type: handle
Default: 0
2580
Writable Attribute
Description
Duration

Type: double
Default: 60
Range: 1 - 16777215
DurationMode
Type: enum
Default: SECONDS
Possible Values:
Value
Description
BURSTS
LatencyType

Type: enum
Default: LILO
Possible Values:
Value Description
LILO
LIFO

LearningFreqMode
Learning frequency.
Type: enum
Possible Values:
Value
Description
NONE
No learning.

MonitorPortList

Type: handle
Default: 0

Type: enum
Default: IGMP_V2
Possible Values:
Value
Description
MLD_V1
MLD, version 1.
MLD_V2
MLD, version 2.

Type: handle
Default: 0

Type: u16
Default: 0
Range: 47 - 16383

Type: u32
Default: 0
Range: 1 - 32768
2581
Writable Attribute
Description

Type: ip
Default: 225.0.0.1

Type: ip
Default: 0.1.0.0

Type: u32
Default: 2
Range: 1 - 4294967295

Type: ipv6
Default: ff1e::1

Type: ipv6
Default: 0:0:0:1::0

Type: u32
Default: 2
Range: 1 - 4294967295
MulticastLoadList

Type: double
Default: 0
Range: 0.000001 - 100000.0
MulticastLoadUnits

Type: enum
Possible Values:
Value
Description
PERCENT_LINE_RATE
FRAMES_PER_SECOND

KILOBITS_PER_SECOND
BITS_PER_SECOND
Traffic list.
Type: handle
Default: 0

Type: enum
Default: BACKBONE
Possible Values:
Value
Description
MESH

NumOfTrials
Number of trials.
Type: u16
Default: 1
Range: 1 - 60
SrcDeviceList
Source device list.

Type: handle
Default: 0
2582
Rfc4814EthIIIfDecorator
Writable Attribute
Description

Type: bool
Default: TRUE
Possible Values:
Value Description
TRUE


Type: enum
Default: NONE
Possible Values:
Value
Description
NONE
No verification.
VERIFY_EVERY_TRIAL


Type: u32
Default: 100
Range: 1 - 32767
Type: u32
Default: 1000
Range: 1 - 14880952
Rfc3918SetupScaledGroupForwardingTestCommand Read-Only Attributes

Rfc4814EthIIIfDecorator
Description:

Rfc4814EthIIIfDecorator Writable Attributes

Writable Attribute
Description
Active, Name
RandomSeedValue
Type: u32
Default: 0
Rfc4814EthIIIfDecorator Read-Only Attributes

2583
rffId
rffId
Description:
rffId Attributes
Attribute
Description
fc4FeatureBits
Type: OCTETSTRING
Default: 02
Name
Type: string
portIdentifier
Type: OCTETSTRING
Default: 000000
reserved1
Type: OCTETSTRING
Default: 00
reserved2
Type: OCTETSTRING
Default: 0000
typeCode
Type: OCTETSTRING
Default: 08
RffId (fcgs:RffId)
Description:
RffId Attributes
Attribute
Description
fc4FeatureBits
Type: OCTETSTRING
Default: 02
Name
Type: string
portIdentifier
Type: OCTETSTRING
Default: 000000
reserved1
Type: OCTETSTRING
Default: 00
reserved2
Type: OCTETSTRING
Default: 0000
typeCode
Type: OCTETSTRING
Default: 08
2584
rftId
rftId
Description:
rftId Attributes
Attribute
Description
fc4Types
Type: OCTETSTRING
Name
Type: string
portIdentifier
Type: OCTETSTRING
Default: 000000
reserved
Type: OCTETSTRING
Default: 00
RftId (fcgs:RftId)
Description:
RftId Attributes
Attribute
Description
fc4Types
Type: OCTETSTRING
Name
Type: string
portIdentifier
Type: OCTETSTRING
Default: 000000
reserved
Type: OCTETSTRING
Default: 00
RI
Description:
Children: Configuration, OAMPDUConfiguration, State
2585
rieln
RI Attributes
Attribute
Description
InfoLength
Type: OCTETSTRING
Default: 10
InfoRevision
Type: OCTETSTRING
Default: 0000
InfoType
Type: OCTETSTRING
Default: 02
InfoVersion
Type: OCTETSTRING
Default: 01
Name
Type: string
OUI
Type: OCTETSTRING
Default: 000000
VSI
Type: OCTETSTRING
Default: 00000000
rieln
Description:
rieln Attributes
Attribute
Description
Type: WWN
Default: 10:00:10:94:00:00:00:00
logicalName
Type: ASCII
logicalNameLength
Type: INTEGER
Default: 0
Name
Type: string
reserved1
Rieln (fcgs:Rieln)
Description:
2586
RingTopologyGenParams
Rieln Attributes
Attribute
Description
Type: WWN
Default: 10:00:10:94:00:00:00:00
logicalName
Type: ASCII
logicalNameLength
Type: INTEGER
Default: 0
Name
Type: string
reserved1
RingTopologyGenParams
Description:
Ring topology generation parameters. The specified ring topology is created on each emulated router.

RingTopologyGenParams Writable Attributes

Writable Attribute
Description
Active, Name
EmulatedRouterPos
Location of the emulated router in the ring.

Type: enum
Default: ATTACHED_TO_RING
Possible Values:
Value
Description
ATTACHED_TO_RING Emulated router is attached to one of the simulated routers in the ring.
MEMBER_OF_RING
NumRouters
Emulated router is a member of the ring.
Total number of routers in the ring topology.

Type: u16
Default: 10
Range: 1 - 10000
RingTopologyGenParams Read-Only Attributes

2587
rip1Entries
rip1Entries
Description:
Parents: Ripv1
Children: Rip1Entry
rip1Entries Attributes
Attribute
Description
Name
information.
Type: string
Rip1Entry
Description:
Parents: rip1Entries
Children: None
Rip1Entry Attributes
Attribute
Description
afi
Type: INTEGER
Default: 2
ipaddr
Type: IPV4ADDR
Default: 192.0.0.1
metric
Type: INTEGER
Default: 1
Name
Type: string
reserved
Type: INTEGER
Default: 0
reserved1
Type: INTEGER
Default: 0
reserved2
Type: INTEGER
Default: 0
rip2Entries
Description:
Parents: Ripv2
Children: Rip2Entry
2588
Rip2Entry
rip2Entries Attributes
Attribute
Description
Name
information.
Type: string
Rip2Entry
Description:
Parents: rip2Entries
Children: None
Rip2Entry Attributes
Attribute
Description
afi
Type: INTEGER
Default: 2
ipaddr
Type: IPV4ADDR
Default: 192.0.0.1
metric
Type: INTEGER
Default: 1
Name
Type: string
nextHop
Type: IPV4ADDR
Default: 192.0.0.1
routeTag
Type: INTEGER
Default: 0
subnetMask
Type: IPV4ADDR
Default: 255.255.255.0
RipAuthenticationParams
Description:
RIP authentication settings.

Automatically created from: RipRouterConfig, RipSharedSessionParams
2589
RipDeviceGenProtocolParams
RipAuthenticationParams Writable Attributes

Writable Attribute
Description
Authentication
Authentication method to use.

Spirent TestCenter supports MD5 Authentication for emulated RIPv2, and for RIPv1-compatible RIPv2 routers. A RIPv1-compatible
is a RIPv2 router that broadcasts route updates.
Type: enum
Default: NONE
Possible Values:
Value
Description
NONE
No authentication.
SIMPLE RIP-2 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 watching the RIP
packets.
MD5
RIP-2 packet contains a cryptographic checksum, but not the authentication key itself. The receiving router performs a
calculation based on the MD5 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.
Md5KeyId
Key ID for MD5 authentication.

MD5 verifies the integrity of the communication, authenticates the origin, and checks for timeliness. This is an integer ID for the
specified MD5 password.
Type: u8
Default: 1
Password
Used for authentication of RIPv2 messages. This is used as a password string for simple authentication, or as a key string for
MD5.
If the SUT is configured to authenticate messages, this password must match the SUT password in order for the SUT to accept
RIP packets.
Type: string
Default: Spirent
RipAuthenticationParams Read-Only Attributes

RipDeviceGenProtocolParams
Description:
Specifies the RIP specific router generator parameters.

RipDeviceGenProtocolParams Writable Attributes

Writable Attribute
Description
Active, Name
EnableBfd

Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
Enable BFD.
FALSE Disable BFD.
2590
Ripng
Writable Attribute
Description
RipVersion
RIP version to be used for the emulated router.

Type: enum
Default: V2
Possible Values:
Value Description
V1
RIP version 1.
V2
RIP version 2.
NG
RIPng (Next Generation).
RipDeviceGenProtocolParams Read-Only Attributes

Ripng (rip:Ripng)
Description:
Children: ripngEntries
Ripng Attributes
Attribute
Description
command
Type: RipCommand
Default: 1
Possible Values:
Value Description
1
Request
Response
Name
Type: string
reserved
Type: INTEGER
Default: 0
version
Type: INTEGER
Default: 1
ripngEntries
Description:
Parents: Ripng
Children: RipngEntry
2591
RipngEntry
ripngEntries Attributes
Attribute
Description
Name
information.
Type: string
RipngEntry
Description:
Parents: ripngEntries
Children: None
RipngEntry Attributes
Attribute
Description
ipaddr
Type: IPV6ADDR
Default: 2000::1
metric
Type: INTEGER
Default: 1
Name
Type: string
prefixLen
Type: INTEGER
Default: 64
routeTag
Type: INTEGER
Default: 0
RipngRouteParams
Description:
RIP IPv6 route configuration settings.

Parents: RipRouterConfig
RipngRouteParams Writable Attributes

Writable Attribute
Description
Metric
Cost to the destination network, and is usually the hop count to reach the destination network. The hop limit for RIP is 15.
A hop count of 16 indicates an unreachable destination.
Type: u8
Default: 1
Range: 1 - 16
2592
RipngRouterConfig
Writable Attribute
Description
NextHop
IPv6 address of the adjacent router to which the packet should be sent next. This attribute applies only to RIPng.
Type: ipv6
Default: null
RouteCategory
Route category.
Type: enum
Default: UNDEFINED
Possible Values:
Value
Description
UNDEFINED
PRIMARY
RouteTag
UNIQUE
Indicates that a single port in the test configuration advertises this route.
ANY
ANY
Used to distinguish internal routes (learned by RIP) from external routes (learned from other protocols, such as BGP or
OSPF).
Type: u16
Default: 0
Range: 0 - 65535
RipngRouteParams Read-Only Attributes

RipngRouterConfig
Description:
RIPng router configuration settings.
RipngRouterConfig Writable Attributes

Writable Attribute
Description
Active, Name
RipngRouterConfig Read-Only Attributes

RipngStateSummary
Description:
RIPv4 router states summarized at port and project level.

Relations:
2593
RipPauseRouteUpdateCommand
Side name
(Type)
Relative
Description
ResultParent
(ResultChild)
Port, Project
RipngStateSummary Writable Attributes

RipngStateSummary Read-Only Attributes

Read-Only Attribute
Description
ClosedCount
Number of routers in closed state.

Type: u32
Default: 0
NotStartedCount
Number of routers in NotStarted state.

Type: u32
Default: 0
OpenCount
Number of routers in open state.

Type: u32
Default: 0
RouterDownCount
Number of routers in NotStarted/Closed state.

Type: u32
Default: 0
RouterUpCount

Type: u32
Default: 0
RipPauseRouteUpdateCommand
Description:
Pause RIP Route Update messages.

RipPauseRouteUpdateCommand Writable Attributes

Writable Attribute
Description
RouterList
Router handle list.

Type: handle
Default: 0
RipPauseRouteUpdateCommand Read-Only Attributes

Read-Only Attribute
Description

2594
RipReadvertiseRouteCommand
RipReadvertiseRouteCommand
Description:
Readvertise RIP routes.

RipReadvertiseRouteCommand Writable Attributes

Writable Attribute
Description
RouterList
Router handle list.

Type: handle
Default: 0
RipReadvertiseRouteCommand Read-Only Attributes

Read-Only Attribute
Description

RipResumeRouteUpdateCommand
Description:
Resume RIP Route Update messages.

RipResumeRouteUpdateCommand Writable Attributes

Writable Attribute
Description
RouterList
Router handle list.

Type: handle
Default: 0
RipResumeRouteUpdateCommand Read-Only Attributes

Read-Only Attribute
Description

2595
RipRouteGenParams
RipRouteGenParams
Description:
RIP route generator parameters.

Parents: Project
Relations:
Side name
(Type)
Relative
Description
EmulatedDevice
Routers that routes will be generated on.
RipRouteGenParams Writable Attributes

Writable Attribute
Description
Active, Name
RipRouteGenParams Read-Only Attributes

Description:
RIP route generator configure route parameters.

RipRouteGenRouteAttrParams Writable Attributes

Writable Attribute
Description
Active, Name
PrimaryMetric
RIP route metric for primary routes.

Type: u8
Default: 1
Range: 1 - 16
SecondaryMetric
RIP route metric for secondary routes.

Type: u8
Default: 2
Range: 1 - 16
RipRouteGenRouteAttrParams Read-Only Attributes

2596
RipRouterConfig
RipRouterConfig
Description:
RIP router configuration settings.

Children: RipngRouteParams, Ripv4RouteParams
Automatically-created children: RipAuthenticationParams
Result children (automatically created): RipRouterResults
Relations:
Side name
(Type)
Relative
Description
ResultChild
(ResultChild)
RipRouterResults
UsesIf
(UsesIf)


RipRouterConfig Writable Attributes

Writable Attribute
Description
Active, Name
DutIpv4Addr
IPv4 address of the DUT.

Type: ip
Default: null
DutIpv6Addr
IPv6 address of the DUT.

Type: ipv6
Default: null
EnableBfd
Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
Enable BFD.
FALSE Disable BFD.

InterUpdateDelay
Interval in milliseconds between successive RIP packets.

Type: u16
Default: 10
Range: 0 - 5000
MaxRoutePerUpdate
Maximum number of route advertisements carried in an UPDATE message.

Type: u8
Default: 25
Range: 1 - 70
RipVersion
Which RIP version to use for each emulated router.

Type: enum
Default: V2
Possible Values:
Value Description
V1
RIP version 1.
V2
RIP version 2.
NG
RIPng (Next Generation).
2597
RipRouterResults
Writable Attribute
Description
UpdateInterval
Interval in seconds used by the emulated router between successive RIP updates.
Type: u16
Default: 30
Range: 1 - 65535
UpdateJitter
Maximum inter-update variance. The maximum value of a random time interval used to vary the time at which updates
are sent. For example, if UpdateInterval is 30 seconds, and UpdateJitter is 5 seconds, then Spirent TestCenter sends
updates every 25 to 30 seconds. The variance helps prevent updates from flooding the network.
Type: u16
Default: 0
Range: 0 - 5
UpdateType
RIP router communication method. This specifies the type of address to be used when sending RIP messages.
Type: enum
Default: MULTICAST
Possible Values:
Value
Description
UNICAST
For RIP v1 or v2, Spirent TestCenter sends the RIP message to the IPv4 router specified by DutIpv4Addr.
For RIPng, Spirent TestCenter sends the RIP message to the IPv6 router specified by DutIpv6Addr.
MULTICAST
Spirent TestCenter sends the RIP message to all routers in the multicast group.
BROADCAST Spirent TestCenter sends the RIP message to all routers.

Enable use Partial Block State.

Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
Use Partial Block State.
FALSE Do not use Partial Block State.

ViewRoutes
If enabled, the stack will start to collect routes/LSAs it receives from the peer. Then later if a "View Routes" command
is issued, the stack can send the stored routes for display.
Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
Enable View Routes.
FALSE Disable View Routes.
RipRouterConfig Read-Only Attributes

Read-Only Attribute
Description
RouterState
Type: enum
Default: NONE
Possible Values:
Value
Description
NONE
No state.
CLOSED Emulated router has been created but the Start Router command has not been sent.
OPEN
Emulated router has been created and the Start Router command has been sent.
RipRouterResults
Description:
RIP router results.
2598
RipSharedSessionParams

Relations:
Side name
(Type)
Relative
Description
ResultParent
(ResultChild)
RipRouterConfig
RipRouterResults Writable Attributes

RipRouterResults Read-Only Attributes

Read-Only Attribute
Description
RxAdvertisedUpdateCount
Number of advertised routes received by the emulated router.

Type: u64
Default: 0
RxWithdrawnUpdateCount
Number of unreachable (metric 16) routes received by the emulated router.

Type: u64
Default: 0
TxAdvertisedUpdateCount
Number of advertised routes sent by the emulated router.

Type: u64
Default: 0
TxWithdrawnUpdateCount
Number of unreachable (metric 16) routes sent by the emulated router.

Type: u64
Default: 0
RipSharedSessionParams
Description:
RIP shared session parameters used by wizard.

Automatically-created children: RipAuthenticationParams
RipSharedSessionParams Writable Attributes

Writable Attribute
Description
Active, Name
EnableBfd
Enable BFD.
Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
Enable BFD.
FALSE Disable BFD.
2599
Ripv1
Writable Attribute
Description
RipVersion
RIP version.
Type: enum
Default: V2
Possible Values:
Value Description
V1
RIP version 1.
V2
RIP version 2.
NG
RIP NG.
RipSharedSessionParams Read-Only Attributes

Ripv1 (rip:Ripv1)
Description:
Children: rip1Entries
Ripv1 Attributes
Attribute
Description
command
Type: RipCommand
Default: 1
Possible Values:
Value Description
1
Request
Response
Name
Type: string
reserved
Type: INTEGER
Default: 0
version
Type: INTEGER
Default: 1
Ripv2 (rip:Ripv2)
Description:
Children: rip2Entries
2600
Ripv4RouteParams
Ripv2 Attributes
Attribute
Description
command
Type: RipCommand
Default: 1
Possible Values:
Value Description
1
Request
Response
Name
Type: string
reserved
Type: INTEGER
Default: 0
version
Type: INTEGER
Default: 2
Ripv4RouteParams
Description:
RIP IPv4 route configuration settings.

Ripv4RouteParams Writable Attributes

Writable Attribute
Description
Metric
Indicates the cost to the destination network, and is usually the hop count needed to reach the destination network.
Type: u8
Default: 1
Range: 1 - 16
NextHop
IPv4 address of the adjacent router to which the packet should be sent next. A value of 0.0.0.0 indicates that the next hop is
the advertising router. This attribute applies only to RIP v2.
Type: ip
Default: null
RouteCategory
Route category.
Type: enum
Default: UNDEFINED
Possible Values:
Value
Description
UNDEFINED
Default category assigned to a manually-created block.
PRIMARY

UNIQUE
Indicates that a single port in the test configuration advertises this route.
ANY
ANY
2601
Ripv4RouterConfig
Writable Attribute
Description
RouteTag
Used to distinguish internal routes (learned by RIP) from external routes (learned from other protocols, such as BGP or OSPF).
Causes the simulated RIP router to act as a router that runs RIP together with other protocols (such as BGP, OSPF).
Type: u16
Default: 0
Range: 0 - 65535
Ripv4RouteParams Read-Only Attributes

Ripv4RouterConfig
Description:
RIPv1/RIPv2 router configuration settings.
Ripv4RouterConfig Writable Attributes

Writable Attribute
Description
Active, Name
Ripv4RouterConfig Read-Only Attributes

Ripv4StateSummary
Description:
RIPv4 router states summarized at port and project level.

Relations:
Side name
(Type)
Relative
Description
ResultParent
(ResultChild)
Port, Project
Ripv4StateSummary Writable Attributes

2602
RipViewRoutesCommand
Ripv4StateSummary Read-Only Attributes

Read-Only Attribute
Description
ClosedCount
Number of routers in closed state.

Type: u32
Default: 0
NotStartedCount
Number of routers in NotStarted state.

Type: u32
Default: 0
OpenCount

Type: u32
Default: 0
RouterDownCount
Number of routers in NotStarted/Closed state.

Type: u32
Default: 0
RouterUpCount

Type: u32
Default: 0
RipViewRoutesCommand
Description:
View the received RIP routes.

RipViewRoutesCommand Writable Attributes

Writable Attribute
Description
FileName

Default: routes.txt
RouterList
RIP router handle list.

Type: handle
Default: 0
RipViewRoutesCommand Read-Only Attributes

Read-Only Attribute
Description

2603
RipWithdrawRouteCommand
RipWithdrawRouteCommand
Description:
Withdraw RIP routes.

RipWithdrawRouteCommand Writable Attributes

Writable Attribute
Description
CategoryFilter

Type: enum
Default: ANY
Possible Values:
Value
Description
UNDEFINED
Category is Undefined.
PRIMARY
Category is Primary.
SECONDARY Category is Secondary.

UNIQUE
Category is Unique.
ANY
Category is Any.
PercentFilter

Type: double
Default: 100.0
Range: 0 - 100
PrefixFilter
Type: u8
Default: 0
Range: 0 - 128
RouteList
Route handle list.

Type: handle
Default: 0
RipWithdrawRouteCommand Read-Only Attributes

Read-Only Attribute
Description

rnnId
Description:
2604
RnnId
rnnId Attributes
Attribute
Description
Name
Type: string
nodeName
Type: WWN
Default: 10:00:10:94:00:00:00:00
portIdentifier
Type: OCTETSTRING
Default: 000000
reserved
Type: OCTETSTRING
Default: 00
RnnId (fcgs:RnnId)
Description:
RnnId Attributes
Attribute
Description
Name
Type: string
nodeName
Type: WWN
Default: 10:00:10:94:00:00:00:00
portIdentifier
Type: OCTETSTRING
Default: 000000
reserved
Type: OCTETSTRING
Default: 00
RouteGenApplyCommand
Description:
Apply the specified route/topology generator parameters. When the apply command is called, the route/topology parameters are expanded into protocol specific
objects (OSPF LSAs, IS-IS LSPs, BGP routes, RIP routes, and so on).

2605
RouteGenGetConfigurableRouteCountCommand
RouteGenApplyCommand Writable Attributes

Writable Attribute
Description
DeleteRoutesOnApply
Determines how to handle pre-existing routes when the route/topology generator parameters are applied.
Type: enum
Default: PROMPT
Possible Values:
Value
Description
PROMPT Prompt user for YES/NO response.
GenParams
YES
Delete pre-existing routes.
NO
Keep pre-existing routes. Note: This may cause duplicate routes, if the new route addresses
overlap the old route addresses.
Route/topology generator parameters to apply.

Type: handle
Default: 0
RouteGenApplyCommand Read-Only Attributes

Read-Only Attribute
Description

Summary
A summary string describing the results of the route/topology generation.

Type: string
Description:

RouteGenGetConfigurableRouteCountCommand Writable Attributes

Writable Attribute
Description
GenParams
Handle of ProtocolRouteGenParams.
Type: handle
Default: 0
RouteIpVersion
Route IP version.
Type: enum
Default: IPV4
Possible Values:
Value Description
IPV4
IPv4
IPV6
IPv6
2606
RouteGenGetPrefixLengthDistCommand
Writable Attribute
Description
RouteType
Route Type.
Type: u8
Default: 0
RouteGenGetConfigurableRouteCountCommand Read-Only Attributes

Read-Only Attribute
Description

Count
Configurable route count.

Type: u32
Default: 0
RouteGenGetPrefixLengthDistCommand
Description:
Get the route generator's prefix length distribution.

RouteGenGetPrefixLengthDistCommand Writable Attributes

Writable Attribute
Description
RouteGenParams
List of route generator parameter handles.

Type: handle
Default: 0
RouteGenGetPrefixLengthDistCommand Read-Only Attributes

Read-Only Attribute
Description

PrefixLengthDist
Prefix length distribution.

Type: double
Default: 0
Range: 0 - 100
RouteGenSetDefaultsCommand
Description:
Set the specified route generator parameters object to default values.

2607
Router

RouteGenSetDefaultsCommand Writable Attributes

Writable Attribute
Description
RouteGenParams
Route generator parameters to set to default values.

Type: handle
Default: 0
RouteGenSetDefaultsCommand Read-Only Attributes

Read-Only Attribute
Description

Router
Description:
Router device object.

Parents: Project
Relations:
Side name
(Type)
Relative
Description
AffiliatedRouter
(AffiliatedRouter)
EmulatedDevice
AffiliatedPort
(AffiliationPort)
Port
PrimaryIf
(PrimaryIf)


DUT.
TopLevelIf
(TopLevelIf)


interface stack.
Router Writable Attributes

Writable Attribute
Description
Active, Name
DeviceCount

Type: u32
Default: 1
2608
RouterAdvertisement
Writable Attribute
Description
EnablePingResponse

Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
FALSE Not used on this object.

RouterId
Router ID.
Type: ip
Default: 192.0.0.1
Router Read-Only Attributes

RouterAdvertisement (icmpv6:RouterAdvertisement)
Description:
Children: linkLayerOption, mtuOption, prefixOption
RouterAdvertisement Attributes
Attribute
Description
checksum
Type: INTEGER
Default: 0
code
Type: INTEGER
Default: 0
curHopLimit
Type: INTEGER
Default: 0
mBit
Type: BITSTRING
Default: 0
Name
Type: string
oBit
Type: BITSTRING
Default: 0
reachableTime
Type: INTEGER
Default: 0
reserved2
Type: INTEGER
Default: 0
retransTime
Type: INTEGER
Default: 0
routerLifetime
Type: INTEGER
Default: 0
2609
routerAlert
Attribute
Description
type
Type: Icmpv6Type
Default: 134
Possible Values:
Value Description
1
Packet Too Big
Time Exceeded
Parameter Problem
128
Echo Request
129
Echo Reply
130
MLDv1 Query
131
132
MLDv1 Listener Done
133
Router Solicitation
134
135
136
137
Redirect
143
routerAlert
Description:
Parents: Ipv6HopByHopOption
Children: None
routerAlert Attributes
Attribute
Description
length
Type: INTEGER
Default: 2
Name
more information.
Type: string
pad
Type: ALIGNMENTPAD
Default: 0
routerAlert
Type: INTEGER
Default: 5
value
Type: RouterAlertValues
Default: 0
Possible Values:
Value Description
0
MLD
RSVP
Active Networks
2610
RouterGenParams
RouterGenParams
Description:
Defines parameters for generating Router objects.

Relations:
Side name
(Type)
Relative
Description
TopLevelIf

Port
(SelectedPort)
Port
Collection of ports to generate routers on.
RouterGenParams Writable Attributes

Writable Attribute
Description
Active, Name
Count
Number of routers to create per port/VLAN.

Type: u32
Default: 1
Range: 1 - 4294967295
GroupAssignmentMode

Type: enum
Possible Values:
Value
Description
ALL_SAME_GROUPS All routers are assigned to the same group(s).
PortType
Type of port to generate routers on.

Type: enum
Default: ETHERNET
Possible Values:
Value
Description
ETHERNET Ethernet.
POS
POS (PPP/HDLC).
ATM
ATM.
FC
PreviewMaxCount
Maximum number of routers to return in the preview.

Type: u32
Default: 1000
Range: 1 - 100000
2611
RouterInformationTlv
Writable Attribute
Description
Maximum number of routers to show in the preview for each increment level (for example, port, VLAN, host, and
so on). This is used to reduce the number of items in the preview. This option is only applicable in PARTIAL preview
mode.
Type: u32
Default: 3
Range: 1 - 100000
PreviewMode
Preview mode.
Type: enum
Default: FULL
Possible Values:
Value
Description
FULL
Show all routers in the preview.
PARTIAL Show a subset of the routers in the preview.

BLOCK
Show all router blocks in the preview.
RouterId
Router ID value.
Type: ip
Default: 192.0.0.1
RouterIdSrc
Determines how the Router ID value is determined.

Type: enum
Default: MANUAL
Possible Values:
Value
Description
MANUAL
Use the configured Router ID value and step.
USE_IPV4ADDR Use the Router ID from the IPv4 interface address.

RouterIdStep
Router ID step value.

Type: ip
Default: 0.0.0.1
StepOrder
Type: string
RouterGenParams Read-Only Attributes

RouterInformationTlv
Description:
Router Information TLV.

Parents: TeLsa
RouterInformationTlv Writable Attributes

Writable Attribute
Description
Active, Name
2612
RouterLsa
Writable Attribute
Description
Option
TLV Options.
Type: enum
Default: BBIT
Possible Values:
Value
Description
BBIT
B bit
EBIT
E bit
MBIT
M bit
PBIT
P bit
UNUSED5
Unused bit
UNUSED6
Unused bit
UNUSED7
Unused bit
UNUSED8
Unused bit
UNUSED9
Unused bit
UNUSED10 Unused bit

UNUSED11 Unused bit
UNUSED12 Unused bit
UNUSED13 Unused bit
UNUSED14 Unused bit
UNUSED15 Unused bit
UNUSED16 Unused bit
UNUSED17 Unused bit
UNUSED18 Unused bit
UNUSED19 Unused bit
UNUSED20 Unused bit
UNUSED21 Unused bit
UNUSED22 Unused bit
UNUSED23 Unused bit
UNUSED24 Unused bit
UNUSED25 Unused bit
UNUSED26 Unused bit
UNUSED27 Unused bit
UNUSED28 Unused bit
UNUSED29 Unused bit
UNUSED30 Unused bit
UNUSED31 Unused bit
RouterInformationTlv Read-Only Attributes

RouterLsa
Description:
Router LSA object. A Router LSA summarizes all the links that start from the advertising router.

Children: RouterLsaLink
2613
RouterLsa
RouterLsa Writable Attributes

Writable Attribute
Description
Abr
Specifies whether the emulated router is an area border router. This is "Router Type" in the GUI, with a choice of ABR, ASBR, or
Virtual Link.
Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
Emulated router is an area border router.
FALSE Emulated router is not an area border router.

AdvertisingRouterId
Specifies the OSPF Router ID of the LSA's originator. The Router LSAs value is identical to the Link-state ID value. The Network
LSAs value is originated by the Designated Router. The Summary LSAs value is originated by area border routers. The External/NSSA
LSAs value is originated by AS boundary routers.
Type: ip
Default: null
Age
Age of the LSA, in seconds.

LS Age field is examined if a router receives two instances of an LSA with identical LS Sequence numbers and LS Checksums. The
LS Age value is set to 0 when the LSA is originated.
Type: u16
Default: 0
Range: 0 - 3600
Asbr
This is "Router Type" in the GUI, with a choice of ABR, ASBR, or Virtual Link. Specifies whether the emulated router is an AS border
router.
Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
Emulated router is an AS border router.
FALSE Emulated router is not an AS border router.

CheckSum
Whether the LSA will be advertised with a good or bad checksum. A bad checksum indicates a corrupted LSA and is used for negative
testing.
Type: enum
Default: GOOD
Possible Values:
Value Description
BAD

LinkStateId
Link State ID (IP address).

Type: ip
Default: 0.0.0.0
Options
A bit mask that specifies the settings of the OSPFv2 Options field in the LSAs. The Options field describes the optional OSPF
capabilities of the router. Section A.2 in RFC 2328 describes the Options field. Use hexadecimal for this value. The default, 0x02,
sets the E-bit (binary 00000010).
Type: enum
Default: EBIT
Possible Values:
Value
Description
TBIT
EBIT
MCBIT
NPBIT
EABIT
DCBIT
OBIT
2614
RouterLsaLink
Writable Attribute
Description
RouteCategory

Type: enum
Default: UNDEFINED
Possible Values:
Value
Description
UNDEFINED
PRIMARY
Primary route.

UNIQUE
Unique route.
ANY
Any route.
SeqNum
Used to detect old and duplicate LSAs. The larger the sequence number, the more recent the LSA. A detailed explanation of the LS
Sequence Number is included in RFC 2328, section 12.1.6.
Type: u32
Default: 0x80000001
Vl
This is "Router Type" in the GUI, with a choice of ABR, ASBR, or Virtual Link. Specifies whether this router is one end of a virtual
link. If it is part of a virtual link, it must be an area border router.
Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
This router is one end of a virtual link. This sets bit V in the Router LSA.
FALSE This router is not part of a virtual link.
RouterLsa Read-Only Attributes

RouterLsaLink
Description:
Defines a link (interface) on the emulated OSPF router (the parent RouterLsa object). Each router can have one or more Router LSA Links. RouterLsaLink
includes the Link Attributes.

Parents: RouterLsa
RouterLsaLink Writable Attributes

Writable Attribute
Description
Active, Name
LinkData
Link data to be used for the simulated link. The value in this field is dependent on the value in the Link Type field.
Type: ip
Default: 0.0.0.0
LinkId
Link ID (IP address) to be used for the simulated link. The Link ID is different for each Link Type.
Type: ip
Default: 0.0.0.0
2615
routerLsaLinks
Writable Attribute
Description
LinkType
Type of interface that is going to be simulated.

Type: enum
Possible Values:
Value
Description
POINT_TO_POINT
Point-to-point link.
TRANSIT_NETWORK Link to transit network.

STUB_NETWORK
Link to stub network.
VL
Virtual link.
Metric
Cost metric to reach the simulated link.

Type: u16
Default: 1
Range: 1 - 65535
TosMetrics
Type of Service metrics.

Type: u8
Default: 0
RouterLsaLink Read-Only Attributes

routerLsaLinks
Description:
Parents: ospfv2RouterLsa
Children: Ospfv2RouterLsaLink
routerLsaLinks Attributes
Attribute
Description
Name
information.
Type: string
routerLsaOptions
Description:
OSPFv2 router-LSA Options field. See RFC 2328.
Parents: ospfv2RouterLsa
Children: None
routerLsaOptions Attributes
Attribute
Description
bBit
Type: BITSTRING
Default: 0
2616
routerLsaTosMetrics
Attribute
Description
eBit
Type: BITSTRING
Default: 0
Name
Type: string
reserved3
Type: BITSTRING
Default: 0
reserved4
Type: BITSTRING
Default: 0
reserved5
Type: BITSTRING
Default: 0
reserved6
Type: BITSTRING
Default: 0
reserved7
Type: BITSTRING
Default: 0
vBit
Type: BITSTRING
Default: 0
routerLsaTosMetrics
Description:
Parents: Ospfv2RouterLsaLink
Children: Ospfv2RouterLsaTosMetric
routerLsaTosMetrics Attributes
Attribute
Description
Name
information.
Type: string
RouterSolicitation (icmpv6:RouterSolicitation)
Description:
RouterSolicitation Attributes
Attribute
Description
checksum
Type: INTEGER
Default: 0
2617
RouterTlv
Attribute
Description
code
Type: INTEGER
Default: 0
Name
information.
Type: string
reserved
Type: INTEGER
Default: 0
type
Type: Icmpv6Type
Default: 133
Possible Values:
Value Description
1
Packet Too Big
Time Exceeded
Parameter Problem
128
Echo Request
129
Echo Reply
130
MLDv1 Query
131
132
MLDv1 Listener Done
133
Router Solicitation
134
135
136
137
Redirect
143
RouterTlv
Description:
Router Type-Length-Value (TLV).

Parents: TeLsa
RouterTlv Writable Attributes

Writable Attribute
Description
Active, Name
RouterAddr
Stable and reachable IP address of the advertising router.

Type: ip
Default: 0.0.0.0
RouterTlv Read-Only Attributes

2618
RoutingConvergenceInjectCommand
RoutingConvergenceInjectCommand
Description:
Injects a convergence event on the egress routers defined in RoutingConvergenceSetupCommand. This command needs to be associated with an instance
of RoutingConvergenceSetupCommand.

Relations:
Side name
(Type)
Relative
Description
SetupCommand
(RoutingConvergenceAffiliatedSetup)
RoutingConvergenceSetupCommand
Associated RoutingConvergenceSetupCommand.
RoutingConvergenceInjectCommand Writable Attributes

Writable Attribute
Description
CommandArguments
Working directory for the External Script. Only used if TestType is External Script.
Type: string
CommandLine
Command line for the external script. Only used if TestType is External Script.
Type: string
CommandWorkingDir
Working directory for the External Script. Only used if TestType is External Script.
Type: string
TestType
The convergence event injected on the egress routers.

Type: enum
Default: COST_CHANGE
Possible Values:
Value
Description
EXTERNAL_SCRIPT
Run an external script for the convergence event.
LOCAL_INTERFACE_FAILURE
Breaks the L2 link between the egress routers and the DUT.
LOCAL_INTERFACE_RESTORE
Restores the L2 link between the egress routers and the DUT.
REMOTE_INTERFACE_FAILURE
Emulates a remote interface failure on the egress routers.
REMOTE_INTERFACE_RESTORE
Restores the remote interfaces on the egress routers.
LOSS_OF_ADJACENCY
Emulates a loss of adjacency event between the egress routers and the DUT.
RESTORE_ADJACENCY
Restores adjacency between the egress routers and the DUT.
WITHDRAW_ROUTE
Withdraws all routes on the egress routers.
READVERTISE_ROUTE
Readvertises all routes on the egress routers.
COST_CHANGE
Emulates an increase in cost for all routes on the egress routers.
REVERT_COST
Reverts the cost for all routes on the egress routers to their default values.
ECMP_LOCAL_INTERFACE_FAILURE
Breaks the L2 link between the egress routers and the DUT.
ECMP_LOCAL_INTERFACE_RESTORE
Restores the L2 link between the egress routers and the DUT.
ECMP_REMOTE_INTERFACE_FAILURE
Emulates a remote interface failure on the egress routers.
ECMP_REMOTE_INTERFACE_RESTORE Restores the remote interfaces on the egress routers.
RoutingConvergenceInjectCommand Read-Only Attributes

Read-Only Attribute
Description

2619
RoutingConvergenceMeasureCommand
RoutingConvergenceMeasureCommand
Description:
Calculates and saves the Routing Convergence Test Results in a db file.

Relations:
Side name
(Type)
Relative
Description
SetupCommand
(RoutingConvergenceAffiliatedSetup)
Associated RoutingConvergenceSetupCommand.
RoutingConvergenceMeasureCommand Writable Attributes

Writable Attribute
Description
RoutingConvergenceMeasureCommand Read-Only Attributes

Read-Only Attribute
Description

TestResultsFullDbPath
The full path of the convergence test output results database.

Type: string
Description:
Sets up a data-plane convergence test for Routing Protocols. The Routing convergence test methodology is based on
draft-ietf-bmwg-igp-dataplane-conv-meth-15.txt.

RoutingConvergenceSetupCommand Writable Attributes

Writable Attribute
Description
EgressRouterList
List of egress EmulatedDevice handles where traffic is expected to fall after convergence event.
Type: handle
Default: 0
IngressRouterList
List of ingress EmulatedDevice (traffic initiators) handles in the test.

Type: handle
Default: 0
2620
RoutingResult
Writable Attribute
Description
IpVersion
IP version of the routing protocol and the streamblock traffic.

Type: enum
Default: IPV4
Possible Values:
Value Description
IPV4
IPv4
IPV6
IPv6
MaxConvergenceTime
The maximum time in the data-plane during which the DUT is expected to converge in.
Type: u16
Default: 70
Range: 15 - 70
SecondaryEgressRouterList
List of secondary egress EmulatedDevice handles where traffic is expected to increase after convergence
event.
Type: handle
Default: 0
StreamBlockList
List of streamblock handles for the test.

Type: handle
Default: 0
TestProtocol
Routing Protocol for which convergence test should be performed.

Type: enum
Default: BGP
Possible Values:
Value
Description
BGP
BGP
OSPFV2 OSPFv2
OSPFV3 OSPFv3
ISIS
ISIS
RIP
RIP
RoutingConvergenceSetupCommand Read-Only Attributes

Read-Only Attribute
Description

RoutingResult
Description:
Base class for routing results.
RoutingResult Writable Attributes

RoutingResult Read-Only Attributes

2621
rpab
rpab
Description:
rpab Attributes
Attribute
Description
Type: INTEGER
Default: 0
attributeEntryType
Default: 01
Possible Values:
Value Description
0001
Vendor ID
0002
Product ID
0003
0004
Description
0005
Label
0006
Location
0007
System ID
0008
0009
Cluster ID

attributeEntryValue
Type: ASCII
Name
Type: string
pad
platformName
Type: ASCII
platformNameFormat
Type: OCTETSTRING
Default: 02
platformNameLength
Type: INTEGER
Default: 0
reserved1
Rpab (fcgs:Rpab)
Description:
2622
RpcMsg
Rpab Attributes
Attribute
Description
Type: INTEGER
Default: 0
attributeEntryType
Default: 01
Possible Values:
Value Description
0001
Vendor ID
0002
Product ID
0003
0004
Description
0005
Label
0006
Location
0007
System ID
0008
0009
Cluster ID

attributeEntryValue
Type: ASCII
Name
Type: string
pad
platformName
Type: ASCII
platformNameFormat
Type: OCTETSTRING
Default: 02
platformNameLength
Type: INTEGER
Default: 0
reserved1
RpcMsg (oncrpcv2:RpcMsg)
Description:
Children: None
Next headers: oncrpcv2:CallBody, oncrpcv2:ReplyBody, custom:Custom
2623
rpfcp
RpcMsg Attributes
Attribute
Description
mtype
Type: MsgType
Default: 0
Possible Values:
Value Description
0
CALL
REPLY
Name
information.
Type: string
xid
Type: INTEGER
Default: 0
rpfcp
Description:
rpfcp Attributes
Attribute
Description
Name
Type: string
platformFcpType
Type: OCTETSTRING
Default: 00000000
platformName
Type: ASCII
platformNameFormat
Type: OCTETSTRING
Default: 02
platformNameLength
Type: INTEGER
Default: 0
reserved1
Rpfcp (fcgs:Rpfcp)
Description:
2624
rpl
Rpfcp Attributes
Attribute
Description
Name
Type: string
platformFcpType
Type: OCTETSTRING
Default: 00000000
platformName
Type: ASCII
platformNameFormat
Type: OCTETSTRING
Default: 02
platformNameLength
Type: INTEGER
Default: 0
reserved1
rpl
Description:
Children: ctIuPreamble, managementAddressEntries, platformNodeNameEntries
rpl Attributes
Attribute
Description
Name
Type: string
Type: INTEGER
Type: INTEGER
Default: 0
platformName
Type: ASCII
platformNameFormat
Type: OCTETSTRING
Default: 02
platformNameLength
Type: INTEGER
Default: 0
platformType
Type: OCTETSTRING
Default: 00000002
reserved1
2625
Rpl
Rpl (fcgs:Rpl)
Description:
Children: ctIuPreamble, managementAddressEntries, platformNodeNameEntries
Rpl Attributes
Attribute
Description
Name
Type: string
Type: INTEGER
Type: INTEGER
Default: 0
platformName
Type: ASCII
platformNameFormat
Type: OCTETSTRING
Default: 02
platformNameLength
Type: INTEGER
Default: 0
platformType
Type: OCTETSTRING
Default: 00000002
reserved1
rpli
Description:
rpli Attributes
Attribute
Description
Name
Type: string
Type: INTEGER
Rpli (fcgs:Rpli)
2626
rplm
Description:
Rpli Attributes
Attribute
Description
Name
Type: string
Type: INTEGER
rplm
Description:
rplm Attributes
Attribute
Description
Name
Type: string
Type: INTEGER
Default: 0
Type: ASCII
platformName
Type: ASCII
platformNameFormat
Type: OCTETSTRING
Default: 02
platformNameLength
Type: INTEGER
Default: 0
reserved1
reserved2
Rplm (fcgs:Rplm)
Description:
2627
rpln
Rplm Attributes
Attribute
Description
Name
Type: string
Type: INTEGER
Default: 0
Type: ASCII
platformName
Type: ASCII
platformNameFormat
Type: OCTETSTRING
Default: 02
platformNameLength
Type: INTEGER
Default: 0
reserved1
reserved2
rpln
Description:
rpln Attributes
Attribute
Description
Name
Type: string
platformName
Type: ASCII
platformNameFormat
Type: OCTETSTRING
Default: 02
platformNameLength
Type: INTEGER
Default: 0
platformNodeName
Type: WWN
Default: 10:00:10:94:00:00:00:00
reserved1
2628
Rpln
Rpln (fcgs:Rpln)
Description:
Rpln Attributes
Attribute
Description
Name
Type: string
platformName
Type: ASCII
platformNameFormat
Type: OCTETSTRING
Default: 02
platformNameLength
Type: INTEGER
Default: 0
platformNodeName
Type: WWN
Default: 10:00:10:94:00:00:00:00
reserved1
rplt
Description:
rplt Attributes
Attribute
Description
Name
Type: string
platformName
Type: ASCII
platformNameFormat
Type: OCTETSTRING
Default: 02
platformNameLength
Type: INTEGER
Default: 0
platformType
Type: OCTETSTRING
Default: 00000002
reserved1
2629
Rplt
Rplt (fcgs:Rplt)
Description:
Rplt Attributes
Attribute
Description
Name
Type: string
platformName
Type: ASCII
platformNameFormat
Type: OCTETSTRING
Default: 02
platformNameLength
Type: INTEGER
Default: 0
platformType
Type: OCTETSTRING
Default: 00000002
reserved1
RplyEgr (EOAMTLV:RplyEgr)
Description:
Children: theEPID
RplyEgr Attributes
Attribute
Description
EgressAction
Default: 01
Possible Values:
Value Description
01
EgrOk
02
EgrDown
03
EgrBlocked
04
EgrVID
EgressMac
Type: MACADDR
Default: 00:00:00:00:00:00
Length
Type: OCTETSTRING
Default: 0000
2630
RplyIng
Attribute
Description
Name
Type: string
Type
Type: OCTETSTRING
Default: 06
RplyIng (EOAMTLV:RplyIng)
Description:
Children: theIPID
RplyIng Attributes
Attribute
Description
IngressAction
Default: 01
Possible Values:
Value Description
01
IngOk
02
IngDown
03
IngBlock
04
IngVID
IngressMac
Type: MACADDR
Default: 00:00:00:00:00:00
Length
Type: OCTETSTRING
Default: 0000
Name
Type: string
Type
Type: OCTETSTRING
Default: 05
rpnId
Description:
2631
RpnId
rpnId Attributes
Attribute
Description
Name
Type: string
portIdentifier
Type: OCTETSTRING
Default: 000000
portName
Type: WWN
Default: 20:00:10:94:00:00:00:00
reserved
Type: OCTETSTRING
Default: 00
RpnId (fcgs:RpnId)
Description:
RpnId Attributes
Attribute
Description
Name
Type: string
portIdentifier
Type: OCTETSTRING
Default: 000000
portName
Type: WWN
Default: 20:00:10:94:00:00:00:00
reserved
Type: OCTETSTRING
Default: 00
rptId
Description:
2632
RptId
rptId Attributes
Attribute
Description
Name
Type: string
portIdentifier
Type: OCTETSTRING
Default: 000000
portType
Type: PortType
Default: 00
Possible Values:
Value Description
00
Unidentified
01
N_Port
02
NL_Port
03
F/NL_Port
7F
Nx_Port
81
F_Port
82
FL_Port
84
E_Port
85
B_Port
reserved
Type: OCTETSTRING
Default: 00
reserved
Type: OCTETSTRING
Default: 000000
RptId (fcgs:RptId)
Description:
RptId Attributes
Attribute
Description
Name
Type: string
portIdentifier
Type: OCTETSTRING
Default: 000000
2633
rrdy
Attribute
Description
portType
Type: PortType
Default: 00
Possible Values:
Value Description
00
Unidentified
01
N_Port
02
NL_Port
03
F/NL_Port
7F
Nx_Port
81
F_Port
82
FL_Port
84
E_Port
85
B_Port
reserved
Type: OCTETSTRING
Default: 00
reserved
Type: OCTETSTRING
Default: 000000
rrdy
Description:
Parents: islFlowControl
Children: None
rrdy Attributes
Attribute
Description
bbCredit
Type: OCTETSTRING
Default: 00000000
compatibilityParameters
Type: OCTETSTRING
islFlowControlLength
Type: INTEGER
Default: 20
islFlowControlMode
Type: OCTETSTRING
Default: 0002
Name
Type: string
rsnnNn
Description:
2634
RsnnNn
rsnnNn Attributes
Attribute
Description
Name
Type: string
NameLength
Type: INTEGER
Default: 0
nodeName
Type: WWN
Default: 10:00:10:94:00:00:00:00
symbolicNodeName
Type: ASCII
RsnnNn (fcgs:RsnnNn)
Description:
RsnnNn Attributes
Attribute
Description
Name
Type: string
NameLength
Type: INTEGER
Default: 0
nodeName
Type: WWN
Default: 10:00:10:94:00:00:00:00
symbolicNodeName
Type: ASCII
rspnId
Description:
2635
RspnId
rspnId Attributes
Attribute
Description
Name
Type: string
NameLength
Type: INTEGER
Default: 0
portIdentifier
Type: OCTETSTRING
Default: 000000
reserved
Type: OCTETSTRING
Default: 00
symbolicPortName
Type: ASCII
RspnId (fcgs:RspnId)
Description:
RspnId Attributes
Attribute
Description
Name
Type: string
NameLength
Type: INTEGER
Default: 0
portIdentifier
Type: OCTETSTRING
Default: 000000
reserved
Type: OCTETSTRING
Default: 00
symbolicPortName
Type: ASCII
rspvIpv6LspSubTlv
Description:
Children: None
2636
RsvpCustomObject
rspvIpv6LspSubTlv Attributes
Attribute
Description
extendedTunnelId
Type: IPV6ADDR
Default: 2000::1
ipv6TunnelEndPoint
Type: IPV6ADDR
Default: 2000::2
ipv6TunnelSender
Type: IPV6ADDR
Default: 2000::1
length
Type: INTEGER
Default: 56
lspId
Type: INTEGER
Default: 1
Name
Type: string
reserved1
Type: INTEGER
Default: 0
reserved2
Type: INTEGER
Default: 0
tunnelId
Type: INTEGER
Default: 1
type
Type: INTEGER
Default: 4
RsvpCustomObject
Description:
RSVP custom object configuration.

Parents: Project
Relations:
Side name
(Type)
Relative
Description
(HelloCustomObject)
RsvpEgressTunnelParams, RsvpEgressTunnelParams,
RsvpIngressTunnelParams, RsvpIngressTunnelParams, RsvpRouterConfig,
RsvpRouterConfig, RsvpRouterConfig
RsvpCustomObject Writable Attributes

Writable Attribute
Description
Active, Name
ClassNumber
Class number.
Type: u8
Default: 0
2637
RsvpDetourSubObject
Writable Attribute
Description
CType
CType
Type: u8
Default: 0
CustomData
Custom data.
Type: u8
Default: 0
RsvpCustomObject Read-Only Attributes

RsvpDetourSubObject
Description:
RSVP DetourSubObject.

Parents: RsvpIngressTunnelParams
RsvpDetourSubObject Writable Attributes

Writable Attribute
Description
Active, Name
AvoidNodeId
Avoid Node IP address.

Type: ip
Default: 0.0.0.0
PlrId
Point of Local Repair IP address.

Type: ip
Default: 0.0.0.0
RsvpDetourSubObject Read-Only Attributes

RsvpDeviceGenProtocolParams
Description:
Specifies the RSVP specific router generator parameters.

RsvpDeviceGenProtocolParams Writable Attributes

Writable Attribute
Description
Active, Name
2638
RsvpEgressS2lSubLspParams
Writable Attribute
Description
DutIpAddr
IP address of the DUT connected to the Spirent TestCenter port.

Type: ip
Default: 192.85.1.1
DutIpAddrStep
IP address step of the DUT connected to the Spirent TestCenter port.

Type: ip
Default: 0.0.0.0
EgressLabel
Defines the label advertised if the emulated router is at the tail-end of the tunnel. This label is advertised in response to a
PATH message with a destination IP address matching the router tester IP address.
Type: enum
Default: RSVP_EGRESS_NEXTAVAILABLE
Possible Values:
Value
Description
RSVP_EGRESS_IMPLICIT_NULL
This label value (three) is used in an LDP or RSVP packet to enable penultimate
hop label popping. The egress LSR signals a request to its upstream neighbor to
pop the top label in the stack and forward the rest of the packet. This value does
not appear in the encapsulation.
RSVP_EGRESS_EXPLICIT_NULL
A zero (IPv4 datagram) or two (IPv6 datagram) MPLS label value indicates to the
penultimate router that it is to pop the label upon receipt and forward the IP packet
to the egress router for Layer 3 forwarding. Explicit null instructions are signaled
to the penultimate router by the egress router.
RSVP_EGRESS_NEXTAVAILABLE For each FEC, the LSR advertises the next available label from the label pool (Min
Label to Max Label).
EnableBfd

Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
Enable BFD.
FALSE Disable BFD.

LabelMax
Specifies the maximum label advertised by the emulated router.

Type: u32
Default: 65535
Range: 1 - 1048575
LabelMin
Specifies the minimum label advertised by the emulated router.

Type: u32
Default: 16
Range: 1 - 1048575
Set router interface gateway address as DUT IP address.

Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
FALSE Do not use gateway address as DUT IP address.
RsvpDeviceGenProtocolParams Read-Only Attributes

RsvpEgressS2lSubLspParams
Description:
RsvpEgress S2lSubLsp object.
2639
RsvpEgressTunnelParams

Parents: RsvpEgressTunnelParams
Children: RsvpIpv4LsrParams
RsvpEgressS2lSubLspParams Writable Attributes

Writable Attribute
Description
Active, Name
DestIpV4Addr
Destination IPv4 address.

Type: ip
Default: 0.0.0.0
RsvpEgressS2lSubLspParams Read-Only Attributes

RsvpEgressTunnelParams
Description:
RSVP egress tunnel parameter object.

Parents: RsvpRouterConfig
Children: RsvpEgressS2lSubLspParams, RsvpIpv4LsrParams
Relations:
Side name
(Type)
Relative
Description
(ReservationCustomObject)
RsvpCustomObject, RsvpCustomObject
RsvpEgressTunnelParams Writable Attributes

Writable Attribute
Description
Active, Name
AcceptAnyTunnelId
Accepts PATH message with any Tunnel ID.

Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
Enables accept any tunnel ID.
FALSE Disables accept any tunnel ID.

DstIpAddr
Destination IP address of the RSVP PATH message. This parameter applies to both ingress and egress. The
default is the SUT IP address.
Type: ip
Default: 192.85.1.1
2640
RsvpFrrNodeFailureCommand
Writable Attribute
Description
EnablePointToMultiPoint
Enables P2MP mode for RSVP Tunnel.

Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
Enables P2MP.
FALSE Disables P2MP.

SrcIpAddr
IP address of the RSVP PATH message sender. This parameter applies to both ingress and egress. The
default is the IP address of the emulated RSVP router.
Type: ip
Default: 192.85.1.3
TunnelCount
Tunnel count.
Type: u16
Default: 1
TunnelId
16-bit tunnel identifier. Applies to both ingress and egress.

Type: u16
Default: 1
TunnelIdStep
Tunnel ID step.
Type: u16
Default: 1
RsvpEgressTunnelParams Read-Only Attributes

RsvpFrrNodeFailureCommand
Description:
RSVP FRR NodeFailure command.

RsvpFrrNodeFailureCommand Writable Attributes

Writable Attribute
Description
FailureType
Node failure type.

Type: enum
Default: BREAK_LINK
Possible Values:
Value
Description
BREAK_LINK
Break port link.
STOP_HELLOS
Stop RSVP Hellos.
STOP_ROUTER
Stop RSVP router.
WITHDRAW_ROUTES Withdraw IGP routes.

RouterList
Router handle list.

Type: handle
Default: 0
2641
RsvpIngressS2lSubLspParams
RsvpFrrNodeFailureCommand Read-Only Attributes

Read-Only Attribute
Description

RsvpIngressS2lSubLspParams
Description:
RsvpIngress S2lSubLsp object.

Parents: RsvpP2MpSubGroupParams
Children: RsvpIpv4EroObject, RsvpIpv4ExplicitRouteParams
RsvpIngressS2lSubLspParams Writable Attributes

Writable Attribute
Description
Active, Name
DestIpV4Addr
Destination IPv4 address for sub-LSP.

Type: ip
Default: 0.0.0.0
RsvpIngressS2lSubLspParams Read-Only Attributes

Description:
RSVP ingress tunnel parameters object.

Children: RsvpDetourSubObject, RsvpIpv4EroObject, RsvpIpv4ExplicitRouteParams, RsvpP2MpSubGroupParams
Relations:
Side name
(Type)
Relative
Description
(MemberGroup)
Ipv4Group
(ResolvesInterface)

L2tpv2If, MplsIf, PppIf, PppoeIf, RsvpCustomObject,
RsvpCustomObject, VlanIf, WimaxIf

2642
RsvpIngressTunnelParams Writable Attributes

Writable Attribute
Description
Active, Name
Affinities
Disables or enables the three (resource class) affinities in tunnel messages.

Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
Affinities enabled.
FALSE Affinities disabled.

DstIpAddr
Destination IP address of the RSVP PATH message. This parameter applies to both ingress and egress. The
default is the SUT IP address.
Type: ip
Default: 192.85.1.1
EnableEroCompression
Enable explicit route object compression.

Type: bool
Default: TRUE
Possible Values:
Value Description
TRUE
Enable explicit route object compression.
FALSE Disable explicit route object compression.

EnablePointToMultiPoint
Enable P2MP RSVP tunnel.

Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
Enable P2MP RSVP Tunnel.
FALSE Disable P2MP RSVP Tunnel.

EnableRecordRoute
Causes the ingress to include a record-route object in the path message.

Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
Record route on.
FALSE Record route off.

EnableUniqueSubGroupSessionName
Enable unique SubGroup session name.

Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
Enable unique SubGroup session name.
FALSE Disable unique SubGroup session name.

ExcludeAny
(Optional) Represents a set of attribute filters associated with a backup path, any of which renders a link
unacceptable. If any bit in the link bit mask matches the corresponding bit in the exclude any bit mask, the link is
excluded from the tunnel.
Type: u32
Default: 0
ExtendedTunnelId
Extended 32-bit tunnel identifier, normally set to all zeros.

Type: ip
Default: 0.0.0.0
FastRerouteBandwidth
Bandwidth estimate; 32-bit IEEE floating point integer, in bytes per second.
Type: u32
Default: 0
2643
Writable Attribute
Description
FastRerouteExcludeAny
Represents a set of attribute filters associated with a backup path, any of which renders a link unacceptable.
Type: u32
Default: 0
FastRerouteHoldPriority
Priority of the backup path with respect to holding resources. Used in deciding whether this session can be
preempted by another session.
Type: u8
Default: 0
Range: 0 - 7
FastRerouteHopLimit
Maximum number of extra hops that the backup path is allowed to take, from current node (a PLR) to an MP, with
PLR and MP excluded the count.
Type: u8
Default: 0
FastRerouteIncludeAll
Represents a set of attribute filters associated with a backup path, all of which must be present for a link to be
acceptable (with respect to this test).
Type: u32
Default: 0
FastRerouteIncludeAny
Represents a set of attribute filters associated with a backup path, any of which renders a link acceptable (with
respect to this test).
Type: u32
Default: 0
FastRerouteObject
Enables fast re-reroute. Used to control the backup used for the protected LSP. This specifies the setup and hold
priorities, session attribute filters, and bandwidth to be used for protection. It also allows a specific local protection
method to be requested.
Type: enum
Default: NONE
Possible Values:
Value
Description
NONE
Not enabled.
ONE_TO_ONE_BACKUP Creates detour LSPs for each protected LSP at each potential point of local repair.
FACILITY_BACKUP
Creates a bypass tunnel to protect a potential failure point; by taking advantage of

MPLS label stacking, this bypass tunnel can protect a set of protected LSPs that
have similar backup constraints.
FastRerouteSetupPriority
Priority of the backup path with respect to taking resources. The priority assigned to each tunnel is used to determine
which tunnel(s) can preempt other tunnels. (Used in tunnel resource allocation.)
Type: u8
Default: 0
Range: 0 - 7
Flag
Opens the RSVP flags dialog.

Type: enum
Default: 0
Possible Values:
Value
Description
RSVP_FLAG_LOCAL_PROTECTION_DESIRED
Local protection is enabled.
RSVP_FLAG_LABLE_RECORD
Label record is enabled.
RSVP_FLAG_SHARED_EXPLICIT
Shared explicit is enabled.
RSVP_FLAG_BANDWIDTH_PROTECTION_DESIRED Bandwidth protection is enabled.

RSVP_FLAG_NODE_PROTECTION_DESIRED
Node protection is enabled.
HoldPriority
Priority assigned to each tunnel is used to determine which tunnel(s) can be preempted by other tunnels. (Used
to determine resource holding.)
Type: u8
Default: 7
Range: 0 - 7
IncludeAll
(Optional) Represents a set of attribute filters associated with a backup path, all of which must be present for a
link to be acceptable (with respect to this test). If the entire link bit mask matches the entire include all bit mask,
the link is included in the tunnel. A null set (all bits set to zero) automatically passes.
Type: u32
Default: 0
2644
Writable Attribute
Description
IncludeAny
(Optional) Represents a set of attribute filters associated with a backup path, any of which renders a link acceptable
(with respect to this test). If any bit in the link bit mask matches the corresponding bit in the include any bit mask,
the link is included in the tunnel. A null set (all bits set to zero) automatically passes.
Type: u32
Default: 0
LspCount
Number of LSPs established within the tunnel.

Type: u16
Default: 1
Range: 1 - 20
LspId
LSP ID.
Type: u16
Default: 1
Range: 1 - 65535
LspIdStep
LSP ID step.
Type: u16
Default: 1
Range: 1 - 65535
MakeBeforeBreak
Enable Make Before Break.

Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
Enable Make Before Break.
FALSE Disable Make Before Break.

MakeBeforeBreakRetryAlgorithm
Retry algorithm for signaling backup LSP.

Type: enum
Default: LOOP_CONTINUOUS
Possible Values:
Value
Description
LOOP_CONTINUOUS Loop continuously.
LOOP_ONCE
Loop once.
MakeBeforeBreakRetryTime
Make Before Break Retry Time (ms).

Type: u32
Default: null
MaxPktSize
Biggest packet that conforms to the traffic specification.

Type: u32
Default: 1500
Range: 0 - 2147483647
MinPolicedUnit
This size includes the application data and all protocol headers at or above the IP level.
Type: u32
Default: 20
Range: 0 - 2147483647
P2MpId
P2MP Identifier.
Type: string
Default: 0.0.0.1
PeakDataRate
Maximum rate of IP datagrams.

Type: double
Default: 0
Range: 0 - 2147483647
2645
RsvpInitiateMakeBeforeBreakCommand
Writable Attribute
Description
SessionAttribute
Adds a session attribute with Setup Priority, Hold Priority, Flags, and Session Name fields to the PATH message.
Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
On
FALSE Off
SessionName
Optional text name for the session/tunnel.

Type: string
SetupPriority
Type: u8
Default: 7
Range: 0 - 7
SrcIpAddr
IP address of the RSVP PATH message sender. This parameter applies to both ingress and egress. The default
is the IP address of the emulated RSVP router.
Type: ip
Default: 192.85.1.3
TokenBucketRate
Rate of IP datagrams.
Type: double
Default: 0
Range: 0 - 2147483647
TokenBucketSize
Token bucket size.

Type: double
Default: 0
Range: 0 - 2147483647
TunnelCount
Number of tunnels.
Type: u16
Default: 1
TunnelId
16-bit tunnel identifier. Applies to both ingress and egress.

Type: u16
Default: 1
TunnelIdStep
Tunnel ID step for incrementing Tunnel ID when TunnelCount is greater than one.
Type: u16
Default: 1
RsvpIngressTunnelParams Read-Only Attributes

RsvpInitiateMakeBeforeBreakCommand
Description:
Initiate MakeBeforeBreak.

2646
RsvpIpv4EroObject
RsvpInitiateMakeBeforeBreakCommand Writable Attributes

Writable Attribute
Description
IngressTunnelList
Ingress Tunnel handle list.

Type: handle
Default: 0
RsvpInitiateMakeBeforeBreakCommand Read-Only Attributes

Read-Only Attribute
Description

RsvpIpv4EroObject
Description:
RsvpIpv4Ero object.

Parents: RsvpIngressS2lSubLspParams, RsvpIngressTunnelParams
Children: RsvpIpv4ExplicitRouteParams
RsvpIpv4EroObject Writable Attributes

Writable Attribute
Description
Active, Name
RsvpIpv4EroObject Read-Only Attributes

RsvpIpv4ExplicitRouteParams
Description:
RSVP IPv4 explicit route parameters object.

Parents: RsvpIngressS2lSubLspParams, RsvpIngressTunnelParams, RsvpIpv4EroObject
RsvpIpv4ExplicitRouteParams Writable Attributes

Writable Attribute
Description
Active, Name
2647
rsvpIpv4LspSubTlv
Writable Attribute
Description
RouteType
Indicates that the tunnel is established along an explicit path. Used to specify the route that RSVP path messages
take for setting up LSPs.
Type: enum
Default: RSVP_STRICT
Possible Values:
Value
Description
RSVP_STRICT Two nodes must be adjacent to one another with no intermediate hops separating them.
RSVP_LOOSE Two nodes need not be adjacent. IGP can be used to determine the best path to the loose hop.
RsvpIpv4ExplicitRouteParams Read-Only Attributes

rsvpIpv4LspSubTlv
Description:
Children: None
rsvpIpv4LspSubTlv Attributes
Attribute
Description
extendedTunnelId
Type: IPV4ADDR
Default: 192.168.1.1
ipv4TunnelEndPoint
Type: IPV4ADDR
Default: 192.168.1.2
ipv4TunnelSender
Type: IPV4ADDR
Default: 192.168.1.1
length
Type: INTEGER
Default: 20
lspId
Type: INTEGER
Default: 1
Name
Type: string
reserved1
Type: INTEGER
Default: 0
reserved2
Type: INTEGER
Default: 0
tunnelId
Type: INTEGER
Default: 1
type
Type: INTEGER
Default: 3
2648
RsvpIpv4LsrParams
RsvpIpv4LsrParams
Description:
RSVP IPv4 LSR parameters object.

Parents: RsvpEgressS2lSubLspParams, RsvpEgressTunnelParams
RsvpIpv4LsrParams Writable Attributes

Writable Attribute
Description
Active, Name
FrrMergePoint
Indicates that the IP address specified in that row is the merge point.
Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
Indicates that this is the merge point. One LSR must be set to true.
FALSE All others are false.

Label
Label used for record route object.

Type: u32
Default: 16
RroFlags
RRO sub-object flags.

Type: enum
Default: 0
Possible Values:
Value
Description
RSVP_RRO_FLAG_LOCAL_PROTECTION_AVAILABLE LOCAL_PROTECTION_AVAILABLE
RSVP_RRO_FLAG_LOCAL_PROTECTION_IN_USE
LOCAL_PROTECTION_IN_USE
RSVP_RRO_FLAG_BANDWIDTH_PROTECTION
BANDWIDTH_PROTECTION
RSVP_RRO_FLAG_NODE_PROTECTION
NODE_PROTECTION
RSVP_RRO_FLAG_NODE_ID
NODE_ID
RsvpIpv4LsrParams Read-Only Attributes

RsvpLspResults
Description:
RSVP LSP results.

Relations:
Side name
(Type)
Relative
Description
ResultParent
(ResultChild)
RsvpRouterConfig
2649
RsvpLspResults
RsvpLspResults Writable Attributes

RsvpLspResults Read-Only Attributes

Read-Only Attribute
Description
Direction
States whether the tunnel is ingress or egress.

Type: enum
Default: RSVP_TUNNEL_INGRESS
Possible Values:
Value
Description
RSVP_TUNNEL_INGRESS Spirent TestCenter sends the PATH message.
RSVP_TUNNEL_EGRESS Spirent TestCenter sends the reservation message.
DstIpAddr
IP address of the LSP destination.

Type: ip
Default: 0.0.0.0
ExtendedTunnelId
Extended 32-bit tunnel identifier.

Type: ip
Default: 0.0.0.0
Label
Label value.
Type: u32
Default: 0
LspId
LSP ID.
Type: u16
Default: 0
LspType
LSP Type.
Type: enum
Default: P2P
Possible Values:
Value Description
P2P
Point-to-Point.
P2MP Point-to-Multipoint.
P2MpId
P2MP Tunnel Identifier.

Type: string
Default: 0.0.0.0
RxPathMsg
PATH messages received. Recorded for incoming LSPs only.

Type: u64
Default: 0
RxReservationMsg
Reservation messages received. Recorded for incoming LSPs only.

Type: u64
Default: 0
SrcIpAddr
IP address of the LSP source.

Type: ip
Default: 0.0.0.0
SubLspDownCount
Number of P2MP sub-LSPs in UP state.

Type: u16
Default: 0
SubLspUpCount
Number of P2MP sub-LSPs in DOWN state.

Type: u16
Default: 0
Timestamp
Timestamp for the result.

Type: u64
Default: 0
2650
RsvpMoveEroHopsUnderEroObjectCommand
Read-Only Attribute
Description
TunnelId
16-bit tunnel identifier. (Applies to both ingress and egress.)

Type: u16
Default: 0
TunnelState
Reports if the LSP is up, down, or connecting. (Run-time results only).

Type: enum
Default: RSVP_TUNNEL_STATE_NO_STATE
Possible Values:
Value
Description
RSVP_TUNNEL_STATE_NO_STATE
No state, has not been applied.
RSVP_TUNNEL_STATE_DOWN
Tunnel is down.
RSVP_TUNNEL_STATE_UP
Tunnel is up.
RSVP_TUNNEL_STATE_CONNECTING Tunnel is connecting.

RSVP_TUNNEL_STATE_REROUTED
Tunnel is re-routed.
TxPathMsg
PATH messages sent. Recorded for outgoing LSPs only.

Type: u64
Default: 0
TxReservationMsg
Reservation messages sent. Recorded for outgoing LSPs only.

Type: u64
Default: 0
RsvpMoveEroHopsUnderEroObjectCommand
Description:
EroHops under IngressTunnel moved to Ero Object under Ingress Tunnel.

RsvpMoveEroHopsUnderEroObjectCommand Writable Attributes

Writable Attribute
Description
RsvpMoveEroHopsUnderEroObjectCommand Read-Only Attributes

Read-Only Attribute
Description

RsvpP2mPGraftEgressSubLspCommand
Description:
Graft Egress sub-LSPs.
2651
RsvpP2mPGraftIngressSubLspCommand

RsvpP2mPGraftEgressSubLspCommand Writable Attributes

Writable Attribute
Description
SubLspList
List of sub-LSPs.
Type: handle
Default: 0
RsvpP2mPGraftEgressSubLspCommand Read-Only Attributes

Read-Only Attribute
Description

RsvpP2mPGraftIngressSubLspCommand
Description:
Graft Ingress sub-LSPs.

RsvpP2mPGraftIngressSubLspCommand Writable Attributes

Writable Attribute
Description
SubLspList
List of sub-LSPs.
Type: handle
Default: 0
RsvpP2mPGraftIngressSubLspCommand Read-Only Attributes

Read-Only Attribute
Description

RsvpP2mPPruneEgressSubLspCommand
Description:
Prune Egress sub-LSPs.

2652
RsvpP2mPPruneIngressSubLspCommand
RsvpP2mPPruneEgressSubLspCommand Writable Attributes

Writable Attribute
Description
SubLspList
List of Egress sub-LSPs.

Type: handle
Default: 0
RsvpP2mPPruneEgressSubLspCommand Read-Only Attributes

Read-Only Attribute
Description

RsvpP2mPPruneIngressSubLspCommand
Description:
Prune P2MP Ingress sub-LSPs.

RsvpP2mPPruneIngressSubLspCommand Writable Attributes

Writable Attribute
Description
SubLspList
List sub-LSPs for command.

Type: handle
Default: 0
RsvpP2mPPruneIngressSubLspCommand Read-Only Attributes

Read-Only Attribute
Description

RsvpP2MpSubGroupParams
Description:
RsvpP2Mp SubGroup object.

Parents: RsvpIngressTunnelParams
Children: RsvpIngressS2lSubLspParams
2653
RsvpRestartRouterCommand
RsvpP2MpSubGroupParams Writable Attributes

Writable Attribute
Description
Active, Name
SubGroupId
SubGroup ID.
Type: u16
Default: 0
SubGroupOriginatorId
SubGroup Originator ID.

Type: ip
Default: 0.0.0.0
RsvpP2MpSubGroupParams Read-Only Attributes

RsvpRestartRouterCommand
Description:
Performs the RSVP graceful restart from the list of routers.

RsvpRestartRouterCommand Writable Attributes

Writable Attribute
Description
RouterList
RSVP router handle list command to be executed on.

Type: handle
Default: 0
RsvpRestartRouterCommand Read-Only Attributes

Read-Only Attribute
Description

RsvpResumeHellosCommand
Description:
Resume Hellos on selected RSVP router(s).

2654
RsvpRouterConfig
RsvpResumeHellosCommand Writable Attributes

Writable Attribute
Description
RouterList

Type: handle
Default: 0
RsvpResumeHellosCommand Read-Only Attributes

Read-Only Attribute
Description

RsvpRouterConfig
Description:
RSVP router configuration.

Children: RsvpEgressTunnelParams, RsvpIngressTunnelParams
Result children (automatically created): RsvpLspResults, RsvpRouterResults, RsvpSubLspResults
Relations:
Side name
(Type)
Relative
Description
(ResolvesInterface)

MplsIf, PppIf, PppoeIf, RsvpCustomObject, RsvpCustomObject,
RsvpCustomObject, VlanIf, WimaxIf
Use this to link the traffic binding interfaces

and traffic binding resolver.
ResultChild
(ResultChild)
RsvpLspResults, RsvpRouterResults, RsvpSubLspResults

object.
RsvpRouterConfig Writable Attributes

Writable Attribute
Description
CapabilityObject
Capability object to be carried in Hello message.

Type: enum
Default: CLASS_NUMBER_132
Possible Values:
Value
Description
CLASS_NUMBER_132 Class Number 132.
CLASS_NUMBER_134 Class Number 134.
NONE
DutIpAddr
No capability object.
IP address of the DUT connected to the Spirent TestCenter port.

Type: ip
Default: null
2655
RsvpRouterConfig
Writable Attribute
Description
EgressLabel
Defines the label advertised if the emulated router is at the tail-end of the tunnel. This label is advertised in
response to a PATH message with a destination IP address matching the router tester IP address.
Type: enum
Possible Values:
Value
Description
This label value (three) is used in an LDP or RSVP packet to enable

penultimate hop label popping. The egress LSR signals a request to
its upstream neighbor to pop the top label in the stack and forward
the rest of the packet. This value does not appear in the encapsulation.
A zero (IPv4 datagram) or two (IPv6 datagram) MPLS label value

indicates to the penultimate router that it is to pop the label upon
receipt and forward the IP packet to the egress router for Layer 3
forwarding. Explicit null instructions are signaled to the penultimate
router by the egress router.
RSVP_EGRESS_NEXTAVAILABLE For each FEC, the LSR advertises the next available label from the
label pool (Min Label to Max Label).
EnableBfd
Enable or disable BFD (Bidirectional Forwarding Detection) for this router. You must also create a
BfdRouterConfig object under the parent Router object.
Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
Enable BFD.
FALSE Disable BFD.

Indicates whether the RSVP router allows graceful restart.

Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
Allow graceful restart. (Restart time and recovery time parameters must be set. In the sequencer,
a new command is available: perform graceful restart - RSVP.
FALSE Do not allow graceful restart.

EnableHello
Enables sending RSVP hello packet.

Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
Hello packets are sent.
FALSE Hello packets are not sent.

EnableLspResults
Enable LSP results.

Type: bool
Default: TRUE
Possible Values:
Value Description
TRUE
Enable
FALSE Disable
EnableReliableDelivery
Enables reliable delivery (retransmission parameters).

Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
Enables reliable delivery.
FALSE Disables reliable delivery.
2656
RsvpRouterConfig
Writable Attribute
Description
EnableResvRequestConfirmation
Causes the egress to include a RESV_CONFIRM object in its reservation message. When the ingress
receives a RESV message containing this object, this signals the ingress to send out a ResvConf message
to confirm the successful installation of a reservation.
Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
RESV confirmation is on.
FALSE RESV confirmation is off.

HelloInterval
Interval between RSVP hello packets. This attribute requires that EnableHello is set to TRUE.
Type: u32
Default: 1000
Range: 1 - 2147483647
InterPktDelay
Gap or time delay between transmitted RSVP packets. For example, a minimum delay between any two
PATH messages.
Type: u32
Default: 30
Range: 0 - 2147483647
LabelBindingMode
Label binding mode.

Type: enum
Default: TX_AND_RX
Possible Values:
Value
Description
TX_AND_RX Enable binding for both Tx and Rx.
TX_ONLY
Enable binding for Tx only.
RX_ONLY
Enable binding for Rx only.
NONE
Disable binding.
LabelMax
Specifies the maximum label advertised by the peer.

Type: u32
Default: 65535
Range: 1 - 1048575
LabelMin
Specifies the minimum label advertised by the peer.

Type: u32
Default: 16
Range: 1 - 1048575
RecoveryTime
Period of time (in ms) that the sender needs for the recipient to re-synchronize RSVP and MPLS forwarding
state with the sender after the re-establishment of hello synchronization. (Enabled only if graceful restart is
enabled.)
Type: u32
Default: 0
Range: 0 - 4294967295
RefreshInterval
Time interval for a path and resv message to be sent out to the path receiver to refresh the path/resv state
along each hop of the path.
Type: u32
Default: 30000
Range: 1 - 2147483647
RefreshReductionBundleInterval
Messages are held in a buffer and are sent out as a bundle after the interval (in ms) expires or when the
message size exceeds the MTU.
Type: u32
Default: null
Range: 1 - 2147483647
RefreshReductionSummaryRefreshInterval
Time interval (in ms) to gather refresh messages that would have been sent out individually. Messages are
sent out as a single refresh message upon interval expiration or when the message size exceeds the MTU.
Type: u32
Default: null
Range: 1 - 2147483647
2657
RsvpRouterConfig
Writable Attribute
Description
RestartTime
Set to the sum of the time (in ms) that it takes the sender of the object to restart its RSVP-TE component
and the communication channel that is used for RSVP communication. (Enabled only if graceful restart is
enabled.) If the emulated router is a helper, it should wait at least this amount of time before invoking
procedures related to communication loss.
Type: u32
Default: 3000
Range: 0 - 4294967295
RetransmitDelta
Multiplier by which the retransmission interval is increased each time an unacknowledged message is
retransmitted. This helps reduce the number of simultaneous retransmissions that are sent by introducing
some element of randomness into the retransmission process.
Type: u16
Default: 1
Range: 0 - 3
RetransmitInterval
Initial retransmission interval (in ms) for unacknowledged messages.

Type: u32
Default: 500
Range: 1 - 2147483647
RetransmitLimit
Maximum number of times a message is transmitted without being acknowledged.

Type: u16
Default: 3
Range: 0 - 10
Transit
Defines the RESV message sent if the emulated router is not the tail-end for PATH messages that it receives.
Type: enum
Default: RSVP_TRANSIT_ACCEPT_CONFIGURED
Possible Values:
Value
Description
RSVP_TRANSIT_ACCEPT_ALL
Router sends an RESV message with the next available label

for every PATH message received by the port.
RSVP_TRANSIT_ACCEPT_CONFIGURED Router sends an RESV with the next available label in

response to PATH messages that match one of its egress
tunnels.
RsvpRouterConfig Read-Only Attributes

Read-Only Attribute
Description
LearnedLabelCount
Number of learned labels.

Type: u32
Default: 0
LspReroutedCount
Number of Path Error messages received as result of Node failure during FRR.
Type: u32
Default: 0
ResolvedLabelCount
Number of resolved labels.

Type: u32
Default: 0
RouterState
Reports the state of routers on the current port.

Type: enum
Default: RSVP_STATE_NO_STATE
Possible Values:
Value
Description
RSVP_STATE_NO_STATE API has not received a status update from the embedded software.
RSVP_STATE_DOWN
Stop router command has been sent, and the session has been brought down.
RSVP_STATE_INIT
Emulated router has been created, but the start router command has not been
sent.
RSVP_STATE_UP
Start router command has been sent, and the session is running.
2658
RsvpRouterResults
Read-Only Attribute
Description
Number of unresolved labels.

Type: u32
Default: 0
RsvpRouterResults
Description:
RSVP router results.

Relations:
Side name
(Type)
Relative
Description
ResultParent
(ResultChild)
RsvpRouterConfig
RsvpRouterResults Writable Attributes

RsvpRouterResults Read-Only Attributes

Read-Only Attribute
Description
AvgLspSetupTime
Average time (in ms) to set up an LSP on the session.

Type: u64
Default: 0
EgressLspUpCount
Number of egress LSPs in Up state.

Type: u64
Default: 0
EventInProgress
Event in progress.
Type: u8
Default: 0
LastRxPathErrorCode
Reports the last path error message code received.

Type: u8
Default: 0
LastRxReservationErrorCode
Reports the last reservation error message code received.

Type: u8
Default: 0
LastTxPathErrorCode
Reports the last path error message code sent.

Type: u8
Default: 0
LastTxReservationErrorCode
Reports the last reservation error message code sent.

Type: u8
Default: 0
LspConnectingCount
Number of LSPs in the connecting state.

Type: u64
Default: 0
2659
RsvpRouterResults
Read-Only Attribute
Description
LspDownCount
Number of LSPs in the down state.

Type: u64
Default: 0
LspUpCount
Number of LSPs in the up state.

Type: u64
Default: 0
MaxLspSetupTime
Maximum time (in ms) to set up an LSP on the session.

Type: u64
Default: 0
MinLspSetupTime
Minimum time (in ms) to set up an LSP on the session.

Type: u64
Default: 0
RxHello
Number of hello packets received.

Type: u64
Default: 0
RxPath
Number of PATH messages received.

Type: u64
Default: 0
RxPathError
Number of path error messages received.

Type: u64
Default: 0
RxPathRecovery
Number of PATH recovery packets received.

Type: u64
Default: 0
RxPathTeardown
Number of path tear messages received.

Type: u64
Default: 0
RxReservation
Number of reservation messages received.

Type: u64
Default: 0
RxReservationConfirmation
Number of reservation confirm messages received.

Type: u64
Default: 0
RxReservationError
Number of reservation error messages received.

Type: u64
Default: 0
RxReservationTeardown
Number of reservation tear messages received.

Type: u64
Default: 0
Timestamp
Timestamp of the results.

Type: u64
Default: 0
TxHello
Number of hello packets sent.

Type: u64
Default: 0
TxPath
Number of PATH messages sent.

Type: u64
Default: 0
TxPathError
Number of path error messages sent.

Type: u64
Default: 0
2660
RsvpSharedSessionParams
Read-Only Attribute
Description
TxPathRecovery
Number of PATH recovery packets sent.

Type: u64
Default: 0
TxPathTeardown
Number of path tear messages sent.

Type: u64
Default: 0
TxReservation
Number of reservation messages sent.

Type: u64
Default: 0
TxReservationConfirmation
Number of reservation confirm messages sent.

Type: u64
Default: 0
TxReservationError
Number of reservation error messages sent.

Type: u64
Default: 0
TxReservationTeardown
Number of reservation tear messages sent.

Type: u64
Default: 0
Description:
RSVP RouterConfig parameters for wizards.
RsvpSharedSessionParams Writable Attributes

Writable Attribute
Description
Active, Name
EgressLabel
Defines the label advertised if the emulated router is at the tail-end of the tunnel. This label is advertised in
response to a PATH message with a destination IP address matching the router tester IP address.
Type: enum
Possible Values:
Value
Description
This label value (three) is used in an LDP or RSVP packet to enable

penultimate hop label popping. The egress LSR signals a request to
its upstream neighbor to pop the top label in the stack and forward
the rest of the packet. This value does not appear in the encapsulation.
A zero (IPv4 datagram) or two (IPv6 datagram) MPLS label value

indicates to the penultimate router that it is to pop the label upon
receipt and forward the IP packet to the egress router for Layer 3
forwarding. Explicit null instructions are signaled to the penultimate
router by the egress router.
RSVP_EGRESS_NEXTAVAILABLE For each FEC, the LSR advertises the next available label from the
label pool (Min Label to Max Label).
2661
Writable Attribute
Description
EnableBfd
Enable or disable BFD (Bidirectional Forwarding Detection) for this router. You must also create a
BfdRouterConfig object under the parent Router object.
Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
Enable BFD.
FALSE Disable BFD.

Indicates whether the RSVP router allows graceful restart.

Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
Allow graceful restart. (Restart time and recovery time parameters must be set. In the sequencer,
a new command is available: perform graceful restart - RSVP.
FALSE Do not allow graceful restart.

EnableHello
Enables sending RSVP hello packet.

Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
Hello packets are sent.
FALSE Hello packets are not sent.

EnableReliableDelivery
Enables reliable delivery (retransmission parameters).

Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
Enables reliable delivery.
FALSE Disables reliable delivery.

EnableResvRequestConfirmation
Causes the egress to include a RESV_CONFIRM object in its reservation message. When the ingress
receives a RESV message containing this object, this signals the ingress to send out a ResvConf message
to confirm the successful installation of a reservation.
Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
RESV confirmation is on.
FALSE RESV confirmation is off.

HelloInterval
Interval between RSVP hello packets. This attribute requires that EnableHello is set to TRUE.
Type: u32
Default: 1000
Range: 1 - 2147483647
InterPktDelay
Gap or time delay between transmitted RSVP packets. For example, a minimum delay between any two
PATH messages.
Type: u32
Default: 30
Range: 0 - 2147483647
LabelMax
Specifies the maximum label advertised by the peer.

Type: u32
Default: 65535
Range: 1 - 1048575
2662
Writable Attribute
Description
LabelMin
Specifies the minimum label advertised by the peer.

Type: u32
Default: 16
Range: 1 - 1048575
RecoveryTime
Period of time (in ms) that the sender needs for the recipient to re-synchronize RSVP and MPLS forwarding
state with the sender after the re-establishment of hello synchronization. (Enabled only if graceful restart is
enabled.)
Type: u32
Default: 0
Range: 0 - 4294967295
RefreshInterval
Time interval for a path and resv message to be sent out to the path receiver to refresh the path/resv state
along each hop of the path.
Type: u32
Default: 30000
Range: 1 - 2147483647
RefreshReductionBundleInterval
Messages are held in a buffer and are sent out as a bundle after the interval (in ms) expires or when the
message size exceeds the MTU.
Type: u32
Default: null
Range: 1 - 2147483647
RefreshReductionSummaryRefreshInterval
Time interval (in ms) to gather refresh messages that would have been sent out individually. Messages are
sent out as a single refresh message upon interval expiration or when the message size exceeds the MTU.
Type: u32
Default: null
Range: 1 - 2147483647
RestartTime
Set to the sum of the time (in ms) that it takes the sender of the object to restart its RSVP-TE component
and the communication channel that is used for RSVP communication. (Enabled only if graceful restart is
enabled.) If the emulated router is a helper, it should wait at least this amount of time before invoking
procedures related to communication loss.
Type: u32
Default: 3000
Range: 0 - 4294967295
RetransmitDelta
Multiplier by which the retransmission interval is increased each time an unacknowledged message is
retransmitted. This helps reduce the number of simultaneous retransmissions that are sent by introducing
some element of randomness into the retransmission process.
Type: u16
Default: 1
Range: 0 - 3
RetransmitInterval
Initial retransmission interval (in ms) for unacknowledged messages.

Type: u32
Default: 500
Range: 1 - 2147483647
RetransmitLimit
Maximum number of times a message is transmitted without being acknowledged.

Type: u16
Default: 3
Range: 0 - 10
Transit
Defines the RESV message sent if the emulated router is not the tail-end for PATH messages that it receives.
Type: enum
Default: RSVP_TRANSIT_ACCEPT_CONFIGURED
Possible Values:
Value
Description
RSVP_TRANSIT_ACCEPT_ALL
Router sends an RESV message with the next available label

for every PATH message received by the port.
RSVP_TRANSIT_ACCEPT_CONFIGURED Router sends an RESV with the next available label in

response to PATH messages that match one of its egress
tunnels.
RsvpSharedSessionParams Read-Only Attributes

2663
RsvpSharedTunnelHeadEndParams
RsvpSharedTunnelHeadEndParams
Description:
RSVP shared tunnel head end parameters.
RsvpSharedTunnelHeadEndParams Writable Attributes

Writable Attribute
Description
Active, Name
Affinities
Disables or enables the three (resource class) affinities in tunnel messages.

Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
Affinities enabled.
FALSE Affinities disabled.

EnableRecordRoute
Causes the ingress to include a record-route object in the path message.

Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
Record route on.
FALSE Record route off.

ExcludeAny
(Optional) Represents a set of attribute filters associated with a backup path, any of which renders a link unacceptable.
If any bit in the link bit mask matches the corresponding bit in the exclude any bit mask, the link is excluded from the
tunnel.
Type: u32
Default: 0
Flag
Opens the RSVP flags dialog.

Type: enum
Default: 0
Possible Values:
Value
Description
RSVP_FLAG_LOCAL_PROTECTION_DESIRED
Local protection is enabled.
RSVP_FLAG_LABLE_RECORD
Label record is enabled.
RSVP_FLAG_SHARED_EXPLICIT
Shared explicit is enabled.
RSVP_FLAG_BANDWIDTH_PROTECTION_DESIRED Bandwidth protection is enabled.

RSVP_FLAG_NODE_PROTECTION_DESIRED
Node protection is enabled.
HoldPriority
Priority assigned to each tunnel is used to determine which tunnel(s) can be preempted by other tunnels. (Used to
determine resource holding.)
Type: u8
Default: 7
Range: 0 - 7
IncludeAll
(Optional) Represents a set of attribute filters associated with a backup path, all of which must be present for a link to
be acceptable (with respect to this test). If the entire link bit mask matches the entire include all bit mask, the link is
included in the tunnel. A null set (all bits set to zero) automatically passes.
Type: u32
Default: 0
IncludeAny
(Optional) Represents a set of attribute filters associated with a backup path, any of which renders a link acceptable (with
respect to this test). If any bit in the link bit mask matches the corresponding bit in the include any bit mask, the link is
included in the tunnel. A null set (all bits set to zero) automatically passes.
Type: u32
Default: 0
2664
RsvpStateSummary
Writable Attribute
Description
MaxPktSize
Biggest packet that conforms to the traffic specification.

Type: u32
Default: 1500
Range: 0 - 2147483647
MinPolicedUnit
This size includes the application data and all protocol headers at or above the IP level.
Type: u32
Default: 64
Range: 0 - 2147483647
PeakDataRate
Maximum rate of IP datagrams.

Type: double
Default: 512000
Range: 0 - 2147483647
SessionAttribute
Adds a session attribute with Setup Priority, Hold Priority, Flags, and Session Name fields to the PATH message.
Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
On
FALSE Off
SessionName
it.
Optional text name for the session/tunnel.
Type: string
SessionNamePrefix
Session Name Prefix when generating Session Names.

Type: string
SetupPriority
Type: u8
Default: 7
Range: 0 - 7
TokenBucketRate
Rate of IP datagrams.
Type: double
Default: 128000
Range: 0 - 2147483647
TokenBucketSize
Token bucket size.

Type: double
Default: 256000
Range: 0 - 2147483647
RsvpSharedTunnelHeadEndParams Read-Only Attributes

RsvpStateSummary
Description:
RSVP State Summary.

Relations:
2665
RsvpStopHellosCommand
Side name
(Type)
Relative
Description
ResultParent
(ResultChild)
Port, Project
RsvpStateSummary Writable Attributes

RsvpStateSummary Read-Only Attributes

Read-Only Attribute
Description
DownCount
Number of routers in DOWN state.

Type: u32
Default: 0
InitCount
Number of routers in INIT state.

Type: u32
Default: 0
NotStartedCount

Type: u32
Default: 0
RouterDownCount
Number of routers in DOWN state.

Type: u32
Default: 0
RouterUpCount
Number of routers in UP state.

Type: u32
Default: 0
UpCount
Number of routers in UP state.

Type: u32
Default: 0
RsvpStopHellosCommand
Description:
Stops Hellos on selected RSVP routers.

RsvpStopHellosCommand Writable Attributes

Writable Attribute
Description
RouterList

Type: handle
Default: 0
2666
RsvpSubLspResults
RsvpStopHellosCommand Read-Only Attributes

Read-Only Attribute
Description

RsvpSubLspResults
Description:
RSVP sub-LSP results object.

Relations:
Side name
(Type)
Relative
Description
ResultParent
(ResultChild)
RsvpRouterConfig
RsvpSubLspResults Writable Attributes

RsvpSubLspResults Read-Only Attributes

Read-Only Attribute
Description
Direction
Tunnel Direction.
Type: enum
Default: RSVP_TUNNEL_INGRESS
Possible Values:
Value
Description
RSVP_TUNNEL_INGRESS Ingress Tunnel.
RSVP_TUNNEL_EGRESS Egress Tunnel.
DstIpAddr
Destination IP address.
Type: ip
Default: 0.0.0.0
ExtendedTunnelId
Extended Tunnel ID.

Type: ip
Default: 0.0.0.0
Label
Label
Type: u32
Default: 0
P2MpId
P2MP ID.
Type: string
Default: 0.0.0.0
SrcIpAddr
Source IP address.
Type: ip
Default: 0.0.0.0
2667
RsvpViewCompressedEROCommand
Read-Only Attribute
Description
SubGroupId
SubGroup ID.
Type: u16
Default: 0
SubGroupOriginatorId
SubGroup Originator ID.

Type: ip
Default: 0.0.0.0
SubLspState
Sub LSP State.

Type: enum
Default: RSVP_SUBLSP_STATE_NO_STATE
Possible Values:
Value
Description
RSVP_SUBLSP_STATE_NO_STATE
No State.
RSVP_SUBLSP_STATE_DOWN
Down.
RSVP_SUBLSP_STATE_UP
Up.
RSVP_SUBLSP_STATE_CONNECTING Connecting.
TunnelId
Tunnel ID.
Type: u16
Default: 0
RsvpViewCompressedEROCommand
Description:
View compressed ERO.

RsvpViewCompressedEROCommand Writable Attributes

Writable Attribute
Description
RsvpP2MpSubGroupParamsList
SubGroups for ERO compression.

Type: handle
Default: 0
RsvpViewCompressedEROCommand Read-Only Attributes

Read-Only Attribute
Description

CompressedERO
Output string for compressed ERO.

Type: string
2668
RsvpViewSubLspResultsCommand
RsvpViewSubLspResultsCommand
Description:
View sub-LSP results.

RsvpViewSubLspResultsCommand Writable Attributes

Writable Attribute
Description
RsvpLspResultList
LSP results for which sub-LSP results are needed.

Type: handle
Default: 0
SubLspState
Filter results based on sub-LSP state.

Type: enum
Default: RSVP_SUBLSP_STATE_ALL
Possible Values:
Value
Description
RSVP_SUBLSP_STATE_DOWN
Down
RSVP_SUBLSP_STATE_UP
Up
RSVP_SUBLSP_STATE_CONNECTING Connecting
RSVP_SUBLSP_STATE_ALL
All
RsvpViewSubLspResultsCommand Read-Only Attributes

Read-Only Attribute
Description

RsvpSubLspResults
Output string for RSVP sub-LSP results.

Type: string
RsvpWaitForRerouteCommand
Description:
Wait for reroute to complete.

Parents: Sequencer
RsvpWaitForRerouteCommand Writable Attributes

Writable Attribute
Description
ErrorOnFailure
2669
RtpHeader
Writable Attribute
Description
ObjectList
Router list.
Type: handle
Default: 0
WaitLspState
Wait until LSP state changes to re-routed.

Type: enum
Default: RSVP_LSP_STATE_REROUTED
Possible Values:
Value
Description
RSVP_LSP_STATE_NON_REROUTED Non Rerouted.
RSVP_LSP_STATE_REROUTED
WaitTime
Rerouted.
Wait time (seconds).

Type: double
Default: 30.0
Range: 0.005 - 2147483647.0
RsvpWaitForRerouteCommand Read-Only Attributes

Read-Only Attribute
Description
RtpHeader (rtp:RtpHeader)
Description:
Children: csrc
RtpHeader Attributes
Attribute
Description
csrcCount
Type: INTEGER
Default: 0
extension
Type: rtpBoolean
Default: 0
Possible Values:
Value Description
marker
Name
False
True
Type: rtpBoolean
Default: 0
Possible Values:
Value Description
0
False
True
Type: string
2670
rtrAlert
Attribute
Description
padding
Type: rtpBoolean
Default: 0
Possible Values:
Value Description
0
False
True
payloadType
Type: INTEGER
Default: 0
sequenceNumber
Type: INTEGER
Default: 0
ssrc
Type: OCTETSTRING
Default: 00000000
timestamp
Type: OCTETSTRING
Default: 00000000
version
Type: INTEGER
Default: 2
rtrAlert
Description:
Children: None
rtrAlert Attributes
Attribute
Description
length
Type: INTEGER
Default: 4
Name
information.
Type: string
routerAlert
Type: INTEGER
Default: 0
2671
RunCustomCommand
Attribute
Description
type
Default: 148
Possible Values:
Value Description
0
End of Options List
NOP
130
Security
131
Loose Source Route
68
Time Stamp
133
Extended Security
Record Route
136
Stream Identifier
137
Strict Source Route
11
MTU Probe
12
MTU Reply
82
Traceroute
147
Address Extension
148
Router Alert
149
RunCustomCommand
Description:
Executes a Spirent Global Services script.

Parents: Sequencer
RunCustomCommand Writable Attributes

Writable Attribute
Description
Parameters
Script parameters. Parameters must be passed as name value pairs (ex. -time 10 -length 35 -mode burst). Parameters
can be referenced by the specified script using the stc::scriptParameters array (ex: $stc::scriptParameters(-mode)).
Type: string
ResetScriptingEngine
Indicates if we should reset the Tcl interpreter before running script. Resetting the interpreter will clear defined
variables.
Type: bool
Default: TRUE
Possible Values:
Value Description
TRUE
Resets interpreter before running script.
FALSE Does not reset interpreter before running script.

ScriptFileName
Script file to be executed.

Type: inputFilePath
2672
RunExternalProcessCommand
RunCustomCommand Read-Only Attributes

Read-Only Attribute
Description
PassFailState
ScriptResult
Result string returned by executed script.

Type: string
RunExternalProcessCommand
Description:
Runs an external process from within the sequencer.

Parents: Sequencer
RunExternalProcessCommand Writable Attributes

Writable Attribute
Description
Arguments
Arguments to append to command string when executed.

Type: string
CommandLine
Command line string to evaluate in new process.

Type: string
ExecutionMode
Which execution mode to use for new process.

Type: enum
Default: BACKGROUND
Possible Values:
Value
Description
BACKGROUND Executes new process in the background. Sequencer will not block on this command.
BLOCKING
InsertTime
Executes process in blocking mode, which means that sequencer will block on this command until the
process is complete.
Whether the execution time should be appended to the command line as an argument (-reftime).
Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
Appends -reftime + start time (in seconds) to the command line (ex. -reftime 145).
FALSE Does not append -reftime to command line.

TimeoutOption
Configures what action to take when process timeout occurs.

Type: enum
Default: TERMINATE_PROCESS
Possible Values:
Value
Description
TERMINATE_PROCESS Terminates process and returns execution back to sequencer.
PROMPT_USER
Prompts user on what he would like to do.
2673
RxCpuPortResults
Writable Attribute
Description
UseTimeout
When a process is running in Blocking mode, indicates if process timeout after specified amount of time.
Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
Process will timeout and execute selected TimeoutOption after specified amount of time.
FALSE Process will not timeout.

WaitTime
Amount of time in seconds to wait before process timeout occurs.

Type: double
Default: 0
WorkingDir
Working directory to execute process in.

Type: string
RunExternalProcessCommand Read-Only Attributes

Read-Only Attribute
Description
PassFailState
RxCpuPortResults
Description:
Result object to store port cut-through results on the analyzer.

Parents: Analyzer
Relations:
Side name
(Type)
Relative
Description
ResultParent
(ResultChild)
Analyzer
RxCpuPortResults Writable Attributes

RxCpuPortResults Read-Only Attributes

Read-Only Attribute
Description
CounterTimestamp

Type: u64
Default: 0
CpuArpReplyCount
Number of CPU ARP replies received.

Type: u64
Default: 0
CpuArpReplyRate
Number of CPU ARP reply frames received over the last 1-second interval.
Type: u64
Default: 0
2674
RxCpuPortResults
Read-Only Attribute
Description
CpuArpRequestCount
Number of CPU ARP requests received.

Type: u64
Default: 0
CpuArpRequestRate
Number of CPU ARP request frames received over the last 1-second interval.
Type: u64
Default: 0
CpuBitRate
Number of CPU bits received over the last 1-second interval.

Type: u64
Default: 0
CpuDroppedFrameCount
Number of CPU frames dropped in transit.

Type: u64
Default: 0
CpuDroppedFrameRate
Number of CPU frames dropped over last 1-second interval.

Type: u64
Default: 0
CpuFrameCount
Number of CPU frames received.

Type: u64
Default: 0
CpuFrameRate
Number of CPU frames received over the last 1-second interval.

Type: u64
Default: 0
CpuIcmpEchoReplyCount
Number of CPU ICMP echo replies received.

Type: u64
Default: 0
CpuIcmpEchoReplyRate
Number of CPU ICMP echo reply frames received over the last 1-second interval.
Type: u64
Default: 0
CpuIcmpEchoRequestCount
Number of CPU ICMP echo requests received.

Type: u64
Default: 0
CpuIcmpEchoRequestRate
Number of CPU ICMP echo request frames received over the last 1-second interval.
Type: u64
Default: 0
CpuIcmpv6EchoReplyCount
Number of CPU ICMPv6 echo reply frames received.

Type: u64
Default: 0
CpuIcmpv6EchoReplyRate
Number of CPU ICMPv6 echo reply frames received over the last 1-second interval.
Type: u64
Default: 0
CpuIcmpv6EchoRequestCount
Number of CPU ICMPv6 echo request frames received.

Type: u64
Default: 0
CpuIcmpv6EchoRequestRate
Number of CPU ICMPv6 echo request frames received over the last 1-second interval.
Type: u64
Default: 0
CpuIpv4FrameCount
Number of CPU IPv4 frames received.

Type: u64
Default: 0
CpuIpv4FrameRate
Number of CPU IPv4 frames received over the last 1-second interval.
Type: u64
Default: 0
2675
RxPacketChannelOptions
Read-Only Attribute
Description
CpuIpv6FrameCount
Number of CPU IPv6 frames received.

Type: u64
Default: 0
CpuIpv6FrameRate
Number of CPU IPv6 frames received over the last 1-second interval.
Type: u64
Default: 0
CpuMplsFrameCount
Number of CPU MPLS frames received.

Type: u64
Default: 0
CpuMplsFrameRate
Number of CPU MPLS frames received over the last 1-second interval.
Type: u64
Default: 0
CpuNeighborAdvertisementCount
Number of CPU neighbor advertisement frames received.

Type: u64
Default: 0
CpuNeighborAdvertisementRate
Number of CPU neighbor advertisement frames received over the last 1-second interval.
Type: u64
Default: 0
CpuNeighborSolicitationCount
Number of CPU neighbor solicitation frames received.

Type: u64
Default: 0
CpuNeighborSolicitationRate
Number of CPU neighbor solicitation frames received over the last 1-second interval.
Type: u64
Default: 0
CpuOctetCount
Number of CPU bytes received.

Type: u64
Default: 0
CpuOctetRate
Number of CPU bytes received over the last 1-second interval.

Type: u64
Default: 0
RxPacketChannelOptions
Description:
Define a RX packet socket channel options.

Automatically created from: PacketChannel
RxPacketChannelOptions Writable Attributes

Writable Attribute
Description
Active, Name
2676
RxPortPairResults
Writable Attribute
Description
ReceiveRxFcs
Whether to store Ethernet FCS bytes for the receive packets.

Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
Store Ethernet FCS bytes for the receive packets.
FALSE Strip off Ethernet FCS bytes for the receive packets.
RxQueueLimit
Number of packets that can be stored in the receive queue.

Type: u16
Default: 100
Range: 1 - 5000
RxQueueOverflowMode
Receive queue overflow mode.

Type: enum
Default: DROP_LAST_RECEIVE
Possible Values:
Value
Description
DROP_LAST_RECEIVE Drop the last/newest packet received when the receive queue is full.
DROP_FIRST_RECEIVE Drop the first/oldest packet received when the receive queue is full.
RxPacketChannelOptions Read-Only Attributes

RxPortPairResults
Description:
Port-to-port results data. Provides port-to-port statistics.

Parents: Port
Relations:
Side name
(Type)
Relative
Description
AssociatedTxResult
(AssociatedResult)
TxPortPairResults
Links Tx and Rx results together so the results can be correlated
AssociatedRxResult
(AssociatedResult)
TxPortPairResults
ContainerResultParent
(ContainerResult)
Port
General-purpose relation for result objects. For example,

RxTrafficGroupResults objects are linked to the StreamBlock object with
this relation.
ResultParent
(ResultChild)
Port
RxPortPairResults Writable Attributes

2677
RxPortPairResults
RxPortPairResults Read-Only Attributes

Read-Only Attribute
Description
AvgInterarrivalTime

Type: double
Default: 0
AvgJitter
will be measured.
Type: double
Default: 0
AvgLatency

Type: double
Default: 0
BitCount

Type: u64
Default: 0
BitRate

Type: u64
Default: 0
CellCount

Type: u64
Default: 0
CellRate

Type: u64
Default: 0
Comp16_1
Type: u16
Default: 0
Comp16_2
Type: u16
Default: 0
Comp16_3
Type: u16
Default: 0
Comp16_4
Type: u16
Default: 0
Comp32
Type: u32
Default: 0
CounterTimestamp

Type: u64
Default: 0
DroppedFrameCount

Type: u64
Default: 0
DroppedFramePercent
Percentage of frames dropped in transit.

Type: double
Default: 0

Type: double
Default: 0
2678
RxPortPairResults
Read-Only Attribute
Description
DroppedFrameRate

Type: u64
Default: 0
DuplicateFrameCount

Type: u64
Default: 0
DuplicateFrameRate

Type: u64
Default: 0
ExpectedSeqNum

Type: u64
Default: 0
FcsErrorFrameCount

Type: u64
Default: 0
FcsErrorFrameRate
Type: u64
Default: 0
FirstArrivalTime
Type: double
Default: 0
FrameCount

Type: u64
Default: 0
FrameRate

Type: u64
Default: 0
HistBin10Count

Type: u64
Default: 0
HistBin10Name

Type: string
HistBin10Rate
Type: u64
Default: 0
HistBin11Count

Type: u64
Default: 0
HistBin11Name

Type: string
HistBin11Rate
Type: u64
Default: 0
HistBin12Count

Type: u64
Default: 0
HistBin12Name

Type: string
2679
RxPortPairResults
Read-Only Attribute
Description
HistBin12Rate
Type: u64
Default: 0
HistBin13Count

Type: u64
Default: 0
HistBin13Name

Type: string
HistBin13Rate
Type: u64
Default: 0
HistBin14Count

Type: u64
Default: 0
HistBin14Name

Type: string
HistBin14Rate
Type: u64
Default: 0
HistBin15Count

Type: u64
Default: 0
HistBin15Name

Type: string
HistBin15Rate
Type: u64
Default: 0
HistBin16Count

Type: u64
Default: 0
HistBin16Name

Type: string
HistBin16Rate
Type: u64
Default: 0
HistBin1Count

Type: u64
Default: 0
HistBin1Name

Type: string
HistBin1Rate
Type: u64
Default: 0
HistBin2Count

Type: u64
Default: 0
2680
RxPortPairResults
Read-Only Attribute
Description
HistBin2Name

Type: string
HistBin2Rate
Type: u64
Default: 0
HistBin3Count

Type: u64
Default: 0
HistBin3Name

Type: string
HistBin3Rate
Type: u64
Default: 0
HistBin4Count

Type: u64
Default: 0
HistBin4Name

Type: string
HistBin4Rate
Type: u64
Default: 0
HistBin5Count

Type: u64
Default: 0
HistBin5Name

Type: string
HistBin5Rate
Type: u64
Default: 0
HistBin6Count

Type: u64
Default: 0
HistBin6Name

Type: string
HistBin6Rate
Type: u64
Default: 0
HistBin7Count

Type: u64
Default: 0
HistBin7Name

Type: string
HistBin7Rate
Type: u64
Default: 0
2681
RxPortPairResults
Read-Only Attribute
Description
HistBin8Count

Type: u64
Default: 0
HistBin8Name

Type: string
HistBin8Rate
Type: u64
Default: 0
HistBin9Count

Type: u64
Default: 0
HistBin9Name

Type: string
HistBin9Rate
Type: u64
Default: 0
InOrderFrameCount

Type: u64
Default: 0
InOrderFrameRate

Type: u64
Default: 0
InSeqFrameCount

Type: u64
Default: 0
InSeqFrameRate
Type: u64
Default: 0

Type: u64
Default: 0
Type: u64
Default: 0
L1BitCount

Type: u64
Default: 0
L1BitRate

Type: u64
Default: 0
LastArrivalTime
Type: double
Default: 0
LastSeqNum

Type: u64
Default: 0
LateFrameCount

Type: u64
Default: 0
2682
RxPortPairResults
Read-Only Attribute
Description
LateFrameRate

Type: u64
Default: 0
MaxFrameLength

Type: u64
Default: 0
MaxInterarrivalTime

Type: double
Default: 0
MaxJitter
Maximum jitter measured in 1 microsecond units. Although jitter value could be negative, only absolute value
will be measured.
Type: double
Default: 0
MaxLatency

Type: double
Default: 0
MinFrameLength

Type: u64
Default: 0
MinInterarrivalTime

Type: double
Default: 0
MinJitter
will be measured.
Type: double
Default: 0
MinLatency

Type: double
Default: 0
OctetCount

Type: u64
Default: 0
OctetRate

Type: u64
Default: 0
OutSeqFrameCount

Type: u64
Default: 0
OutSeqFrameRate
Type: u64
Default: 0
PortStrayFrames
Type: enum
Default: NA
Possible Values:
Value Description
PrbsBitErrorCount
NA
YES
NO

Type: u64
Default: 0
2683
RxPortPairResults
Read-Only Attribute
Description
PrbsBitErrorRate
Type: u64
Default: 0
PrbsBitErrorRatio

Type: double
Default: 0
PrbsErrorFrameCount

Type: u64
Default: 0
PrbsErrorFrameRate

Type: u64
Default: 0
PrbsFillOctetCount

Type: u64
Default: 0
PrbsFillOctetRate
Type: u64
Default: 0
ReorderedFrameCount

Type: u64
Default: 0
ReorderedFrameRate

Type: u64
Default: 0

Type: double
Default: 0
SeqRunLength
sequence run can contain reordered frames (in which the received sequence number is less than the expected
sequence number) but no discontinuities (in which the received sequence number is greater than the expected
sequence number). Sequence runs have no missing sequence numbers between start and end values.
Type: u64
Default: 0

Type: double
Default: 0
ShortTermAvgJitter

Type: double
Default: 0
ShortTermAvgLatency

Type: double
Default: 0
SigFrameCount

Type: u64
Default: 0
SigFrameRate

Type: u64
Default: 0
StreamIndex
Type: u32
Default: 0
2684
RxPortResultFilter
Read-Only Attribute
Description

Type: u64
Default: 0
Type: u64
Default: 0

Type: u64
Default: 0
TotalJitter
Total jitter measured in 1 microsecond units. Although jitter value could be negative, only absolute value will
be measured.
Type: u64
Default: 0
TotalJitterRate

Type: u64
Default: 0
RxPortResultFilter
Description:
Configures a list of ports used to filter the results.

Parents: Project
Relations:
Side name
(Type)
Relative
ResultQuery
(ResultFilters)
ResultQuery
Description
RxPortResultFilter Writable Attributes

Writable Attribute
Description
Active, Name
RxPortList
Receiving port names.

Type: handle
Default: 0
RxPortResultFilter Read-Only Attributes

RxStreamBlockResults
Description:
Provides grouped results for all streams under this stream block. Data is subscribed from firmware, grouped by stream block ID.
2685
You do not need to create this object, it is created automatically.

Note: This object is for end of test results. You must use RefreshResultViewCommand before you can access the results.

Result children (automatically created): RxStreamResults
Relations:
Side name
(Type)
Relative
Description
AssociatedTxResult
(AssociatedResult)
TxStreamBlockResults
AssociatedRxResult
(AssociatedResult)
TxStreamBlockResults
ResultParent
(ResultChild)
StreamBlock
SummaryResultChild
RxStreamResults
Specifies a child of the summary result. Used to find out which

objects are used in the summary.
RxStreamBlockResults Writable Attributes

RxStreamBlockResults Read-Only Attributes

Read-Only Attribute
Description
AvgInterarrivalTime

Type: double
Default: 0
AvgJitter
will be measured.
Type: double
Default: 0
AvgLatency

Type: double
Default: 0
BitCount

Type: u64
Default: 0
BitRate

Type: u64
Default: 0
CellCount

Type: u64
Default: 0
CellRate

Type: u64
Default: 0
Comp16_1
Type: u16
Default: 0
Comp16_2
Type: u16
Default: 0
2686
Read-Only Attribute
Description
Comp16_3
Type: u16
Default: 0
Comp16_4
Type: u16
Default: 0
Comp32
Type: u32
Default: 0
CounterTimestamp

Type: u64
Default: 0
DroppedFrameCount

Type: u64
Default: 0
DroppedFramePercent

Type: double
Default: 0

Type: double
Default: 0
DroppedFrameRate

Type: u64
Default: 0
DuplicateFrameCount

Type: u64
Default: 0
DuplicateFrameRate

Type: u64
Default: 0
ExpectedSeqNum

Type: u64
Default: 0
FcsErrorFrameCount

Type: u64
Default: 0
FcsErrorFrameRate
Type: u64
Default: 0
FirstArrivalTime
Type: double
Default: 0
FrameCount

Type: u64
Default: 0
FrameRate

Type: u64
Default: 0
HistBin10Count

Type: u64
Default: 0
2687
Read-Only Attribute
Description
HistBin10Name

Type: string
HistBin10Rate
Type: u64
Default: 0
HistBin11Count

Type: u64
Default: 0
HistBin11Name

Type: string
HistBin11Rate
Type: u64
Default: 0
HistBin12Count

Type: u64
Default: 0
HistBin12Name

Type: string
HistBin12Rate
Type: u64
Default: 0
HistBin13Count

Type: u64
Default: 0
HistBin13Name

Type: string
HistBin13Rate
Type: u64
Default: 0
HistBin14Count

Type: u64
Default: 0
HistBin14Name

Type: string
HistBin14Rate
Type: u64
Default: 0
HistBin15Count

Type: u64
Default: 0
HistBin15Name

Type: string
HistBin15Rate
Type: u64
Default: 0
2688
Read-Only Attribute
Description
HistBin16Count

Type: u64
Default: 0
HistBin16Name

Type: string
HistBin16Rate
Type: u64
Default: 0
HistBin1Count

Type: u64
Default: 0
HistBin1Name

Type: string
HistBin1Rate
Type: u64
Default: 0
HistBin2Count

Type: u64
Default: 0
HistBin2Name

Type: string
HistBin2Rate
Type: u64
Default: 0
HistBin3Count

Type: u64
Default: 0
HistBin3Name

Type: string
HistBin3Rate
Type: u64
Default: 0
HistBin4Count

Type: u64
Default: 0
HistBin4Name

Type: string
HistBin4Rate
Type: u64
Default: 0
HistBin5Count

Type: u64
Default: 0
HistBin5Name

Type: string
2689
Read-Only Attribute
Description
HistBin5Rate
Type: u64
Default: 0
HistBin6Count

Type: u64
Default: 0
HistBin6Name

Type: string
HistBin6Rate
Type: u64
Default: 0
HistBin7Count

Type: u64
Default: 0
HistBin7Name

Type: string
HistBin7Rate
Type: u64
Default: 0
HistBin8Count

Type: u64
Default: 0
HistBin8Name

Type: string
HistBin8Rate
Type: u64
Default: 0
HistBin9Count

Type: u64
Default: 0
HistBin9Name

Type: string
HistBin9Rate
Type: u64
Default: 0
InOrderFrameCount

Type: u64
Default: 0
InOrderFrameRate

Type: u64
Default: 0
InSeqFrameCount

Type: u64
Default: 0
InSeqFrameRate
Type: u64
Default: 0
2690
Read-Only Attribute
Description

Type: u64
Default: 0
Type: u64
Default: 0
L1BitCount

Type: u64
Default: 0
L1BitRate

Type: u64
Default: 0
LastArrivalTime
Type: double
Default: 0
LastSeqNum

Type: u64
Default: 0
LateFrameCount

Type: u64
Default: 0
LateFrameRate

Type: u64
Default: 0
MaxFrameLength

Type: u64
Default: 0
MaxInterarrivalTime

Type: double
Default: 0
MaxJitter
will be measured.
Type: double
Default: 0
MaxLatency

Type: double
Default: 0
MinFrameLength

Type: u64
Default: 0
MinInterarrivalTime

Type: double
Default: 0
MinJitter
will be measured.
Type: double
Default: 0
MinLatency

Type: double
Default: 0
2691
Read-Only Attribute
Description
OctetCount

Type: u64
Default: 0
OctetRate

Type: u64
Default: 0
OutSeqFrameCount

Type: u64
Default: 0
OutSeqFrameRate
Type: u64
Default: 0
PortStrayFrames
Type: enum
Default: NA
Possible Values:
Value Description
NA
YES
NO
PrbsBitErrorCount

Type: u64
Default: 0
PrbsBitErrorRate
Type: u64
Default: 0
PrbsBitErrorRatio

Type: double
Default: 0
PrbsErrorFrameCount
Count of total PRBS error frames received.

Type: u64
Default: 0
PrbsErrorFrameRate

Type: u64
Default: 0
PrbsFillOctetCount

Type: u64
Default: 0
PrbsFillOctetRate
Type: u64
Default: 0
ReorderedFrameCount

Type: u64
Default: 0
ReorderedFrameRate

Type: u64
Default: 0

Type: double
Default: 0
2692
RxStreamResults
Read-Only Attribute
Description
SeqRunLength
Type: u64
Default: 0

Type: double
Default: 0
ShortTermAvgJitter

Type: double
Default: 0
ShortTermAvgLatency

Type: double
Default: 0
SigFrameCount

Type: u64
Default: 0
SigFrameRate

Type: u64
Default: 0
StreamIndex
Type: u32
Default: 0

Type: u64
Default: 0
Type: u64
Default: 0

Type: u64
Default: 0
TotalJitter
be measured.
Type: u64
Default: 0
TotalJitterRate

Type: u64
Default: 0
RxStreamResults
Description:
Result object to store receive stream result data for a single port.

Parents: Analyzer
Relations:
2693
RxStreamResults
Side name
(Type)
Relative
Description
AssociatedTxResult
(AssociatedResult)
TxStreamResults
Links Tx and Rx results together so the results can be

correlated
ResultParent
(ResultChild)
Analyzer, RxStreamSummaryResults
SummaryResultParent
RxStreamBlockResults,
RxStreamSummaryResults,
RxTrafficGroupResults
Specifies a child of the summary result. Used to find out

which objects are used in the summary.
RxStreamResults Writable Attributes

RxStreamResults Read-Only Attributes

Read-Only Attribute
Description
AvgInterarrivalTime

Type: double
Default: 0
AvgJitter
will be measured.
Type: double
Default: 0
AvgLatency

Type: double
Default: 0
BitCount

Type: u64
Default: 0
BitRate

Type: u64
Default: 0
CellCount

Type: u64
Default: 0
CellRate

Type: u64
Default: 0
Comp16_1
Type: u16
Default: 0
Comp16_2
Type: u16
Default: 0
Comp16_3
Type: u16
Default: 0
Comp16_4
Type: u16
Default: 0
2694
RxStreamResults
Read-Only Attribute
Description
Comp32
Type: u32
Default: 0
CounterTimestamp

Type: u64
Default: 0
DroppedFrameCount

Type: u64
Default: 0
DroppedFramePercent

Type: double
Default: 0
Percentage rate of the dropped frame.

Type: double
Default: 0
DroppedFrameRate

Type: u64
Default: 0
DuplicateFrameCount

Type: u64
Default: 0
DuplicateFrameRate

Type: u64
Default: 0
ExpectedSeqNum

Type: u64
Default: 0
FcsErrorFrameCount

Type: u64
Default: 0
FcsErrorFrameRate
Type: u64
Default: 0
FirstArrivalTime
Type: double
Default: 0
FrameCount

Type: u64
Default: 0
FrameRate

Type: u64
Default: 0
HistBin10Count

Type: u64
Default: 0
HistBin10Name

Type: string
HistBin10Rate
Type: u64
Default: 0
2695
RxStreamResults
Read-Only Attribute
Description
HistBin11Count

Type: u64
Default: 0
HistBin11Name

Type: string
HistBin11Rate
Type: u64
Default: 0
HistBin12Count

Type: u64
Default: 0
HistBin12Name

Type: string
HistBin12Rate
Type: u64
Default: 0
HistBin13Count

Type: u64
Default: 0
HistBin13Name

Type: string
HistBin13Rate
Type: u64
Default: 0
HistBin14Count

Type: u64
Default: 0
HistBin14Name

Type: string
HistBin14Rate
Type: u64
Default: 0
HistBin15Count

Type: u64
Default: 0
HistBin15Name

Type: string
HistBin15Rate
Type: u64
Default: 0
HistBin16Count

Type: u64
Default: 0
HistBin16Name

Type: string
2696
RxStreamResults
Read-Only Attribute
Description
HistBin16Rate
Type: u64
Default: 0
HistBin1Count

Type: u64
Default: 0
HistBin1Name

Type: string
HistBin1Rate
Type: u64
Default: 0
HistBin2Count

Type: u64
Default: 0
HistBin2Name

Type: string
HistBin2Rate
Type: u64
Default: 0
HistBin3Count

Type: u64
Default: 0
HistBin3Name

Type: string
HistBin3Rate
Type: u64
Default: 0
HistBin4Count

Type: u64
Default: 0
HistBin4Name

Type: string
HistBin4Rate
Type: u64
Default: 0
HistBin5Count

Type: u64
Default: 0
HistBin5Name

Type: string
HistBin5Rate
Type: u64
Default: 0
HistBin6Count

Type: u64
Default: 0
2697
RxStreamResults
Read-Only Attribute
Description
HistBin6Name

Type: string
HistBin6Rate
Type: u64
Default: 0
HistBin7Count

Type: u64
Default: 0
HistBin7Name

Type: string
HistBin7Rate
Type: u64
Default: 0
HistBin8Count

Type: u64
Default: 0
HistBin8Name

Type: string
HistBin8Rate
Type: u64
Default: 0
HistBin9Count

Type: u64
Default: 0
HistBin9Name

Type: string
HistBin9Rate
Type: u64
Default: 0
InOrderFrameCount

Type: u64
Default: 0
InOrderFrameRate

Type: u64
Default: 0
InSeqFrameCount

Type: u64
Default: 0
InSeqFrameRate
Type: u64
Default: 0

Type: u64
Default: 0
Type: u64
Default: 0
2698
RxStreamResults
Read-Only Attribute
Description
L1BitCount

Type: u64
Default: 0
L1BitRate

Type: u64
Default: 0
LastArrivalTime
Type: double
Default: 0
LastSeqNum

Type: u64
Default: 0
LateFrameCount

Type: u64
Default: 0
LateFrameRate

Type: u64
Default: 0
MaxFrameLength

Type: u64
Default: 0
MaxInterarrivalTime

Type: double
Default: 0
MaxJitter
will be measured.
Type: double
Default: 0
MaxLatency

Type: double
Default: 0
MinFrameLength

Type: u64
Default: 0
MinInterarrivalTime

Type: double
Default: 0
MinJitter
will be measured.
Type: double
Default: 0
MinLatency

Type: double
Default: 0
OctetCount

Type: u64
Default: 0
OctetRate

Type: u64
Default: 0
2699
RxStreamResults
Read-Only Attribute
Description
OutSeqFrameCount

Type: u64
Default: 0
OutSeqFrameRate
Type: u64
Default: 0
PortStrayFrames
Type: enum
Default: NA
Possible Values:
Value Description
NA
YES
NO
PrbsBitErrorCount

Type: u64
Default: 0
PrbsBitErrorRate
Type: u64
Default: 0
PrbsBitErrorRatio

Type: double
Default: 0
PrbsErrorFrameCount

Type: u64
Default: 0
PrbsErrorFrameRate

Type: u64
Default: 0
PrbsFillOctetCount

Type: u64
Default: 0
PrbsFillOctetRate
Type: u64
Default: 0
ReorderedFrameCount

Type: u64
Default: 0
ReorderedFrameRate

Type: u64
Default: 0

Type: double
Default: 0
SeqRunLength
Type: u64
Default: 0
2700
RxStreamSummaryResults
Read-Only Attribute
Description

Type: double
Default: 0
ShortTermAvgJitter

Type: double
Default: 0
ShortTermAvgLatency

Type: double
Default: 0
SigFrameCount

Type: u64
Default: 0
SigFrameRate

Type: u64
Default: 0
StreamIndex
Type: u32
Default: 0

Type: u64
Default: 0
Type: u64
Default: 0

Type: u64
Default: 0
TotalJitter
be measured.
Type: u64
Default: 0
TotalJitterRate

Type: u64
Default: 0
Description:
Result object to store receive stream result data across ports.
You do not need to create this object, it is created automatically.

Relations:
Side name
(Type)
Relative
Description
AssociatedTxResult
(AssociatedResult)
TxStreamResults
2701
Side name
(Type)
Relative
Description
ResultParent
(ResultChild)
StreamBlock
ResultChild
(ResultChild)
RxStreamResults
SummaryResultChild
RxStreamResults
Specifies a child of the summary result. Used to find out which

objects are used in the summary.
RxStreamSummaryResults Writable Attributes

RxStreamSummaryResults Read-Only Attributes

Read-Only Attribute
Description
AvgInterarrivalTime

Type: double
Default: 0
AvgJitter
will be measured.
Type: double
Default: 0
AvgLatency

Type: double
Default: 0
BitCount

Type: u64
Default: 0
BitRate

Type: u64
Default: 0
CellCount

Type: u64
Default: 0
CellRate

Type: u64
Default: 0
Comp16_1
Type: u16
Default: 0
Comp16_2
Type: u16
Default: 0
Comp16_3
Type: u16
Default: 0
Comp16_4
Type: u16
Default: 0
Comp32
Type: u32
Default: 0
2702
Read-Only Attribute
Description
CounterTimestamp

Type: u64
Default: 0
DroppedFrameCount

Type: u64
Default: 0
DroppedFramePercent

Type: double
Default: 0

Type: double
Default: 0
DroppedFrameRate

Type: u64
Default: 0
DuplicateFrameCount

Type: u64
Default: 0
DuplicateFrameRate

Type: u64
Default: 0
ExpectedSeqNum

Type: u64
Default: 0
FcsErrorFrameCount

Type: u64
Default: 0
FcsErrorFrameRate
Type: u64
Default: 0
FirstArrivalTime
Type: double
Default: 0
FrameCount

Type: u64
Default: 0
FrameRate

Type: u64
Default: 0
HistBin10Count

Type: u64
Default: 0
HistBin10Name

Type: string
HistBin10Rate
Type: u64
Default: 0
HistBin11Count

Type: u64
Default: 0
2703
Read-Only Attribute
Description
HistBin11Name

Type: string
HistBin11Rate
Type: u64
Default: 0
HistBin12Count

Type: u64
Default: 0
HistBin12Name

Type: string
HistBin12Rate
Type: u64
Default: 0
HistBin13Count

Type: u64
Default: 0
HistBin13Name

Type: string
HistBin13Rate
Type: u64
Default: 0
HistBin14Count

Type: u64
Default: 0
HistBin14Name

Type: string
HistBin14Rate
Type: u64
Default: 0
HistBin15Count

Type: u64
Default: 0
HistBin15Name

Type: string
HistBin15Rate
Type: u64
Default: 0
HistBin16Count

Type: u64
Default: 0
HistBin16Name

Type: string
HistBin16Rate
Type: u64
Default: 0
2704
Read-Only Attribute
Description
HistBin1Count

Type: u64
Default: 0
HistBin1Name

Type: string
HistBin1Rate
Type: u64
Default: 0
HistBin2Count

Type: u64
Default: 0
HistBin2Name

Type: string
HistBin2Rate
Type: u64
Default: 0
HistBin3Count

Type: u64
Default: 0
HistBin3Name

Type: string
HistBin3Rate
Type: u64
Default: 0
HistBin4Count

Type: u64
Default: 0
HistBin4Name

Type: string
HistBin4Rate
Type: u64
Default: 0
HistBin5Count

Type: u64
Default: 0
HistBin5Name

Type: string
HistBin5Rate
Type: u64
Default: 0
HistBin6Count

Type: u64
Default: 0
HistBin6Name

Type: string
2705
Read-Only Attribute
Description
HistBin6Rate
Type: u64
Default: 0
HistBin7Count

Type: u64
Default: 0
HistBin7Name

Type: string
HistBin7Rate
Type: u64
Default: 0
HistBin8Count

Type: u64
Default: 0
HistBin8Name

Type: string
HistBin8Rate
Type: u64
Default: 0
HistBin9Count

Type: u64
Default: 0
HistBin9Name

Type: string
HistBin9Rate
Type: u64
Default: 0
InOrderFrameCount

Type: u64
Default: 0
InOrderFrameRate

Type: u64
Default: 0
InSeqFrameCount

Type: u64
Default: 0
InSeqFrameRate
Type: u64
Default: 0

Type: u64
Default: 0
Type: u64
Default: 0
L1BitCount

Type: u64
Default: 0
2706
Read-Only Attribute
Description
L1BitRate

Type: u64
Default: 0
LastArrivalTime
Type: double
Default: 0
LastSeqNum

Type: u64
Default: 0
LateFrameCount

Type: u64
Default: 0
LateFrameRate

Type: u64
Default: 0
MaxFrameLength

Type: u64
Default: 0
MaxInterarrivalTime

Type: double
Default: 0
MaxJitter
will be measured.
Type: double
Default: 0
MaxLatency

Type: double
Default: 0
MinFrameLength

Type: u64
Default: 0
MinInterarrivalTime

Type: double
Default: 0
MinJitter
will be measured.
Type: double
Default: 0
MinLatency

Type: double
Default: 0
OctetCount

Type: u64
Default: 0
OctetRate

Type: u64
Default: 0
OutSeqFrameCount

Type: u64
Default: 0
2707
Read-Only Attribute
Description
OutSeqFrameRate
Type: u64
Default: 0
PortStrayFrames
Type: enum
Default: NA
Possible Values:
Value Description
NA
YES
NO
PrbsBitErrorCount

Type: u64
Default: 0
PrbsBitErrorRate
Type: u64
Default: 0
PrbsBitErrorRatio

Type: double
Default: 0
PrbsErrorFrameCount

Type: u64
Default: 0
PrbsErrorFrameRate

Type: u64
Default: 0
PrbsFillOctetCount

Type: u64
Default: 0
PrbsFillOctetRate
Type: u64
Default: 0
ReorderedFrameCount

Type: u64
Default: 0
ReorderedFrameRate

Type: u64
Default: 0

Type: double
Default: 0
SeqRunLength
Type: u64
Default: 0

Type: double
Default: 0
2708
Read-Only Attribute
Description
ShortTermAvgJitter

Type: double
Default: 0
ShortTermAvgLatency

Type: double
Default: 0
SigFrameCount

Type: u64
Default: 0
SigFrameRate

Type: u64
Default: 0
StreamIndex
Type: u32
Default: 0

Type: u64
Default: 0
Type: u64
Default: 0

Type: u64
Default: 0
TotalJitter
be measured.
Type: u64
Default: 0
TotalJitterRate

Type: u64
Default: 0
Description:
Contains TrafficGroup data delivered to one particular port.

Parents: TrafficGroup
Relations:
Side name
(Type)
Relative
Description
AssociatedTxResult
(AssociatedResult)
TxTrafficGroupResults
AssociatedRxResult
(AssociatedResult)
TxTrafficGroupResults
2709
Side name
(Type)
Relative
Description
ContainerResultParent
(ContainerResult)
StreamBlock
General-purpose relation for result objects. For example,

RxTrafficGroupResults objects are linked to the StreamBlock object
with this relation.
ResultParent
(ResultChild)
TrafficGroup
SummaryResultChild
RxStreamResults
Specifies a child of the summary result. Used to find out which objects
are used in the summary.
RxTrafficGroupResults Writable Attributes

RxTrafficGroupResults Read-Only Attributes

Read-Only Attribute
Description
AvgInterarrivalTime

Type: double
Default: 0
AvgJitter
will be measured.
Type: double
Default: 0
AvgLatency

Type: double
Default: 0
BitCount
Number of bits received.

Type: u64
Default: 0
BitRate
Number of bits received over the last 1-second interval.

Type: u64
Default: 0
CellCount
Number of cells received.

Type: u64
Default: 0
CellRate
Number of cells received over last 1-second interval.

Type: u64
Default: 0
Comp16_1
Type: u16
Default: 0
Comp16_2
Type: u16
Default: 0
Comp16_3
Type: u16
Default: 0
Comp16_4
Type: u16
Default: 0
2710
Read-Only Attribute
Description
Comp32
Type: u32
Default: 0
CounterTimestamp

Type: u64
Default: 0
DroppedFrameCount

Type: u64
Default: 0
DroppedFramePercent

Type: double
Default: 0

Type: double
Default: 0
DroppedFrameRate

Type: u64
Default: 0
DroppedFramesPercent
Percentage of frames dropped in transit.

Type: double
Default: 0
DuplicateFrameCount

Type: u64
Default: 0
DuplicateFrameRate

Type: u64
Default: 0
ExpectedSeqNum

Type: u64
Default: 0
FcsErrorFrameCount

Type: u64
Default: 0
FcsErrorFrameRate
Type: u64
Default: 0
FirstArrivalTime
Type: double
Default: 0
FrameCount

Type: u64
Default: 0
FrameRate
Number of frames received over the last 1-second interval.

Type: u64
Default: 0
HistBin10Count

Type: u64
Default: 0
HistBin10Name

Type: string
2711
Read-Only Attribute
Description
HistBin10Rate
Type: u64
Default: 0
HistBin11Count

Type: u64
Default: 0
HistBin11Name

Type: string
HistBin11Rate
Type: u64
Default: 0
HistBin12Count

Type: u64
Default: 0
HistBin12Name

Type: string
HistBin12Rate
Type: u64
Default: 0
HistBin13Count

Type: u64
Default: 0
HistBin13Name

Type: string
HistBin13Rate
Type: u64
Default: 0
HistBin14Count

Type: u64
Default: 0
HistBin14Name

Type: string
HistBin14Rate
Type: u64
Default: 0
HistBin15Count

Type: u64
Default: 0
HistBin15Name

Type: string
HistBin15Rate
Type: u64
Default: 0
HistBin16Count

Type: u64
Default: 0
2712
Read-Only Attribute
Description
HistBin16Name

Type: string
HistBin16Rate
Type: u64
Default: 0
HistBin1Count

Type: u64
Default: 0
HistBin1Name

Type: string
HistBin1Rate
Type: u64
Default: 0
HistBin2Count

Type: u64
Default: 0
HistBin2Name

Type: string
HistBin2Rate
Type: u64
Default: 0
HistBin3Count

Type: u64
Default: 0
HistBin3Name

Type: string
HistBin3Rate
Type: u64
Default: 0
HistBin4Count

Type: u64
Default: 0
HistBin4Name

Type: string
HistBin4Rate
Type: u64
Default: 0
HistBin5Count

Type: u64
Default: 0
HistBin5Name

Type: string
HistBin5Rate
Type: u64
Default: 0
2713
Read-Only Attribute
Description
HistBin6Count

Type: u64
Default: 0
HistBin6Name

Type: string
HistBin6Rate
Type: u64
Default: 0
HistBin7Count

Type: u64
Default: 0
HistBin7Name

Type: string
HistBin7Rate
Type: u64
Default: 0
HistBin8Count

Type: u64
Default: 0
HistBin8Name

Type: string
HistBin8Rate
Type: u64
Default: 0
HistBin9Count

Type: u64
Default: 0
HistBin9Name

Type: string
HistBin9Rate
Type: u64
Default: 0
InOrderFrameCount

Type: u64
Default: 0
InOrderFrameRate

Type: u64
Default: 0
InSeqFrameCount

Type: u64
Default: 0
InSeqFrameRate
Type: u64
Default: 0

Type: u64
Default: 0
2714
Read-Only Attribute
Description
Type: u64
Default: 0
L1BitCount
Number of layer1 bits received.

Type: u64
Default: 0
L1BitRate
Number of layer1 bits received over last 1-second interval.

Type: u64
Default: 0
LastArrivalTime
Type: double
Default: 0
LastSeqNum

Type: u64
Default: 0
LateFrameCount

Type: u64
Default: 0
LateFrameRate

Type: u64
Default: 0
MaxFrameLength

Type: u64
Default: 0
MaxInterarrivalTime

Type: double
Default: 0
MaxJitter
will be measured.
Type: double
Default: 0
MaxLatency

Type: double
Default: 0
MinFrameLength

Type: u64
Default: 0
MinInterarrivalTime

Type: double
Default: 0
MinJitter
will be measured.
Type: double
Default: 0
MinLatency

Type: double
Default: 0
OctetCount

Type: u64
Default: 0
2715
Read-Only Attribute
Description
OctetRate
Number of bytes received over the last 1-second interval.

Type: u64
Default: 0
OutSeqFrameCount

Type: u64
Default: 0
OutSeqFrameRate
Type: u64
Default: 0
PortStrayFrames
Type: enum
Default: NA
Possible Values:
Value Description
NA
YES
NO
PrbsBitErrorCount

Type: u64
Default: 0
PrbsBitErrorRate
Type: u64
Default: 0
PrbsBitErrorRatio

Type: double
Default: 0
PrbsErrorFrameCount

Type: u64
Default: 0
PrbsErrorFrameRate

Type: u64
Default: 0
PrbsFillOctetCount

Type: u64
Default: 0
PrbsFillOctetRate
Type: u64
Default: 0
ReorderedFrameCount

Type: u64
Default: 0
ReorderedFrameRate

Type: u64
Default: 0

Type: double
Default: 0
2716
SaaBindWaitCommand
Read-Only Attribute
Description
SeqRunLength
Type: u64
Default: 0

Type: double
Default: 0
ShortTermAvgJitter

Type: double
Default: 0
ShortTermAvgLatency

Type: double
Default: 0
SigFrameCount

Type: u64
Default: 0
SigFrameRate
Number of Spirent signature frames received over the last 1-second interval.
Type: u64
Default: 0
StreamIndex
Type: u32
Default: 0

Type: u64
Default: 0
Type: u64
Default: 0

Type: u64
Default: 0
TotalJitter
be measured.
Type: u64
Default: 0
TotalJitterRate

Type: u64
Default: 0
TrafficGroup
Logical group of the streamblock.

Type: string
Default: 0
TrafficSubgroup
Logical sub group of the streamblock.

Type: string
Default: 0
SaaBindWaitCommand
2717
SaaDeviceConfig
Description:
Wait a specified time for IPv6 Autoconfiguration sessions to bind.

Parents: Sequencer
SaaBindWaitCommand Writable Attributes

Writable Attribute
Description
ErrorOnFailure
ObjectList
List of SaaBlockConfig object handles.

Type: handle
Default: 0
WaitTime
Number of seconds to wait.

Type: double
Default: 30.0
Range: 0.005 - 2147483647.0
SaaBindWaitCommand Read-Only Attributes

Read-Only Attribute
Description
SaaDeviceConfig
Description:
IPv6 autoconfiguration device config.

Result children (automatically created): SaaDeviceResults, SaaSessionResults
Relations:
Side name
(Type)
Relative
Description
ResultChild
(ResultChild)
SaaDeviceResults
UsesIf
(UsesIf)


SaaDeviceConfig Writable Attributes

Writable Attribute
Description
Active, Name
2718
SaaDeviceGenProtocolParams
Writable Attribute
Description
DupAddrDetection
A procedure for detecting duplicate addresses using neighbor solicitation and advertisement messages.
Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
Specifies that the device will attempt to detect duplicate addresses.
FALSE Specifies that the device will no attempt to detect duplicate addresses.
DupAddrDetectTransmits
Specifies the number of consecutive Neighbor Solicitation messages sent while performing duplicate address
detection on a tentative address.
Type: u8
Default: 1
Range: 1 - 255
RetransTimer
Specifies the delay, in msec, between consecutive Neighbor Solicitation transmissions performed during duplicate
address detection.
Type: u32
Default: 1000
Range: 1000 - 4294967295
RouterSolicitationRetransTimer
Specifies the delay, in msec, between router solicitation messages.

Type: u32
Default: 3000
Range: 1000 - 4294967295
RouterSolicitationRetries
Specifies the number of times to resend router solicitation to the all-routers multicast group. If no valid router
advertisement is received within this period, the device returns to the IDLE state and is considered an RA timeout
failure.
Type: u32
Default: 2

Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
SaaDeviceConfig Read-Only Attributes

Read-Only Attribute
Description
State
SaaDeviceGenProtocolParams
Description:
IPv6 autoconfiguration configuration settings for the wizard.

2719
SaaDeviceResults
SaaDeviceGenProtocolParams Writable Attributes

Writable Attribute
Description
Active, Name
DupAddrDetection
A procedure for detecting duplicate addresses using neighbor solicitation and advertisement messages.
Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
Specifies that the device will attempt to detect duplicate addresses.
FALSE Specifies that the device will no attempt to detect duplicate addresses.
DupAddrDetectTransmits
Specifies the number of consecutive Neighbor Solicitation messages sent while performing duplicate address
detection on a tentative address.
Type: u8
Default: 1
Range: 1 - 255
RetransTimer
Specifies the delay, in msec, between consecutive Neighbor Solicitation transmissions performed during duplicate
address detection.
Type: u32
Default: 1000
Range: 1000 - 4294967295
RouterSolicitationRetransTimer
Specifies the delay, in msec, between router solicitation messages.

Type: u32
Default: 3000
Range: 1000 - 4294967295
RouterSolicitationRetries
Specifies the number of times to resend router solicitation to the all-routers multicast group. If no valid router
advertisement is received within this period, the device returns to the IDLE state and is considered an RA timeout
failure.
Type: u32
Default: 2
SaaDeviceGenProtocolParams Read-Only Attributes

SaaDeviceResults
Description:
IPv6 Autoconfiguration results.

Parents: SaaDeviceConfig
Relations:
Side name
(Type)
Relative
Description
ResultParent
(ResultChild)
SaaDeviceConfig
SaaDeviceResults Writable Attributes

2720
SaaPortConfig
SaaDeviceResults Read-Only Attributes

Read-Only Attribute
Description
BindingState
State of the current binding attempts.

Type: enum
Default: 0
Possible Values:
Value
Description
SUCCESS All interfaces were bound to addresses.
PARTIAL
Some interfaces did not bind an address.
FAILED
None of the interfaces were bound to an address due to either DAD failures or RA timeouts.
NONE
Binding has not been initiated.
CurrAttempt
Number of interfaces attempting to bind to an address.

Type: u32
Default: 0
CurrBound
Number of interfaces currently bound to an address.

Type: u32
Default: 0
CurrIdle
Number of interfaces not currently attempting to bind to an address.

Type: u32
Default: 0
State
State of an IPv6 Autoconfiguration session.

Type: enum
Default: 0
Possible Values:
Value
Description
IDLE
Autoconfiguration has not been initiated.
ESTABLISHING A router solicitation message has been sent.

BOUND
A router advertisement message has been received and an address assigned.
TotAttempt
Total number of attempts to bind addresses for all interfaces.

Type: u32
Default: 0
TotBound
Total number of interfaces bound to an address.

Type: u32
Default: 0
TotDadFailures
Number of duplicate address dectection failures.

Type: u32
Default: 0
TotFailed
Total number of interfaces that failed to bind to an address.

Type: u32
Default: 0
TotRaTimeoutFailures
Number of router advertisements that timed out.

Type: u32
Default: 0
SaaPortConfig
Description:
IPv6 autoconfiguration port config.
2721
SaaPortResults

Result children (automatically created): SaaPortResults
Relations:
Side name
(Type)
Relative
Description
ResultChild
(ResultChild)
SaaPortResults
SaaPortConfig Writable Attributes

Writable Attribute
Description
Active, Name
SaaPortConfig Read-Only Attributes

SaaPortResults
Description:
IPv6 Autoconfiguration port aggregated results.

Parents: SaaPortConfig
Relations:
Side name
(Type)
Relative
Description
ResultParent
(ResultChild)
SaaPortConfig
SaaPortResults Writable Attributes

SaaPortResults Read-Only Attributes

Read-Only Attribute
Description
CurrBound
Number of addresses currently bound to interfaces.

Type: u32
Default: 0
CurrIdle
Number of addresses currently not bound to any interfaces.

Type: u32
Default: 0
RxNbrAdv
Number of neighbor advertisement messages received.

Type: u32
Default: 0
RxRtrAdv
Number of router advertisement messages received.

Type: u32
Default: 0
2722
SaaSessionInfoCommand
Read-Only Attribute
Description
State
State of an IPv6 Autoconfiguration session.

Type: enum
Default: 0
Possible Values:
Value
Description
IDLE
Autoconfiguration has not been initiated.
ESTABLISHING A router solicitation message has been sent.

BOUND
A router advertisement message has been received and an address assigned.
SuccessPercent
Percent of interfaces successfully bound with an address.

Type: double
Default: 0
TotAttempt
Number of attempts to bind addresses to interfaces.

Type: u32
Default: 0
TotBound
Total number of addresses bound to interfaces.

Type: u32
Default: 0
TotDadFailures
Total number of duplicate address detection failures.

Type: u32
Default: 0
TotFailed
Number of failures to bind an address to an interface.

Type: u32
Default: 0
TotRaTimeoutFailures
Total number of router advertisements that timed out.

Type: u32
Default: 0
TxNbrSol
Number of neighbor solicitation messages sent.

Type: u32
Default: 0
TxRtrSol
Number of router solicitation messages sent.

Type: u32
Default: 0
SaaSessionInfoCommand
Description:
Save IPv6 Autoconfiguraton session information.

SaaSessionInfoCommand Writable Attributes

Writable Attribute
Description
2723
SaaSessionResults
Writable Attribute
Description
BlockList

Type: handle
Default: 0
FileName
Name of session information file.

SaveToFile

Type: bool
Default: TRUE
Possible Values:
Value Description
TRUE
Save session info results to file.
FALSE Do not save session info results to file.

TimestampFilename
Specify whether to append a date/time stamp to the end of the file name.
Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
Append a date/time stamp to the end of the file name.
FALSE Do not append a date/time stamp to the end of the file name.
SaaSessionInfoCommand Read-Only Attributes

Read-Only Attribute
Description

SaaSessionResults
Description:
IPv6 autoconfiguration session results.

Parents: SaaDeviceConfig
SaaSessionResults Writable Attributes

Writable Attribute
Description
Active, Name
2724
SaaSessionResults
SaaSessionResults Read-Only Attributes

Read-Only Attribute
Description
ErrorStatus
Specifies the error status of the session.

Type: enum
Default: NONE
Possible Values:
Value
Description
NONE
Specifies that the session bound successfully without error.
DAD
Specifies that the session failed to bind due to a duplicate address detected.
RA_TIMEOUT Specifies that the session failed to bind due to not receiving a valid router advertisement.
GlobalAddr
Specifies the global IPv6 address of the session.

Type: ipv6
Default: ::
InnerVlanId
Specifies the inner VLAN ID of the session.

Type: u16
Default: 1
Lifetime
Specifies the lifetime of the session.

Type: u32
Default: 0
LifetimeLeft
Specifies the session's remaining lifetime.

Type: double
Default: 0
LocalAddr
Specifies the link-local IPv6 address of the session.

Type: ipv6
Default: ::
MacAddr
Specifies the MAC address of the session.

Type: mac
Default: 00-00-00-00-00-00
PreferredLifetime
Specifies the session's preferred lifetime.

Type: u32
Default: 0
PrefixAddr
Specifies the IPv6 prefix of the session.

Type: ipv6
Default: ::
PrefixLength
Specifies the prefix length of the session.

Type: u8
Default: 64
SessionState
Specifies the state of the session.

Type: enum
Default: IDLE
Possible Values:
Value
Description
IDLE
Specifies that the session is IDLE.
ESTABLISHING Specifies that the session is ESTABLISHING.

BOUND
Specifies that the session is BOUND.
FAILED
Specifies that the session FAILED to bind.
Vci
Specifies the VCI of the session.

Type: u16
Default: 32
VlanId
Specifies the VLAN ID of the session.

Type: u16
Default: 1
2725
SaaShowSessionInfoCommand
Read-Only Attribute
Description
Vpi
Specifies the VPI of the session.

Type: u16
Default: 0
SaaShowSessionInfoCommand
Description:
Shows IPv6 autoconfiguration session info.

SaaShowSessionInfoCommand Writable Attributes

Writable Attribute
Description
BlockList

Type: handle
Default: 0
SaaShowSessionInfoCommand Read-Only Attributes

Read-Only Attribute
Description

SaaStartCommand
Description:
Start IPv6 Autoconfiguration.

SaaStartCommand Writable Attributes

Writable Attribute
Description
BlockList

Type: handle
Default: 0
2726
SaaStopCommand
SaaStartCommand Read-Only Attributes

Read-Only Attribute
Description

SaaStopCommand
Description:
Stop IPv6 Autoconfiguration.

SaaStopCommand Writable Attributes

Writable Attribute
Description
BlockList

Type: handle
Default: 0
SaaStopCommand Read-Only Attributes

Read-Only Attribute
Description

SaveAsTclCommand
Description:
Saves the current configuration as one or two Tcl files that use Spirent TestCenter Automation commands.

SaveAsTclCommand Writable Attributes

Writable Attribute
Description
BeforeDisconnectScript
An optional Tcl script to run with the generated script before disconnecting from the Spirent TestCenter
chassis.
Type: string
2727
SaveAsTclWithXmlCommand
Writable Attribute
Description
Config
Handle of the portion of the configuration to save. The default of 1 means system1, which is the root
object of the entire configuration.
Type: handle
Default: 1
FileName
File name to use for the script.

Default: config.tcl
PathReplacements
Type: string
ProcedurePrefix
A prefix to prepend to the generated Tcl procedures to ensure uniqueness.

Type: string
SaveDefault
Type: bool
Default: TRUE
Possible Values:
Value Description
TRUE
FALSE
TclNamespace
Type: string
UseDefaultsForRarelyUsedSettings
Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
FALSE
SaveAsTclCommand Read-Only Attributes

Read-Only Attribute
Description

SaveAsTclWithXmlCommand
Description:
Saves the current configuration as a configuration XML file and a Tcl script that loads the XML configuration file.

SaveAsTclWithXmlCommand Writable Attributes

Writable Attribute
Description
2728
SaveAsTemplateCommand
Writable Attribute
Description
BeforeDisconnectScript
An optional Tcl script to run with the generated script before disconnecting from the Spirent TestCenter chassis.
Type: string
Config
Handle of the portion of the configuration to save. The default of 1 means system1, which is the root object of the
entire configuration.
Type: handle
Default: 1
FileName
File name to use for the script.

Default: config.tcl
PathReplacements
Type: string
ProcedurePrefix
A prefix to add to the generated Tcl procedure names to ensure uniqueness. This can be a namespace like abc::
(abc::procedurename) or a simple text prefix (abcprocedurename).
Type: string
SaveDefault
Whether to include only objects and attributes that are changed from their default settings. This can make the
script much more compact and easier to read. It does not change the way the script functions.
Type: bool
Default: TRUE
Possible Values:
Value Description
TRUE
Include only objects and attributes with changed defaults.
FALSE Include all objects and attributes.

TclNamespace
Type: string
SaveAsTclWithXmlCommand Read-Only Attributes

Read-Only Attribute
Description

SaveAsTemplateCommand
Description:
Save the object as a template.

SaveAsTemplateCommand Writable Attributes

Writable Attribute
Description
ClassFilterList
List of classes that should not be saved to the template.

Type: classId
Default: 0
2729
SaveAsXmlCommand
Writable Attribute
Description
Config
The object that will be saved to a template.

Type: handle
Default: 0
SaveAsSystemDefaultTemplate
Whether to save the template as a system default template or a user template.

Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
Save the template as a system default template.
FALSE Save the template as an user template.

TemplateUri
The URI of the template to save as.

Type: string
SaveAsTemplateCommand Read-Only Attributes

Read-Only Attribute
Description

SaveAsXmlCommand
Description:
Saves the current configuration as an XML file. You can load this XML file using the LoadFromXmlCommand object or the Spirent TestCenter GUI. In the GUI,
choose File / Open, and then set Files of type to Xml files (*.xml).

SaveAsXmlCommand Writable Attributes

Writable Attribute
Description
Config
Handle of the portion of the configuration to save. The default of 1 means system1, which is the root object
of the entire configuration.
Type: handle
Default: 1
ConfigList

Type: handle
Default: 0
FileName
Name of the file to save to.

Default: config.xml
2730
SaveFilterToLibraryCommand
Writable Attribute
Description
SaveDefault
Type: bool
Default: TRUE
Possible Values:
Value Description
TRUE
FALSE
SaveAsXmlCommand Read-Only Attributes

Read-Only Attribute
Description

SavedConfigString
Type: string
Default: 0
SaveFilterToLibraryCommand
Description:
Save a capture pattern matching template.

SaveFilterToLibraryCommand Writable Attributes

Writable Attribute
Description
CaptureProxyId

Type: handle
Default: 0
FileName
Name of the pattern matching template file under which to save.

Type: string
SaveFilterToLibraryCommand Read-Only Attributes

Read-Only Attribute
Description

SaveFrameConfigToPduTemplateCommand
Description:
Save the FrameConfig property of the stream block to a PDU template file located in the Templates subfolder.
2731
SaveResultCommand

SaveFrameConfigToPduTemplateCommand Writable Attributes

Writable Attribute
Description
Category
Category of the PDU template. You can use predefined categories or create new ones.
Type: string
Description
Description of the PDU template.

Type: string
FileName
File name of the PDU template.

StreamBlock

Type: handle
Default: 0
SaveFrameConfigToPduTemplateCommand Read-Only Attributes

Read-Only Attribute
Description

SaveResultCommand
Description:
Save all results configuration data in the system.

SaveResultCommand Writable Attributes

Writable Attribute
Description
CollectResult
Whether command should force results to be updated.

Type: bool
Default: TRUE
Possible Values:
Value Description
TRUE
Command will force a result update.
FALSE Command will not force a update, current result values will be used.
2732
SaveResultsCommand
Writable Attribute
Description
Filename to use for the output file. By default the filename will have the date and time as part of its name, like this
example: Results-2007-08-08_18-37-51.db
OverwriteIfExist
Flag to indicate whether the file will be overwritten if it exists.

Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
If a file with the same name exists it will be overwritten.
FALSE If a file with the same name exists it will be appended to.
ParentEotResultNode
Specifies which object will be the parent of the EotResultNode created by this command. The default of 0 means
the EotResultNode is a child of the system. If the handle is another EotResultNode, this node will be a child of it.
Type: handle
Default: 0
SaveDetailedResults
Type: bool
Default: TRUE
Possible Values:
Value Description
TRUE
FALSE
SaveToDatabase
Flag to indicate whether results should be written to the database.

Type: bool
Default: TRUE
Possible Values:
Value Description
TRUE
Results will be saved to the database.
FALSE Results will be not be saved to the database.
SaveResultCommand Read-Only Attributes

Read-Only Attribute
Description

SaveResultsCommand
Description:
Saves results in a .db file.

SaveResultsCommand Writable Attributes

Writable Attribute
Description
2733
SaveSelectedCaptureDataCommand
Writable Attribute
Description
ClearChartResultAfterSave
Specify whether to clear chart results after saving.

Type: bool
Default: TRUE
Possible Values:
Value Description
TRUE
Clear chart results after saving.
FALSE Do not clear chart results after saving.

CollectResult
Specify whether to collect results before saving.

Type: bool
Default: TRUE
Possible Values:
Value Description
TRUE
Collect results before saving.
FALSE Do not collect results before saving.

LoopMode
Specify whether to append results to an existing file or overwrite the file when looping.
Type: enum
Default: APPEND
Possible Values:
Value
Description
APPEND
Append results to an existing file when looping.
OVERWRITE Overwrite an existing file when looping.

ResultFileName
Name of results file.

SaveDetailedResults
Specify whether to save detailed results.

Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
Save detailed results.
FALSE Do not save detailed results.
SaveResultsCommand Read-Only Attributes

Read-Only Attribute
Description

SaveSelectedCaptureDataCommand
Description:
Save selected captured data to file.

2734
SaveToTccCommand
SaveSelectedCaptureDataCommand Writable Attributes

Writable Attribute
Description
CaptureProxyId

Type: handle
Default: 0
EndFrameIndex
End index of the frame.

Type: u32
Default: 0
FileName
Name of the capture file.

Type: string
FileNameFormat
Specifies the format of the capture file.

Type: enum
Default: PCAP
Possible Values:
Value Description
PCAP PCAP file format.
FileNamePath
Path in which to save the capture file.

Type: string
StartFrameIndex
Start index of the frame.

Type: u32
Default: 0
SaveSelectedCaptureDataCommand Read-Only Attributes

Read-Only Attribute
Description

SaveToTccCommand
Description:
Saves the current configuration as a database file. The database file is in TestCenter Configuration (.tcc) format.
You can load this database file using the LoadFromDatabaseCommand object or the Spirent TestCenter GUI. In the GUI, choose File / Open, and then set
Files of type to TestCenter Configuration (*.tcc).

SaveToTccCommand Writable Attributes

Writable Attribute
Description
2735
SawToothPatternDescriptor
Writable Attribute
Description
Config
Handle of the portion of the configuration to save. The default of 1 means system1, which is the root object
of the entire configuration.
Type: handle
Default: 1
FileName
Name of the file to save to.

Default: config.tcc
SaveToTccCommand Read-Only Attributes

Read-Only Attribute
Description

SawToothPatternDescriptor
Description:
Describes a saw tooth load.

SawToothPatternDescriptor Writable Attributes

Writable Attribute
Description
Active, Name
Height
Maximum height of a sawtooth in the load applied. The LoadType attribute in the ClientLoadProfile object
controls the type of load that is generated.
Type: s32
Default: 30
PauseTime

Type: u32
Default: 20
Repetitions
Number of saw teeth.

Type: u32
Default: 1
SteadyTime
Duration of load within the sawtooth curve. The time unit is controlled by the LoadPhaseDurationUnits
attribute on the ClientLoadPhase object.
Type: u32
Default: 40
SawToothPatternDescriptor Read-Only Attributes

2736
security
security
Description:
Children: None
security Attributes
Attribute
Description
compartments
Type: INTEGER
Default: 0
handlingRestrictions
Type: INTEGER
Default: 0
length
Type: INTEGER
Default: 11
Name
Type: string
security
Type: INTEGER
Default: 1
txControlCode
Type: INTEGER
Default: 0
type
Default: 11
Possible Values:
Value Description
0
End of Options List
NOP
130
Security
131
Loose Source Route
68
Time Stamp
133
Extended Security
Record Route
136
Stream Identifier
137
Strict Source Route
11
MTU Probe
12
MTU Reply
82
Traceroute
147
Address Extension
148
Router Alert
149
selBrdcast
Description:
Children: addrList
2737
SenderIDTLV
selBrdcast Attributes
Attribute
Description
length
Type: INTEGER
Default: 0
Name
Type: string
type
Default: 149
Possible Values:
Value Description
0
End of Options List
NOP
130
Security
131
Loose Source Route
68
Time Stamp
133
Extended Security
Record Route
136
Stream Identifier
137
Strict Source Route
11
MTU Probe
12
MTU Reply
82
Traceroute
147
Address Extension
148
Router Alert
149
SenderIDTLV (overloaded)
SenderIDTLV (EOAM)
SenderIDTLV (serviceoam)
SenderIDTLV Object (EOAM PDU library)

Description:

Children: None
2738
SenderIDTLV
SenderIDTLV Attributes
Attribute
Description
ChassisID
Type: OCTETSTRING
Default: 00
ChassisIDLen
Type: OCTETSTRING
Default: 01
ChassisIDSubtype
Type: OCTETSTRING
Default: 01
Length
Type: OCTETSTRING
Default: 0000
MAD
Type: OCTETSTRING
MADL
Type: OCTETSTRING
Default: 00
MAL
Type: OCTETSTRING
ManAdd
Type: OCTETSTRING
Name
Type: string
Type
Type: OCTETSTRING
Default: 01
SenderIDTLV Object (serviceoam PDU library)

Description:

Children: theChassisID, theManagementAddressDomain
SenderIDTLV Attributes
Attribute
Description
ChassisIDLen
Type: OCTETSTRING
Default: 00
Length
Type: OCTETSTRING
Default: 0000
Name
Type: string
2739
SeqDiffCheckHistogram
Attribute
Description
Type
Type: OCTETSTRING
Default: 01
SeqDiffCheckHistogram
Description:
Sequence Diff Check histogram configuration. InSeqCount, OutSeqCount, SeqRunLength, LastSeqNum, InSeqRate, OutSeqRate, and 16 histogram bin
counters can be retrieved from the results.

Relations:
Side name
(Type)
Relative
Description
ActiveParent
(ActiveHistogram)
AnalyzerConfig

object.
SeqDiffCheckHistogram Writable Attributes

Writable Attribute
Description
Active, Name
BucketSizeList
Type: s64
Default: 0
ConfigMode

Type: enum
Possible Values:
Value
Description
Description

Type: string
Default: (in deltas)
DistributionMode
mode.
Type: enum
Possible Values:
Value
Description
LEFT_MODE
RIGHT_MODE

CUSTOM_MODE
2740
seqNums
Writable Attribute
Description
Type: u32
Default: 1024
LimitList
Type: s64
Default: 0
Type: u32
Default: 8
SeqDiffCheckHistogram Read-Only Attributes

seqNums
Description:
Parents: Gre
Children: GreSeqNum
seqNums Attributes
Attribute
Description
Name
information.
Type: string
Description:
Sequence run length histogram configuration. InSeqCount, OutSeqCount, SeqRunLength, LastSeqNum, InSeqRate, OutSeqRate, and 16 histogram bin
counters can be retrieved from the results. SeqRunLength value gives the number of frames for the current continuous run.

Relations:
Side name
(Type)
Relative
Description
ActiveParent
(ActiveHistogram)
AnalyzerConfig

object.
2741
Sequencer
SeqRunLengthHistogram Writable Attributes

Writable Attribute
Description
Active, Name
BucketSizeList
Type: u32
Default: 0
ConfigMode

Type: enum
Possible Values:
Value
Description
Description

Type: string
Default: (in frames)
DistributionMode
mode.
Type: enum
Possible Values:
Value
Description
LEFT_MODE
RIGHT_MODE

CUSTOM_MODE
Type: u32
Default: 1024
LimitList
Type: u32
Default: 0
Type: u32
Default: 8
SeqRunLengthHistogram Read-Only Attributes

Sequencer
Description:
Used to run a sequence of commands.
2742
Sequencer
Parents: StcSystem
Children: AccessConcentratorGenConfigExpandCommand, AccessConcentratorGenUpdateTrafficCommand, AccessTestGenConfigExpandCommand,
AccessTestGenUpdateAvailablePortsCommand, AccessTestGenUpdateTrafficCommand, AddChartMarkerCommand,
AddResultChartQueryFromResultObjectCommand, AnalyzerFilterCreateCommand, AnalyzerStartCommand, AnalyzerStopCommand, AncpAbortCommand,
AncpAccessLoopGenConfigExpandCommand, AncpClearStatsCommand, AncpImportSubscriberInfoCommand, AncpInitiateAdjacencyCommand,
AncpInitiateAdjacencyWaitCommand, AncpMapSubscriberCommand, AncpPortDownCommand, AncpPortDownWaitCommand, AncpPortUpCommand,
AncpPortUpWaitCommand, AncpStartKeepAliveCommand, AncpStopKeepAliveCommand, AncpTerminateAdjacencyCommand,
AncpTerminateAdjacencyWaitCommand, AncpUnMapSubscriberCommand, ApplyToILCommand, ArpNdStartCommand, ArpNdStartOnAllDevicesCommand,
ArpNdStartOnAllStreamBlocksCommand, ArpNdStopCommand, ArpNdUpdateArpCacheCommand, ArpNdVerifyResolvedCommand, AttachPortsCommand,
BfdAdminDownCommand, BfdAdminUpCommand, BfdDisableDemandModeCommand, BfdEnableDemandModeCommand, BfdInitiatePollCommand,
BfdResumePdusCommand, BfdSetDiagnosticStateCommand, BfdStopPdusCommand, BgpBreakTcpSessionCommand, BgpImportRouteTableCommand,
BgpReadvertiseRouteCommand, BgpRefreshRoutesCommand, BgpRestartRouterCommand, BgpResumeKeepaliveCommand,
BgpResumeTcpSessionCommand, BgpStopKeepaliveCommand, BgpViewRoutesCommand, BgpWithdrawRouteCommand, CaptureDataSaveCommand,
CaptureFilterResetCommand, CaptureFilterResetStartEventCommand, CaptureFilterResetStopEventCommand, CaptureGetFrameCommand,
CaptureGetRawDataCommand, CapturePktPduParserCommand, CaptureReleaseCommand, CaptureStartAllCommand, CaptureStartCommand,
CaptureStopAllCommand, CaptureStopCommand, CaptureViewCommand, ChangeLacpGroupCommand, ChangeMstpRegionCommand,
ChangePimGroupCommand, ChangePimRpmapCommand, ChangeStpTypeCommand, ChannelFlushRxQueueCommand, ChannelReceiveCommand,
ChannelResetCounterCommand, ChannelSendCommand, ChannelStartCommand, ChannelStopCommand, ChassisConnectCommand,
ChassisDisconnectAllCommand, ChassisDisconnectCommand, ClientLoadProfileRunStateWaitCommand, CloneCommand, CollapseResultViewDataCommand,
ConfigBfdIlLoggingCommand, ConfigBgpIlLoggingCommand, ConfigFcFcoeIlLoggingCommand, ConfigIeee1588v2IlLoggingCommand,
ConfigIsisIlLoggingCommand, ConfigLacpIlLoggingCommand, ConfigLdpIlLoggingCommand, ConfigLldpIlLoggingCommand, ConfigOspfv2IlLoggingCommand,
ConfigOspfv3IlLoggingCommand, ConfigPimIlLoggingCommand, ConfigPropertiesCommand, ConfigRipIlLoggingCommand, ConfigRsvpIlLoggingCommand,
ConfigStpIlLoggingCommand, ConfigSyncEthIlLoggingCommand, ConfigureTestModuleCommand, CopyCommand, CopyFilterToPortsCommand,
CounterResultFilterLoadFromTemplateCommand, CounterResultFilterSaveAsTemplateCommand, CreateAndReservePortsCommand,
CreateConnectionCommand, CreateEventMessageResultQueryCommand, CreateFrameConfigFromPduTemplateCommand,
CreateFrameLengthDistributionCommand, CreateFromTemplateCommand, CreateGroupedStreamBlocksCommand,
CreateHighResolutionStreamBlockConfigCommand, CreateIgmpMldHostProtocolCommand, CreateIgmpMldQuerierProtocolCommand,
CreateLogicalPortsCommand, CreateMulticastIpv4GroupCommand, CreateMulticastIpv6GroupCommand, CreateNetworkIfCommand,
CreateNewMulticastGroupCommand, CreateNewMulticastGroupMembershipCommand, CreateNewOptionCommand, CreatePimIpv4GroupsCommand,
CreatePimIpv4MapCommand, CreatePimIpv6GroupsCommand, CreatePimIpv6MapCommand, CreatePosPhyCommand, CreatorCommand,
CustomPropertyCreateCommand, CustomPropertyUpdateCommand, DbGetCommand, DcbExpandConfigCommand, DcbIteratePfcPauseTimeCommand,
DcbIteratePfcQuantaValueCommand, DcbIteratePfcResponseTimeCommand, DcbUpdateConfigCommand, DefineDynamicResultViewCommand,
DeleteCommand, DeleteFileCommand, DetachPortsCommand, DetectSourceMacCommand, DeviceCreateCommand, DeviceGenConfigExpandCommand,
DeviceGenConfigPreviewCommand, DevicesStartAllCommand, DevicesStopAllCommand, DeviceStartCommand, DeviceStopCommand, Dhcpv4AbortCommand,
Dhcpv4AbortServerCommand, Dhcpv4BindCommand, Dhcpv4BindWaitCommand, Dhcpv4CopyOptionsCommand, Dhcpv4ForceRenewFromServerCommand,
Dhcpv4RebindCommand, Dhcpv4ReleaseCommand, Dhcpv4ReleaseWaitCommand, Dhcpv4RenewCommand, Dhcpv4SessionInfoCommand,
Dhcpv4ShowSessionInfoCommand, Dhcpv4StartServerCommand, Dhcpv4StopServerCommand, Dhcpv6AbortCommand, Dhcpv6AbortServerCommand,
Dhcpv6BindCommand, Dhcpv6BindWaitCommand, Dhcpv6ConfirmCommand, Dhcpv6CopyAuthKeyListCommand, Dhcpv6InfoRequestCommand,
Dhcpv6RebindCommand, Dhcpv6ReleaseCommand, Dhcpv6ReleaseWaitCommand, Dhcpv6RenewCommand, Dhcpv6ServerReconfigureRebindCommand,
Dhcpv6ServerReconfigureRenewCommand, Dhcpv6SessionInfoCommand, Dhcpv6ShowSessionInfoCommand, Dhcpv6StartServerCommand,
Dhcpv6StopServerCommand, DistributeNetworkCountCommand, Dot1xAbortAuthCommand, Dot1xDeleteAllCertificateCommand,
Dot1xDownloadCertificateCommand, Dot1xLogoutCommand, Dot1xStartAuthCommand, Dot1xWaitForAuthStateCommand, DownloadFileCommand,
EoamChangeAisRxEnableCommand, EoamChangeInterfaceStatusCommand, EoamChangeLckRxEnableCommand, EoamChangePortStatusCommand,
EoamClearTlvsCommand, EoamContChkRemoteResultsCommand, EoamDelayMeasurementDetailedResultsCommand, EoamGenConfigExpandCommand,
EoamLinkTraceDetailedResultsCommand, EoamLoopbackDetailedResultsCommand, EoamLossMeasurementDetailedResultsCommand,
EoamRequestLinkTracePathCommand, EoamResetMpsToUseDefaultLmrFrameCountValuesCommand,
EoamResetMpsToUseDefaultLossMeasurementOffsetsCommand, EoamResetMpsToUseDefaultTlvsCommand, EoamSaveLinkTracePathCommand,
EoamStartAisCommand, EoamStartAutoMepDiscoveryCommand, EoamStartContChkCommand, EoamStartDelayMeasurementCommand,
EoamStartLckCommand, EoamStartLinkTraceCommand, EoamStartLoopbackCommand, EoamStartLossMeasurementCommand, EoamStopAisCommand,
EoamStopAutoMepDiscoveryCommand, EoamStopContChkCommand, EoamStopDelayMeasurementCommand, EoamStopLckCommand,
EoamStopLinkTraceCommand, EoamStopLoopbackCommand, EoamStopLossMeasurementCommand, EoamUpdateMpTypesCommand,
EOTResultsWriteDatasetCommand, EOTResultsWriteIterationCommand, ExpandBenchmarkConfigCommand, ExpandCustomConfigCommand,
ExpandResultViewDataCommand, ExportDbResultsCommand, ExportFecDetailsCommand, ExportResultsCommand, ExternalDeviceAddNewTypeCommand,
ExternalDeviceCustom10Command, ExternalDeviceCustom1Command, ExternalDeviceCustom2Command, ExternalDeviceCustom3Command,
ExternalDeviceCustom8Command, ExternalDeviceCustom9Command, ExternalDeviceCustomPollingStartCommand, ExternalDeviceCustomPollingStopCommand,
ExternalDeviceDeleteTypeCommand, ExternalDeviceGetAllPortsCommand, ExternalDeviceLoadConfigCommand, ExternalDevicePortStatsStartCommand,
ExternalDevicePortStatsStopCommand, ExternalDeviceRefreshPortsStatusCommand, ExternalDeviceResetCommand, ExternalDeviceRunConfigCommand,
ExternalDeviceSaveCommandMappingCommand, ExternalDeviceSessionConnectCommand, ExternalDeviceSessionDisconnectCommand,
ExternalDeviceSyncMapCommand, ExternalDeviceWriteConfigCommand, FcBaseTestGenUpdateAvailablePortsCommand,
FcFcoeTestGenConfigExpandCommand, FcLoginCommand, FcLogoutCommand, FcoeClearVirtualLinksCommand, FcoeDiscoveryCommand,
FcoeLoginCommand, FcoeLogoutCommand, FcoeStartCommand, FcoeStopCommand, FcoeTestGenConfigExpandCommand,
FcoeTestGenUpdateAvailablePortsCommand, FcPhyClearStatsCommand, FcTestGenUpdateAvailablePortsCommand, FcWaitForAggregateSubStateCommand,
FilePathReplacementCommand, FlapSetupCommand, FrameLengthDistributionLoadFromTemplateCommand,
FrameLengthDistributionSaveAsTemplateCommand, GenerateRawPacketTagsCommand, GenerateStreamBlockFromPcapCommand, GeneratorStartCommand,
GeneratorStopCommand, GeneratorUpdateCommand, GeneratorWaitForStopCommand, GetAllEndpointCommand, GetAllSupportedEndpointTypeCommand,
GetAllSupportedProtocolCommand, GetBfdLoggingConfigCommand, GetBgpLoggingConfigCommand, GetChassisLicenseInfoCommand,
GetConfigInfoCommand, GetEquipmentLogsCommand, GetFcFcoeLoggingConfigCommand, GetFieldOffsetCommand,
GetHighResolutionSamplingResultCommand, GetIeee1588v2LoggingConfigCommand, GetIsisLoggingConfigCommand, GetLacpLoggingConfigCommand,
GetLdpLoggingConfigCommand, GetLldpLoggingConfigCommand, GetObjectInfoCommand, GetObjectsCommand, GetOspfv2LoggingConfigCommand,
GetOspfv3LoggingConfigCommand, GetPimLoggingConfigCommand, GetPluginInfoCommand, GetPreviewDataCommand, GetPropertyTypeMetaInfoCommand,
GetRelationsMetaInfoCommand, GetRelativesCommand, GetRipLoggingConfigCommand, GetRsvpLoggingConfigCommand, GetStpLoggingConfigCommand,
GetSyncEthLoggingConfigCommand, HdlcGetLinkConfigCommand, HdlcSetLinkConfigCommand, HelpCommand, HighResolutionSamplingGetChartCommand,
HighResolutionSamplingStartCommand, HighResolutionSamplingStopCommand, HighResolutionSamplingTriggerCommand, IfStackAddCommand,
IfStackAttachCommand, IfStackGetCommand, IfStackRemoveCommand, IfStackReplaceCommand, IgmpMldJoinGroupsCommand,
IgmpMldLeaveGroupsCommand, IgmpMldRejoinGroupsCommand, IgmpMldStartQuerierCommand, IgmpMldStopQuerierCommand, InstallFirmwareCommand,
InstallRawImageCommand, InstallTestPackageCommand, IptvStartTestCommand, IptvStopTestCommand, IptvWaitForTestCompletionCommand,
IsisClearOverloadBitCommand, IsisReadvertiseLspsCommand, IsisRemoveLspNeighborCommand, IsisRestartIsisRouterCommand, IsisResumeHellosCommand,
IsisSetOverloadBitCommand, IsisStopHellosCommand, IsisViewRoutesCommand, IsisWithdrawIpRoutesCommand, IsisZeroAgeLspCommand,
2743
Sequencer
IterateBurstSizeCommand, IterateComboCommand, IterateFrameSizeCommand, IterateLoadSizeCommand, IterateMulticastGroupCountCommand,

IterateThroughputCommand, IterateTrialCommand, L2LearningStartCommand, L2LearningStopCommand, L2TestBreakLinkCommand,
L2TestLoadTemplateCommand, L2TestReloadRegistersCommand, L2TestRestoreLinkCommand, L2TestSaveTemplateCommand,
L2TestStartLinkFaultSignallingCommand, L2TestStopLinkFaultSignallingCommand, L2tpAbortCommand, L2tpClearStatsCommand, L2tpConnectCommand,
L2tpConnectWaitCommand, L2tpDisconnectCommand, L2tpDisconnectWaitCommand, L2tpNodeInfoCommand, L2tpSessionInfoCommand,
L2tpShowNodeInfoCommand, L2tpShowSessionInfoCommand, L2tpShowTunnelInfoCommand, L2tpTunnelInfoCommand, L4L7GenerateTrafficConfigCommand,
LacpCreateLagCommand, LacpResumePdusCommand, LacpStopPdusCommand, LdpAbortRequestCommand, LdpPseudowireGroupStatusNotificationCommand,
LdpPseudowireStatusNotificationCommand, LdpReadvertiseLspCommand, LdpReadvertisePseudowireGroupCommand, LdpRequestLabelCommand,
LdpRestartRouterCommand, LdpResumeHellosCommand, LdpResumeKeepAlivesCommand, LdpStopHellosCommand, LdpStopKeepAlivesCommand,
LdpWithdrawLspCommand, LdpWithdrawMacAddrCommand, LdpWithdrawPseudowireGroupCommand, LicenseCheckCommand, LicenseDeleteFileCommand,
LicenseDownloadFileCommand, LicenseSetAPIVersionCommand, LicenseShowCommand, LicenseUploadFileCommand, LinkCreateCommand,
LinkDeleteCommand, LinkOamEventLogCommand, LinkOamGenerateVariableRequestsCommand, LinkOamGenerateVariableResponsesCommand,
LinkOamLoadVariableResponsesCommand, LinkOamResumeCommand, LinkOamSaveVariableResponsesCommand, LinkOamStartCommand,
LinkOamStartEventNotificationCommand, LinkOamStartLoopbackRequestCommand, LinkOamStartOrgSpecificCommand,
LinkOamStartVariableRequestCommand, LinkOamStopCommand, LinkOamStopEventNotificationCommand, LinkOamStopLoopbackRequestCommand,
LinkOamStopOrgSpecificCommand, LinkOamStopVariableRequestCommand, LinkOamWaitOnDiscoveryCompleteCommand, LinkReconnectCommand,
LinksReconnectAllCommand, LldpPauseCommand, LldpResumeCommand, LldpShowNeighborsInfoCommand, LoadFilterFromLibraryCommand,
LoadFromDatabaseCommand, LoadFromTemplateCommand, LoadFromXmlCommand, LspPingImportFecInfoFromStreamBlockCommand,
LspPingPausePingCommand, LspPingPauseTraceRouteCommand, LspPingResumePingCommand, LspPingResumeTraceRouteCommand,
ManualScheduleLoadFromTemplateCommand, ManualScheduleSaveAsTemplateCommand, MapPortCommand, ModifyTrafficGroupCommand,
MplsGeneralizedPwBindIfCreateCommand, MplsIpv4PrefixBindIfCreateCommand, MplsIpv4VpnBindIfCreateCommand, MplsIpv6PrefixBindIfCreateCommand,
MplsIpv6VpnBindIfCreateCommand, MplsRsvpTunnelBindIfCreateCommand, MplsStaticBindIfCreateCommand, MplsVcBindIfCreateCommand,
MplsVplsBindIfCreateCommand, MulticastGroupCountCommand, Ospfv2AgeAsbrLsaCommand, Ospfv2AgeExternalLsaCommand,
Ospfv2AgeNetworkLsaCommand, Ospfv2AgeRouterLsaCommand, Ospfv2AgeSummaryLsaCommand, Ospfv2AgeTeLsaCommand, Ospfv2FloodLsasCommand,
Ospfv2PerformGracefulRestartCommand, Ospfv2ReadvertiseLsaCommand, Ospfv2RemoveNetworkLsaLinkCommand, Ospfv2RemoveRouterLsaLinkCommand,
Ospfv2RestartRouterCommand, Ospfv2RestoreRouterCommand, Ospfv2ResumeHellosCommand, Ospfv2ShutdownRouterCommand,
Ospfv2StopHellosCommand, Ospfv2ViewRoutesCommand, Ospfv3AgeExternalLsaCommand, Ospfv3AgeInterAreaPrefixLsaCommand,
Ospfv3AgeInterAreaRouterLsaCommand, Ospfv3AgeIntraAreaPrefixLsaCommand, Ospfv3AgeLinkLsaCommand, Ospfv3AgeNetworkLsaCommand,
Ospfv3AgeNssaLsaCommand, Ospfv3AgeRouterLsaCommand, Ospfv3ReadvertiseLsaCommand, Ospfv3RemoveIfCommand, Ospfv3RemoveRouterIdCommand,
Ospfv3RestoreRoutersCommand, Ospfv3ResumeHellosCommand, Ospfv3ShutdownRoutersCommand, Ospfv3StopHellosCommand,
PauseDynamicResultViewCommand, PfcMeasureResponseTimeCommand, PhyVerifyLinkUpCommand, PimIncrementGenIdCommand,
PimResumeBsmsCommand, PimResumeHellosCommand, PimResumeJoinsCommand, PimSendBsmsCommand, PimSendJoinsCommand,
PimSendPrunesCommand, PimStopBsmsCommand, PimStopHellosCommand, PimStopJoinsCommand, PimSwitchTrafficToDataMdtCommand,
PimSwitchTrafficToDefaultMdtCommand, PingStartCommand, PingStopCommand, PingVerifyConnectivityCommand, PortSetupGetActivePhyCommand,
PortSetupRestartAutoNegotiationCommand, PortSetupSetActivePhyCommand, PppAbortCommand, PppConnectCommand, PppDisconnectCommand,
PppoxAbortCommand, PppoxClearStatsCommand, PppoxConnectCommand, PppoxConnectWaitCommand, PppoxDisconnectCommand,
PppoxDisconnectWaitCommand, PppoxPauseCommand, PppoxResumeCommand, PppoxRetryCommand, PppoxRetryWaitCommand,
PppoxSessionInfoCommand, PppoxShowSessionInfoCommand, PreviewCustomConfigCommand, ProfilesLoadFromTemplateCommand,
ProfilesSaveAsTemplateCommand, ProtocolAdvertiseCommand, ProtocolAttachCommand, ProtocolCreateCommand, ProtocolDetachCommand,
ProtocolEstablishCommand, ProtocolStartCommand, ProtocolStopCommand, QueryResultCommand, RebootEquipmentCommand, RefreshResultViewCommand,
ReleasePortCommand, ReorderRelativesCommand, ReservePortCommand, ResetActiveEventDefaultResponseCommand, ResetConfigCommand,
ResultClearAllTrafficCommand, ResultDataSetCreateCommand, ResultDataSetPauseCommand, ResultDataSetResumeCommand,
ResultDataSetSubscribeCommand, ResultDataSetUnsubscribeCommand, ResultsClearAllCommand, ResultsClearAllProtocolCommand,
ResultsClearChartCommand, ResultsClearRoutingCommand, ResultsClearViewCommand, ResultsSubscribeCommand, ResumeDynamicResultViewCommand,
Rfc2544SetupBackToBackTestCommand, Rfc2544SetupFrameLossTestCommand, Rfc2544SetupLatencyTestCommand,
Rfc2544SetupThroughputTestCommand, Rfc2889SetupAddressCachingCapacityTestCommand, Rfc2889SetupAddressLearningRateTestCommand,
Rfc2889SetupBroadcastFrameForwardingTestCommand, Rfc2889SetupBroadcastFrameLatencyTestCommand, Rfc2889SetupCongestionControlTestCommand,
Rfc2889SetupErroredFramesFilteringTestCommand, Rfc2889SetupForwardingTestCommand, Rfc2889SetupForwardPressureTestCommand,
Rfc2889SetupMaxForwardingRateTestCommand, Rfc3918SetupAggregatedMulticastThroughputTestCommand, Rfc3918SetupJoinLeaveLatencyTestCommand,
Rfc3918SetupMixedClassThroughputTestCommand, Rfc3918SetupMulticastForwardingLatencyTestCommand,
Rfc3918SetupMulticastGroupCapacityTestCommand, Rfc3918SetupScaledGroupForwardingTestCommand, RipPauseRouteUpdateCommand,
RipReadvertiseRouteCommand, RipResumeRouteUpdateCommand, RipViewRoutesCommand, RipWithdrawRouteCommand, RouteGenApplyCommand,
RouteGenGetConfigurableRouteCountCommand, RouteGenGetPrefixLengthDistCommand, RouteGenSetDefaultsCommand,
RoutingConvergenceInjectCommand, RoutingConvergenceMeasureCommand, RoutingConvergenceSetupCommand, RsvpFrrNodeFailureCommand,
RsvpInitiateMakeBeforeBreakCommand, RsvpMoveEroHopsUnderEroObjectCommand, RsvpP2mPGraftEgressSubLspCommand,
RsvpP2mPGraftIngressSubLspCommand, RsvpP2mPPruneEgressSubLspCommand, RsvpP2mPPruneIngressSubLspCommand, RsvpRestartRouterCommand,
RsvpResumeHellosCommand, RsvpStopHellosCommand, RsvpViewCompressedEROCommand, RsvpViewSubLspResultsCommand,
RsvpWaitForRerouteCommand, RunCustomCommand, RunExternalProcessCommand, SaaBindWaitCommand, SaaSessionInfoCommand,
SaaShowSessionInfoCommand, SaaStartCommand, SaaStopCommand, SaveAsTclCommand, SaveAsTclWithXmlCommand, SaveAsTemplateCommand,
SaveAsXmlCommand, SaveFilterToLibraryCommand, SaveFrameConfigToPduTemplateCommand, SaveResultCommand, SaveResultsCommand,
SaveSelectedCaptureDataCommand, SaveToTccCommand, SequencerBreakLoopCommand, SequencerClearCommand, SequencerComment,
SequencerContinueLoopCommand, SequencerDisableCommand, SequencerDoWhileCommand, SequencerElseCommand, SequencerElseIfCommand,
SequencerEnableCommand, SequencerGotoCommand, SequencerGroupCommand, SequencerIfCommand, SequencerInsertBreakpointCommand,
SequencerInsertCommand, SequencerLoopCommand, SequencerMoveCommand, SequencerPauseCommand, SequencerRemoveBreakpointCommand,
SequencerRemoveCommand, SequencerReplaceCommand, SequencerStartCommand, SequencerStepCommand, SequencerStopCommand,
SequencerWhileCommand, SetCounterGroupCommand, SetDurationCommand, SetFirmwareArchivesDirCommand, SetMstpRegionCommand,
SetRawArchivesDirCommand, SetRelationCommand, SetRelativesCommand, SetupPortMappingsCommand, SetupPortsCommand, SipCancelRegsCommand,
SipCancelRegsWaitCommand, SipCreateDataPlaneCommand, SipRegisterCommand, SipRegisterWaitCommand, SipUnregisterCommand,
SonetClearStatsCommand, SonetGetConfigCommand, SonetInjectOneCommand, SonetInjectorCommand, SonetResetAlarmsCommand,
SonetSetConfigCommand, StpInitTopoChangeBridgePortCommand, StpInitTopoChangeCistCommand, StpInitTopoChangeMstiCommand, StpStartCistCommand,
StpStartMstiCommand, StpStopCistCommand, StpStopMstiCommand, StpUpdateMstiCommand, StreamBlockActivateCommand,
StreamBlockAutoSelectTunnelCommand, StreamBlockClearAllTunnelCommand, StreamBlockExpandCommand, StreamBlockGetInfoCommand,
StreamBlockGetOffsetReferenceCommand, StreamBlockGetTunnelCommand, StreamBlockSetTrafficPatternCommand, StreamBlockStartCommand,
StreamBlockStopCommand, StreamBlockUpdateCommand, StreamBlockVerifyForwardingCommand, SubscribeDynamicResultViewCommand,
SubscribeResultsViewCommand, SyncEthConfigChangeCommand, TimedRefreshPauseCommand, TimedRefreshResumeCommand,
TimedResultLoggingStartCommand, TimedResultLoggingStopAllCommand, TrafficGroupLoadSearchCommand, TrafficGroupWeightedLoadSearchCommand,
TwampPauseTestPacketsCommand, TwampRequestSessionsCommand, TwampResumeTestPacketsCommand, TwampStartHostsCommand,
TwampStartSessionsCommand, TwampStopHostsCommand, TwampStopSessionsCommand, UnMapPortCommand, UnsubscribeDynamicResultViewCommand,
UpdateDynamicResultViewCommand, UpdateMplsBindingsCommand, UploadFileCommand, ValidateConfigCommand, ValidateFilterExpressionCommand,
2744
Sequencer
VerifyResultsValueCommand, VerifyRouterUpCommand, VicCreateRequestCommand, VicCreateVifsCommand, VicDeleteRequestCommand,

VicDisableRequestCommand, VicEnableRequestCommand, VicFindVicsCommand, VicFindVifsCommand, VicGetRequestCommand, VicLinkVifsCommand,
VicOpenRequestCommand, VicResetTlvsToDefaultsCommand, VideoClipDeleteCommand, VideoClipDownloadCommand, VideoClipsEnumerateCommand,
ViewControlPlaneMplsBindingCommand, ViewFlappableEventsCommand, ViewMplsBindingsCommand, ViewMplsBindingsSummaryCommand,
VpnAvailableMembersCommand, VpnCreateSitesCommand, VpnSiteGenConfigExpandCommand, VqAnalyzerClearCommand,
VqAnalyzerGenConfigExpandCommand, VqAnalyzerStartCommand, VqAnalyzerStopCommand, WaitCommand, WaitForAggregateSubStateCommand,
WaitForDataPlaneSamplesCommand, WaitForMplsBindingsCommand, WaitForRouterStateCommand, WaitForRoutingEventsCommand,
WaitForStorageEventsCommand, WildcardPreviewCommand
Relations:
Side name
(Type)
Relative
Description
CleanupCommand
(SequencerFinalizeType)
Identifies which command to process as the sequencer stop

routine.
Sequencer Writable Attributes

Writable Attribute
Description
Active, Name
BreakpointList
Collection of command handles that contain breakpoints.

Type: handle
Default: 0
CleanupCommand
Handle of the cleanup command. The cleanup command is executed every time the sequencer is stopped.
Type: handle
Default: 0
DisabledCommandList
Collection of command handles that are disabled.

Type: handle
Default: 0
ErrorHandler
Specifies how to handle errors when running sequencer commands.

Type: enum
Default: PAUSE_ON_ERROR
Possible Values:
Value
Description
PAUSE_ON_ERROR Pause the sequencer on the failed command.
IGNORE_ERROR
Ignore failed commands.
STOP_ON_ERROR
Stop the sequencer on the failed command.
Sequencer Read-Only Attributes

Read-Only Attribute
Description
ElapsedTime, Status
CurrentCommand
Handle of command currently being executed.

Type: handle
Default: 0
IsStepping
Indicates if the sequencer is executing commands in a stepping mode.

Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
Sequencer is executing commands in stepping mode. While in stepping mode, the sequencer will pause
before executing each command.
FALSE Sequencer is executing commands in regular mode.

PausedCommand
Handle of the command the sequencer paused on.

Type: handle
Default: 0
2745
SequencerBreakLoopCommand
Read-Only Attribute
Description
SavesResult
Whether the sequencer contains commands that will save results. This property only updates on sequencer start.
Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
Sequencer contains commands that save results.
FALSE Sequencer does not contains commands that save results.

State
State that the sequencer is currently in.

Type: enum
Default: IDLE
Possible Values:
Value
Description
IDLE
Sequencer is idle (stopped).
INIT
Sequencer is initializing. The INIT state occurs every time the sequencer goes from an idle to a running
state.
RUNNING Sequencer is running a command.

WAIT
Sequencer is waiting for a command to return.
PAUSE
Sequencer is paused.
FINALIZE This state is not valid at this time.

StoppedCommand
Handle of the command the sequencer stopped on.

Type: handle
Default: 0
TestState
Indicates if the test sequence passed or failed. This property is set using SequencerStopCommand.
Type: enum
Default: NONE
Possible Values:
Value
Description
NONE
Default value.
PASSED Test sequence passed.

FAILED
Test sequence failed.
SequencerBreakLoopCommand
Description:
Breaks out of the currently executing loop and executes the next instruction following the loop.

SequencerBreakLoopCommand Writable Attributes

Writable Attribute
Description
2746
SequencerClearCommand
SequencerBreakLoopCommand Read-Only Attributes

Read-Only Attribute
Description

SequencerClearCommand
Description:
Removes all commands from the sequencer or specified loop command.

SequencerClearCommand Writable Attributes

Writable Attribute
Description
ClearCleanupCommand
Whether the commands in the sequencer cleanup routine should also be removed.
Type: bool
Default: TRUE
Possible Values:
Value Description
TRUE
Remove all commands from sequencer cleanup routine.
FALSE Don't remove any commands from sequencer cleanup routine.

CommandParent
Handle of SequencerLoopCommand to clear.

Type: handle
Default: 0
DoDestroy
Whether the command object should be destroyed after it is deleted from the sequencer.
Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
Destroys the command object after it is deleted from sequencer.
FALSE Doesn't destroy command object after it is deleted from sequencer.
SequencerClearCommand Read-Only Attributes

Read-Only Attribute
Description

SequencerComment
Description:
Comment.
2747
SequencerContinueLoopCommand

SequencerComment Writable Attributes

Writable Attribute
Description
Text
Comment.
Type: string
SequencerComment Read-Only Attributes

Read-Only Attribute
Description

SequencerContinueLoopCommand
Description:
Causes sequencer execution to immediately continue to next iteration of current loop.

SequencerContinueLoopCommand Writable Attributes

Writable Attribute
Description
SequencerContinueLoopCommand Read-Only Attributes

Read-Only Attribute
Description

SequencerDisableCommand
Description:
Disables specified sequencer commands.

2748
SequencerDoWhileCommand
SequencerDisableCommand Writable Attributes

Writable Attribute
Description
CommandList
Collection of handles of commands to disable.

Type: handle
Default: 0
SequencerDisableCommand Read-Only Attributes

Read-Only Attribute
Description

Description:
Do-While conditional block. Commands in the Do-While block are executed at least once and then until the condition in the Do-While evaluates false.

2749

2750

SequencerDoWhileCommand Writable Attributes

Writable Attribute
Description
Condition
Value that ExpressionCommand must return in order for Do-While to evaluate true.
Type: enum
Default: PASSED
Possible Values:
Value
Description
PASSED Expression command must return PASSED.
FAILED
ExpressionCommand
Expression command must return FAILED.
Pass/fail command to execute when evaluating Do-While command.

Type: handle
Default: 0
SequencerDoWhileCommand Read-Only Attributes

Read-Only Attribute
Description

2751
SequencerElseCommand
Read-Only Attribute
Description
CurrentIteration
Current iteration number being executed.

Type: u32
Default: 0
Description:
Else conditional block. If commands may be followed by an optional Else command. The Else command is executed only when the condition in the previous
If command evaluates false.

2752

2753
SequencerElseIfCommand

SequencerElseCommand Writable Attributes

Writable Attribute
Description
SequencerElseCommand Read-Only Attributes

Read-Only Attribute
Description

Description:
Else-If conditional block. If commands may be followed by an optional Else If command. The Else If command is executed only when the condition in the
previous If command evaluates false.

2754

2755

2756
SequencerEnableCommand
SequencerElseIfCommand Writable Attributes

Writable Attribute
Description
Condition
Value that ExpressionCommand must return in order for Else-If to evaluate true.
Type: enum
Default: PASSED
Possible Values:
Value
Description
FAILED
ExpressionCommand
Pass/fail command to execute when evaluating Else-If command.

Type: handle
Default: 0
SequencerElseIfCommand Read-Only Attributes

Read-Only Attribute
Description

SequencerEnableCommand
Description:
Enables specified sequencer commands.

SequencerEnableCommand Writable Attributes

Writable Attribute
Description
CommandList
Collection of handles of commands to enable.

Type: handle
Default: 0
SequencerEnableCommand Read-Only Attributes

Read-Only Attribute
Description

SequencerGotoCommand
2757
Description:
Moves sequencer execution index to the specified target command. Only commands on the same level (within the same group/loop) are supported as Goto
targets. Spirent Communications strongly recommends using conditional commands to create branching logic instead of using the Goto command.

SequencerGotoCommand Writable Attributes

Writable Attribute
Description
Command
Target command that we'd like to move execution to.

Type: handle
Default: 0
SequencerGotoCommand Read-Only Attributes

Read-Only Attribute
Description

Description:
Group structure. Commands in the group are executed once.

2758

2759

Relations:
Side name
(Type)
Relative
Description
SequenceToCleanup
(SequencerFinalizeType)
Sequencer
TestCaseConfig
DcbBackToBackTestCaseConfig, DcbCongestionControlTestCaseConfig,
DcbErroredFramesFilteringTestCaseConfig,
DcbMaximumForwardingRateTestCaseConfig,
DcbPfcLoadValidationTestCaseConfig, DcbPfcResponseTimeTestCaseConfig,
DcbQueueputTestCaseConfig, DcbStepTestCaseConfig
SequencerGroupCommand Writable Attributes

Writable Attribute
Description
2760
SequencerIfCommand
SequencerGroupCommand Read-Only Attributes

Read-Only Attribute
Description

SequencerIfCommand
Description:
If conditional block. Commands in the If block are executed only when the condition in the If command evaluates true.

2761
SequencerIfCommand

2762
SequencerInsertBreakpointCommand

SequencerIfCommand Writable Attributes

Writable Attribute
Description
Condition
Value that ExpressionCommand must return in order for If to evaluate true.

Type: enum
Default: PASSED
Possible Values:
Value
Description
FAILED
ExpressionCommand
Pass/fail command to execute when evaluating If command.

Type: handle
Default: 0
SequencerIfCommand Read-Only Attributes

Read-Only Attribute
Description

SequencerInsertBreakpointCommand
Description:
Inserts breakpoints into the sequencer.
2763
SequencerInsertCommand

SequencerInsertBreakpointCommand Writable Attributes

Writable Attribute
Description
CommandList
Collection of handles of commands to insert breakpoints at.

Type: handle
Default: 0
SequencerInsertBreakpointCommand Read-Only Attributes

Read-Only Attribute
Description

SequencerInsertCommand
Description:
Insert commands into the sequencer.

SequencerInsertCommand Writable Attributes

Writable Attribute
Description
CommandList
Collection of command handles to add to the sequencer.

Type: handle
Default: 0
CommandParent
The parent to add commands to. The default (0) adds commands to the root of the sequencer. However, if you
want to add commands to a loop or to the cleanup routine, then specify the parent command handle here.
Type: handle
Default: 0
InsertAfter
Handle of command to insert new commands after.

Type: handle
Default: 0
InsertIndex
Index within parent to insert commands at. The default (-1) will append commands to the end of the parent.
This attribute takes precedence over the InsertAfter attribute.
Type: s32
Default: -1
SequencerInsertCommand Read-Only Attributes

Read-Only Attribute
Description

2764
SequencerLoopCommand
Description:
Looping structure. Commands in the loop are executed once for each iteration.

2765

2766
SequencerMoveCommand

SequencerLoopCommand Writable Attributes

Writable Attribute
Description
ContinuousMode
Indicates if loop should run continuously.

Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
Run loop in continuous mode. IterationCount property is ignored in this mode.
FALSE Run loop the number of times specified by IterationCount property.

IterationCount
Number of loop iterations to execute.

Type: u32
Default: 1
SequencerLoopCommand Read-Only Attributes

Read-Only Attribute
Description

CurrentIteration

Type: u32
Default: 0
SequencerMoveCommand
Description:
Moves commands inside sequencer.

2767
SequencerPauseCommand
SequencerMoveCommand Writable Attributes

Writable Attribute
Description
CommandParent
Handle of a parent command to move command into (if you want to move a command inside or outside
of a loop).
Type: handle
Default: 0
SrcCommand
Handle of a command to move.

Type: handle
Default: 0
TargetCommand
Handle of a command to move command to.

Type: handle
Default: 0
TargetIndex
Index of a command to move command to. Takes precedence over TargetCommand attribute.
Type: s32
Default: -1
SequencerMoveCommand Read-Only Attributes

Read-Only Attribute
Description

SequencerPauseCommand
Description:
Pauses sequencer execution when the currently executing command has completed.

SequencerPauseCommand Writable Attributes

Writable Attribute
Description
SequencerPauseCommand Read-Only Attributes

Read-Only Attribute
Description

SequencerRemoveBreakpointCommand
2768
SequencerRemoveCommand
Description:
Removes breakpoints from the sequencer.

SequencerRemoveBreakpointCommand Writable Attributes

Writable Attribute
Description
CommandList
Collection of handles of commands to remove breakpoints from.

Type: handle
Default: 0
SequencerRemoveBreakpointCommand Read-Only Attributes

Read-Only Attribute
Description

SequencerRemoveCommand
Description:
Deletes commands from the sequencer.

SequencerRemoveCommand Writable Attributes

Writable Attribute
Description
CommandList
Collection of command handles to delete from the sequencer.

Type: handle
Default: 0
DoDestroy
Whether to destroy the command object after it is deleted from the sequencer.
Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
Destroy the command object after it is deleted from sequencer.
FALSE Do not destroy command object after it is deleted from sequencer.
SequencerRemoveCommand Read-Only Attributes

Read-Only Attribute
Description

2769
SequencerReplaceCommand
SequencerReplaceCommand
Description:
Replace a sequencer command with another.

SequencerReplaceCommand Writable Attributes

Writable Attribute
Description
NewCommand
Handle of a command to replace old command with.

Type: handle
Default: 0
OldCommand
Handle of a command to be replaced with a new command.

Type: handle
Default: 0
SequencerReplaceCommand Read-Only Attributes

Read-Only Attribute
Description

SequencerStartCommand
Description:
Start sequencer execution in regular mode.

SequencerStartCommand Writable Attributes

Writable Attribute
Description
SequencerStartCommand Read-Only Attributes

Read-Only Attribute
Description

2770
SequencerStepCommand
SequencerStepCommand
Description:
Starts sequencer execution in stepping mode.

SequencerStepCommand Writable Attributes

Writable Attribute
Description
SequencerStepCommand Read-Only Attributes

Read-Only Attribute
Description

SequencerStopCommand
Description:
Stops the sequencer execution when the currently executing command has completed.

SequencerStopCommand Writable Attributes

Writable Attribute
Description
SequencerTestState
Sets the sequencer TestState property once the sequencer has been stopped.
Type: enum
Default: CHANGE_TO_PASSED
Possible Values:
Value
Description
NO_CHANGE
Does not set the sequencer TestState property.
CHANGE_TO_PASSED Sets the sequencer TestState property to PASSED.

CHANGE_TO_FAILED
StoppedReason
Sets the sequencer TestState property to FAILED.
Indicates why the sequencer was stopped.

Type: string
SequencerStopCommand Read-Only Attributes

Read-Only Attribute
Description

2771
SequencerWhileCommand
Description:
While conditional block. Commands in the While block are executed until the condition in the While evaluates false.

2772

2773
serverId

SequencerWhileCommand Writable Attributes

Writable Attribute
Description
Condition
Value that ExpressionCommand must return in order for While to evaluate true.
Type: enum
Default: PASSED
Possible Values:
Value
Description
FAILED
ExpressionCommand
Pass/fail command to execute when evaluating While command.

Type: handle
Default: 0
SequencerWhileCommand Read-Only Attributes

Read-Only Attribute
Description

CurrentIteration

Type: u32
Default: 0
serverId
Description:
DHCP server identifier option
Parents: DHCPOption
Children: None
serverId Attributes
Attribute
Description
length
Type: OCTETSTRING
Default: 04
2774
ServerProfile
Attribute
Description
Name
more information.
Type: string
reqAddr
Type: IPV4ADDR
Default: 0.0.0.0
type
Type: OCTETSTRING
Default: 36
ServerProfile
Description:
Protocol behavioral characteristics for servers.

Parents: Project
Children: FtpServerProtocolProfile, HttpServerProtocolProfile, RawTcpServerProtocolProfile
Relations:
Side name
(Type)
Relative
Description
FtpProtocolParams, FtpServerProtocolConfig, HttpProtocolParams,

HttpServerProtocolConfig, RawTcpProtocolParams, RawTcpServerProtocolConfig,
SipCalleeProtocolParams, SipCallerProtocolParams, VideoProtocolParams,
ServerProfile Writable Attributes

Writable Attribute
Description
Active, Name
EnableDelayedAck
Whether to enable or disable Delayed ACK on TCP connections.

Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
Enable
FALSE Disable
Ipv4Tos
IPv4 type of service setting to use for application layer traffic.

Type: u8
Default: 192
Range: 0 - 255
Ipv6TrafficClass
IPv6 traffic class settings to use for application layer traffic.

Type: u8
Default: 0
Range: 0 - 255
ProfileName
User-specified name for the profile.

Type: string
2775
ServiceClass
Writable Attribute
Description
RxWindowSizeLimit
Upper limit of advertised Rx Window for TCP connections.

Type: u32
Default: 32768
ServerProfile Read-Only Attributes

ServiceClass
Description:
A set of traffic characteristics with lower and upper bound limits

Parents: Project
Children: ServiceClassParameterThreshold
Relations:
Side name
(Type)
Relative
Description
Observer
(ObserverSource)
TrafficGroup
Traffic characteristics that traffic groups aim to achieve
ServiceClass Writable Attributes

Writable Attribute
Description
Active, Name
ServiceClass Read-Only Attributes

ServiceClassParameterThreshold
Description:
Defines traffic characteristics pertaining to a specific parameter

Parents: ServiceClass
ServiceClassParameterThreshold Writable Attributes

Writable Attribute
Description
Active, Name
Max
Acceptable upper bound value (inclusive) of the parameter being measured

Type: double
Default: 1.0
2776
serviceName
Writable Attribute
Description
Min
Acceptable lower bound value (inclusive) of the parameter being measured

Type: double
Default: 0.0
ParameterId
String identifier specifying which traffic characteristic should be measured. List of possible parameters and result view modes
that support them:
FrameLoss (Interarrivaltime, Basic, Histogram, Forwarding)
MaxLatency (Interarrivaltime, Basic, Histogram, Jitter)
AvgLatency (Basic, Histogram)
Ipv4ChecksumErrorCount (Interarrivaltime, Basic, Histogram, Forwarding)
TcpUdpChecksumErrorCount (Basic, Histogram)
PrbsBitErrorCount (Basic, Histogram, Forwarding)
FcsErrorFrameCount (Basic, Histogram)
DroppedFrameCount (Basic, Forwarding)
DuplicateFrameCount (Basic, Forwarding)
OutSeqFrameCount (Interarrivaltime, Histogram, Jitter)
ReorderedFrameCount (Basic, Forwarding)
LateFrameCount (Basic, Forwarding)
MaxJitter (Jitter)
AvgJitter (Jitter)
AvgInterarrivalTime (Interarrivaltime, Forwarding)
MaxInterarrivalTime (Interarrivaltime, Forwarding)
Type: string
ServiceClassParameterThreshold Read-Only Attributes

serviceName
Description:
Parents: PPPoETag
Children: None
serviceName Attributes
Attribute
Description
length
Type: OCTETSTRING
Default: 0000
Name
more information.
Type: string
type
Type: OCTETSTRING
Default: 0101
value
Type: OCTETSTRING
2777
serviceNameError
serviceNameError
Description:
Parents: PPPoETag
Children: None
serviceNameError Attributes
Attribute
Description
length
Type: OCTETSTRING
Default: 0000
Name
more information.
Type: string
type
Type: OCTETSTRING
Default: 0201
value
Type: OCTETSTRING
SetCounterGroupCommand
Description:
Select a counter group to use (1-16).

SetCounterGroupCommand Writable Attributes

Writable Attribute
Description
GroupIndex
Index to the counter group.

Type: u8
Default: 13
JitterMode
Index to the jitter mode.

Type: u8
Default: 1
Project
Project handle under which the counter group is created.

Type: handle
Default: 0
SetCounterGroupCommand Read-Only Attributes

Read-Only Attribute
Description

2778
SetDurationCommand
SetDurationCommand
Description:
Sets duration specifications for all specified generators in GeneratorList.

SetDurationCommand Writable Attributes

Writable Attribute
Description
DurationBursts

Type: u32
Default: 1000
Range: 1 - 16777215
DurationMode
Type: enum
Default: SECONDS
Possible Values:
Value
Description
CONTINUOUS Sets duration mode to run continuous.
BURSTS
SECONDS
Sets duration mode to number of seconds.
DurationSeconds

Type: double
Default: 10
Range: 0.000064 - 4398046.0
GeneratorList
List of generators to set the specified duration on.

Type: handle
Default: 0
SetDurationCommand Read-Only Attributes

Read-Only Attribute
Description

TestStatus
Test status.
Type: string
SetFirmwareArchivesDirCommand
Description:
Set the location where the firmware packages/zip files are located on the client machine. Example "chos-2.0.100.zip".
NOTE: You must call this command before calling InstallFirmwareCommand or InstallTestPackageCommand, unless the firmware packages are located in
the default firmware directory (example: "{application installation directory}/Firmware/bundle"). If successful, the command returns the firmware packages
found in the specified directory.

2779
SetMstpRegionCommand
SetFirmwareArchivesDirCommand Writable Attributes

Writable Attribute
Description
Dir
The directory where the firmware zip files are located (input).
Type: string
Default: 0
SetFirmwareArchivesDirCommand Read-Only Attributes

Read-Only Attribute
Description

Archives
The firmware zip files found in the specified directory (output).

Type: string
Default: 0
SetMstpRegionCommand
Description:
Creates CIST and MSTIs along with associated VLAN info on specified ports.

SetMstpRegionCommand Writable Attributes

Writable Attribute
Description
InstanceNumList
List of instance numbers for the MSTIs within the specified region.
Type: u16
Default: 0
InstanceVlanList
List of VLAN IDs for each MSTI in the region. Each VLAN ID string is a comma separated list of valid
VLANs. No spaces allowed.
Type: string
Default: 0
MstpRegion
MstpRegion handle to be configured.

Type: handle
Default: 0
StpPortList
List of StpPort handles of type MSTP that need to be added to the region.
Type: handle
Default: 0
2780
SetRawArchivesDirCommand
SetMstpRegionCommand Read-Only Attributes

Read-Only Attribute
Description

SetRawArchivesDirCommand
Description:
Set the location where the raw image files are located on the client machine.
NOTE: You must call this command before calling the InstallRawImageCommand command, unless the raw images are located in the default raw image
directory (example: "{application installation directory}/Firmware/rawimg"). The command returns the raw images found in the specified directory.

SetRawArchivesDirCommand Writable Attributes

Writable Attribute
Description
Dir
The name of the directory where the raw image files are located. Example: "spt9000-2.0.100.img.gz.tgz".
(input)
Type: string
Default: 0
SetRawArchivesDirCommand Read-Only Attributes

Read-Only Attribute
Description

Archives
The files found in the specified directory (output).

Type: string
Default: 0
SetRelationCommand
Description:
Sets relations between objects.

2781
SetRelativesCommand
SetRelationCommand Writable Attributes

Writable Attribute
Description
RelationIdList
This attribute, SrcList, and TargetList are parallel arrays. The nth object in SrcList is related to the nth object in
TargetList using the nth RelationId in this list.
Type: relationId
Default: 1
RemoveAll
Whether to remove existing relation of specified object between objects first.

Type: bool
Default: TRUE
Possible Values:
Value Description
TRUE
Remove existing relations.
FALSE Remove no relations.

SrcList
RelationIdList, this attribute, and TargetList are parallel arrays. The nth object in this list is related to the nth object
in TargetList using the nth RelationId in the RelationIdList list.
Type: handle
Default: 0
SrcTargetMapping
Type: enum
Default: ONE_SRC_TO_ONE_TARGET
Possible Values:
Value
Description
ONE_SRC_TO_ONE_TARGET
EACH_SRC_TO_ALL_TARGET
EACH_TARGET_TO_ALL_SRC
TargetList
RelationIdList, SrcList, and this attribute are parallel arrays. The nth object in SrcList is related to the nth object in
this list using the nth RelationId in the RelationIdList list.
Type: handle
Default: 0
SetRelationCommand Read-Only Attributes

Read-Only Attribute
Description

SetRelativesCommand
Description:
Adds relatives to a single object.

SetRelativesCommand Writable Attributes

Writable Attribute
Description
2782
SetRelativesCommand
Writable Attribute
Description
Config
Handle of the object that will have relatives added to it. You specify the relatives with the RelativesList attribute.
Type: handle
Default: 0
Direction
Direction of the relations. There are three choices: forward, backward, and bidirectional. There are several equivalent strings
for each choice, as follows (case-sensitive):
Type: enum
Possible Values:
Value
Description
DESTINATION
CHILD
CHILDREN
DOWN
DOWNWARD
FORWARD
SOURCE
PARENT
UP
UPWARD
BACKWARD
BIDIRECTIONAL
BOTH
ALL
RelationType
Type of relation to set.

Type: string
RelativesList
List of relatives to add to the object specified by the Config attribute. A relation is added only if it does not already exist.
Type: handle
Default: 0
RemoveAll
Whether to remove all children from an object that is being replaced.

For example, you are adding a new Port child to a Project object that already has 3 other Port children. If RemoveAll is set
to TRUE, all three existing Port children will be removed and the new Port object will replace them. If RemoveAll is set to
FALSE, the three existing Port children will remain and the new Port object will be added to the list of children.
Type: bool
Default: TRUE
Possible Values:
Value Description
TRUE
Remove all children from objects that are being replaced.
FALSE Remove no children.
SetRelativesCommand Read-Only Attributes

Read-Only Attribute
Description

2783
SetupPortMappingsCommand
SetupPortMappingsCommand
Description:
Set up the port mappings between the port object and the chassis. This command uses the chassis/slot/port information from the Port object to create the
mapping.

SetupPortMappingsCommand Writable Attributes

Writable Attribute
Description
SetupPortMappingsCommand Read-Only Attributes

Read-Only Attribute
Description

SetupPortsCommand
Description:

SetupPortsCommand Writable Attributes

Writable Attribute
Description
AutoNegotiation
Type: bool
Default: TRUE
Possible Values:
Value Description
TRUE
FALSE
Duplex
Type: enum
Default: FULL
Possible Values:
Value Description
HALF
FULL
2784
simplePassword
Writable Attribute
Description
LineSpeed
Type: enum
Default: DEFAULT
Possible Values:
Value
Description
DEFAULT
SPEED_10M
SPEED_100M
SPEED_1G
SPEED_10G
Media
Type: enum
Default: DEFAULT
Possible Values:
Value
Description
DEFAULT
COPPER
FIBER
Mtu
Type: u32
Default: 1500
Range: 0 - 16383
PortList
Type: handle
Default: 0
SetupPortsCommand Read-Only Attributes

Read-Only Attribute
Description

simplePassword
Description:
Parents: auth
Children: Password
simplePassword Attributes
Attribute
Description
Name
information.
Type: string
SinusoidPatternDescriptor
Description:
Describes a sinusoidal (sine wave) load type.
2785
SipCalleeProtocolParams

SinusoidPatternDescriptor Writable Attributes

Writable Attribute
Description
Active, Name
Height
Maximum amount of load to apply on the sinusoidal curve. The LoadType attribute in the ClientLoadProfile
object controls the type of load that is generated.
Type: s32
Default: 30
Period
Amount of time it takes to gradually achieve the total load specified in the Height attribute. The time unit is
controlled by the LoadPhaseDurationUnits attribute on the ClientLoadPhase object.
Type: u32
Default: 600
Repetitions
Specify the number of stair steps.

Type: u32
Default: 1
SinusoidPatternDescriptor Read-Only Attributes

Description:
Configure SIP callee specific parameters in the ALP Traffic Wizard.

Relations:
Side name
(Type)
Relative
Description
ClientLoadProfile
ClientLoadProfile
ClientProfile
ClientProfile
ServerProfile
ServerProfile
Specifies the server profile used by a client.
SipCalleeProtocolParams Writable Attributes

Writable Attribute
Description
Active, Name
AuthPasswordFormat
Specify the Password format for MD5 authorization.

Type: string
Default: spirent%u
AuthPasswordNumStart
Specify the UA password for MD5 authorization.

Type: u32
Default: 1
2786
Writable Attribute
Description
AuthPasswordNumStep
Specify the UA password step for MD5 authorization.

Type: u32
Default: 0
AuthType
Flag to specify authentication type.

Type: enum
Default: MD5_DIGEST
Possible Values:
Value
Description
MD5_DIGEST MD5 digest authenticaiton.
AuthUserNameFormat
Specify the UA user name Format for MD5 authorization.

Type: string
Default: spirent%u
AuthUserNameNumStart
Specify the UA user name start number for MD5 authorization.

Type: u32
Default: 10000
AuthUserNameNumStep
Specify the UA user name Step for MD5 authorization.

Type: u32
Default: 1
LocalSipUdpPortNumber
Local SIP UDP port number.

Type: u16
Default: 5060
StartUaNumber
Start UA number.
Type: u64
Default: 10000
StepUaNumberBetweenDevices
Step UA number (between devices).

Type: u64
Default: 2000
StepUaNumberWithinDevices
Step UA number (within devices).

Type: u64
Default: 1
UaNumFormat
UA number format.
Type: string
Default: %06u
UaPrefix
UA prefix.
Type: string
Default: Callee_
UaSuffix
UA suffix.
Type: string
UseOtherUARegMode
Use carried by other UA registration mode.

Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
Use carried by other UA registration.
FALSE Use normal mode for registration.
SipCalleeProtocolParams Read-Only Attributes

2787
SipCallerProtocolParams
SipCallerProtocolParams
Description:
Configure SIP caller specific parameters in the ALP Traffic Wizard.

Relations:
Side name
(Type)
Relative
Description
ClientLoadProfile
ClientLoadProfile
ClientProfile
ClientProfile
ServerProfile
ServerProfile
Specifies the Server profile used by a client.
SipCallerProtocolParams Writable Attributes

Writable Attribute
Description
Active, Name
AuthPasswordFormat
Specify the UA Password Format for MD5 authorization.

Type: string
Default: spirent%u

Type: u32
Default: 1
AuthPasswordNumStep

Type: u32
Default: 0
AuthType
Flag to specify authentication type.

Type: enum
Default: MD5_DIGEST
Possible Values:
Value
Description
MD5_DIGEST MD5 digest authentication.
AuthUserNameFormat
Specify the UA user name Format for MD5 authorization.

Type: string
Default: spirent%u

Type: u32
Default: 10000
AuthUserNameNumStep
Specify the UA user name Step for MD5 authorization.

Type: u32
Default: 1
LocalSipUdpPortNumber
Local SIP UDP port number.

Type: u16
Default: 5060
StartUaNumber
Start UA number.
Type: u64
Default: 10000
2788
SipCancelRegsCommand
Writable Attribute
Description
StepUaNumberBetweenDevices
Step UA number (between devices).

Type: u64
Default: 2000
StepUaNumberWithinDevices
Step UA number (within devices).

Type: u64
Default: 1
UaNumFormat
UA number format.
Type: string
Default: %08u
UaPrefix
UA prefix.
Type: string
Default: Caller_
UaSuffix
UA suffix.
Type: string
UseOtherUARegMode
Use normal registration mode or carried by other UA registration mode.

Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
Use carried by other UA registration mode.
FALSE Use normal registration mode.
SipCallerProtocolParams Read-Only Attributes

SipCancelRegsCommand
Description:
Wait for completion of the SipCancelRegs command.

SipCancelRegsCommand Writable Attributes

Writable Attribute
Description
UaProtocolList
SIP UA Protocol Config List.

Type: handle
Default: 0
SipCancelRegsCommand Read-Only Attributes

Read-Only Attribute
Description

2789
SipCancelRegsWaitCommand
SipCancelRegsWaitCommand
Description:
Waits for completion of Registration Cancellation on SIP UA blocks.

Parents: Sequencer
SipCancelRegsWaitCommand Writable Attributes

Writable Attribute
Description
ErrorOnFailure
BlockRegistrationState
Block registration state.

Type: enum
Default: REGISTRATION_CANCELED
Possible Values:
Value
Description
NOT_REGISTERED
Not registered.
REGISTERING
Registering.
REGISTRATION_SUCCEEDED Registration succeeded.

REGISTRATION_FAILED
Registration failed.
REGISTRATION_CANCELED
Registration canceled.
UNREGISTERING
Unregistering.
ObjectList

Type: handle
Default: 0
WaitTime

Type: double
Default: 30.0
Range: 0.005 - 2147483647.0
SipCancelRegsWaitCommand Read-Only Attributes

Read-Only Attribute
Description
SipCreateDataPlaneCommand
Description:
Creates RTP/RTCP stream block.

SipCreateDataPlaneCommand Writable Attributes

Writable Attribute
Description
2790
SipPortResults
Writable Attribute
Description
UaDstProtocolList
SIP User Agent Block Config List for callee.

Type: handle
Default: 0
UaSrcProtocolList
SIP User Agent Block Config List for caller.

Type: handle
Default: 0
SipCreateDataPlaneCommand Read-Only Attributes

Read-Only Attribute
Description

SipPortResults
Description:
SIP port results.

Parents: Port
Relations:
Side name
(Type)
Relative
Description
ResultParent
(ResultChild)
Port
SipPortResults Writable Attributes

SipPortResults Read-Only Attributes

Read-Only Attribute
Description
CallAttemptCount
Count for how many UAs will attempt to start call.

Type: u64
Default: 0
CallAvgTime
Average time of all SIP UAs calls.

Type: u32
Default: 0
CallCumulativeTime

Type: u32
Default: 0
CallFailureCount
Count for how many UAs started calls unsuccessfully.

Type: u64
Default: 0
CallMaxTime
Maximum time in all SIP UAs calls.

Type: u32
Default: 0
2791
SipPortResults
Read-Only Attribute
Description
CallMinTime
Minimum time in all SIP UAs calls.

Type: u32
Default: 0
CallsAnsweredCount
Number of calls answered by this UA.

Type: u64
Default: 0
CallSuccessCount
Count for how many UAs started call successfully.

Type: u64
Default: 0
CallSuccessPercent
Percent of SIP UAs calls successfully.

Type: double
Default: 0
ParentName
Name of the port for which the results apply.

Type: string
RegistrationAttemptCount
SIP UAs count that will attempt to register to SIP proxy.

Type: u64
Default: 0
RegistrationAvgTime
Average registration time of all SIP UAs registration.

Type: u32
Default: 0
RegistrationCumulativeTime

Type: u32
Default: 0
RegistrationFailureCount
SIP UAs count that registered to SIP proxy unsuccessfully.

Type: u64
Default: 0
RegistrationMaxTime
Maximum time in all SIP UAs registration.

Type: u32
Default: 0
RegistrationMinTime
Minimum time in all SIP UAs registration.

Type: u32
Default: 0
RegistrationRetryCount

Type: u64
Default: 0
RegistrationSuccessCount
SIP UAs count that registered to SIP proxy successfully.

Type: u64
Default: 0
RegistrationSuccessPercent
Percentage of SIP UAs registered successfully.

Type: double
Default: 0
SessionRefreshesCount
Number of calls for which a refresh/update was performed by this UA.

Type: u64
Default: 0
TotalUaCount
Total SIP UAs count.

Type: u64
Default: 0
2792
SipRegisterCommand
SipRegisterCommand
Description:
Register SIP UA Blocks to Registrar Proxy.

SipRegisterCommand Writable Attributes

Writable Attribute
Description
UaProtocolList

Type: handle
Default: 0
SipRegisterCommand Read-Only Attributes

Read-Only Attribute
Description

SipRegisterWaitCommand
Description:
Waits for SIP UA blocks to register. If one of the selected SIP UA blocks registered unsuccessfully, this command will block the command sequence from
continuing. Otherwise, this command will not block the command sequence.

Parents: Sequencer
SipRegisterWaitCommand Writable Attributes

Writable Attribute
Description
ErrorOnFailure
BlockRegistrationState
Block registration state.

Type: enum
Default: REGISTRATION_SUCCEEDED
Possible Values:
Value
Description
NOT_REGISTERED
Not registered.
REGISTERING
Registering.
ObjectList
REGISTRATION_FAILED
UNREGISTERING
Unregistering.

Type: handle
Default: 0
2793
SipUaProtocolConfig
Writable Attribute
Description
WaitTime

Type: double
Default: 30.0
Range: 0.005 - 2147483647.0
SipRegisterWaitCommand Read-Only Attributes

Read-Only Attribute
Description
SipUaProtocolConfig
Description:
Create instance of a SIP UA protocol.

Result children (automatically created): SipUaResults
Relations:
Side name
(Type)
Relative
Description
ClientLoadProfile
ClientLoadProfile
ClientProfile
ClientProfile
AudioRtcpStreamBlock
(AudioRtcpStreamBlock)
StreamBlock
Audio RTCP stream block relations.
AudioStreamBlock
(AudioStreamBlock)
StreamBlock
Audio RTP stream block relations.
SipUaProtocolConfig
One SipUaProtocolConfig can have 0..1 associations

with SipUaProtocolConfig.
ResultChild
(ResultChild)
SipUaResults
(UseRegistrationCarrier)
SipUaProtocolConfig
UsesIf
(UsesIf)
Aal5If, EthIIIf, FcIf, GreIf, HdlcIf, Ipv4If,

Ipv6If, ItagIf, L2tpv2If, MplsIf, PppIf,

VideoRtcpStreamBlock
(VideoRtcpStreamBlock)
StreamBlock
Video RTCP stream block relations.
VideoStreamBlock
(VideoStreamBlock)
StreamBlock
Video RTP stream block relations.
2794
SipUaProtocolConfig
SipUaProtocolConfig Writable Attributes

Writable Attribute
Description
Active, Name
AuthPasswordDebug
Controls whether display MD5 Password or not in SIP MD5 authentication packet.
Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
There is Authentication Password field in SIP captured packet for MD5 authentication.
FALSE There is no Authentication Password field in SIP captured packet for MD5 authentication.
AuthPasswordFormat
Specify the password format for MD5 authorization.

Type: string
Default: spirent%u

Type: u32
Default: 1
AuthPasswordNumStep

Type: u32
Default: 0
AuthType
Specifies authentication type.

Type: enum
Default: MD5_DIGEST
Possible Values:
Value
Description
MD5_DIGEST MD5 digest authentication.
AuthUserNameFormat
Specify the UA user name format for MD5 authorization.

Type: string
Default: spirent%u

Type: u32
Default: 10000
AuthUserNameNumStep
Specify the UA user name step for MD5 authorization.

Type: u32
Default: 1
ClientName
A name for the client.

Type: string
DynamicLoad
Type: s32
Default: 30
Range: 1 - 500000
Intra block connection pattern options.

Type: enum
Default: PAIR
Possible Values:
Value
Description
PAIR
Pair connection(s).
BACKBONE_SRC_FIRST
Backbone connection(s) - varying the source address first.
BACKBONE_DST_FIRST
Backbone connection(s) - varying the destination address first.
BACKBONE_INTERLEAVED Backbone connection(s) - varying the source address first.
2795
SipUaProtocolConfig
Writable Attribute
Description
LocalPort
UDP port that emulated SIP UA runs on.

Type: u16
Default: 5060
RegistersFor
User agent block handler registered for gateway.

Type: handle
Default: 1
UaNumFormat
Specify the UA number format.

Type: string
Default: spirent%u
UaNumsPerDevice
Number of UAs per device.

Type: u32
Default: 1
UaNumStart
Starting UA number.
Type: u64
Default: 10000
UaNumStep
UA number step value when UaNumsPerDevice is set larger than 1.

Type: u64
Default: 1
Unused.
Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
Unused.
FALSE Unused.
SipUaProtocolConfig Read-Only Attributes

Read-Only Attribute
Description
LoadProfileRunState
Status indicator to show if the Client Protocol Config is actually running.

Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
Client Protocol Config is actually running.
FALSE Client Protocol Config is not running.

RegState
Specify UA Block's registration state.

Type: enum
Default: NOT_REGISTERED
Possible Values:
Value
Description
NOT_REGISTERED
Not registered.
REGISTERING
Registering.

REGISTRATION_FAILED
UNREGISTERING
Unregistering.
2796
SipUaProtocolProfile
Description:
SIP protocol specific attributes for a SIP UA.

SipUaProtocolProfile Writable Attributes

Writable Attribute
Description
Active, Name
AudioCodec
Emulated audio codec.

Type: enum
Default: G_711
Possible Values:
Value
Description
G_711
G.711 (Mu-law)
G_723_1
G.723.1 (6.3 kbit/s)
G_729
G.729
G_711_LOWRATE
G.711 (LowRate)
G_711_A_LAW
G.711 (A-law)
G_723_1_5_3
G.723.1 (5.3 kbit/s)
G_729_A
G.729A
G_729_B
G.729B
G_729_AB
G.729AB
G_726_32
G.726 (32 kbit/s)
G_711_1_MU_LAW_96
G_711_1_A_LAW_96
AudioPayloadType
Type: u8
Default: 96
Range: 96 - 127
AudioSrcPort
UDP port that RTP/Audio streams should be send out.

Type: u16
Default: 50050
CalleeNumberContext
Specifies Callee Number Context for local tel-URI format.

Type: string
CalleeUriScheme
Specify uniform resource identifier (URI) scheme used to invite callees.

Type: enum
Default: SIP
Possible Values:
Value Description
CallTime
SIP
sip:
TEL
tel:
Specify the duration (in seconds) of calls.

Type: u32
Default: 300
2797
Writable Attribute
Description
CallType
Emulated UA call type: signaling only, audio UA or audio/video UA.

Type: enum
Default: AUDIO_ONLY
Possible Values:
Value
Description
SIGNALING_ONLY Signaling Only.
DefaultRefresher
AUDIO_ONLY
Audio.
AUDIO_VIDEO
Audio.
Specifies Default Refresher as UAC or UAS.

Type: enum
Default: REFRESHER_UAC
Possible Values:
Value
Description
REFRESHER_UAC Default Refresher is UAC.
REFRESHER_UAS Default Refresher is UAS.
EnableRegRefresh
Enable automatic registration refresh.

Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
Enable automatic registration refresh.
FALSE Disable automatic registration refresh.

IncludeSdpStartTs
Includes active time(t) assignment to start timestamp in SDP Time Description.

Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
Active time(t) is set to start timestamp.
FALSE Active time(t) is set to 0.

LocalTelUriFormat
Enable local tel-URI format (RFC3966).

Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
Use local tel-URI format.
FALSE Use global tel-URI format.

MinSessionExpiration
Specify a minimum session expiration (Min-SE) header value for all calls using the session expiration timer. If its
value is 0, this function will be disabled, otherwise, it has value 90-4294967295.
Type: u32
Default: 1800
Range: 0 - 86400
ProxyDomain
Domain suffix that is used to build URI in SIP messages. This is also the SIP proxy server domain name. If this field
isn't set, proxy IP address is used to build URI.
Type: string
ProxyIpv4Addr
SIP Proxy server IPv4 address.

Type: ip
Default: 0.0.0.0
ProxyIpv6Addr
SIP Proxy server IPv6 address.

Type: ipv6
Default: ::
2798
Writable Attribute
Description
ProxyPort
Port that SIP proxy server runs on.

Type: u16
Default: 5060
RegBurstSize
Specify how many registration requests should be send in one second.

Type: u32
Default: 1
RegExpires
Specify how many seconds the registration is valid for.

Type: u32
Default: 604800
Range: 1 - 4294967295
RegRetries
Specify how many registration requests should be send after timeout.

Type: u32
Default: 3
RegsPerSecond
Specify how many registration requests should be send in one second.

Type: u32
Default: 10
RingTime
Specify the waiting time (in seconds) before sending 200 OK after sending "180 Ring" when answering an INVITE
request from a caller.
Type: u32
Default: 0
RtpTrafficType
Specifies RTP traffic type: Simulated RTP or Media Encoded RTP.

Type: enum
Default: SIMULATED_RTP
Possible Values:
Value
Description
SIMULATED_RTP Simulated RTP.
ENCODED_RTP
UseCompactHeaders
Encoded RTP.
Specify whether to use SIP compact header formats or not.

Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
Indicates to use SIP Compact header format.
FALSE Indicates to use SIP normal header format.

UseUaToUaSignaling
Specify whether to send SIP signaling to another UA or to a SIP server.

Type: bool
Default: TRUE
Possible Values:
Value Description
TRUE
Specify whether to send SIP signaling to another UA.
FALSE Specify whether to send SIP signaling to a SIP server.

VideoCodec
video codec to be emulated.

Type: enum
Default: H_263
Possible Values:
Value
Description
H_263
H.263
H_264
H.264
MP4V_ES MP4V-ES
VideoSrcPort
UDP port that RTP/Video streams should be send out.

Type: u16
Default: 50052
2799
SipUaResults
SipUaProtocolProfile Read-Only Attributes

SipUaResults
Description:
SIP UA results.

Parents: SipUaProtocolConfig
Relations:
Side name
(Type)
Relative
Description
ResultParent
(ResultChild)
SipUaProtocolConfig
SipUaResults Writable Attributes

SipUaResults Read-Only Attributes

Read-Only Attribute
Description
BlockIndex
Internally allocated index for SipUaProtocolConfig.

Type: u32
Default: 0
CallAttemptCount
Count for how many UAs will attempt to start call.

Type: u64
Default: 0
CallAvgTime

Type: u32
Default: 0
CallFailureCount
Count for how many UAs started calls unsuccessfully.

Type: u64
Default: 0
CallMaxTime

Type: u32
Default: 0
CallMinTime

Type: u32
Default: 0
CallsAnsweredCount
Number of calls answered by this UA.

Type: u64
Default: 0
CallSuccessCount
Count for how many UAs started call successfully.

Type: u64
Default: 0
CallSuccessPercent
Percent of SIP UAs calls successfully.

Type: double
Default: 0
2800
SipUaResults
Read-Only Attribute
Description
IntendedCallLoad
Intended Call Load as computed by IL. The value is in units of the configured Load type in the Load Profile.
Type: u32
Default: 0
IntendedRegistrationLoad
Intended Registration Load as computed by IL. The value is in units of the configured Load type in the Load
Profile.
Type: u32
Default: 0
MOS
Mean Opinion Score of the caller side. MOS is calculated using the ITU-T, G.107 E-model.
Type: double
Default: 0
MosLqAvg
Average MOS Listening Quality score received during test execution. MOS is calculated using the ITU-T,
G.107 E-model.
Average MOS Listening Quality score received during test execution. MOS is calculated using the ITU-T,
G.107 E-model. Reported for Encoded RTP traffic. To enable dynamic update of this statistic, you must
subscribe to Detailed Stream Results.
Type: double
Default: 0
MosLqMax
Maximum MOS Listening Quality score received during test execution. MOS is calculated using the ITU-T,
G.107 E-model.
Type: double
Default: 0
MosLqMin
Minimum MOS Listening Quality score received during test execution. MOS is calculated using the ITU-T,
G.107 E-model.
Type: double
Default: 0
ParentName
Name of the SipUaProtocolConfig for which the results apply.

Type: string
RegistrationAttemptCount
SIP UAs count that will attempt to register to SIP proxy.

Type: u64
Default: 0
RegistrationAvgTime

Type: u32
Default: 0
RegistrationFailureCount

Type: u64
Default: 0
RegistrationMaxTime
Maximum time in all SIP UAs registration.

Type: u32
Default: 0
RegistrationMinTime
Minimum time in all SIP UAs registration.

Type: u32
Default: 0
RegistrationRetryCount
SIP UAs count that trying to register to SIP proxy unsuccessfully.

Type: u64
Default: 0
RegistrationSuccessCount
SIP UAs count that registered to SIP proxy successfully.

Type: u64
Default: 0
RegistrationSuccessPercent
Percent of SIP UAs registered successfully.

Type: double
Default: 0
2801
SipUnregisterCommand
Read-Only Attribute
Description
SessionRefreshesCount
Number of calls for which a refresh/update was performed.

Type: u64
Default: 0
TotalUaCount
Total SIP UAs count.

Type: u64
Default: 0
SipUnregisterCommand
Description:
Unregister SIP UA Blocks to Registrar Proxy.

SipUnregisterCommand Writable Attributes

Writable Attribute
Description
UaProtocolList

Type: handle
Default: 0
SipUnregisterCommand Read-Only Attributes

Read-Only Attribute
Description

snap
Description:
Parents: LlcRoutedSnap, EthernetSnap, EthernetSnap, EncapEthernetSnap
Children: None
2802
snapheader
snap Attributes
Attribute
Description
EthernetType
Type: EtherTypes
Default: 88B5
Possible Values:
Value Description
0200
XEROX PUP
0201
PUP Addr Trans
0400
Nixdorf
0600
XEROX NS IDP
0660
DLOG
0661
DLOG2
0800
Internet IP
0801
X.75 Internet
0802
NBS Internet
0803
ECMA Internet
0804
Chaosnet
0805
X.25 Level 3
0806
ARP
0807
XNS Compatibility
0808
Frame Relay ARP
8035
RARP
86DD IPv6
880B PPP
8809
Slow Protocol
8847
MPLS Unicast
8848
MPLS Multicast
8863
PPPoE Discovery
8864
PPPoE Session
8906
FCoE
8914
FIP
Name
Type: string
orgcode
Type: OCTETSTRING
Default: 000000
snapheader
Description:
Parents: LlcRoutedSnap, EthernetSnap, EthernetSnap, EncapEthernetSnap
Children: None
2803
SndrID
snapheader Attributes
Attribute
Description
EthernetType
Type: EtherTypes
Default: 88B5
Possible Values:
Value Description
0200
XEROX PUP
0201
PUP Addr Trans
0400
Nixdorf
0600
XEROX NS IDP
0660
DLOG
0661
DLOG2
0800
Internet IP
0801
X.75 Internet
0802
NBS Internet
0803
ECMA Internet
0804
Chaosnet
0805
X.25 Level 3
0806
ARP
0807
XNS Compatibility
0808
Frame Relay ARP
8035
RARP
86DD IPv6
880B PPP
8809
Slow Protocol
8847
MPLS Unicast
8848
MPLS Multicast
8863
PPPoE Discovery
8864
PPPoE Session
8906
FCoE
8914
FIP
Name
Type: string
orgcode
Type: OCTETSTRING
Default: 000000
SndrID (EOAMTLV:SndrID)
Description:
Children: theChassisID, theManagementAddressDomain
2804
SonetAlarmsResults
SndrID Attributes
Attribute
Description
ChassisIDLen
Type: OCTETSTRING
Default: 00
Length
Type: OCTETSTRING
Default: 0000
Name
Type: string
Type
Type: OCTETSTRING
Default: 01
SonetAlarmsResults
Description:
Returns the SONET interface section/line alarms and the SONET interface path alarms.

Parents: Port
Relations:
Side name
(Type)
Relative
Description
ResultParent
(ResultChild)
Port
SonetAlarmsResults Writable Attributes

SonetAlarmsResults Read-Only Attributes

Read-Only Attribute
Description
Aisl
Returns the status of the line AIS alarm.

Returns the status of the section Out of Frame (OOF) alarm.
0 - The alarm has not been detected.
1 - The alarm is currently detected.
2 - The alarm was detected at some time.
Type: u8
Default: 0
Aisp
Returns the status of the path AIS alarm.

Type: u8
Default: 0
AlarmsBasicTimestamp
Deprecated, do not use.

Type: string
Default: 0
2805
SonetAlarmsResults
Read-Only Attribute
Description
C2
Returns the C2 overhead byte.

Type: u8
Default: 0
J0
Returns the J0 trace values in the specified format.

Type: string
Default: 0
J0unst
Returns the status of the J0 unstable alarm.

Type: u8
Default: 0
J1
Returns the J1 trace values in the specified format.

Type: string
Default: 0
J1unst
Returns the status of the J1 unstable alarm.

Type: u8
Default: 0
K1
Returns the K1 overhead byte.

Type: u8
Default: 0
K2
Returns the K2 overhead byte.

Type: u8
Default: 0
Kchg
Returns the status of the K1/K2 changed alarm.

Type: u8
Default: 0
Kunst
Returns the status of the K1/K2 unstable alarm.

Type: u8
Default: 0
LastModified

Type: string
Default: 0
Lof
Returns the status of the section LOF alarm.

Type: u8
Default: 0
Lopp
Returns the status of the path LOP alarm. A LOP alarm is triggered when invalid pointers are found in 8 consecutive frames or
if 8 consecutive new data flags (NDF) are received.
Type: u8
Default: 0
2806
SonetAlarmsResults
Read-Only Attribute
Description
Los
Returns the status of the section LOS alarm.

Type: u8
Default: 0
Oocd
ATM Out-Of-Cell-Delineation.
Type: u8
Default: 0
Oof

Type: u8
Default: 0
Plmp
Returns the status of the path PLM alarm. A PLM alarm is triggered when the observed C2 signal label value does not match the
expected signal label value.
Type: u8
Default: 0
Rdil
Returns the status of the line RDI alarm.

Type: u8
Default: 0
Rdip
Returns the status of the path RDI alarm. A path RDI alarm is triggered upon detecting a loss of signal, loss of frame, or AIS
defect.
Type: u8
Default: 0
S1
Returns the S1 overhead byte.

Type: u8
Default: 0
Timp
Returns the status of the path TIM alarm.

Type: u8
Default: 0
Uneqp
Returns the status of the path Unequipped alarm. A path Unequipped alarm is triggered when C2 signal label value is 0x00.
Type: u8
Default: 0
2807
SonetClearStatsCommand
SonetClearStatsCommand
Description:
Clears all SONET interface statistics.

SonetClearStatsCommand Writable Attributes

Writable Attribute
Description
Port
Port ID.
Type: handle
Default: 0
SonetClearStatsCommand Read-Only Attributes

Read-Only Attribute
Description

SonetConfig
Description:
User configurable section/line settings for the Synchronous Optical Network (SONET) physical interface.

Automatically created from: AtmPhy, POSPhy
SonetConfig Writable Attributes

Writable Attribute
Description
Active, Name
AutoAlarmResponse
Enables or disables the automatic alarm response for the interface.

Type: enum
Default: DISABLE
Possible Values:
Value
Description
ENABLE Enables the automatic alarm response for the interface.
DISABLE Disables the automatic alarm response for the interface.
ExS1
Specifies the expected S1 byte value.

Type: u8
Default: 0
2808
SonetConfig
Writable Attribute
Description
FCS
Frame check sequence size.

Type: enum
Default: FCS32
Possible Values:
Value Description
FCS16 Specifies a 16-bit FCS size.
FCS32 Specifies a 32-bit FCS size.
Framing
Specifies the operational SONET framing format for the interface.

Type: enum
Default: SONET
Possible Values:
Value Description
SONET Synchronous Optical Network (SONET).
SDH
HdlcEnable
Synchronous Digital Hierarchy (SDH).
Enables or disables HDLC encapsulation.

Type: enum
Default: ENABLE
Possible Values:
Value
Description
ENABLE Enables HDLC encapsulation.
DISABLE Disables HDLC encapsulation.
HDLCScrambling
Enables or disables HDLC scrambling.

Type: enum
Default: ENABLE
Possible Values:
Value
Description
ENABLE Enable HDLC scrambling.
DISABLE Disable HDLC scrambling.
InternalPpmAdjust
Specifies the PPM value to adjust the IEEE clock frequency tolerance. This value affects the transmit clock frequency when
Transmit Clock Source is set to InternalPpmAdj.
Type: s32
Default: 0
J0TraceMode
Specifies the format of the J0 trace.

Type: enum
Default: SIXTEEN_BYTES_MSB_CRC7
Possible Values:
Value
Description
ONE_BYTE
Specifies a single byte format.
SIXTEEN_BYTES_MSB
Specifies 16 bytes with the leading high order bit set.
SIXTEEN_BYTES_MSB_CRC7 Specifies 16 bytes with the CRC in the leading byte with it's high order bit set.
SIXTYFOUR_BYTES
Specifies 64 unsynchronized bytes.
SIXTYFOUR_BYTES_CRLF
Specifies 64 bytes synchronized on the trailing carriage return and linefeed characters.
LaisLrdiThreshold
Specifies the number of consecutive frames for which the line Alarm Indicating Signal (AIS) and line Remote Defect Indication
(RDI) must be present before being reported.
Type: u32
Default: 5
LaserEnable
Enables or disables laser output for transmission.

Type: enum
Default: ENABLE
Possible Values:
Value
Description
ENABLE Enables laser output.
DISABLE Disables laser output.
2809
SonetConfig
Writable Attribute
Description
LineSpeed
Specifies the optical speed at which the SONET transport signal will operate.
Type: enum
Default: OC192
Possible Values:
Value
Description
SPEED_10MHZ
10 MHz
SPEED_100MHZ
100 MHz
SPEED_1GHZ
1 GHz
SPEED_10GHZ
10 GHz
SPEED_9_286GHZ 9.286 GHz
LoopbackMode
OC192
OC192
OC48
OC48
OC12
OC12
OC3
OC3
UNKNOWN
Unknown
Specifies support for a variety of loop back modes for debugging and diagnostic purposes.
Type: enum
Default: NONE
Possible Values:
Value
Description
NONE
Disables diagnostic loopback mode for the interface.
LOCAL
This mode will support local loop back.
REMOTE
This mode will support line side or remote loop back to determine if the determine the state or the
optical front-end interface to Serdes.
INTERNAL_XGMII
This mode will support internal XGMII loopback to isolate errors in the IPCore and SONET core.
INTERNAL_SERDES This mode will support Serdes loop back to isolate errors in the 10G Serdes.
RxS1
Provides the S1 byte value received.

Type: u8
Default: 0
TxClockSrc
Specifies the transmitter clock source.

Type: enum
Default: INTERNAL
Possible Values:
Value
Description
INTERNAL
Specifies that a crystal on the interface provides the transmit clock.
INTERNAL_PPM_ADJ Specifies support to adjust the clock PPM within the IEEE clock frequency tolerance.
EXTERNAL
Specifies that the transmit clock is locked to an external reference signal provided to the interface.
BITS
Specifies that a Building Integrated Timing Supply is used as the transmit clock.
RX_LOOP
Specifies that a Clock recovered from the received data is used as the transmit clock.
TxJ0Trace
Transmitted J0 trace values.

Type: u8
Default: 1
TxK1
Specifies the K1 overhead byte to be transmitted.

Type: u8
Default: 0
TxK1K2Enable
Enables or disables the TxK1 and TxK2 bytes.

Type: enum
Default: ENABLE
Possible Values:
Value
Description
ENABLE Enable TxK1 and TxK2 bytes.
DISABLE Disable TxK1 and TxK2 bytes.
2810
SonetGetConfigCommand
Writable Attribute
Description
TxK2
Specifies the K2 overhead byte to be transmitted.

Type: u8
Default: 4
TxS1
Specifies the synchronization status S1 byte value to be transmitted.

Type: u8
Default: 0
SonetConfig Read-Only Attributes

SonetGetConfigCommand
Description:
Returns the current SONET interface configuration.

SonetGetConfigCommand Writable Attributes

Writable Attribute
Description
SonetPhy

Type: handle
Default: 0
SonetGetConfigCommand Read-Only Attributes

Read-Only Attribute
Description

SonetInjectOneCommand
Description:
Triggers an interface section/line/path error.

2811
SonetInjectorCommand
SonetInjectOneCommand Writable Attributes

Writable Attribute
Description
InjectorCommand
Type of error injection condition.

Type: enum
Default: 0
Possible Values:
Value
Description
OFF
Disables the continuous error injection condition.
MOMENTARY Triggers a momentary error condition.

START
InjectorProperty
Enables the continuous error injection condition.
Type of section/line/path error to trigger on the interface.

Type: enum
Default: 0
Possible Values:
Value
Description
SECTION_LOS
Section Loss of Signal (LOS).
SECTION_LOF
Section Loss of Frame (LOF).
SECTION_B1
Section B1 byte error.
LINE_AIS
Line Alarm Indication Signal (AIS).
LINE_RDI
Line Remote Defect Indication (RDI).
LINE_REI
Line Remote Error Indication (REI).
LINE_B2
Line B2 byte error.
PATH_AIS
Path AIS.
PATH_LOP
Path Loss of Pointer (LOP).
PATH_PLM
Path Payload Label Mismatch (PLM).
PATH_RDI
Path RDI.
PATH_REI
Path REI.
PATH_UNEQUIPPED Path Unequipped alarm.

PATH_B3
Port
Path B3 byte error.
Port ID.
Type: handle
Default: 0
SonetInjectOneCommand Read-Only Attributes

Read-Only Attribute
Description

SonetInjectorCommand
Description:
Triggers a list of interface section/line/path errors.

2812
SonetInjectors
SonetInjectorCommand Writable Attributes

Writable Attribute
Description
InjectorCommandArray
Injector trigger command type.

Type: enum
Default: 0
Possible Values:
Value
Description
OFF
MOMENTARY Triggers a momentary error condition.

START
InjectorPropertyArray
Type of section/line/path error to trigger on the interface.

Type: enum
Default: 0
Possible Values:
Value
Description
SECTION_LOS
Section Loss of Signal (LOS).
SECTION_LOF
Section Loss of Frame (LOF).
SECTION_B1
Section B1 byte error.
LINE_AIS
Line Alarm Indication Signal (AIS).
LINE_RDI
Line Remote Defect Indication (RDI).
LINE_REI
Line Remote Error Indication (REI).
LINE_B2
Line B2 byte error.
PATH_AIS
Path AIS.
PATH_LOP
Path Loss of Pointer (LOP).
PATH_PLM
Path Payload Label Mismatch (PLM).
PATH_RDI
Path RDI.
PATH_REI
Path REI.
PATH_UNEQUIPPED Path Unequipped alarm.

PATH_B3
Port
Path B3 byte error.
Port ID.
Type: handle
Default: 0
SonetInjectorCommand Read-Only Attributes

Read-Only Attribute
Description

SonetInjectors
Description:
Controls for the continuous interface section/line error injector triggers for the interface.

2813
SonetInjectors
SonetInjectors Writable Attributes

Writable Attribute
Description
Active, Name
SonetInjectors Read-Only Attributes

Read-Only Attribute
Description
LineAis
Triggers the injection of the Alarm Indication Signal (AIS) alarm, which inserts 0xFF into all bytes, except the section overhead.
Type: enum
Default: OFF
Possible Values:
Value
Description
OFF
MOMENTARY Triggers a momentary error condition. (Not currently supported).

START
LineB2
Triggers the injection of bit errors in the B2 byte value.

Type: enum
Default: OFF
Possible Values:
Value
Description
OFF

START
LineRdi
Triggers the injection of the Remote Defect Indication (RDI) alarm, by inserting 110 in bits 6, 7, and 8 of the K2 byte.
Type: enum
Default: OFF
Possible Values:
Value
Description
OFF

START
LineRei
Triggers the injection of the Remote Error Indication (REI) alarm, by inserting an REI count of 1 in the M1 byte.
Type: enum
Default: OFF
Possible Values:
Value
Description
OFF

START
SectionB1

Type: enum
Default: OFF
Possible Values:
Value
Description
OFF

START
2814
SonetPathConfig
Read-Only Attribute
Description
SectionLof
A severely errored frame condition is triggered to produce a loss of frame (LOF) condition.
Type: enum
Default: OFF
Possible Values:
Value
Description
OFF

START
SectionLos
Triggers the injection of continuous zeros in the incoming data stream to trigger a loss of signal (LOS) condition.
Type: enum
Default: OFF
Possible Values:
Value
Description
OFF

START
SonetPathConfig
Description:
User-configurable path settings for the SONET interface.

SonetPathConfig Writable Attributes

Writable Attribute
Description
Active, Name
ExC2
Specifies the expected C2 byte value.

Type: u8
Default: 22
ExJ1Trace
Specifies the expected J1 trace.

Type: u8
Default: 1
J1TraceMode
Specifies the format of the J1 trace.

Type: enum
Default: SIXTYFOUR_BYTES_CRLF
Possible Values:
Value
Description
ONE_BYTE
Specifies a single byte format.
SIXTEEN_BYTES_MSB
Specifies 16 bytes with the leading high order bit set.
SIXTEEN_BYTES_MSB_CRC7 Specifies 16 bytes with the CRC in the leading byte with it's high order bit set.
RxC2
SIXTYFOUR_BYTES
Specifies 64 unsynchronized bytes.
SIXTYFOUR_BYTES_CRLF
Specifies 64 bytes synchronized on the trailing carriage return and linefeed

characters.
Provides the value of the C2 byte received.

Type: u8
Default: 0
2815
SonetPathInjectors
Writable Attribute
Description
TimpEnable
Enables or disables the Path TIM alarm.

Type: enum
Default: ENABLE
Possible Values:
Value
Description
ENABLE Enable the Path TIM alarm.
DISABLE Disable the Path TIM alarm.
TxC2
Specifies the value of the path label C2 byte to be transmitted.

Type: u8
Default: 22
TxJ1Trace
Transmitted J1 trace values.

Type: u8
Default: 1
SonetPathConfig Read-Only Attributes

SonetPathInjectors
Description:
Controls for the continuous interface path error injector triggers for the interface.

SonetPathInjectors Writable Attributes

Writable Attribute
Description
Active, Name
SonetPathInjectors Read-Only Attributes

Read-Only
Attribute
Description
PathAis
Triggers the injection of a path AIS alarm, which inserts 0xFF into pointer bytes H1, H2, and H3 and Synchronous Payload Envelope
bytes for a particular path.
Type: enum
Default: OFF
Possible Values:
Value
Description
OFF

START
2816
SonetPathInjectors
Read-Only
Attribute
Description
PathB3

Type: enum
Default: OFF
Possible Values:
Value
Description
OFF

START
PathLop
Triggers the injection of a path Loss of Pointer (LOP) alarm. A LOP alarm is triggered when invalid pointers are found in 8 consecutive
frames or if 8 consecutive new data flags (NDF) are received.
Type: enum
Default: OFF
Possible Values:
Value
Description
OFF

START
PathPlm
Triggers the injection of a path Payload Label Mismatch (PLM) alarm. A PLM alarm is triggered when the observed C2 signal label
value does not match that of the expected signal label value.
Type: enum
Default: OFF
Possible Values:
Value
Description
OFF

START
PathRdi
Triggers the injection of a path RDI alarm. A path RDI alarm is triggered upon detecting a loss of signal, loss of frame, or AIS defect.
Type: enum
Default: OFF
Possible Values:
Value
Description
OFF

START
PathRei
Triggers the injection of a path REI alarm. A path REI alarm is triggered when B3 BIP-8 errors are detected at the far end device.
Type: enum
Default: OFF
Possible Values:
Value
Description
OFF

START
PathUnequipped
Triggers the injection of a path Unequipped alarm. A path Unequipped alarm is triggered when C2 signal label value is 0x00.
Type: enum
Default: OFF
Possible Values:
Value
Description
OFF

START
2817
SonetResetAlarmsCommand
SonetResetAlarmsCommand
Description:
Resets SONET interface alarm indicators.

SonetResetAlarmsCommand Writable Attributes

Writable Attribute
Description
Port
Port ID.
Type: handle
Default: 0
SonetResetAlarmsCommand Read-Only Attributes

Read-Only Attribute
Description

SonetResults
Description:
Returns the SONET interface section/line statistics and the SONET interface path statistics.

Parents: Port
Relations:
Side name
(Type)
Relative
Description
ResultParent
(ResultChild)
Port
SonetResults Writable Attributes

SonetResults Read-Only Attributes

Read-Only Attribute
Description
AbortCount
Returns a count of aborted POS packets.

Type: u64
Default: 0
AbortRate
Returns the rate in error/s of aborted POS packets.

Type: u64
Default: 0
2818
SonetResults
Read-Only Attribute
Description
CounterTimestamp

Type: string
Default: 0
DropCount
Returns a count of dropped POS packets.

Type: u64
Default: 0
DropRate
Returns the rate in error/s of dropped POS packets.

Type: u64
Default: 0
LastModified

Type: string
Default: 0
LineCount
Returns a count of B2 BIP-8 errors that have been detected.

Type: u64
Default: 0
LineRate
Returns the ratio of B2 BIP-8 errors to the number of bits in the SONET frame received during the elapsed test
time.
Type: u64
Default: 0
PathCount

Type: u64
Default: 0
PathRate

Type: u64
Default: 0
RateTimestamp

Type: string
Default: 0
REILCount
Returns the Remote Error Indication count, which is the count of B2 errors received the far end.
Type: u64
Default: 0
REILRate
Returns the ratio of REI errors to the number of bits in the SONET frame (except for section overhead) received
during the elapsed test time.
Type: u64
Default: 0
REIPCount
Returns an REI error count, which is a count of the B3 BIP-8 detected at the far end device.
Type: u64
Default: 0
REIPRate
Returns an REI error count, which is a count of the B3 BIP-8 detected at the far end device.
Type: u64
Default: 0
SectionCount

Type: u64
Default: 0
SectionRate
Returns the ratio of B1 BIP-8 errors to the number of bits in the SONET frame received during the elapsed test
time.
Type: u64
Default: 0
2819
SonetSetConfigCommand
SonetSetConfigCommand
Description:
Sets up the SONET interface configuration.

SonetSetConfigCommand Writable Attributes

Writable Attribute
Description
SonetPhy

Type: handle
Default: 0
SonetSetConfigCommand Read-Only Attributes

Read-Only Attribute
Description

sourceAddr (overloaded)
sourceAddr (pim) - Object definition for the following paths:
StreamBlock.Pimv4RegisterStop.sourceAddr
StreamBlock.Pimv4JoinPrune.sourceAddr
StreamBlock.Pimv6RegisterStop.sourceAddr
StreamBlock.Pimv6JoinPrune.sourceAddr
StreamBlock.Pimv4JoinPrune.groupRecords.JoinPrunev4GroupRecord.joinedSources.sourceAddr
StreamBlock.Pimv4JoinPrune.groupRecords.JoinPrunev4GroupRecord.prunedSources.sourceAddr
StreamBlock.Pimv4Assert.sourceAddr
StreamBlock.Pimv6JoinPrune.groupRecords.JoinPrunev6GroupRecord.joinedSources.sourceAddr
StreamBlock.Pimv6JoinPrune.groupRecords.JoinPrunev6GroupRecord.prunedSources.sourceAddr
StreamBlock.Pimv6Assert.sourceAddr
sourceAddr Object (pim PDU library)

Description:

Children: None
2820
sourceAddr
sourceAddr Attributes
Attribute
Description
address
Type: IPV4ADDR
Default: 192.0.0.1
addrFamily
Default: 1
Possible Values:
Value Description
1
IPv4
IPv6
NSAP
HDLC
BBN 1822
802
E.163
E.164
F.69
10
X.121
11
IPX
12
AppleTalk
13
Decnet IV
14
Banyan Vines
15
16
DNS
17
Distinguished Name
18
AS Number
19
XTP over IPv4
20
XTP over IPv6
21
XTP native mode
22
23
24
GWID
encodingType
Type: INTEGER
Default: 0
Name
information.
Type: string

Description:

Children: None
2821
sourceAddr
Attribute
Description
address
Type: IPV6ADDR
Default: 2000:0000:0000:0000:0000:0000:0000:0001
addrFamily
Default: 2
Possible Values:
Value Description
1
IPv4
IPv6
NSAP
HDLC
BBN 1822
802
E.163
E.164
F.69
10
X.121
11
IPX
12
AppleTalk
13
Decnet IV
14
Banyan Vines
15
16
DNS
17
Distinguished Name
18
AS Number
19
XTP over IPv4
20
XTP over IPv6
21
XTP native mode
22
23
24
GWID
encodingType
Type: INTEGER
Default: 0
Name
information.
Type: string

Description:
Parents: joinedSources (StreamBlock.Pimv4JoinPrune.groupRecords.JoinPrunev4GroupRecord.joinedSources)

joinedSources (StreamBlock.Pimv4JoinPrune.groupRecords.JoinPrunev4GroupRecord.prunedSources)
Children: None
2822
sourceAddr
Attribute
Description
address
Type: IPV4ADDR
Default: 192.0.0.1
addrFamily
Default: 1
Possible Values:
Value Description
1
IPv4
IPv6
NSAP
HDLC
BBN 1822
802
E.163
E.164
F.69
10
X.121
11
IPX
12
AppleTalk
13
Decnet IV
14
Banyan Vines
15
16
DNS
17
Distinguished Name
18
AS Number
19
XTP over IPv4
20
XTP over IPv6
21
XTP native mode
22
23
24
GWID
encoding-type
Type: INTEGER
Default: 0
maskLen
Type: INTEGER
Default: 24
Name
more information.
Type: string
rBit
Type: BITSTRING
Default: 0
reserved
Type: BITSTRING
Default: 000000
sBit
Type: BITSTRING
Default: 0
wBit
Type: BITSTRING
Default: 0
2823
sourceAddr

Description:
Parents: joinedSources (StreamBlock.Pimv6JoinPrune.groupRecords.JoinPrunev6GroupRecord.joinedSources)

joinedSources (StreamBlock.Pimv6JoinPrune.groupRecords.JoinPrunev6GroupRecord.prunedSources)
Children: None
Attribute
Description
address
Type: IPV6ADDR
Default: 2000:0000:0000:0000:0000:0000:0000:0001
addrFamily
Default: 2
Possible Values:
Value Description
1
IPv4
IPv6
NSAP
HDLC
BBN 1822
802
E.163
E.164
F.69
10
X.121
11
IPX
12
AppleTalk
13
Decnet IV
14
Banyan Vines
15
16
DNS
17
Distinguished Name
18
AS Number
19
XTP over IPv4
20
XTP over IPv6
21
XTP native mode
22
23
24
GWID
encoding-type
Type: INTEGER
Default: 0
maskLen
Type: INTEGER
Default: 24
Name
more information.
Type: string
rBit
Type: BITSTRING
Default: 0
2824
sourcePortsFabricEgressPathInformation
Attribute
Description
reserved
Type: BITSTRING
Default: 000000
sBit
Type: BITSTRING
Default: 0
wBit
Type: BITSTRING
Default: 0
sourcePortsFabricEgressPathInformation (overloaded)
sourcePortsFabricEgressPathInformation (fc)
sourcePortsFabricEgressPathInformation (fcgs)
sourcePortsFabricEgressPathInformation Object (fc PDU library)

Description:

Children: None
sourcePortsFabricEgressPathInformation Attributes
Attribute
Description
domainId
Type: OCTETSTRING
Default: 00000000
Type: OCTETSTRING
Default: 00000000
egressPortName
Type: WWN
Default: 20:00:10:94:00:00:00:00
Type: OCTETSTRING
Default: 00000000
ingressPortName
Type: WWN
Default: 20:00:10:94:00:00:00:00
Name
Type: string
switchName
Type: WWN
Default: 10:00:10:94:00:00:00:00
2825
sourcePortsFabricIngressPathInformation
sourcePortsFabricEgressPathInformation Object (fcgs PDU library)

Description:

Children: None
sourcePortsFabricEgressPathInformation Attributes
Attribute
Description
domainId
Type: OCTETSTRING
Default: 00000000
Type: OCTETSTRING
Default: 00000000
egressPortName
Type: WWN
Default: 20:00:10:94:00:00:00:00
Type: OCTETSTRING
Default: 00000000
ingressPortName
Type: WWN
Default: 20:00:10:94:00:00:00:00
Name
Type: string
switchName
Type: WWN
Default: 10:00:10:94:00:00:00:00
sourcePortsFabricIngressPathInformation (overloaded)
sourcePortsFabricIngressPathInformation (fc)
sourcePortsFabricIngressPathInformation (fcgs)
sourcePortsFabricIngressPathInformation Object (fc PDU library)

Description:

Children: None
2826
sourcePortsFabricIngressPathInformation
sourcePortsFabricIngressPathInformation Attributes
Attribute
Description
domainId
Type: OCTETSTRING
Default: 00000000
Type: OCTETSTRING
Default: 00000000
egressPortName
Type: WWN
Default: 20:00:10:94:00:00:00:00
Type: OCTETSTRING
Default: 00000000
ingressPortName
Type: WWN
Default: 20:00:10:94:00:00:00:00
Name
Type: string
switchName
Type: WWN
Default: 10:00:10:94:00:00:00:00
sourcePortsFabricIngressPathInformation Object (fcgs PDU library)

Description:

Children: None
sourcePortsFabricIngressPathInformation Attributes
Attribute
Description
domainId
Type: OCTETSTRING
Default: 00000000
Type: OCTETSTRING
Default: 00000000
egressPortName
Type: WWN
Default: 20:00:10:94:00:00:00:00
Type: OCTETSTRING
Default: 00000000
ingressPortName
Type: WWN
Default: 20:00:10:94:00:00:00:00
Name
Type: string
2827
specificIdentificationData
Attribute
Description
switchName
Type: WWN
Default: 10:00:10:94:00:00:00:00
specificIdentificationData (overloaded)
specificIdentificationData (fc)
specificIdentificationData (fcgs)
specificIdentificationData Object (fc PDU library)

Description:
Parents: gnidAccept (StreamBlock.FCoE.fc.fcPayloads.FCPayload-Choice.gnidAccept)

Children: SpecificIdentificationData
specificIdentificationData Attributes
Attribute
Description
Name
information.
Type: string
specificIdentificationData Object (fcgs PDU library)

Description:
Parents: gnidAccept (StreamBlock.GnidAccept)

Children: SpecificIdentificationData
specificIdentificationData Attributes
Attribute
Description
Name
information.
Type: string
2828
SpecificIdentificationData
Description:
Parents: specificIdentificationData
Children: None
SpecificIdentificationData Attributes
Attribute
Description
associatedType
Type: OCTETSTRING
Default: 00000001
ipAddress
Type: OCTETSTRING
ipVersion
Type: IpVersion
Default: 00
Possible Values:
Value Description
00
None
01
IPv4
02
IPv6
Name
Type: string
nodeManagement
Type: NodeManagement
Default: 00
Possible Values:
Value Description
00
IP/UDP/SNMP
01
IP/TCP/Telnet
02
IP/TCP/HTTP
03
IP/TCP/HTTPS
04
P/TCP/HTTP/XML
numberOfAttachedDevices
Type: OCTETSTRING
Default: 00000001
physicalPortNumber
Type: OCTETSTRING
Default: 00000000
reserved
Type: OCTETSTRING
Default: 0000
udpTcpPortNumber
Type: OCTETSTRING
Default: 0000
vendorSpecific
Type: OCTETSTRING
Default: 0000
vendorUnique
Type: OCTETSTRING
Description:
2829
sTag
Parents: specificIdentificationData
Children: None
SpecificIdentificationData Attributes
Attribute
Description
associatedType
Type: OCTETSTRING
Default: 00000001
ipAddress
Type: OCTETSTRING
ipVersion
Type: IpVersion
Default: 00
Possible Values:
Value Description
00
None
01
IPv4
02
IPv6
Name
Type: string
nodeManagement
Type: NodeManagement
Default: 00
Possible Values:
Value Description
00
IP/UDP/SNMP
01
IP/TCP/Telnet
02
IP/TCP/HTTP
03
IP/TCP/HTTPS
04
P/TCP/HTTP/XML
numberOfAttachedDevices
Type: OCTETSTRING
Default: 00000001
physicalPortNumber
Type: OCTETSTRING
Default: 00000000
reserved
Type: OCTETSTRING
Default: 0000
udpTcpPortNumber
Type: OCTETSTRING
Default: 0000
vendorSpecific
Type: OCTETSTRING
Default: 0000
vendorUnique
Type: OCTETSTRING
sTag
Description:
Parents: svlans
Children: None
2830
stag8021ad
sTag Attributes
Attribute
Description
DEI
Type: BITSTRING
Default: 0
Name
more information.
Type: string
PCP
Type: BITSTRING
Default: 001
Type
Type: OCTETSTRING
Default: 88a8
VID
Type: INTEGER
Default: 100
stag8021ad
Description:
Parents: CiscoDCE8021adSTag
Children: None
stag8021ad Attributes
Attribute
Description
dei_cfi
Type: BITSTRING
Default: 0
Name
more information.
Type: string
rsvd
Type: INTEGER
Default: 0
vl
Type: BITSTRING
Default: 0
vlan
Type: INTEGER
Default: 0
stags
Description:
Parents: TagList
Children: None
2831
StairPatternDescriptor
stags Attributes
Attribute
Description
DEI
Type: BITSTRING
Default: 0
Name
more information.
Type: string
PCP
Type: BITSTRING
Default: 000
Type
Type: OCTETSTRING
Default: 88a8
VID
Type: INTEGER
Default: 0
StairPatternDescriptor
Description:
Describes a stair-step load.

StairPatternDescriptor Writable Attributes

Writable Attribute
Description
Active, Name
Height
Amount of additional load to add per "stair." The LoadType attribute in the ClientLoadProfile object controls
the type of load that is generated.
Type: s32
Default: 30
RampTime

Type: u32
Default: 20
Repetitions

Type: u32
Default: 1
SteadyTime
Amount of time to apply the load. The time unit is controlled by the LoadPhaseDurationUnits attribute on
the ClientLoadPhase object.
Type: u32
Default: 40
StairPatternDescriptor Read-Only Attributes

2832
startStopUnit
startStopUnit
Description:
Parents: fcpCdb
Children: None
startStopUnit Attributes
Attribute
Description
control
Type: OCTETSTRING
Default: 00
immed
Type: BITSTRING
Default: 0
loej
Type: BITSTRING
Default: 0
Name
Type: string
noFlush
Type: BITSTRING
Default: 0
opCode
Type: OCTETSTRING
Default: 1B
pwrCond
Type: BITSTRING
Default: 0000
pwrCondMod
Type: BITSTRING
Default: 0000
reserved
Type: BITSTRING
Default: 0000000
reserved1
Type: OCTETSTRING
Default: 00
reserved2
Type: BITSTRING
Default: 0000
reserved3
Type: BITSTRING
Default: 0
start
Type: BITSTRING
Default: 0
StartStopUnit (scsi:StartStopUnit)
Description:
Children: None
2833
State
StartStopUnit Attributes
Attribute
Description
control
Type: OCTETSTRING
Default: 00
immed
Type: BITSTRING
Default: 0
loej
Type: BITSTRING
Default: 0
Name
Type: string
noFlush
Type: BITSTRING
Default: 0
opCode
Type: OCTETSTRING
Default: 1B
pwrCond
Type: BITSTRING
Default: 0000
pwrCondMod
Type: BITSTRING
Default: 0000
reserved
Type: BITSTRING
Default: 0000000
reserved1
Type: OCTETSTRING
Default: 00
reserved2
Type: BITSTRING
Default: 0000
reserved3
Type: BITSTRING
Default: 0
start
Type: BITSTRING
Default: 0
State
Description:
Parents: LI, RI
Children: None
State Attributes
Attribute
Description
MultiAction
Type: MALITLV
Default: 0
Possible Values:
Value Description
0
Device is forwarding non-OAMPDUs to lower sublayer
Device is discarding non-OAMPDUs
2834
StaticChartSeries
Attribute
Description
Name
more information.
Type: string
ParserAction
Type: PALITLV
Default: 0
Possible Values:
Value Description
RESERVED
Device is forwarding non-OAMPDUs to higher sublayer
Device is looping back non-OAMPDUs to lower sublayer
Device is discarding non-OAMPDUs
Reserved
Type: BITSTRING
Default: 00000
StaticChartSeries
Description:

Parents: Result
StaticChartSeries Writable Attributes

StaticChartSeries Read-Only Attributes

Read-Only Attribute
Description
DataSourcePropertyId
Type: propertyId
Default: 0
DataStream
Type: chartPoint
Default: 0,0
Query
Type: handle
Default: 0
StcSystem
Description:
The StcSystem object is the internal root of a Spirent TestCenter test configuration. You do not create the StcSystem object, Spirent TestCenter creates the
StcSystem object automatically. When you create a Project object as the external root of your test configuration, Spirent TestCenter automatically uses the
StcSystem object as its parent.
There are situations in which you reference the StcSystem object in order to gain access to Spirent TestCenter components (the physical chassis manager,
for instance). These components are indicated as the children of StcSystem. To reference the StcSystem object, use the name system1.
For example: set chassisHandle [stc::get system1 -children-PhysicalChassisManager]

Automatically-created children: ActiveEventManager, AutomationOptions, IfManager, PhysicalChassisManager, Project, Sequencer
2835
StepTestConfig
StcSystem Writable Attributes

StcSystem Read-Only Attributes

StepTestConfig
Description:
Configuration for the custom step test.

Parents: Project
StepTestConfig Writable Attributes

Writable Attribute
Description
Active, Name
CustomFrameSizeList
List of frame sizes in the format of a comma-delimited string. Applicable when FrameSizeType is CUSTOM.
Type: u16
Default: 0
CustomLoadList
List of load rates in the format of a comma-delimited string. Applicable when LoadType is CUSTOM.
Type: double
Default: 0
Type: u16
Default: 15
Range: 0 - 3600
DurationBursts

Type: u32
Default: 1000
Range: 1 - 16777215
DurationMode
Type: enum
Default: SECONDS
Possible Values:
Value
Description
BURSTS
DurationSeconds

Type: double
Default: 10
Range: 0.000064 - 4398046.0
EnableArp
Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
ARP is enabled.
2836
StepTestConfig
Writable Attribute
Description
EnableDhcp
Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
DHCP is enabled.

EnableL2Learning
Whether to enable Layer 2 learning mode.

Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
Enable Layer 2 learning mode.
FALSE Disable Layer 2 learning mode.

EnableL2tp
Flag to add L2TP commands.

Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
Adds L2TP commands.

Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE

EnablePpp
Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
PPP is enabled.

EnableRouter
Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
Router is enabled.

events and states.
Type: bool
Default: TRUE
Possible Values:
Value Description
TRUE
2837
StepTestConfig
Writable Attribute
Description
Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE

Type: u8
Default: 0
Range: 0 - 100
FrameSizeEnd
Maximum frame size when using Step mode for incrementing the frame size. This attribute is ignored if FrameSizeType
Type: u16
Default: 256
Range: 40 - 16383
FrameSizeStart
Type: u16
Default: 128
Range: 40 - 16383
FrameSizeStep
Step value for incrementing the frame size from StartFrameSize to StopFrameSize. This attribute is ignored if
FrameSizeType is set to RANDOM, FIXED or CUSTOM.
Type: u16
Default: 128
Range: 1 - 16383
FrameSizeType
Method of setting the frame size.

Type: enum
Default: STEP
Possible Values:
Value
Description
STEP
Frame size increases by StepFrameSize with each test iteration, beginning with StartFrameSize and
increasing to StopFrameSize.
CUSTOM Customized frame sizes. CustomFrameSizeList specifies all frame sizes.

IMIX
Frame sizes is defined by existing iMIX distribution.
RANDOM Frame size is randomly chosen within the range set by RandomMinFrameSize and RandomMaxFrameSize.
Type: handle
Default: 0
InterburstGapMode
Specifies the Inter-burst gap mode, the idle time between packets, as either fixed or random.
Type: enum
Default: FIXED
Possible Values:
Value
Description
FIXED
Type: u16
Default: 2
LoadEnd
When LoadType is STEP, the maximum load for each port. This attribute is ignored if LoadType is set to RANDOM or
CUSTOM.
Type: double
Default: 50
2838
StepTestConfig
Writable Attribute
Description
LoadStart
When LoadType is STEP, the starting load for each port. This attribute is ignored if LoadType is set to RANDOM or
CUSTOM.
Type: double
Default: 10
LoadStep
Step value for incrementing the load from LoadStart to LoadEnd. This attribute is ignored if LoadType is set to RANDOM
or CUSTOM.
Type: double
Default: 10
Range: 0.001 - 100000000000.0
LoadType

Type: enum
Default: STEP
Possible Values:
Value
Description
RANDOM Load rate is randomly chosen within the range set by RandomMinLoad and RandomMaxLoad.
STEP
Load rate increases by LoadStep with each test iteration, beginning with LoadStart and increasing to
LoadEnd.
CUSTOM Customized load rates. CustomLoadList specifies all load rates.

LoadUnits
Type: enum
Possible Values:
Value
Description
PERCENT_LINE_RATE
FRAMES_PER_SECOND
Frames per second.
INTER_BURST_GAP
PerformL2Learning
KILOBITS_PER_SECOND
BITS_PER_SECOND
Bits per second.
Specifies when to perform Layer 2 learning.

Type: enum
Default: BEFORE_TEST
Possible Values:
Value
Description
BEFORE_TEST
Perform Layer 2 learning before the test.
EACH_ITERATION Perform Layer 2 learning for each iteration.

RandomMaxFrameSize
FIXED or CUSTOM.
Type: u16
Default: 256
Range: 40 - 16383
Type: u8
Default: 12
Range: 0 - 100
RandomMaxLoad
Type: double
Default: 50
RandomMinFrameSize
Minimum frame size when FrameSizeType is RANDOM. This attribute is ignored if FrameSizeType is set to STEP,
FIXED or CUSTOM.
Type: u16
Default: 128
Range: 40 - 16383
2839
StpBridgePortConfig
Writable Attribute
Description
Type: u8
Default: 12
Range: 0 - 100
RandomMinLoad
Type: double
Default: 10
StartTrafficDelay
This is the number of seconds to wait before sending traffic. This setting gives you the flexibility to start traffic a specific
number of seconds after test start, or after advertisement is complete.
Type: u16
Default: 0
Range: 0 - 3600
TrafficStartMode
Traffic start mode to use.

Type: enum
Possible Values:
Value
Description
SYNCHRONOUS
StepTestConfig Read-Only Attributes

Read-Only Attribute
Description
TestType
Test type is custom.

Type: string
Default: Custom
StpBridgePortConfig
Description:
STP specific protocol parameters (empty object).

Parents: BridgePortConfig
Automatically-created children: VlanBlock
StpBridgePortConfig Writable Attributes

Writable Attribute
Description
Active, Name
StpBridgePortConfig Read-Only Attributes

2840
Description:

StpDeviceGenProtocolParams Writable Attributes

Writable Attribute
Description
Active, Name
BridgeMacAddr
Type: mac
Default: 00:00:10:00:10:00
BridgeMacAddrRepeatCount
Type: u16
Default: 0
BridgeMacAddrStep
Type: mac
Default: 00:00:00:00:00:00
BridgePriority
Type: u16
Default: 32768
Range: 0 - 65535
Type: u32
Default: 0
Range: 0 - 200000000
CistInternalRootPathCostStep
Type: u32
Default: 0
Range: 0 - 200000000
Type: mac
Default: 00-00-10-00-10-00
CistRegionalRootMacAddrStep
Type: mac
Default: 00-00-00-00-00-00
Type: u16
Default: 32768
Range: 0 - 65535
MstiId
Type: u16
Default: 1
MstiInstanceCount
Type: u16
Default: 1
Range: 1 - 64
MstiVlanCount
Type: u16
Default: 1
MstiVlanId
Type: u16
Default: 1
MstiVlanIdStep
Type: u16
Default: 0
PortNum
Type: u16
Default: 1
Range: 1 - 255
PortNumRecycleCount
Type: u16
Default: 0
2841
Writable Attribute
Description
PortNumStep
Type: u16
Default: 0
Range: 1 - 255
PortPriority
Type: u16
Default: 128
Range: 0 - 255
RegionName
Type: string
Default: Region1
RegionRootBridge
Type: enum
Default: 0
Possible Values:
Value
Description
SELF
CUSTOM
RootBridge
Type: enum
Default: 0
Possible Values:
Value
Description
SELF
CUSTOM
RootMacAddr
Type: mac
Default: 00:00:10:00:10:00
RootMacAddrRepeatCount
Type: u16
Default: 0
RootMacAddrStep
Type: mac
Default: 00:00:00:00:00:00
RootPortCost
Type: u32
Default: 0
Range: 0 - 200000000
RootPortCostRecycleCount
Type: u32
Default: 0
RootPortCostStep
Type: u32
Default: 0
Range: 0 - 200000000
RootPriority
Type: u16
Default: 32768
Range: 0 - 65535
StpType
Type: enum
Default: STP
Possible Values:
Value Description
STP
RSTP
PVST
RPVST
MSTP
VlanCount
Type: u16
Default: 1
Range: 0 - 4095
2842
StpInitTopoChangeBridgePortCommand
Writable Attribute
Description
VlanId
Type: u16
Default: 100
Range: 0 - 4095
VlanPriority
Type: u8
Default: 1
Range: 0 - 7
StpDeviceGenProtocolParams Read-Only Attributes

StpInitTopoChangeBridgePortCommand
Description:
Initiates topology change.

StpInitTopoChangeBridgePortCommand Writable Attributes

Writable Attribute
Description
BridgePortConfigList
List of BridgePortConfig object handles on which the command has to be executed.

Type: handle
Default: 0
StpInitTopoChangeBridgePortCommand Read-Only Attributes

Read-Only Attribute
Description

StpInitTopoChangeCistCommand
Description:
Initiates topology change on CIST.

2843
StpInitTopoChangeMstiCommand
StpInitTopoChangeCistCommand Writable Attributes

Writable Attribute
Description
MstpBridgePortConfigList

Type: handle
Default: 0
StpInitTopoChangeCistCommand Read-Only Attributes

Read-Only Attribute
Description

StpInitTopoChangeMstiCommand
Description:
Initiate Topology Change on MSTI.

StpInitTopoChangeMstiCommand Writable Attributes

Writable Attribute
Description
MstiConfigList
List of MstiConfig object handles on which the command has to be executed.

Type: handle
Default: 0
StpInitTopoChangeMstiCommand Read-Only Attributes

Read-Only Attribute
Description

StpPortConfig
Description:
STP/MSTP specific port level parameters.

Relations:
2844
StpPortConfig
Side name
(Type)
Relative
Description
MemberRegion
(MemberOf)
MstpRegionConfig
Relationship between MSTP region and StpPortConfig.
StpPortConfig Writable Attributes

Writable Attribute
Description
Active, Name
EnableMacAddrReduction
Enables or disables MAC address reduction. This is used only with PVSTP and RPVSTP.
Some switches support only 1,024 MAC addresses that can be used as bridge identifiers for VLANs running PVSTP. Each
bridge must have its own unique identifier in the network. Normally the VLAN ID is added to the MAC address to make up the
MAC address, but with MAC address reduction enabled, the VLAN address is added to the bridge priority.
MAC address reduction is used to enable extended range VLAN identification. MAC address reduction results in a unique MAC
address by deriving the last 3 bytes of the address from the VLAN ID. This ensures that each instance has a unique MAC
address for use in the bridge ID. If enabled, the VLAN ID is put in the last 3 bytes of the priority portion of the bridge ID. If
disabled, the VLAN ID is put in the last 3 bytes of the MAC address portion of the bridge ID.
Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
MAC address reduction enabled.
FALSE MAC address reduction disabled.

EnablePt2PtLink
Enables point-to-point connection or shared media.

Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
Point-to-point connection enabled.
FALSE Point-to-point connection disabled.

EthernetType
EtherType field, used with PVSTP and RPVSTP. For a tagged STP BPDU (the Cisco proprietary BPDU for a non-native VLAN),
the packet contains the EtherType.
Type: string
Default: 8100
NativeVlan
Supports the Cisco native VLAN. This is the VLAN ID of the native VLAN.
BPDUs are sent out for the native VLAN. The first BPDU is the standard IEEE 802.ID BPDU, and the second is the Cisco STP
BPDU. The Cisco STP BPDU is sent untagged to the STP MAC address 0100.Occc.cccd on the native VLAN of the trunk.
A native VLAN is associated with a particular VLAN ID number. A native VLAN specifies which VLAN BPDUs are sent without
a VLAN tag. If the native VLAN ID is 1, two BPDUs are sent untagged. One is a PVST/RPVST BPDU, and the other is an
RSTP/STP BPDU. If the native VLAN ID is not 1, only a PVST/RSTP BPDU is transmitted.
Type: u16
Default: 1
Range: 1 - 4094
PortType
STP port type.

Type: enum
Default: TRUNK
Possible Values:
Value
Description
ACCESS Runs a single instance. Runs STP if configured for PVST+ or RSTP if configured for PVST+.
TRUNK
Indicates a common or mono spanning tree region.
2845
StpStartCistCommand
Writable Attribute
Description
StpType
STP protocol type.

Type: enum
Default: STP
Possible Values:
Value Description
STP
STP
RSTP
RSTP
PVST
PVST
RPVST RPVST
MSTP
MSTP
StpPortConfig Read-Only Attributes

StpStartCistCommand
Description:
Starts CIST.

StpStartCistCommand Writable Attributes

Writable Attribute
Description

Type: handle
Default: 0
StpStartCistCommand Read-Only Attributes

Read-Only Attribute
Description

StpStartMstiCommand
Description:
Start MSTI.

2846
StpStateSummary
StpStartMstiCommand Writable Attributes

Writable Attribute
Description
MstiConfigList

Type: handle
Default: 0
StpStartMstiCommand Read-Only Attributes

Read-Only Attribute
Description

StpStateSummary
Description:
Summary of STP states at port and project level.

Relations:
Side name
(Type)
Relative
Description
ResultParent
(ResultChild)
Port, Project
StpStateSummary Writable Attributes

StpStateSummary Read-Only Attributes

Read-Only Attribute
Description
NotStartedCount
Number of bridge ports not started.

Type: u32
Default: 0
StartedCount
Number of bridge ports started.

Type: u32
Default: 0
StpStopCistCommand
Description:
Stops CIST.
2847
StpStopMstiCommand

StpStopCistCommand Writable Attributes

Writable Attribute
Description

Type: handle
Default: 0
StpStopCistCommand Read-Only Attributes

Read-Only Attribute
Description

StpStopMstiCommand
Description:
Stop MSTI.

StpStopMstiCommand Writable Attributes

Writable Attribute
Description
MstiConfigList

Type: handle
Default: 0
StpStopMstiCommand Read-Only Attributes

Read-Only Attribute
Description

StpUpdateMstiCommand
Description:
Update the MSTI setings.

2848
StpUpdateMstiCommand
StpUpdateMstiCommand Writable Attributes

Writable Attribute
Description
BridgePriority
Priority for the bridge. A low value indicates a high bridge priority.
Type: u16
Default: null
Range: 0 - 65535
MstiConfigList
List of MST instances to update.

Type: handle
Default: 0
PortPriority
Priority for the port. A low value indicates a high bridge priority.
Type: u16
Default: null
Range: 0 - 255
RegionMacAddrRepeatCount
Number of iterations before restarting the MAC address value.

Type: u16
Default: 0
RegionRootBridge
Initial Region Root Bridge on the Bridge port.

Type: enum
Default: NONE
Possible Values:
Value
Description
SELF
Current bridge is the Root Bridge. (Path Cost is 0.)
CUSTOM A user-specified bridge is the root bridge.

NONE
No bridge is specified as the root bridge.
RegionRootMacAddr
MAC address of the region root.

Type: mac
Default: null
RegionRootMacAddrStep
Increment value to calculate subsequent region root MAC addresses.

Type: mac
Default: null
RegionRootPathCost
Cost to reach the root bridge. Used by the DUT to determine which port is the primary path to the root
bridge.
Type: u32
Default: null
Range: 0 - 200000000
RegionRootPathCostRecycleCount
Number of iterations before restarting the number of the region root path cost.
Type: u32
Default: 0
RegionRootPathCostStep
Increment value to calculate the next region root path cost.

Type: u32
Default: 0
Range: 0 - 200000000
RegionRootPriority
Used to determine which bridge is elected as root.

Type: u16
Default: null
Range: 0 - 65535
2849
StreamBlock
StpUpdateMstiCommand Read-Only Attributes

Read-Only Attribute
Description

StreamBlock
Description:
A group of one or more streams. This object holds the definition of data plane traffic.

Children: Aal5, AcceptedReply, AccessAggregationCircuitIdAsciiTlv, AccessAggregationCircuitIdBinaryAtmTlv, AccessAggregationCircuitIdBinaryVlanTlv,
AccessLoopCircuitIdTlv, AccessLoopEncapsulationTlv, AccessLoopRemoteIdTlv, ActualInterleavingDelayDownstreamTlv, ActualInterleavingDelayUpstreamTlv,
ActualNetDataRateDownstreamTlv, ActualNetDataRateUpstreamTlv, AddrArrayTLV, ApplicationPriorityTlv, ARP, ATM, AttainableNetDataRateDownstreamTlv,
AttainableNetDataRateUpstreamTlv, BFD, BFDCryptoAuth, BFDSimpleAuth, CallBody, CCM, CDB10, CDB6, ChassisIdTlv, CiscoDCE8021adSTag,
CiscoDCECiscoStag, CiscoHDLC, CongestionNotificationTlv, ControlFrame, ControlWord, CtrlChanCapTLV, Custom, CustomTlv, CustomTLV, DaId, DataFrame,
DataTLV, DcbxTlvt1, DcbxTlvt2, Dhcpclientmsg, Dhcpservermsg, DiaAcc, DiaReq, DMM, DMR, Dpall, Dpl, Dplm, Dpln, DslLineAttributesCustomTlv, DslTypeTlv,
EfpAcc, EfpReq, ELSFLOGI, ELSFLOGILSACC, ELSLOGO, ELSLOGOLSACC, ELSLSRJT, ELSPLOGI, ELSReserved,
ELSSvcAvailabilityAndLoginExtDataLength, EncapEthernet8022, EncapEthernet8023Raw, EncapEthernetII, EncapEthernetSnap, EncapMAC-in-MAC, EndTlv,
EndTLV, EntropyLabel, EscAcc, EscReq, Ethernet8022, Ethernet8023Raw, EthernetCapTLV, EthernetII, EthernetPause, EthernetSnap, EthernetSSM,
ETSConfigurationTlv, ETSRecommendationTlv, EventNoteOAMPDU, FairnessFrame, FC, FCoE, FcoeCapTLV, FCoEHeader, FcpCmnd, FcpCmndDl,
FcSofEof, FIP, Fpng, FpngAccept, Ftr, FtrAccept, FxPortClkSyncQos, GaNxtAccept, GapnlAccept, Gatin, GatinAccept, GcsIdAccept, GdidAccept, GffIdAccept,
GfnAccept, GfpnIdAccept, GftIdAccept, GidFtAccept, GidNnAccept, GidPnAccept, GidPtAccept, GieilAccept, Giel, GielAccept, GielnAccept, GietAccept,
GmalAccept, GmidAccept, Gnid, GnidAccept, GnnFtAccept, GnnIdAccept, Gnpl, GnplAccept, GpabAccept, GpfcpAccept, GplAccept, GpliAccept, GplmlAccept,
GplnlAccept, GpltAccept, GpnFtAccept, GpnIdAccept, Gpnl, GpnlAccept, GppnAccept, GpsAccept, GpscAccept, GptAccept, GptIdAccept, Gre, GsAccept,
GsDeregisterWithPlatformName, GsesAccept, GsnnNnAccept, GspnIdAccept, GsReject, GsRequestWithFc4Type, GsRequestWithInterconnectElementName,
GsRequestWithNodeName, GsRequestWithPlatformName, GsRequestWithPortIdentifier, GsRequestWithPortName, GsRequestWithPortType, Gtin, GtinAccept,
GTPv1, GTPv1Ext, HloReq, IcmpDestUnreach, IcmpEchoReply, IcmpEchoRequest, IcmpInfoReply, IcmpInfoRequest, IcmpParameterProblem, IcmpRedirect,
IcmpSourceQuench, IcmpTimeExceeded, IcmpTimestampReply, IcmpTimestampRequest, Icmpv6DestUnreach, Icmpv6EchoReply, Icmpv6EchoRequest,
Icmpv6PacketTooBig, Icmpv6ParameterProblem, Icmpv6TimeExceeded, IdleFrame, Igmpv1, Igmpv2, Igmpv2Query, Igmpv2Report, Igmpv3Query, Igmpv3Report,
InfoOAMPDU, IntStat, IP, IPv4, IPv6, Ipv6AuthenticationHeader, Ipv6DestinationHeader, Ipv6EncapsulationHeader, Ipv6FragmentHeader, Ipv6HopByHopHeader,
IPv6LL, Ipv6RoutingHeader, iTag, L2TPv2, LACP, LBM, LBR, LinkAggregationTlv, LlcBridgedEth8023, LlcRoutedNlpid, LlcRoutedSnap, LlcSnapIana, LMM,
LMR, LoopbackControlOAMPDU, LsaReq, LspPing, LsuReq, LTM, LTMEgrID, LTR, LTREgrID, MacControl, MAC-in-MAC, MacPhyConfigStatusTlv,
ManagementAddrTlv, Marker, MaxFrameSizeTlv, MaximumInterleavingDelayDownstreamTlv, MaximumInterleavingDelayUpstreamTlv,
MaximumNetDataRateDownstreamTlv, MaximumNetDataRateUpstreamTlv, MinimumNetDataRateDownstreamTlv, MinimumNetDataRateUpstreamTlv,
MinimumNetLowPowerDataRateDownstreamTlv, MinimumNetLowPowerDataRateUpstreamTlv, MismatchInfo, MLDv1, MLDv2Query, MLDv2Report,
ModeSense10, ModeSense6, Mpls, MReq, MReqAcc, MsgTypeArrayTLV, NeighborAdvertisement, NeighborSolicitation, NivSupportTlv, NPortClkSyncQos,
OrganizationallySpecificTlv, OrgSpec, OrgSpecOAMPDU, Ospfv2DatabaseDescription, Ospfv2Hello, Ospfv2LinkStateAcknowledge, Ospfv2LinkStateRequest,
Ospfv2LinkStateUpdate, Ospfv2Unknown, PathDescriptor, PauseMacControl, PbbTeMip, PFC, Pimv4Assert, Pimv4Hello, Pimv4JoinPrune, Pimv4NullRegister,
Pimv4Register, Pimv4RegisterStop, Pimv6Assert, Pimv6Hello, Pimv6JoinPrune, Pimv6Register, Pimv6RegisterStop, PortAndProtocolVlanIdTlv,
PortDescriptionTlv, PortIdTlv, PortVlanIdTlv, POS, PowerViaMdiTlv, PPP, PPPoEDiscovery, PPPoESession, PreviewData, PriorityBasedFlowControlTlv,
ProtocolIdentityTlv, ProvisioningInfoTLV, PrtStat, QlTlv, RandomModifier, RangeModifier, RARP, RcsId, Rdi, Read10, Read6, ReadBuffer, ReadCapacity10,
ReadLong10, Redirect, RejectedReply, RejectedReplyAuthStat, ReplyBody, ReportLUNs, ResourceLimitCapTLV, RffId, RftId, Rieln, Ripng, Ripv1, Ripv2,
RnnId, RouterAdvertisement, RouterSolicitation, Rpab, RpcMsg, Rpfcp, Rpl, Rpli, Rplm, Rpln, Rplt, RplyEgr, RplyIng, RpnId, RptId, RsnnNn, RspnId, RtpHeader,
SndrID, StartStopUnit, StreamCollectionListModifier, StreamCollectionRangeModifier, SystemCapabilitiesTlv, SystemDescriptionTlv, SystemNameTlv,
TableModifier, Tcp, TestTLV, TimeToLiveTlv, TrafficClassesSupportedTlv, TrafficPathInfo, TwampServerGreeting, Udp, VariableRequestOAMPDU,
VariableResponseOAMPDU, VcMuxBridgedEth8023, Verify10, VFT, VifIdTLV, VifStateTLV, VlanNameTlv, Write10, Write6, WriteAndVerify10, WriteBuffer,
WriteLong10, XDRead10, XDWrite10, XPWrite10
Result children (automatically created): RxStreamBlockResults, RxStreamSummaryResults, TxStreamBlockResults, TxStreamResults
Relations:
Side name
(Type)
Relative
Description
AffiliationAnalyzerPreloadProfile
(AffiliationAnalyzerPreloadStreamBlock)
AffiliationFrameLengthDistribution
(AffiliationFrameLengthDistribution)
AffiliationHighResolutionStreamBlockConfig
(AffiliationHighResolutionStreamBlock)
2850
StreamBlock
Side name
(Type)
Relative
ManualScheduleEntry
(AffiliationManualScheduleEntryStreamBlock)
ManualScheduleEntry
AffiliationProjectStreamBlock
(AffiliationStreamBlock)
StreamBlock
Description
Internal use only.
AffiliationStreamBlockLoadProfile
(AffiliationStreamBlockLoadProfile)
Relation to specify stream block to which

load profile binds.
AffiliationTrafficGroup
(AffiliationTrafficGroup)
TrafficGroup
Relation to specify traffic group to which

stream block belongs.
AudioRtcpStreamBlockParent
(AudioRtcpStreamBlock)
SipUaProtocolConfig
AudioStreamBlockParent
(AudioStreamBlock)
SipUaProtocolConfig
ContainerResultChild
(ContainerResult)
RxTrafficGroupResults, TxTrafficGroupResults
General-purpose relation for result objects.

For example, RxTrafficGroupResults objects
are linked to the StreamBlock object with
this relation.
DstBinding
(DstBinding)
Aal5If, Dhcpv4ServerDefaultPoolConfig,
Dhcpv4ServerPoolConfig, Dhcpv6ServerAddrPoolConfig,
Dhcpv6ServerDefaultAddrPoolConfig,
Dhcpv6ServerPrefixPoolConfig, EthIIIf, FcIf, GreIf, HdlcIf,
Ipv4If, Ipv4NetworkBlock, Ipv6If, Ipv6NetworkBlock, ItagIf,
L2tpv2If, MacBlock, MplsIf, Pimv4JoinSrc, Pimv4PruneSrc,
Pimv6JoinSrc, Pimv6PruneSrc, PppIf, PppoeIf,
PppoeServerIpv4PeerPool, PppoxServerIpv4PeerPool,

StreamBlock.
ExpectedRxPort
(ExpectedRx)
Port
Expected receive port for this stream block.

All the receive ports in the relation are
expected to receive all the packets from this
stream block. A stream block with no
expected port relation configured means
any port is expected to receive packets. If
you configure source/destination binding,
they will override the ExpectedRxPort
relation.
Config
(MulticastStreamBlockBinding)
DcbErroredFramesFilteringTestCaseConfig, Rfc3918Config
ResultChild
(ResultChild)
RxStreamBlockResults, RxStreamSummaryResults,
TxStreamBlockResults, TxStreamResults

object.
SrcBinding
(SrcBinding)
Aal5If, Dhcpv4ServerDefaultPoolConfig,
Dhcpv4ServerPoolConfig, Dhcpv6ServerAddrPoolConfig,
Dhcpv6ServerDefaultAddrPoolConfig,
Dhcpv6ServerPrefixPoolConfig, EthIIIf, FcIf, GreIf, HdlcIf,
Ipv4If, Ipv4NetworkBlock, Ipv6If, Ipv6NetworkBlock, ItagIf,
L2tpv2If, MacBlock, MplsIf, Pimv4JoinSrc, Pimv4PruneSrc,
Pimv6JoinSrc, Pimv6PruneSrc, PppIf, PppoeIf,
PppoeServerIpv4PeerPool, PppoxServerIpv4PeerPool,

StreamBlock.
TrafficDescriptorStreamBlockSrc
TrafficDescriptor
Information associated with pairs of source

and destination end points bound to the
stream block.
Profile
Rfc2544BackToBackFramesProfile,
Rfc2544FrameLossProfile, Rfc2544LatencyProfile,
TestCaseConfig
(UnicastStreamBlockBinding)
2851
StreamBlock
Side name
(Type)
Relative
VideoRtcpStreamBlockParent
(VideoRtcpStreamBlock)
SipUaProtocolConfig
VideoStreamBlockParent
(VideoStreamBlock)
SipUaProtocolConfig
Description
StreamBlock Writable Attributes

Writable Attribute
Description
Active, Name
AllowInvalidHeaders
Used to allow FrameConfig to contain an invalid header.

Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
FrameConfig can contains invalid headers.
FALSE FrameConfig cannot contains invalid headers.

BurstSize
use it.
Instead use the BurstSize attribute on the StreamBlockLoadProfile object.
Specifies the burst size applied to all streams in the stream block when in priority-based scheduling mode.
Type: u16
Default: 1
ByPassSimpleIpSubnetChecking
Whether subnet checking will be bypassed for bound stream block if source and destination endpoints are both
Ethernet/IP.
Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
Bypass subnet check.
FALSE Do not bypass subnet check.

ConstantFillPattern
Specifies the value for a constant fill pattern when fill pattern type is not PRBS.
Type: u16
Default: 0
EnableBackBoneTrafficSendToSelf
Whether the endpoint will send traffic to itself in a backbone traffic pattern.
Type: bool
Default: TRUE
Possible Values:
Value Description
TRUE
Allow backbone traffic send to self endpoint.
FALSE Disallow backbone traffic send to self endpoint.

Specifies the direction of traffic flow between two end points (for project-level stream block only).
Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
Traffic flow in both directions.
FALSE Traffic flow from source to destination only.
2852
StreamBlock
Writable Attribute
Description
EnableControlPlane
Enable/disable control plane traffic, such as Ping and ARP.

Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
Enable control plane traffic.
FALSE Disable control plane traffic.

EnableFcsErrorInsertion
Specifies to insert/omit FCS error in the frames.

Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
Insert FCS error in the frames.
FALSE Do not insert FCS error in the frames.

EnableHighSpeedResultAnalysis
Whether this stream block is involved in high speed result analysis.

Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
Used as high speed result analysis.
FALSE Use normal result analysis.

EnableStreamOnlyGeneration
Specifies to use streams or VFDs (Variable Field Definitions) to generate traffic between end points.
Type: bool
Default: TRUE
Possible Values:
Value Description
TRUE
Use streams to generate traffic.
FALSE Use VFDs to generate traffic.

EnableTxPortSendingTrafficToSelf
Enable/disable transmit port sending traffic to itself.

Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
Enable transmit port sending traffic to itself.
FALSE Disable transmit port sending traffic to itself.

EndpointMapping
Specifies the mapping between network end points within interface blocks.
Type: enum
Default: ONE_TO_ONE
Possible Values:
Value
Description
ONE_TO_ONE
One source end point to one destination end point.
ONE_TO_MANY One source end point to many destination end points.
2853
StreamBlock
Writable Attribute
Description
FillType
Specifies fill pattern type to be used for payload.

Type: enum
Default: CONSTANT
Possible Values:
Value
Description
CONSTANT Use fixed fill pattern.
INCR
Use incrementing value to fill the rest of the frame. The step value is 1. The starting value is specified
by ConstantFillPattern.
DECR
Use decrementing value to fill the rest of the frame. The step value is 1. The starting value is specified
by ConstantFillPattern.
PRBS
Use a pseudo-random bit sequence to fill the rest of the frame. The PRBS pattern is shared across
streams that use the PRBS as the fill pattern.
Note: This option requires that you set the InsertSig attribute to true.
Filter
Used by the GUI to store the currently selected filter.

Type: string
FixedFrameLength
Specifies the fixed value for frame length.

Note: 10 gigabit Ethernet range is 56-16383; POS range is 48-16383; range for all others is 12-16383.
Type: u16
Default: 128
Range: 12 - 16383
FrameConfig
PDU (XML) configuration for frame header of the stream block.

Type: string
FrameLengthMode
Specifies the frame length mode used by this stream block.

Type: enum
Default: FIXED
Possible Values:
Value
Description
FIXED
Frame length is fixed for all frames.
INCR
Frame length is incrementing.
DECR
Frame length is decrementing.
IMIX
Use multiple frame lengths as defined by a FrameLengthDistribution object. The StreamBlock object
must be associated with the FrameLengthDistribution object using an AffiliationFrameLengthDistribution
relation.
RANDOM Frame length is random.

AUTO
InsertSig
Frame length is automatically set based on the PDU configuration.
Specifies to insert/omit Spirent signature in traffic.

Type: bool
Default: TRUE
Possible Values:
Value Description
TRUE
Insert Spirent signature.
FALSE Do not insert Spirent signature.

InterFrameGap
use it.
Instead use the InterFrameGap attribute on the StreamBlockLoadProfile object.
Gap (bytes) between frames in the same burst, when the burst size is greater than 1 (only when in priority-based
scheduling mode).
Type: u32
Default: 12
2854
StreamBlock
Writable Attribute
Description
Load
use it.
Instead use the Load attribute on the StreamBlockLoadProfile object.
Specifies the load value set on the stream block. Load has different meanings, based on load unit.
Type: double
Default: 10
LoadUnit
use it.
Instead use the LoadUnit attribute on the StreamBlockLoadProfile object.
Specifies the load unit applied to the stream block.
Type: enum
Possible Values:
Value
Description
PERCENT_LINE_RATE
Load as percentage of line rate.
FRAMES_PER_SECOND
Load as the number of frames per second.
INTER_BURST_GAP
BITS_PER_SECOND
Load as the number of bits per second.
KILOBITS_PER_SECOND
Load as the number of kilobits per second.
MEGABITS_PER_SECOND
Load as the number of megabits per second.
INTER_BURST_GAP_IN_MILLISECONDS Load as the gap in milliseconds between adjacent bursts.

INTER_BURST_GAP_IN_NANOSECONDS Load as the gap in nanoseconds between adjacent bursts.
MaxFrameLength
Specifies the maximum frame length for random mode.

Note: 10 Gigabit Ethernet range is 56-16383; POS range is 48-16383; range for all others is 12-16383.
Type: u16
Default: 256
Range: 12 - 16383
MinFrameLength
Specifies the minimum frame length for random mode.

Note: 10 Gigabit Ethernet range is 56-16383; POS range is 48-16383; range for all others is 12-16383.
Type: u16
Default: 128
Range: 12 - 16383
Priority
use it.
Instead use the Priority attribute on the StreamBlockLoadProfile object.
Specifies the scheduling priority of the stream block in priority-based mode.
Type: u8
Default: 0
ShowAllHeaders
Used to indicate if the FrameConfig contains all the headers including header for bound endpoint.
Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
Frameconfig contains all the headers including header for bound endpoint.
FALSE Frameconfig does not contain all the headers including header for bound endpoint.
StartDelay
use it.
Instead use the StartDelay attribute on the StreamBlockLoadProfile object.
Specifies the delay (in bytes) to start the first frame of stream block when in priority-based scheduling mode.
Type: u32
Default: 0
StepFrameLength
Specifies the step frame length for increment and decrement modes (must be in powers of 2).
Type: u16
Default: 1
Range: 1 - 8192
2855
StreamBlock
Writable Attribute
Description
TrafficPattern
Specifies the traffic pattern between end points.

Type: enum
Default: PAIR
Possible Values:
Value
Description
PAIR
Traffic is transmitted between one or more port pairs, either uni- or bi-directionally.
MESH
Traffic is transmitted from every port to every other port (for project-level stream block only).
BACKBONE Traffic is transmitted in a partially meshed pattern, either uni- or bi-directionally.
StreamBlock Read-Only Attributes

Read-Only Attribute
Description
BpsLoad
Load value as the number of bits per second.

Type: double
Default: 100000000
ControlledBy
Read-only property to indicate by which daemon the stream block is generated and controlled.
Type: string
Default: generator
FlowCount
Number of flows in this stream block.

Type: u32
Default: 0
FpsLoad
Load value as the number of frames per second.

Type: double
Default: 84459
IbgInMillisecondsLoad
Load value as the gap (in milliseconds) between adjacent bursts.

Type: double
Default: 1344
IbgInNanosecondsLoad
Load value as the gap (in nanoseconds) between adjacent bursts.

Type: double
Default: 1344
IbgLoad
Load value as the gap (in bytes) between adjacent bursts.

Type: double
Default: 1344
IsArpResolved
Specifies if ARP is resolved/unresolved for this stream block.

Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
ARP is resolved.
FALSE ARP is unresolved.

KbpsLoad
Load value as the number of kilobits per second.

Type: double
Default: 100000
L2Rate
Layer 2 bit rate.

Type: double
Default: 100000000
MbpsLoad
Load value as the number of megabits per second.

Type: double
Default: 100
PduInfo
Strings containing PDU information. The format is "PDU Name, String Handle, Object Handle, Indexed Name".
Type: string
2856
StreamBlockActivateCommand
Read-Only Attribute
Description
PercentageLoad
Load value as percentage of line rate.

Type: double
Default: 10
RunningState
Whether frames are being transmitted using the stream block.

Type: enum
Default: STOPPED
Possible Values:
Value
Description
STOPPED
Frames defined by the stream block are not being transmitted.
RUNNING
Frames defined by the stream block are being transmitted.
PENDING_START Frames defined by the stream block are getting ready to be transmitted.
PENDING_STOP
State
Frames defined by the stream block are getting ready to stop being transmitted.
Whether traffic can be generated using the stream block.

Type: enum
Default: READY
Possible Values:
Value
Description
READY
Ready to transmit.
NEED_RESOLVE Need to resolve before transmit.

Status
Description of the stream block's condition.

Type: string
Default: None
StreamBlockIndex
Stream block index corresponding to this stream block (only applicable to port-level stream block).
Type: u32
Default: 0
StreamCount
Number of streams in this stream block.

Type: u32
Default: 0
StreamIndex
Stream indexes corresponding to this stream block (only applicable to port-level stream block). This set of values is
read only, because the stream indexes are assigned by firmware.
Type: u32
Default: 0
StreamBlockActivateCommand
Description:
Activate or deactivate a list of stream blocks.

StreamBlockActivateCommand Writable Attributes

Writable Attribute
Description
2857
StreamBlockAutoSelectTunnelCommand
Writable Attribute
Description
Activate
Specify whether activate or deactivate.

Type: bool
Default: TRUE
Possible Values:
Value Description
TRUE
Activate
FALSE Deactivate
StreamBlockList
A list of one or more stream block handles.

Type: handle
Default: 0
StreamBlockActivateCommand Read-Only Attributes

Read-Only Attribute
Description

StreamBlockAutoSelectTunnelCommand
Description:
Allow Spirent TestCenter to select the most appropriate MPLS labeled tunnels for the traffic based on the protocol, VPN, and traffic configuration.

StreamBlockAutoSelectTunnelCommand Writable Attributes

Writable Attribute
Description
CreatePathDescriptor
To indicate if PathDescriptor object will be used to store tunnel information.

Type: bool
Default: TRUE
Possible Values:
Value Description
TRUE
PathDescriptor object will be used to store tunnel information.
FALSE PathDescriptor object will not be used to store tunnel information.

StreamBlockList
List of stream blocks on which to auto select tunnels.

Type: handle
Default: 0
StreamBlockAutoSelectTunnelCommand Read-Only Attributes

Read-Only Attribute
Description

2858
StreamBlockClearAllTunnelCommand
StreamBlockClearAllTunnelCommand
Description:
To clear all Tunnel for the given StreamBlocks.

StreamBlockClearAllTunnelCommand Writable Attributes

Writable Attribute
Description
StreamBlockList
List of StreamBlock handles.

Type: handle
Default: 0
StreamBlockClearAllTunnelCommand Read-Only Attributes

Read-Only Attribute
Description

StreamBlockExpandCommand
Description:
Expand project-level stream block to port-level stream block. The project-level stream block will be destroyed. The port-level stream block will be writable.
This command fails if any stream block handle is invalid.

StreamBlockExpandCommand Writable Attributes

Writable Attribute
Description
StreamBlockList
A list of stream blocks.

Type: handle
Default: 0
StreamBlockExpandCommand Read-Only Attributes

Read-Only Attribute
Description

2859
StreamBlockGetInfoCommand
StreamBlockGetInfoCommand
Description:
Get general information about a stream block, such as total stream count, flow count, traffic path count, etc.

StreamBlockGetInfoCommand Writable Attributes

Writable Attribute
Description
IncludePathDescriptor
Indicate if the preview data will contain the information from path descriptor.
Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
Include
FALSE Exclude
StreamBlock

Type: handle
Default: 0
StreamBlockGetInfoCommand Read-Only Attributes

Read-Only Attribute
Description

StringSeparator
Separator to use between strings.

Type: string
Default:
TotalFlowCount
Specifies the total number of flows generated by the stream block.

Type: u32
Default: 0
TotalStreamCount
Specifies the total number of streams generated by the stream block.

Type: u32
Default: 0
TotalTrafficPathCount
Specifies the total number of traffic paths generated by the stream block.
Type: u32
Default: 0
TrafficPathInfoList
Specifies the handles of traffic path info objects for the stream block.
Type: handle
Default: 0
StreamBlockGetOffsetReferenceCommand
Description:
Given a bit offset, get the offset reference from a streamblock.

2860
StreamBlockGetTunnelCommand

StreamBlockGetOffsetReferenceCommand Writable Attributes

Writable Attribute
Description
BitOffset
Absolute bit offset of the frame config.

Type: u32
Default: 0
StreamBlock
Handle of the StreamBlock for which the offset reference will be retrieved.
Type: handle
Default: 0
StreamBlockGetOffsetReferenceCommand Read-Only Attributes

Read-Only Attribute
Description

OffsetReference
Returned offset reference string for the corresponding bit offset.

Type: string
RelativeBitOffset
Returned relative bit offset within the PDU for offset reference.
Type: u32
Default: 0
StreamBlockGetTunnelCommand
Description:
Get all the tunnel information from the given streamblocks.

StreamBlockGetTunnelCommand Writable Attributes

Writable Attribute
Description
StreamBlockList
List of StreamBlock handles.

Type: handle
Default: 0
StreamBlockGetTunnelCommand Read-Only Attributes

Read-Only Attribute
Description

2861
StreamBlockLoadProfile
Read-Only Attribute
Description
DestinationEndpointList
List of destination endpoint handles.

Type: handle
Default: 0
EndpointCountList
Endpoint count for each streamblock.

Type: u32
Default: 0
SourceEndpointList
List of source endpoint handles.

Type: handle
Default: 0
TunnelCountList
Tunnel count for each endpoint pair.

Type: u32
Default: 0
TunnelInterfaceList
List of tunnel handles.

Type: handle
Default: 0
Description:
Defines a set of load characteristics which traffic exhibits or should exhibit. It's automatically created when a stream block is created. Users can get load profile
from stream block through AffiliatedStreamBlockLoadProfile relation and modify its properties. Deleting or attaching another load profile to a stream block is
not allowed.

Parents: Project
Relations:
Side name
(Type)
Relative
AffiliationStreamBlockLoadProfileStreamBlock
(AffiliationStreamBlockLoadProfile)
Description
Relation specifying load profile used by stream block.
StreamBlockLoadProfile Writable Attributes

Writable Attribute
Description
Active, Name
BurstSize
Specifies the burst size applied to all streams in the stream block when in priority-based scheduling mode.
Type: u16
Default: 1
InterFrameGap
Gap (in bytes) between frames in the same burst, when the burst size is greater than 1 (only when in priority-based scheduling
mode).
Type: double
Default: 12
2862
Writable Attribute
Description
InterFrameGapUnit
Specifies the unit for inter-frame gap.

Type: enum
Default: BYTES
Possible Values:
Value
Description
PERCENT_LINE_RATE
FRAMES_PER_SECOND
BYTES
MILLISECONDS
NANOSECONDS
BITS_PER_SECOND
KILOBITS_PER_SECOND
MEGABITS_PER_SECOND inter-frame gap as the number of megabits per second.

Load
Specifies the load value set on the stream block. Load has different meanings, based on load unit.
Type: double
Default: 10
LoadUnit
Specifies the load unit applied to the stream block.

Type: enum
Possible Values:
Value
Description
PERCENT_LINE_RATE
Load as percentage of line rate.
FRAMES_PER_SECOND
Load as the number of frames per second.
INTER_BURST_GAP
BITS_PER_SECOND
Load as the number of bits per second.
KILOBITS_PER_SECOND
Load as the number of kilobits per second.
MEGABITS_PER_SECOND
Load as the number of megabits per second.
INTER_BURST_GAP_IN_MILLISECONDS Load as the gap in milliseconds between adjacent bursts.

INTER_BURST_GAP_IN_NANOSECONDS Load as the gap in nanoseconds between adjacent bursts.
Priority
Specifies the scheduling priority of the stream block in priority-based mode.

Type: u8
Default: 0
StartDelay
Specifies the delay (in bytes) to start the first frame of stream block when in priority-based scheduling mode.
Type: u32
Default: 0
StreamBlockLoadProfile Read-Only Attributes

Read-Only Attribute
Description
BpsIfg

Type: double
Default: 100000000
BytesIfg

Type: double
Default: 12
FpsIfg

Type: double
Default: 84459
KbpsIfg

Type: double
Default: 100000
2863
StreamBlockResultFilter
Read-Only Attribute
Description
MbpsIfg
inter-frame gap as the number of megabits per second.

Type: double
Default: 100
MillisecondsIfg

Type: double
Default: 1344
NanosecondsIfg

Type: double
Default: 1344
PercentageIfg
Type: double
Default: 10
StreamBlockResultFilter
Description:
Configures a list of streamblocks used to filter the results.

Parents: Project
Relations:
Side name
(Type)
Relative
ResultQuery
(ResultFilters)
ResultQuery
Description
StreamBlockResultFilter Writable Attributes

Writable Attribute
Description
Active, Name
StreamBlockList
Streamblock list of the result.

Type: handle
Default: 0
StreamBlockResultFilter Read-Only Attributes

StreamBlockSetTrafficPatternCommand
Description:
Configure a particular set of end points and additional traffic attributes of stream block(s), overwriting any existing traffic pattern.

2864
StreamBlockStartCommand
StreamBlockSetTrafficPatternCommand Writable Attributes

Writable Attribute
Description
DstEndpointList
List of end points to be bound as traffic destinations to the stream blocks.

Type: handle
Default: 0
Enable/disable traffic to be transmitted from destination end points to source end points (always false for port-level
stream blocks).
Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
Traffic will also be transmitted from destination end points to source end points.
FALSE Traffic will be transmitted only from source end points to destination end points.
EqualRxPortDistribution
Prevent/allow arranging receive port sequence(s) in equally distributed fashion, as specified in RFC 2889, section
5.1.3, for stream block(s).
Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
Use RFC 2889 sequencing to prevent over stressing of DUT ports.
FALSE Do not use RFC 2889 sequencing, and allow over stressing of DUT ports.
SrcEndpointList
List of end points to be bound as traffic sources to the stream blocks.

Type: handle
Default: 0
StreamBlockList
List of stream blocks on which the traffic pattern will be applied.

Type: handle
Default: 0
TrafficPattern
Type of traffic pattern to be applied to the stream blocks.

Type: enum
Default: BACKBONE
Possible Values:
Value
Description
PAIR
Each source end point transmits traffic to only one destination end point.
MESH
Each source end point transmits traffic to all destination end points.
BACKBONE Each source end point transmits traffic to all other source end points.
StreamBlockSetTrafficPatternCommand Read-Only Attributes

Read-Only Attribute
Description

StreamBlockStartCommand
Description:
Start transmitting a list of stream blocks.
NOTE: If the link is down, it may take up to one minute for the generator to start.
2865
StreamBlockStopCommand

StreamBlockStartCommand Writable Attributes

Writable Attribute
Description
StreamBlockList
A list of one or more stream block handles.

Type: handle
Default: 0
StreamBlockStartCommand Read-Only Attributes

Read-Only Attribute
Description

StreamBlockStopCommand
Description:
Stop transmitting a selected list of stream blocks.

StreamBlockStopCommand Writable Attributes

Writable Attribute
Description
StreamBlockList

Type: handle
Default: 0
StreamBlockStopCommand Read-Only Attributes

Read-Only Attribute
Description

StreamBlockUpdateCommand
Description:
Update the stream block configuration (that is, Load, FrameConfig). This command should be called after binding is done with a stream block, in order to get
a valid FrameConfig. (Does not apply the configuration to Spirent TestCenter test modules.)
2866
StreamBlockVerifyForwardingCommand

StreamBlockUpdateCommand Writable Attributes

Writable Attribute
Description
StreamBlock

Type: handle
Default: 0
StreamBlockUpdateCommand Read-Only Attributes

Read-Only Attribute
Description

StreamBlockVerifyForwardingCommand
Description:
Configures the traffic generators associated with the specified streamblocks to transmit a specific number of test frames at a specific rate. If at least one frame
is correctly forwarded on every stream, then this command returns a PASS. However, if any stream receives no forwarded frames, then this command returns
a FAIL.

Parents: Sequencer
Result children (automatically created): ResultDataSet
Relations:
Side name
(Type)
Relative
Description
ResultChild
(ResultChild)
ResultDataSet
StreamBlockVerifyForwardingCommand Writable Attributes

Writable Attribute
Description
HistogramDistributionMode
Histogram Bucket Distribution Mode.

Type: enum
Default: NONE
Possible Values:
Value
Description
NONE
NONE
EXPONENTIAL EXPONENTIAL
LINEAR
LINEAR
2867
StreamCollectionListModifier
Writable Attribute
Description
HistogramMode
Histogram mode.
Type: enum
Default: LATENCY
Possible Values:
Value
Description
FRAME_LENGTH
Frame length.
INTERARRIVAL_TIME Interarrival time.

JITTER
Jitter.
LATENCY
Latency.
StreamBlockList
A list of streamblocks.
Type: handle
Default: 0
VerificationDurationMode
Duration mode for traffic verification.

Type: enum
Default: FRAME_COUNT
Possible Values:
Value
Description
FRAME_COUNT Duration mode for traffic verification is by frame count.
SECONDS
VerificationLoadMode
Duration mode for traffic verification is by seconds.
Load mode for traffic verification.

Type: enum
Default: DEFAULT
Possible Values:
Value
Description
DEFAULT Default.
AS_IS
Use current load mode.
VerificationTxFrameCount
Number of frames to transmit for forwarding verification.

Type: u32
Default: 100
Range: 1 - 2147483648
VerificationTxFrameRate
Rate (in fps) to transmit frames used for forwarding verification.

Type: u32
Default: 1000
Range: 1 - 14880952
VerificationTxSeconds
Duration for which to transmit frames for verification.

Type: double
Default: 5.0
Range: 0.1 - 3600.0
StreamBlockVerifyForwardingCommand Read-Only Attributes

Read-Only Attribute
Description
PassFailState
StreamCollectionListModifier
Description:
A modifier that applies to a collection of streams to vary a target attribute in a list of values.
2868
StreamCollectionRangeModifier
StreamCollectionListModifier Writable Attributes

Writable Attribute
Description
TargetAttribute
Specify which attribute the modifier is applied to.

Type: enum
Default: LOAD
Possible Values:
Value
Description
LOAD
Apply to load.
LOAD_UNIT Apply to load unit.

Values
A list of values.
Type: string
StreamCollectionListModifier Read-Only Attributes

StreamCollectionRangeModifier
Description:
A modifier that applies to a collection of streams to vary a target attribute in a range of values.

StreamCollectionRangeModifier Writable Attributes

Writable Attribute
Description
Mode
Specifies the step mode.

Type: enum
Default: DECR
Possible Values:
Value
Description
INCR
Increment data values.
DECR
Decrement data values.
SHUFFLE Provide every data value once in random order.

RecycleCount
Number of times value will change.

Type: u32
Default: 0
RepeatCount
Number of times value will be repeated.

Type: u32
Default: 0
StepValue
Specify the step value of the modifier.

Type: string
2869
streamId
Writable Attribute
Description
TargetAttribute
Specify which attribute the modifier is applied to.

Type: enum
Default: LOAD
Possible Values:
Value Description
LOAD Apply to load.
StreamCollectionRangeModifier Read-Only Attributes

streamId
Description:
Children: None
streamId Attributes
Attribute
Description
length
Type: INTEGER
Default: 4
Name
information.
Type: string
streamId
Type: INTEGER
Default: 0
type
Default: 136
Possible Values:
Value Description
0
End of Options List
NOP
130
Security
131
Loose Source Route
68
Time Stamp
133
Extended Security
Record Route
136
Stream Identifier
137
Strict Source Route
11
MTU Probe
12
MTU Reply
82
Traceroute
147
Address Extension
148
Router Alert
149
2870
StreamThresholdResults
Description:
Provides Name and value for custom filter.

Parents: Analyzer
Relations:
Side name
(Type)
Relative
Description
ResultParent
(ResultChild)
Analyzer
StreamThresholdResults Writable Attributes

StreamThresholdResults Read-Only Attributes

Read-Only Attribute
Description
CustomFilterCount1
Number of results for custom filter 1.

Type: u64
Default: 0
CustomFilterCount10

Type: u64
Default: 0
CustomFilterCount11

Type: u64
Default: 0
CustomFilterCount12

Type: u64
Default: 0
CustomFilterCount13

Type: u64
Default: 0
CustomFilterCount14

Type: u64
Default: 0
CustomFilterCount15

Type: u64
Default: 0
CustomFilterCount2

Type: u64
Default: 0
CustomFilterCount3

Type: u64
Default: 0
CustomFilterCount4

Type: u64
Default: 0
CustomFilterCount5

Type: u64
Default: 0
2871
Read-Only Attribute
Description
CustomFilterCount6

Type: u64
Default: 0
CustomFilterCount7

Type: u64
Default: 0
CustomFilterCount8

Type: u64
Default: 0
CustomFilterCount9

Type: u64
Default: 0
CustomFilterName1
Name of custom filter 1.

Type: string
CustomFilterName10

Type: string
CustomFilterName11

Type: string
CustomFilterName12

Type: string
CustomFilterName13

Type: string
CustomFilterName14

Type: string
CustomFilterName15

Type: string
CustomFilterName2

Type: string
CustomFilterName3

Type: string
CustomFilterName4

Type: string
CustomFilterName5

Type: string
CustomFilterName6

Type: string
CustomFilterName7

Type: string
2872
strictSrcRoute
Read-Only Attribute
Description
CustomFilterName8

Type: string
CustomFilterName9

Type: string
strictSrcRoute
Description:
Children: addrList
strictSrcRoute Attributes
Attribute
Description
length
Type: INTEGER
Default: 0
Name
Type: string
pointer
Type: INTEGER
Default: 0
type
Default: 137
Possible Values:
Value Description
0
End of Options List
NOP
130
Security
131
Loose Source Route
68
Time Stamp
133
Extended Security
Record Route
136
Stream Identifier
137
Strict Source Route
11
MTU Probe
12
MTU Reply
82
Traceroute
147
Address Extension
148
Router Alert
149
SubscribeDynamicResultViewCommand
2873
SubscribeResultsViewCommand
Description:

SubscribeDynamicResultViewCommand Writable Attributes

Writable Attribute
Description
DynamicResultView
Type: handle
Default: 0
FileExportFormat
Type: string
Default: csv
FileExportInterval
Type: u32
Default: 1
FileExportNamePrefix
Type: string
SubscribeDynamicResultViewCommand Read-Only Attributes

Read-Only Attribute
Description

SubscribeResultsViewCommand
Description:
Subscribe to a run-time Result View already defined by a Result View Template XML file.

SubscribeResultsViewCommand Writable Attributes

Writable Attribute
Description
ExportFormat
Format to use for export.

Type: enum
Default: NONE
Possible Values:
Value
Description
NONE
Use for getting number of rows.
CSV
Export in CSV format.
BINARY Export in Binary format. Command will return all exported values.
FileNamePrefix
Prefix to CSV export file name.

Type: string
2874
SubTlvs
Writable Attribute
Description
Interval
Result update interval to override template value.

Type: u32
Default: 0
RecordsPerPage
Number of records per page to override template value.

Type: u16
Default: 0
TemplateUri
Template to be used for subscribe.

Type: string
WaitTime
Wait time between subscribe results and export results to provide enough time for results to be populated.
Type: double
Default: 3.0
Range: 0.005 - 2147483647.0
SubscribeResultsViewCommand Read-Only Attributes

Read-Only Attribute
Description

ResultDataSet
Handle to the subscribed Result View.

Type: handle
Default: 0
TableColumnCount
Number of columns for each table in TableNames.

Type: u32
Default: 0
TableColumnNames
Comma separated name of columns for each table in TableNames.

Type: string
Default: 0
TableColumnValues
Comma separated values of counters for each table in TableNames.

Type: string
Default: 0
TableNames
Names of the exported table.

Type: string
Default: 0
SubTlvs (overloaded)
SubTlvs (VICTLV) - Object definition for the following paths:
StreamBlock.ProvisioningInfoTLV.Info.ProvList.VmWare.SubTlvs
SubTlvs (VICTLV) - Object definition for the following paths:
StreamBlock.ProvisioningInfoTLV.Info.ProvList.Fixed.SubTlvs
SubTlvs Object (VICTLV PDU library)
2875
summaryAdditionalMetrics
Description:
Parents: VmWare (StreamBlock.ProvisioningInfoTLV.Info.ProvList.VmWare)

Children: VmWareSubTlvList
SubTlvs Attributes
Attribute
Description
Name
information.
Type: string
SubTlvs Object (VICTLV PDU library)

Description:
Parents: Fixed (StreamBlock.ProvisioningInfoTLV.Info.ProvList.Fixed)

Children: FixedSubTlvList
SubTlvs Attributes
Attribute
Description
Name
information.
Type: string
summaryAdditionalMetrics
Description:
Parents: ospfv2SummaryLsa, ospfv2SummaryAsbrLsa
Children: Ospfv2SummaryLsaTosMetric
summaryAdditionalMetrics Attributes
Attribute
Description
Name
information.
Type: string
2876
SummaryLsaBlock
SummaryLsaBlock
Description:
An OSPFv2 SummaryLsaBlock object and its associated NetworkBlock object describe routes to networks outside of the area.

SummaryLsaBlock Writable Attributes

Writable Attribute
Description
AdvertisingRouterId
Router ID of the emulated router that this SummaryLsaBlock object is associated with. This will be the advertising router field
in the advertised LSAs.
Type: ip
Default: null
Age

Type: u16
Default: 0
Range: 0 - 3600
CheckSum
Specifies the LSA will be advertised with a good or a bad checksum.

Type: enum
Default: GOOD
Possible Values:
Value Description
BAD
LSA is advertised with a bad checksum.
GOOD LSA is advertised with a good checksum.

Metric
Route-cost metric to be used when advertising the specified summary LSAs.

Type: u32
Default: 1
Range: 1 - 16777215
Options
Summary LSA Options.

Type: enum
Default: EBIT
Possible Values:
Value
Description
TBIT
EBIT
MCBIT
NPBIT
EABIT
DCBIT
OBIT

RouteCategory

Type: enum
Default: UNDEFINED
Possible Values:
Value
Description
UNDEFINED
PRIMARY
Primary route.

UNIQUE
Unique route.
ANY
Any route.
2877
SupportedEndpointType
Writable Attribute
Description
SeqNum

Type: u32
Default: 0x80000001
SummaryLsaBlock Read-Only Attributes

SupportedEndpointType
Description:
SupportedEndpointType Writable Attributes

Writable Attribute
Description
Active, Name
SupportedEndpointType Read-Only Attributes

Read-Only Attribute
Description
AllowedDstFilterName
Type: string
EndpointClassId
Type: classId
Default: 0
FilterName
Type: string
SupportedProtocol
Description:
SupportedProtocol Writable Attributes

Writable Attribute
Description
Active, Name
2878
SUT
SupportedProtocol Read-Only Attributes

Read-Only Attribute
Description
Protocol
Type: string
ProtocolConfigType
Type: classId
Default: 0
SUT
Description:
System under test object.

Parents: Project
Relations:
Side name
(Type)
Relative
Description
PrimaryIf
(PrimaryIf)

Specifies if a top-level interface is facing the DUT.
TopLevelIf
(TopLevelIf)


stack.
SUT Writable Attributes

Writable Attribute
Description
Active, Name
SUT Read-Only Attributes

svlans
Description:
Parents: EthernetII, Ethernet8023Raw, Ethernet8022, EthernetSnap, EncapEthernetII, EncapEthernet8023Raw, EncapEthernet8022, EncapEthernetSnap
Children: sTag
2879
SyncEthConfigChangeCommand
svlans Attributes
Attribute
Description
Name
information.
Type: string
SyncEthConfigChangeCommand
Description:
SyncE configuration change command.

SyncEthConfigChangeCommand Writable Attributes

Writable Attribute
Description
NodeList
Active nodes to be used in the test.

Type: handle
Default: 0
QualityLevel
Quality level of the source clock.

Type: string
Rate
Number of messages per second to send.

Type: double
Default: 1.0
SyncEthConfigChangeCommand Read-Only Attributes

Read-Only Attribute
Description

SyncEthDeviceConfig
Description:
Defines a SyncE emulated device object.

Result children (automatically created): SyncEthDeviceResults, SyncEthOption1Results, SyncEthOption2Results
Relations:
2880
SyncEthDeviceResults
Side name
(Type)
Relative
Description
ResultChild
(ResultChild)
SyncEthDeviceResults, SyncEthOption1Results,
SyncEthOption2Results
UsesIf
(UsesIf)


SyncEthDeviceConfig Writable Attributes

Writable Attribute
Description
Active, Name
QualityLevel
SyncE Quality Level value.

Type: string
Default: QL-PRS
Rate
SyncE messages per second.

Type: double
Default: 1.0

Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
SyncEthDeviceConfig Read-Only Attributes

Read-Only Attribute
Description
ClockState
State of the clock.

Type: enum
Default: NONE
Possible Values:
Value
Description
NONE
State information is not available.
INITIALIZING Clock is initializing.

SLAVE
Clock is running as a slave.
MASTER
Clock is running as a master.
SyncEthDeviceResults
Description:
Synchronous Ethernet device results.

Parents: SyncEthDeviceConfig
Relations:
2881
Side name
(Type)
Relative
Description
ResultParent
(ResultChild)
SyncEthDeviceConfig
SyncEthDeviceResults Writable Attributes

SyncEthDeviceResults Read-Only Attributes

Read-Only Attribute
Description
RxAvgInfoMsgInterarrivalTime
Average delay in seconds between two received Information messages.

Type: double
Default: 0
RxEvents
Number of Event messages received.

Type: u32
Default: 0
RxInfoMsgs
Number of Information messages received.

Type: u32
Default: 0
RxMaxInfoMsgInterarrivalTime
Maximum delay in seconds between two received Information messages.

Type: double
Default: 0
RxMinInfoMsgInterarrivalTime
Minimum delay in seconds between two received Information messages.

Type: double
Default: 0
RxQl
Received quality level.

Type: string
RxQlNum
Received quality level as an integer value.

Type: u8
Default: 0
TxEvents
Number of Event messages sent.

Type: u32
Default: 0
TxInfoMsgs
Number of Information messages sent.

Type: u32
Default: 0
TxQl
Transmitted quality level.

Type: string
TxQlNum
>Transmitted quality level as an integer value.

Type: u8
Default: 0
Description:
Synchronous Ethernet option 1 device results.
2882

Parents: SyncEthDeviceConfig, SyncEthPortConfig
Relations:
Side name
(Type)
Relative
Description
ResultParent
(ResultChild)
SyncEthDeviceConfig, SyncEthPortConfig
SyncEthOption1Results Writable Attributes

SyncEthOption1Results Read-Only Attributes

Read-Only Attribute
Description
RxQlDnuCount
Number of QL-DNU (Do Not Use) messages received.

Type: u32
Default: 0
RxQlPrcCount
Number of QL-PRC (Primary Reference Clock) messages received.

Type: u32
Default: 0
RxQlSecCount
Number of QL-SEC (SDH Equipment Clock) messages received.

Type: u32
Default: 0
RxQlSsuaCount
Number of QL-SSU-A (Synchronization Supply Unit) messages received.

Type: u32
Default: 0
RxQlSsubCount
Number of QL-SSU-B (Synchronization Supply Unit) messages received.

Type: u32
Default: 0
RxQlUnsupCount
Number of unsupported messages received.

Type: u32
Default: 0
TxQlDnuCount
Number of QL-DNU (Do Not Use) messages sent.

Type: u32
Default: 0
TxQlPrcCount
Number of QL-PRC (Primary Reference Clock) messages sent.

Type: u32
Default: 0
TxQlSecCount
Number of QL-SEC (SDH Equipment Clock) messages sent.

Type: u32
Default: 0
TxQlSsuaCount
Number of QL-SSU-A (Synchronization Supply Unit) messages sent.

Type: u32
Default: 0
TxQlSsubCount
Number of QL-SSU-B (Synchronization Supply Unit) messages sent.

Type: u32
Default: 0
TxQlUnsupCount
Number of unsupported messages sent.

Type: u32
Default: 0
2883
Description:
Synchronous Ethernet option 2 device results.

Parents: SyncEthDeviceConfig, SyncEthPortConfig
Relations:
Side name
(Type)
Relative
Description
ResultParent
(ResultChild)
SyncEthDeviceConfig, SyncEthPortConfig
SyncEthOption2Results Writable Attributes

SyncEthOption2Results Read-Only Attributes

Read-Only Attribute
Description
RxQlDusCount
Number of QL-DUS (Do Not Use) messages received.

Type: u32
Default: 0
RxQlProvCount
Number of QL-PROV (Provisionable by network operator) messages received.

Type: u32
Default: 0
RxQlPrsCount
Number of QL-PRS (Primary Reference Source) messages received.

Type: u32
Default: 0
RxQlSmcCount
Number of QL-SMC messages received.

Type: u32
Default: 0
RxQlSt2Count
Number of QL-ST2 (Stratum 2) messages received.

Type: u32
Default: 0
RxQlSt3Count
Number of QL-ST2 (Stratum 3) messages received.

Type: u32
Default: 0
RxQlSt3eCount
Number of QL-ST2 (Stratum 3 Enhanced) messages received.

Type: u32
Default: 0
RxQlStuCount
Number of QL-STU (Synchronization Traceability Unknown) messages received.

Type: u32
Default: 0
RxQlTncCount
Number of QL-TNC (Transit Node Clock) messages received.

Type: u32
Default: 0
RxQlUnsupCount

Type: u32
Default: 0
TxQlDusCount
Number of QL-DUS (Do Not Use) messages sent.

Type: u32
Default: 0
2884
SyncEthPortConfig
Read-Only Attribute
Description
TxQlProvCount
Number of QL-PROV (provisionable by network operator) messages sent.

Type: u32
Default: 0
TxQlPrsCount
Number of QL-PRS (Primary Reference Source) messages sent.

Type: u32
Default: 0
TxQlSmcCount
Number of QL-SMC (SONET Minimum Clock) messages sent.

Type: u32
Default: 0
TxQlSt2Count
Number of QL-ST2 (Stratum 2) messages sent.

Type: u32
Default: 0
TxQlSt3Count
Number of QL-ST2 (Stratum 3) messages sent.

Type: u32
Default: 0
TxQlSt3eCount
Number of QL-ST2 (Stratum 3 Enhanced) messages sent.

Type: u32
Default: 0
TxQlStuCount
Number of QL-STU (Synchronization Traceability Unknown) messages sent.

Type: u32
Default: 0
TxQlTncCount
Number of QL-TNC (Transit Node Clock) messages sent.

Type: u32
Default: 0
TxQlUnsupCount

Type: u32
Default: 0
SyncEthPortConfig
Description:
SyncE port config.

Parents: Port
Result children (automatically created): SyncEthOption1Results, SyncEthOption2Results, SyncEthPortResults
Relations:
Side name
(Type)
Relative
Description
ResultChild
(ResultChild)
SyncEthOption1Results, SyncEthOption2Results,
SyncEthPortResults
SyncEthPortConfig Writable Attributes

Writable Attribute
Description
Active, Name
2885
SyncEthPortResults
Writable Attribute
Description
OptionType
SyncE Option type.

Type: enum
Default: OPTION2
Possible Values:
Value
Description
OPTION1 Option 1.
OPTION2 Option 2.
SyncEthPortConfig Read-Only Attributes

SyncEthPortResults
Description:
Synchronous Ethernet port results.

Parents: SyncEthPortConfig
Relations:
Side name
(Type)
Relative
Description
ResultParent
(ResultChild)
SyncEthPortConfig
SyncEthPortResults Writable Attributes

SyncEthPortResults Read-Only Attributes

Read-Only Attribute
Description
RxEvents
Number of Event messages received.

Type: u32
Default: 0
RxInfoMsgs
Number of Information messages received.

Type: u32
Default: 0
TxEvents
Number of Event messages sent.

Type: u32
Default: 0
TxInfoMsgs
Number of Information messages sent.

Type: u32
Default: 0
SyncEthStateSummary
2886
systemCapabilities
Description:
SyncE state summary results.

Relations:
Side name
(Type)
Relative
Description
ResultParent
(ResultChild)
Port, Project
SyncEthStateSummary Writable Attributes

SyncEthStateSummary Read-Only Attributes

Read-Only Attribute
Description
DisabledCount
Number of SyncE routers in the DISABLED state.

Type: u64
Default: 0
MasterCount
Number of SyncE routers in the MASTER state.

Type: u64
Default: 0
NotStartedCount
Number of SyncE routers in Not Started State state.

Type: u32
Default: 0
RouterDownCount
Number of SyncE routers in the DOWN state.

Type: u32
Default: 0
RouterUpCount
Number of SyncE routers in the UP state.

Type: u32
Default: 0
SlaveCount
Number of SyncE routers in the SLAVE state.

Type: u64
Default: 0
systemCapabilities
Description:
Parents: SystemCapabilitiesTlv, SystemCapabilitiesTlv
Children: None
lldp:NivSupportTlv
2887
SystemCapabilitiesTlv
systemCapabilities Attributes
Attribute
Description
bridge
Type: BITSTRING
Default: 0
docsisCableDevice
Type: BITSTRING
Default: 0
Name
Type: string
other
Type: BITSTRING
Default: 0
repeater
Type: BITSTRING
Default: 0
reserved
Type: OCTETSTRING
Default: 00
router
Type: BITSTRING
Default: 1
stationOnly
Type: BITSTRING
Default: 0
telephone
Type: BITSTRING
Default: 0
wlanAccessPoint
Type: BITSTRING
Default: 0
SystemCapabilitiesTlv (lldp:SystemCapabilitiesTlv)
Description:
Children: enabledCapabilities, systemCapabilities
lldp:NivSupportTlv
SystemCapabilitiesTlv Attributes
Attribute
Description
length
Type: INTEGER
Default: 4
Name
more information.
Type: string
type
Type: INTEGER
Default: 7
2888
SystemDescriptionTlv
SystemDescriptionTlv (lldp:SystemDescriptionTlv)
Description:
Children: None
lldp:NivSupportTlv
SystemDescriptionTlv Attributes
Attribute
Description
description
Type: ASCII
Default: Spirent Test Center
length
Type: INTEGER
Default: 0
Name
Type: string
type
Type: INTEGER
Default: 6
SystemNameTlv (lldp:SystemNameTlv)
Description:
Children: None
lldp:NivSupportTlv
SystemNameTlv Attributes
Attribute
Description
length
Type: INTEGER
Default: 0
name
Type: ASCII
Default: Spirent Test Center
Name
more information.
Type: string
type
Type: INTEGER
Default: 5
2889
TableModifier
TableModifier
Description:
Use this object to vary a specific portion of a stream block's packet content with a fixed set of values.

Relations:
Side name
(Type)
Relative
Description
CarryChainTo
(CarryChainTo)
RangeModifier, TableModifier
Specifies to link to another modifier.
TableModifier Writable Attributes

Writable Attribute
Description
Active, Name
Data
Specifies the list of bytes to insert into the stream block.

Type: string
Default: 00
DataType
Specifies the type to use for the Data attribute.

Type: enum
Default: NATIVE
Possible Values:
Value
Description
NATIVE Data attribute is the same type as the PDU field being modified.
BYTE
EnableStream
Data attribute is a hexadecimal byte pattern.
Type: bool
Default: FALSE
Possible Values:
Value Description
TRUE
FALSE Use VFDs to generate modified values. The RepeatCount attribute value must be a power of two. The number of
modifiers with EnableStream set to FALSE is limited by the Spirent TestCenter hardware (4 or 6 depending on the
card series).
Offset
Data offset in bytes (starting from most significant byte) to which this modifier applies. This is used when the DataType
attribute is set to BYTE.
Type: u32
Default: 0
OffsetReference
on that object.
to "MyArpPdu". Then in the OffsetReference attribute of the TableModifier object, refer to this ARP field as
MyArpPdu.hardware.
Type: string
RepeatCount
Specifies the number of times the value will be repeated.

Type: u32
Default: 0
TableModifier Read-Only Attributes

2890
TagList
TagList
Description:
Parents: theTags
Children: ctags, stags
TagList Attributes
Attribute
Description
Name
information.
Type: string
tags
Description:
Parents: PPPoEDiscovery
Children: PPPoETag
tags Attributes
Attribute
Description
Name
information.
Type: string
targetFecSubTlvs
Description:
Parents: target

Spirent TestCenter Automation Obj Ref

Uploaded by

Document Information

Copyright

Available Formats

Share this document

Share or Embed Document

Sharing Options

Did you find this document useful?

Is this content inappropriate?

Copyright:

Available Formats

Spirent TestCenter Automation Obj Ref

Uploaded by

Copyright:

Available Formats

TM

Spirent TestCenter Automation

P/N 71-006396 REV A

Spirent Communications, Inc.

Europe, Africa, Middle East

Test Configuration Objects Index

Test Configuration Objects Index

Test Configuration Objects Index

Test Configuration Objects Index

Test Configuration Objects Index

Test Configuration Objects Index

All Command Objects Index

All Command Objects Index

All Command Objects Index

All Command Objects Index

All Command Objects Index

All Command Objects Index

Command Sequencer Command Objects Index

Command Sequencer Command

Command Sequencer Command Objects Index

Command Sequencer Command Objects Index

Result Objects Index

Result Objects Index

Result Objects Index

PDU Objects Index

Protocol Data Unit Objects Index

PDU Objects Index

PDU Objects Index

PDU Objects Index

PDU Objects Index

PDU Objects Index

PDU Objects Index

All Objects Index

All Objects Index

All Objects Index

All Objects Index

All Objects Index

All Objects Index

All Objects Index

All Objects Index

All Objects Index

All Objects Index

All Objects Index

All Objects Index

All Objects Index

All Objects Index

All Objects Index

All Objects Index

All Objects Index

All Objects Index

All Objects Index

User Data, Uncongested

User Data, Congested

Writable Attributes | Read-Only Attributes

Specifies physical layer compatibility

PathDescriptor, StreamBlock, TrafficDescriptor

Specifies destination endpoints bound to

Specifies the encapsulation.

CustomLink, CustomLink, EoamLink, EoamLink, EthernetBridgeLink,

VpnIdGroup, VpnSiteInfo6Pe, VpnSiteInfoRfc2547, VpnSiteInfoVplsBgp,

Do not use, to be removed

Traffic sent to this end point is expected

Aal5If, Dhcpv4ServerDefaultPoolConfig, Dhcpv4ServerPoolConfig,

Specifies an optionally-selected lower