Overview Package Class Deprecated Help

service
ServiceThroughputConfig

This class represents a configuration for preparing the service throughput test. For a typical usage, the user needs to specify: 1) the source SAP, and the source test port where a new SAP will be created based on the source SAP 2) the destination SAP, and the destination port where a new SAP will be created based on the destination SAP 3) if destination service SAP supports loopback, it can be configured 4) if destination port supports loopback, it can be configured 5) if destination service SDP-binding supports loopback, it can be configured By creating this object, NFM-P will copy and create the new SAPs on the test port, and (or) configure the loopback port or SAP/SDP-binding based on the input. By deleting this object, NFM-P will restore the service to its original state, such as, remove the new SAPs created on the test port, recreate the original SAPs, restore the loopback port to its original configuration, remove loopback SAP/SDP-binding, etc.

public class ServiceThroughputConfig

Properties
adminLockSdpBindingPointer Specifies the source site SDP binding for Admin Lock operation

type=Pointer
default=
Displayed(tab/group)=SDP Binding (/Traffic Test Entry/Admin Lock)
compositeSvcId Specifies the composite service ID that contains the services for testing.

type=long
access=read-only
default=0
description Specifies the description.

type=string
default=
minimum=0
maximum=80
Displayed(tab/group)=Description
dstPortForTesting Specifies the destination port dedicated for testing, e.g. a port with loopback and MAC swap.

type=Pointer
default=
Displayed(tab/group)=Port (/Traffic Test Destination/Destination SAP and Port)
dstPortLoopback Specifies the port loopback type if it is applicable for the test port in the test end. If not specified, the value is retrieved from the test port. Any updates to it will be set to the port too.

type=ethernetequipment.PortLoopback
default=none
Displayed(tab/group)=Loopback Type (/Traffic Test Destination/Port Loopback)
dstPortLoopbackTime Specifies the time duration for the port in loopback mode. If not specified, the value is retrieved from the test port. Any updates to it will be set to the port too.

type=long
default=0
minimum=0
maximum=86400
units=seconds
Displayed(tab/group)=Loopback Time (/Traffic Test Destination/Port Loopback)
dstSapBeingReplaced Specifies the destination SAP to be replaced by a new one created on the test port.

type=Pointer
default=
Displayed(tab/group)=SAP (/Traffic Test Destination/Destination SAP and Port)
dstServiceId The destination service ID.

type=long
access=read-only
default=0
Displayed(tab/group)=Service ID (/Traffic Test Destination)
dstSiteId The system ID of destination site.

type=string
access=read-only
default=0.0.0.0
maximum=50
dstSiteIdPointer Destination/Target service site pointer

type=Pointer
default=
Displayed(tab/group)=Site ID (/Traffic Test Destination)
entrySitePointer Specifies the source service site pointer

type=Pointer
default=
Displayed(tab/group)=Site ID (/Traffic Test Entry)
id Specifies the ID for this configuration. It must be unique under its parent.

type=long
access=read-create
default=0
minimum=1
maximum=4294967295
Displayed(tab/group)=ID
loopbackSapPointer Specifies the loopback SAP pointer, it can be used in either: 1) loopback port application 2) loopback SAP application

type=Pointer
default=
Displayed(tab/group)=Loopback SAP (/Traffic Test Destination/Loopback SAP)
loopbackSdpBindingPointer Specifies the SDP binding pointer for Loopback operation

type=Pointer
default=
Displayed(tab/group)=SDP Binding (/Traffic Test Destination/Loopback)
portLoopbackDstMacAddress Specifies the port loopback destination MAC Address.

type=MacAddress
default=00-00-00-00-00-00
Displayed(tab/group)=Destination MAC Address (/Traffic Test Destination/Port Loopback)
portLoopbackPersist Specifies whether make the port loopback persistent.

type=boolean
default=false
Displayed(tab/group)=Persistent Loopback (/Traffic Test Destination/Port Loopback)
portLoopbackSrcMacAddress Specifies the port loopback source MAC Address.

type=MacAddress
default=00-00-00-00-00-00
Displayed(tab/group)=Source MAC Address (/Traffic Test Destination/Port Loopback)
portLoopbackSwapMacAddr Specifies whether swap MAC address for the loopback port.

