l2tp
L2TPSession

Defines L2TP session object that is retrieved on-demand only and not persisted in NFM-P DB.



public class L2TPSession

Properties
cdnResult Indicates the result of a CDN (Call-Disconnect-Notify) message related to this L2TP Session.

type=l2tp.CDNResult
access=read-only
Displayed(tab/group)=CDN Result (General /Operational Information)

closedTime Indicates the value of NE sysUpTime when this L2TP session entered one of the closed states.

type=Date
access=read-only
Displayed(tab/group)=Closed Time (General /Operational Information)

connectionId Local identifier of this L2TP session. In L2TP version 2, it contains the 16-bit session ID in the lower order bits and the 16-bit tunnel ID in the higher order bits. In L2TP version 3, it is the 32-bit session ID.

type=long
access=read-create
default=0
minimum=0
maximum=4294967295
Displayed(tab/group)=Connection ID (General /Session)

cookieInRx Indicates the cookie used in the Received data packets of L2TPv3 Session.

type=string
access=read-only
minimum=0
maximum=8
Displayed(tab/group)=Rx Cookie (General /L2TPv3 Information)

cookieInTx Indicates the cookie used in the transmitted data packets of L2TPv3 Session.

type=string
access=read-only
minimum=0
maximum=8
Displayed(tab/group)=Tx Cookie (General /L2TPv3 Information)

creationOrigin

type=svt.L2RouteOriginType
access=read-create
default=manual

endPoint Indicates the End Point identification of L2TPv3 Session.

type=string
access=read-only
minimum=0
maximum=250
Displayed(tab/group)=End Point (General /L2TPv3 Information)

endPointDescription Indicates the End Point Description of L2TPv3 Session.

type=string
access=read-only
minimum=0
maximum=250
Displayed(tab/group)=End Point Description (General /L2TPv3 Information)

errorMessage Describes the error related to this L2TP Session.

type=string
access=read-only
minimum=0
maximum=255
Displayed(tab/group)=Error Message (General /Operational Information)

establishedTime Indicates the value of NE sysUpTime when this L2TP session entered the state 'Established'.

type=Date
access=read-only
Displayed(tab/group)=Established Time (General /Operational Information)

generalError Indicates an general error related to this L2TP Session.

type=l2tp.GeneralError
access=read-only
Displayed(tab/group)=General Error (General /Operational Information)

l2tpVersion Indicates the Version of L2TP Session .Its a NFM-P Only Property.

type=l2tp.L2TPProtocolVersion
access=read-only
default=l2tpv2
Displayed(tab/group)=L2TP Protocol Version (General )

mlpppBundleId Indicates the identifier of the MLPPP Bundle related to this Layer Two Tunneling Protocol Session. The zero means that no MLPPP bundle is associated with this session.

type=long
access=read-only
default=0
minimum=0
Displayed(tab/group)=Bundle ID (General /LAC MLPPP)

operationalState Operational status for the session.

type=l2tp.SessionOperationalState
access=read-only
Displayed(tab/group)=Operational State (General /Operational Information)

peerAddress Specifies the IP address for the peer.

type=InetAddress
access=read-only

peerAddressType Specifies the address type of the IP address for the peer.

type=rtr.InetAddressType
access=read-only

pppSessionIndex Indicates the index of PPP session on LNS L2TP sessions. The value is equal to zero for LAC L2TP Sessions.

type=long
access=read-only
default=0
Displayed(tab/group)=PPP Session ID (General /LNS PPP)

pwType Indicates the Pseudo Wire type of L2TPv3 Session.

type=l2tp.PWType
access=read-only
Displayed(tab/group)=PW Type (General /L2TPv3 Information)

remoteConnectionId Indicates the identifier of the L2TP Session used by the tunnel peer.

type=long
access=read-only
minimum=0
maximum=4294967295
Displayed(tab/group)=Remote Connection ID (General /Session)

remoteSessionId Indicates the identifier of this L2TP Session used by the tunnel peer, when L2TP version 2 is used. In L2TP version 3, it is equal to zero.

type=long
access=read-only
minimum=0
maximum=65535
Displayed(tab/group)=Remote Session ID (General /Session)

remoteTunnelId Indicates the identifier used by the tunnel peer of the L2TP tunnel associated with this L2TP Session , when L2TP version 2 is used. In L2TP version 3, it is equal to zero.

type=long
access=read-only
minimum=0
maximum=65535
Displayed(tab/group)=Remote Tunnel ID (General /Tunnel)

