pppoe
AbstractPPPSession

Defines the subscriber PPP session object.



public abstract class AbstractPPPSession

Properties
acctSessionId The Account Session ID of the PPP session.

type=string
access=read-only
default=
Displayed(tab/group)=Account Session ID (/PPP General)

addressPool Indicates the IP address pool which is used to search for an IP address for this session..

type=string
access=read-only
default=
Displayed(tab/group)=IP Address Pool (/PPP General/IPv4 Information)

ancpString ASCII representation of DSLAM circuit ID

type=string
access=read-only
default=
Displayed(tab/group)=ANCP String (/Residential Subscriber)

appProfileString The application profile string applicable for this PPP session.

type=string
access=read-only
default=
Displayed(tab/group)=Application Profile String (/Residential Subscriber)

authProtocol The PPP protocol used to authenticate the PPP session. The value 'none' indicates that no PPP authentication was done. The value 'pap' indicates that authentication was done via the Password Authentication Protocol. The value 'chap' indicates that authentication was done via the Challenge-Handshake Authentication Protocol."

type=pppoe.PppAuthProtocol
access=read-only
Displayed(tab/group)=PPP Authentication Protocol (Authentication Protocols/Authentication Protocols)

categoryMapName Indicates the value of the category map name applicable for this session.

type=string
access=read-only
default=
Displayed(tab/group)=Category Map Name (/Residential Subscriber)

circuitId Defines the value of the circuit-id sub-option.

type=string
access=read-only
default=
Displayed(tab/group)=Circuit ID (/DHCP)

description Indicates an automatically generated description of the session.

type=string
access=read-only
Displayed(tab/group)=Description (/PPP General)

encapVal Indicates the value of the label used to identify this SAP on the access port specified by portId.

type=long
access=read-create
Mandatory on create

groupIf Indicates the interface index of the group-interface to which this session belongs.

type=long
access=read-only

groupIfName Indicates the interface name of the group-interface to which this session belongs.

type=string
access=read-only
default=
Displayed(tab/group)=Group Interface (/PPP General)

ignoringDfBit Indicates if this system ignores the Don't Fragment (DF) bit in the IPv4 header of traffic received for this session

type=boolean
access=read-only
Displayed(tab/group)=Ignoring do-not-fragment (DF) Bit (/PPP General)

intermediateDestId ASCII representation of the intermediate destination (a DSLAM for example) of the host.

type=string
access=read-only
default=
Displayed(tab/group)=Intermediate Destination ID (/Residential Subscriber)

ipAddrPrefixLength Indicates the length of ipAddress.

type=int
access=read-only

ipAddress The IP address of the PPP session

type=InetAddress
access=read-only
default=0.0.0.0
Displayed(tab/group)=IP Address (/PPP General/IPv4 Information)

ipAddressType The IP address type for the PPP session

type=rtr.InetAddressType
access=read-only
default=ipv4

ipcpState The current state of the PPP IP Control Protocol of the PPP session

type=pppoe.PppControlProtocolState
access=read-only
default=initial
Displayed(tab/group)=PPP IP Control Protocol State (Authentication Protocols/Authentication Protocols)

ipv6Addr Indicates the IPv6 Address of the PPP session.

type=InetAddress
access=read-only
default=
Displayed(tab/group)=IPv6 Address (/PPP General/IPv6 Information)

ipv6AddrOrigin Indicates the IPv6 Address Origin of the PPP session.

type=pppoe.PppoeSessionInfoOrigin
access=read-only
Displayed(tab/group)=IPv6 Address Source (/PPP General/IPv6 Information)

ipv6AddrPool Indicates the IPv6 Address Pool for the PPP session.

type=string
access=read-only
default=
minimum=0
maximum=253
Displayed(tab/group)=IPv6 Address Pool (/PPP General/IPv6 Information)

ipv6AddrType Indicates the Address Type of the PPP session.

type=rtr.InetAddressType
access=read-only
default=ipv6

ipv6CpState Indicates the current state of the PPP IPv6 Control Protocol of the PPP session

type=pppoe.PppControlProtocolState
access=read-only
Displayed(tab/group)=PPP IPv6 Control Protocol State (Authentication Protocols/Authentication Protocols)

