Overview Package Class Deprecated Help

pppoe
PPPoASession

Defines the subscriber PPPoA session object

public class PPPoASession

Properties
portName The name of the SAP's port.

type=string
access=read-create
default=
minimum=0
maximum=32
Mandatory on create
Displayed(tab/group)=Port Name (/PPP Session General)
vci The vcivalue.

type=int
access=read-create
default=0
Displayed(tab/group)=VCI (/PPP Session General)
vpi The vpi value

type=int
access=read-create
default=0
Displayed(tab/group)=VPI (/PPP Session General)
  
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

retrievePPPoASessions

Method used to query the NE for the PPPoA session(s) for.
Input Parameters:
retrievingSessionStruct : pppoe.RetrievingSessionStruct - retrievingSessionStruct of retrieving PPPoA sessions request with desired siteID, serviceId, sapId, innerEncap, outerEncap, whose values are used to be retrieve PPPoA sessions. The retrievingSessionStruct must have set siteID, serviceId, sapId, innerEncap, outerEncap. outerEncap value must specify the VPI of the ATM SAP and innerEncap value must specify the VCI of the ATM SAP.
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 PPPoA Session(s) to be retrieved.
aInRemoteId : string - (Optional) Specifies Remote ID value of PPPoA 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.PPPoASession.retrievePPPoASessionsException
Supported Network Elements
7750 SR Supported from 9.0.R4
7705 SAR Gen 2
7450 ESS Supported from 9.0.R4
  • Excluded chassis types: 7450-ESS6, 7450-ESS6V
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