Overview Package Class Deprecated Help

ressubscr
 RetrievingIpoeSessionStruct

This structure encapsulates all the necessary parameters required during retrieving IPoE sessions. siteId and svcId are required, sapId, innerEncap, outerEncap, sessionsMac, sessionsId, and timeout are optional. If sapId is specified, innerEncap and outerEncap values have to be specified based on the encapsulation type. If innerEncap and outerEncap values are not specified, all subscribers for the sapId will be fetched. For example, if the node system address is 1.3.1.3, VPRN service-id is 300, and SAP ID is 35684352. If no encapsulation values are specified, all the subscribers for the SAP ID 35684352 will be fetched. However, if Outer Encap Value of 500 and Inner Encap Value of 0 are specified, only the subscribers specific to the corresponding Dot1 Q encapsulation will be fetched.

public struct RetrievingIpoeSessionStruct

Properties
siteId Specifies the NE of the IPoE session(s). This is a required input parameter.

type=string
svcId Specifies the service ID of the IPoE session(s). This is a required input parameter.

type=long
sapId Specifies the Port name of the IPoE session(s). This is an optional input parameter.

type=string
innerEncap Specifies the SAP inner Encap value of the IPoE session(s). This is an optional input parameter.

type=long
outerEncap Specifies the SAP inner Encap value of the IPoE session(s). This is an optional input parameter.

type=long
sessionsMac Specifies the session MAC address of the IPoE session(s). This is an optional input parameter.

type=string
sessionsId Specifies the session ID of the IPoE session. This is an optional input parameter.

type=long
timeout The number of milliseconds to wait before receiving the results. If no results are received in the given time, the method returns.

type=long