routerId "Router Identifier of the routing protocol site where the tunnel resides.

type=int
access=read-only
default=1
minimum=1
maximum=10240

routingInstancePointer FDN of the routing instance object where the Tunnel Instance Endpoint is created.

type=Pointer
access=read-only
default=
Displayed(tab/group)=Routing Instance ID (General )

seqNumConInRx Indicates under which condition the sequence number is present in received data packets of L2TPv3 Session.

type=l2tp.DataType
access=read-only
Displayed(tab/group)=Sequence Number Condition in Rx (General /L2TPv3 Information)

seqNumConInTx Indicates under which condition the sequence number is present in Transmitted data packets of L2TPv3 Session.

type=l2tp.DataType
access=read-only
Displayed(tab/group)=Sequence Number Condition in Tx (General /L2TPv3 Information)

sessionId Indicates the identifier of the L2TP Session, when L2TP version 2 is used. In L2TP version 3, it is equal to zero.

type=long
access=read-only
minimum=0
maximum=65535
Displayed(tab/group)=Session ID (General /Session)

siteId NE ID where the Tunnel Instance Endpoint is created.

type=string
access=read-only
default=
minimum=0
maximum=64
Displayed(tab/group)=Site ID (General )

startTime Indicates the value of NE sysUpTime when this L2TP session entered either the state 'idle', 'waitTunnel', 'waitReply' or 'waitAcceptance'.

type=Date
access=read-only
Displayed(tab/group)=Start Time (General /Operational Information)

subLayerInRx Indicates whether the Layer Two sub-layer is present in the received data packets or not of L2TPv3 Session.

type=boolean
access=read-only
Displayed(tab/group)=Sublayer In Rx (General /L2TPv3 Information)

subLayerInTx Indicates whether the Layer Two sub-layer is present in the Transmitted data packets or not of L2TPv3 Session.

type=boolean
access=read-only
Displayed(tab/group)=Sublayer In Tx (General /L2TPv3 Information)

tunnelConnectionId Indicates the identifier of the L2TP tunnel associated with this L2TP Session.

type=long
access=read-only
minimum=0
maximum=4294967295

tunnelId Indicates the identifier of the L2TP tunnel associated with this L2TP Session, when L2TP version 2 is used. In L2TP version 3, it is equal to zero.

type=long
access=read-only
minimum=0
maximum=65535
Displayed(tab/group)=Tunnel ID (General /Tunnel)

tunnelStatusPointer FDN of the L2Tp Tunnel Instance Endpoint where the session is corresponding.

type=Pointer
access=read-only
default=
Displayed(tab/group)=Tunnel Connection ID (General /Tunnel)

  
Properties inherited from ManagedObject
actionMask, children-Set, deploymentState, isFaultSquelched, name, objectFullName, selfAlarmed
 
Methods

retrieveL2TPSessions

Method used to retrieve L2TP session(s) from NE.
Input Parameters:
sessionStruct : l2tp.SessionStruct -
shallowRetrieval : boolean - (Optional) If it is true, not all of the properties are retrieved for quick response
resultFilter : ResultFilter - (Optional) Filter for narrowing down the information returned per object
continueOnFailure : continueOnFailure - (Optional) Continue processing requests in this stream if an exception occurs, unless the request is invalid. Default: false
Output Parameters:
result : List (generic.CommonManagedEntityInformation) -
Exceptions:
l2tp.L2TPSession.retrieveL2TPSessionsException

retrieveL2TPv3EthernetTunnelStats

Method used to retrieve L2TPv3 Ethernet session stats from NE.
Input Parameters:
sessionStruct : l2tp.SessionStruct -
resultFilter : ResultFilter - (Optional) Filter for narrowing down the information returned per object
continueOnFailure : continueOnFailure - (Optional) Continue processing requests in this stream if an exception occurs, unless the request is invalid. Default: false
Output Parameters:
result : List (generic.CommonManagedEntityInformation) -
Exceptions:
l2tp.L2TPSession.retrieveL2TPv3EthernetTunnelStatsException
Supported Network Elements
7750 SR Supported from 9.0.R1
7450 ESS Supported from 9.0.R1
  • Required Capabilities: MixedMode
Product Specifics
7450 ESS 20.0
7450 ESS 21.0
7450 ESS 22.0
7450 ESS 23.0
7450 ESS 24.0
7450 ESS 25.0
7750 SR 20.0
7750 SR 21.0
7750 SR 22.0
7750 SR 23.0
7750 SR 24.0
7750 SR 25.0