Overview Package Class Deprecated Help

pppoe
PPPSession

Defines the subscriber PPP session object that contains all types of session (PPPoA, PPPoE, PPPoEoA, and PPPoL2TP).

public class PPPSession

Properties
mlpppBundleId Indicates the MLPPP bundle identifier of the session. If the MLPPP Role is equal to 'no', the value is equal to zero.

type=long
access=read-only
default=0
minimum=0
Displayed(tab/group)=Bundle ID (/MLPPP)
mlpppRole Indicates the Multi Link PPP (MLPPP) role of this session. Only 'oL2tp' PPP Sessions can have a value different from 'no'

type=pppoe.MlpppRole
access=read-only
default=no
Displayed(tab/group)=Role (/MLPPP)
  
Properties inherited from pppoe.AbstractPPPSession
acctSessionId, addressPool, ancpString, appProfileString, authProtocol, categoryMapName, circuitId, description, encapVal, groupIf, groupIfName, ignoringDfBit, intermediateDestId, ipAddrPrefixLength, ipAddress, ipAddressType, ipcpState, ipv6Addr, ipv6AddrOrigin, ipv6AddrPool, ipv6AddrType, ipv6CpState, ipv6DelPfxOrigin, ipv6DelPfxPool, ipv6DelPrefix, ipv6DelPrefixLength, ipv6DelPrefixType, ipv6Dns1Type, ipv6Dns2Type, ipv6Prefix, ipv6PrefixLength, ipv6PrefixOrigin, ipv6PrefixPool, ipv6PrefixType, isMcStandBy, l2tpConnectionId, l2tpPeerAddress, l2tpPeerAddressType, l2tpRtrId, lcpState, logicalLineId, origIpv6CpInfo, originDns, originIp, originNbns, originStrings, originSubscrIdent, pppMtu, pppoe.PPPAccessLoopEncap-Set, pppoe.PPPBgpIPv6Entry-Set, pppoe.PPPQosOverride-Set, pppoe.PPPSessionBgpEntry-Set, pppoe.PPPSessionRadiusClassAttribute-Set, primaryDnsIpAddress, primaryDnsIpv6Addr, primaryDnsType, primaryNbnsIpAddress, primaryNbnsType, radiusClass, radiusUsername, remoteId, retailerIf, retailerSvcId, ripListenerStatus, ripPolicyPointer, sapPointer, sapPortId, sapSessionIdx, secondaryDnsIpv6Addr, secondryDnsIpAddress, secondryDnsType, secondryNbnsIpAddress, secondryNbnsType, serviceId, sessionIndex, siteId, siteIdAddrType, spiGroupId, subIdentPolicy, subscrIdent, subscrProfileString, subscrSLAString, subscriberIf, subscriberIfName, terminationType, timeout, type, upTime, userName
 
Properties inherited from ManagedObject
actionMask, children-Set, deploymentState, isFaultSquelched, name, objectFullName, selfAlarmed
 
Methods

retrievePppSessions

Method used to retrieve a PPP session from NE.
Input Parameters:
pppSessionRetrievalStruct : pppoe.PppSessionRetrievalStruct -
retrieveManagedRoutes : boolean - (Optional) Specifies if Managed Routes should be retrieved,the default is "true". The Managed Routes won't be retrieved if Service preferences "retrieveManagedRoutes" is false.
retrieveQoSOvr : boolean - (Optional) Specifies if QoS Override should be retrieved,the default is "true". The QoS Override won't be retrieved if Service preferences "retrieveQoSOvr" is false.
retrieveAcclpEncap : boolean - (Optional) Specifies if Access Loop Encapsulation should be retrieved,the default is "true". The Access Loop Encapsulation won't be retrieved if Service preferences "retrieveAcclpEncap" is false.
retrieveBgpPeerInfo : boolean - (Optional) Specifies if IPv4 BGP Peer Info should be retrieved,the default is "true". The BGP Peer Info won't be retrieved if System Preferences "retrieveBgpPeerInfo" is false.
retrieveBgpPeerV6Info : boolean - (Optional) Specifies if IPv6 BGP Peer Info should be retrieved,the default is "true". The BGP Peer Info won't be retrieved if System Preferences "retrieveBgpPeerV6Info" is false.
aInCircuitId : string - (Optional) Specifies Circuit ID of PPP Session(s) to be retrieved.
aInRemoteId : string - (Optional) Specifies Remote ID value of PPP Session(s) to be retrieved.
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:
pppoe.PPPSession.retrievePppSessionsException
Supported Network Elements
7750 SR Supported from 9.0.R1
7705 SAR Gen 2
7705 SAR Hm
7450 ESS Supported from 9.0.R1
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
7705 SAR Gen 2 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