ipv6DelPfxOrigin The value indicates the origin of ipv6DelPrefix.

type=pppoe.PppoeSessionInfoOrigin
access=read-only
Displayed(tab/group)=Delegate IPv6 Prefix Source (/PPP General/IPv6 Information)

ipv6DelPfxPool Indicates the DHCP server pool from which the delegated prefix, indicated by ipv6DelPrefix, is allocated.

type=string
access=read-only
default=
Displayed(tab/group)=Delegate IPv6 Prefix Pool (/PPP General/IPv6 Information)

ipv6DelPrefix indicates the IPv6 delegated prefix

type=InetAddress
access=read-only
default=0:0:0:0:0:0:0:0
Displayed(tab/group)=Delegate IPv6 Prefix (/PPP General/IPv6 Information)

ipv6DelPrefixLength Indicates the length of ipv6DelPrefix

type=int
access=read-only
Displayed(tab/group)=Delegate IPv6 Prefix Length (/PPP General/IPv6 Information)

ipv6DelPrefixType Indicates the address type of ipv6DelPrefix

type=rtr.InetAddressType
access=read-only
default=ipv6

ipv6Dns1Type Indicates the address type of DnsIpv61IpAddr

type=rtr.InetAddressType
access=read-only
default=ipv6

ipv6Dns2Type Indicates the address type of Ipv6Dns2IpAddr

type=rtr.InetAddressType
access=read-only
default=ipv6

ipv6Prefix Indicates the IPv6 prefix used for stateless address autoconfiguration.

type=InetAddress
access=read-only
default=0:0:0:0:0:0:0:0
Displayed(tab/group)=IPv6 Prefix (/PPP General/IPv6 Information)

ipv6PrefixLength Indicate the length of ipv6Prefix

type=int
access=read-only
Displayed(tab/group)=IPv6 Prefix Length (/PPP General/IPv6 Information)

ipv6PrefixOrigin The value indicates the origin of ipv6Prefix.

type=pppoe.PppoeSessionInfoOrigin
access=read-only
Displayed(tab/group)=IPv6 Prefix Source (/PPP General/IPv6 Information)

ipv6PrefixPool Indicates the IPv6 Prefix Pool for the PPP session.

type=string
access=read-only
default=
minimum=0
maximum=253
Displayed(tab/group)=IPv6 Prefix Pool (/PPP General/IPv6 Information)

ipv6PrefixType Indicates the address type of ipv6Prefix

type=rtr.InetAddressType
access=read-only
default=ipv6

isMcStandBy A session is considered MC standby if the sessions group interface has an srrp instance (tmnxSrrpOperTable) associated with it and this instance's state (tmnxSrrpOperState) is in not master or disabled

type=boolean
access=read-only
default=false

l2tpConnectionId Indicates the connection ID of the L2TP session associated with this session.

type=long
default=0
Displayed(tab/group)=L2TP Session Connection ID (/L2TP)

l2tpPeerAddress Specifies the IP address for the L2TP peer.

type=InetAddress
access=read-only

l2tpPeerAddressType Specifies the address type of the IP address for L2TP the peer.

type=rtr.InetAddressType
access=read-only

l2tpRtrId Indicates the virtual router ID of the L2TP session associated with this session.

type=int
default=0
Displayed(tab/group)=L2TP Session Virtual Router ID (/L2TP)

lcpState The current state of the PPP Link Control Protocol of the PPP session

type=pppoe.PppControlProtocolState
access=read-only
default=initial
Displayed(tab/group)=PPP Link Control Protocol State (Authentication Protocols/Authentication Protocols)

logicalLineId Indicates the value of the Logical Line ID (LLID). This value is first obtained from a RADIUS server in a pre-authentication phase, and subsequently transmitted in the Access-Request message for the actual authentication.

type=string
access=read-only
default=
Displayed(tab/group)=Logical Line ID (Authentication Protocols/RADIUS)

origIpv6CpInfo indicates which source provided the IPv6CP information.

type=pppoe.PppoeSessionInfoOrigin
access=read-only
default=none
Displayed(tab/group)=Session IPv6CP Information Source (Authentication Protocols/Authentication Protocols)

originDns The value indicates which source provided the DNS addresses.