type=boolean
default=false
Displayed(tab/group)=Swap MAC Address (/Traffic Test Destination/Port Loopback)
srcPortForTesting Specifies the source port dedicated for testing, i.e. connecting to a traffic generator.

type=Pointer
default=
Displayed(tab/group)=Port (/Traffic Test Entry)
srcSapBeingReplaced Specifies the source SAP to be replaced by a new one created on the test port.

type=Pointer
default=
Displayed(tab/group)=SAP (/Traffic Test Entry)
srcServiceId The source service ID.

type=long
access=read-only
default=0
Displayed(tab/group)=Service ID (/Traffic Test Entry)
srcSiteId The system ID of source site.

type=string
access=read-only
default=0.0.0.0
maximum=50
Displayed(tab/group)=Site ID (/Traffic Test Entry)
svcSapOrSdpLoopbackMode The value of the property svcSapOrSdpLoopbackMode specifies how traffic will be reflected. If the value is set to 'ingress(1)', traffic arriving at the SAP or SDP Binding ingress will be reflected back out the same SAP/SDP Binding. If the value is set to 'egress(2)', traffic arriving at the SAP/SDP Binding egress will be reflected back into the service in the direction of the original source."

type=service.EthLoopbackMode
access=read-create
default=ingress
Displayed(tab/group)=Loopback Mode (/Traffic Test Destination/Loopback Parameters)
svcSapOrSdpLoopbackmacSwap "TRUE" if enabled. "FALSE" if disabled. With svcSapOrSdpLoopbackmacSwap enabled, any broadcast or multicast packets arriving on a looped point will be dropped.

type=boolean
access=read-create
default=false
Displayed(tab/group)=MAC Swap (/Traffic Test Destination/Loopback Parameters)
svcSapOrSdpLoopbackmacSwapAddr the source MAC address used in the reflected packet when the arriving packet is broadcast or multicast. This does not apply to arriving unicast packets

type=MacAddress
access=read-create
default=00-00-00-00-00-00
Displayed(tab/group)=MAC Swap Address (/Traffic Test Destination/Loopback Parameters)
svcSapOrSdpLoopbackmacSwapAddrAll specifies whether or not to use the configured svcSapOrSdpLoopbackmacSwapAddr as the source address for all reflected parameters

type=boolean
access=read-create
default=false
Displayed(tab/group)=MAC Swap Address All (/Traffic Test Destination/Loopback Parameters)
svcloopbackSDPBindingPointer Specifies the target Site SDP binding for loopback operation

type=Pointer
default=
Displayed(tab/group)=Loopback SDP Binding (/Traffic Test Destination/Loopback SDP Binding)
testMethod Specifies the test method to prepare a throughput test. Currently there are following test methods: - sapFunctions: used combined with parameter 'throughputOption' to apply SAP-to-SAP related tests. The applicable options: swapSap. loopbackPort. and swapSapAndLoopbackPort - loopbackFunctions: used combined with parameter 'throughputOption' to apply loopback related tests. The applicable options: loopbackSap and loopbackSdpBind - lockInstructFunctions: allow the user to prepare a throuhgput test by configuring admin lock and loopback on the SDP binding (using MPLS-TP tunnel).

type=service.TestMethod
default=sapFunctions
Displayed(tab/group)=Test Method
testServiceId Specifies the test service identifier associated with the Admin Lock operation

type=long
access=read-create
default=0
testServicePointer Specifies the test service for Admin Lock operation

type=Pointer
default=
Displayed(tab/group)=Test Service (/Traffic Test Entry/Admin Lock)
throughputOption Specifies the test option under a test method to prepare a throughput test. Currently there are following test options: - swapSap: simply swap the SAP (creating a new SAP by copying the existing one on the port specified). - loopbackPort: set the loopback on the port where desination SAP configured, no swap SAP. - swapSapAndLoopbackPort: the combination of above two options, i.e. allow the user to specify a port to swap the destination SAP and then set the loopback on that port. - loopbackSap: enable the loopback on the specified desination SAP. - loopbackSdpBind: enable the loopback on the specified SDP binding.

type=service.ThroughputOption
default=swapSap
Displayed(tab/group)=Option (/Traffic Test Destination)
  
Properties inherited from ManagedObject
actionMask, children-Set, deploymentState, isFaultSquelched, name, objectFullName, selfAlarmed