type=pppoe.PppoeSessionInfoOrigin
access=read-only
Displayed(tab/group)=DNS Address Source (DNS and NBNS IP Addresses/DNS and NBNS)

originIp The value indicates which source provided the IP address.

type=pppoe.PppoeSessionInfoOrigin
access=read-only
Displayed(tab/group)=IP Address Source (/PPP General/IPv4 Information)

originNbns The value indicates which source provided the NBNS addresses.

type=pppoe.PppoeSessionInfoOrigin
access=read-only
Displayed(tab/group)=NBNS Address Source (DNS and NBNS IP Addresses/DNS and NBNS)

originStrings The value indicates which source provided the subscriber identification strings (subscriber profile string, SLA profile string, ANCP string, intermediate destination identifier and application profile string).

type=pppoe.PppoeSessionInfoOrigin
access=read-only
Displayed(tab/group)=Subscriber Strings Identification Source (/Residential Subscriber)

originSubscrIdent Defines from what source this subscriber identification was received

type=pppoe.PppoeSessionInfoOrigin
access=read-only
Displayed(tab/group)=Subscriber Identification Source (/Residential Subscriber)

pppMtu The PPP MTU of the PPP session.

type=int
access=read-only
units=bytes
Displayed(tab/group)=PPP MTU (/PPP General)

pppoe.PPPAccessLoopEncap-Set type=Children-Set
pppoe.PPPBgpIPv6Entry-Set type=Children-Set
pppoe.PPPQosOverride-Set type=Children-Set
pppoe.PPPSessionBgpEntry-Set type=Children-Set
pppoe.PPPSessionRadiusClassAttribute-Set type=Children-Set
primaryDnsIpAddress The Primary DNS IP address of the PPP session

type=InetAddress
access=read-only
default=0.0.0.0
Displayed(tab/group)=Primary DNS IP Address (DNS and NBNS IP Addresses/DNS and NBNS)

primaryDnsIpv6Addr Indicates the primary DNS server.

type=InetAddress
default=0:0:0:0:0:0:0:0
Displayed(tab/group)=Primary DNS IPv6 Address (DNS and NBNS IP Addresses/DNS (IPv6) )

primaryDnsType The primary DNS address type for the PPP session

type=rtr.InetAddressType
access=read-only
default=ipv4

primaryNbnsIpAddress The Primary NBNS IP address of this PPP session

type=InetAddress
access=read-only
default=0.0.0.0
Displayed(tab/group)=Primary NBNS IP Address (DNS and NBNS IP Addresses/DNS and NBNS)

primaryNbnsType The primary NBNS IP address type for the PPP session

type=rtr.InetAddressType
access=read-only
default=ipv4

radiusClass Indicates the Class attribute returned by the RADIUS server in an Access-Accept message. If no RADIUS authentication is performed for this session, or RADIUS did not return this attribute, the value of this object is empty

type=string
access=read-only
default=
Displayed(tab/group)=Class (Authentication Protocols/RADIUS)

radiusUsername Indicates the User-Name attribute returned by the RADIUS server in an Access-Accept message. If RADIUS did not return this attribute, the value of this object is equal to the User-Name attribute sent in the original Access-Request message. If no RADIUS authentication is performed for this session, the value of this object is empty

type=string
access=read-only
default=
Displayed(tab/group)=User Name (Authentication Protocols/RADIUS)

remoteId Defines the value of the remote-id sub-option inserted by the PPP intermediate agent.

type=string
access=read-only
default=
Displayed(tab/group)=Remote ID (/DHCP)

retailerIf Indicates the interface index of the retailer VPRN interface to which this session belongs. If the value of this object is non-zero, the session belongs to a retailer VPRN.

type=long
access=read-only
Displayed(tab/group)=Retailer Interface Index (/Business Subscriber)

retailerSvcId Indicates the service ID of the retailer VPRN service to which this session belongs. If the value of this object is non-zero, the session belongs to a retailer VPRN.

type=long
access=read-only
Displayed(tab/group)=Retailer Service ID (/Business Subscriber)

ripListenerStatus Indicates the status of the RIP listener.

type=ressubscr.RipListenerStatus
access=read-only
Displayed(tab/group)=RIP Listener Status (/RIP Listener)

ripPolicyPointer Indicates the RIP policy which is used to set up the RIP listener for this PPP session.

type=Pointer
access=read-only
Displayed(tab/group)=RIP Policy (/RIP Listener)

sapPointer Reference to the access interface the session belongs to.

type=Pointer
access=read-only
default=
Displayed(tab/group)=SAP (/PPP General)

sapPortId Indicates the ID of the access port to which this session belongs.

type=long
access=read-create
Mandatory on create

sapSessionIdx Indicates the sap session index of the PPP session.

type=int
access=read-only
Displayed(tab/group)=SAP Session Index (/PPP General)

secondaryDnsIpv6Addr Indicates the secondary DNS server.

type=InetAddress
default=0:0:0:0:0:0:0:0
Displayed(tab/group)=Secondary DNS IPv6 Address (DNS and NBNS IP Addresses/DNS (IPv6) )

secondryDnsIpAddress The secondary DNS IP address of this PPP session

type=InetAddress
access=read-only
default=0.0.0.0
Displayed(tab/group)=Secondary DNS IP Address (DNS and NBNS IP Addresses/DNS and NBNS)

secondryDnsType The secondary DNS address type for the PPP session

type=rtr.InetAddressType
access=read-only
default=ipv4

secondryNbnsIpAddress The secondary NBNS IP address of this PPP session

type=InetAddress
access=read-only
default=0.0.0.0
Displayed(tab/group)=Secondary NBNS IP Address (DNS and NBNS IP Addresses/DNS and NBNS)

secondryNbnsType The secondary NBNS IP address type for this PPP session

type=rtr.InetAddressType
access=read-only
default=ipv4

serviceId The service ID of IES/VPRN service to which the PPP session belongs.

type=long
access=read-create
Mandatory on create
Displayed(tab/group)=Service ID (/PPP General)

sessionIndex The local identifier of the session.

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

siteId System IP address of the node on which PPP session exists.

type=InetAddress
default=0.0.0.0
Displayed(tab/group)=Site ID (/PPP General)

siteIdAddrType

type=rtr.InetAddressType
default=ipv4

spiGroupId Indicates the SLA profile instance group identifier specified by the AAA server.

type=long
access=read-only
Displayed(tab/group)=SLA Profile Instance Group ID (/PPP General)

subIdentPolicy Pointer specifies the subscriber identification policy applicable on this SAP

type=Pointer
default=

subscrIdent Defines the subscriber identification applicable for this PPP session

type=string
access=read-only
Displayed(tab/group)=Subscriber Identification (/Residential Subscriber)

subscrProfileString Mapped string to the subscriber profile assigned to the PPP session.

type=string
access=read-only
default=
Displayed(tab/group)=Subscriber Profile String (/Residential Subscriber)

subscrSLAString Mapped string to the subscriber SLA profile assigned to the PPP session.

type=string
access=read-only
default=
Displayed(tab/group)=SLA Profile String (/Residential Subscriber)

subscriberIf Indicates the interface index of the subscriber-interface to which this session belongs.

type=long
access=read-only

subscriberIfName Indicates the interface name of the subscriber-interface to which this session belongs.

type=string
access=read-only
default=
Displayed(tab/group)=Subscriber Interface (/PPP General)

terminationType Indicate the the termination type of this session.

type=pppoe.SessionTerminationType
access=read-only
Displayed(tab/group)=Termination Type (/Business Subscriber)

timeout Defines the session timeout received from the Radius server (if applicable).

type=int
access=read-only
default=0
Displayed(tab/group)=Timeout (/PPP General)

type Determines the type of this session.

type=pppoe.PppSessionType
access=read-only
default=oE
Displayed(tab/group)=Session Type (/PPP General)

upTime The value specifies how long the PPP session already exists.

type=Time
access=read-only
Displayed(tab/group)=System Up Time (/PPP General)

userName The user name learned during the PPP authentication phase

type=string
access=read-only
Displayed(tab/group)=User Name (Authentication Protocols/Authentication Protocols)

  
Properties inherited from ManagedObject
actionMask, children-Set, deploymentState, isFaultSquelched, name, objectFullName, selfAlarmed
 
Supported Network Elements
7750 SR
7705 SAR Gen 2
7705 SAR Hm
7450 ESS
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