| Overview | Package | Class | Deprecated | Help |
| Properties | |
|---|---|
| acctSessionId |
Indicates the accounting session id of the IPoE session.
type=string access=read-only Displayed(tab/group)=Accounting Session ID (/IPoE General) |
| addressPool |
Indicates the IP address pool which is used
to search for an IP address for this session.
type=string access=read-only minimum=0 maximum=255 Displayed(tab/group)=IP Address Pool (/IPoE General/IPv4 Information) |
| ancpString |
Indicates the ANCP string applicable for this session.
type=string access=read-only Displayed(tab/group)=ANCP String (/Residential Subscriber) |
| apnName |
Indicates the Network Identifier part of the Access Point Name (APN) for this IPoE Session..
type=string access=read-only Displayed(tab/group)=APN (/GTP) |
| appProfileString |
Indicates the application profile string applicable for this session.
type=string access=read-only Displayed(tab/group)=Application Profile String (/Residential Subscriber) |
| categoryMap |
Indicates the category map name applicable for this session.
type=string access=read-only Displayed(tab/group)=Category Map Name (/Residential Subscriber) |
| circuitId |
Indicates the value of the circuit-id sub-option.
type=string access=read-only Displayed(tab/group)=Circuit ID (/DHCP) |
| clear.ClearRequest-Set |
type=Children-Set |
| encapType |
type=equipment.PortEncapType 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 (/IPoE General) |
| groupInterfaceId |
Indicates the interface index of the group-interface.
type=long access=read-only |
| imsi |
Indicates the IMSI for this IPoE Session.
type=string access=read-only Displayed(tab/group)=IMSI (/GTP) |
| innerEncapValue |
The inner Encap value.
type=int access=read-create default=0 |
| interDestId |
Indicates the intermediate destination identifier
applicable for this session.
type=string access=read-only Displayed(tab/group)=Intermediate Destination (/Residential Subscriber) |
| ipAddress |
Indicates the IP address of the session.
type=InetAddress access=read-only default=0.0.0.0 Displayed(tab/group)=IP Address (/IPoE General/IPv4 Information) |
| ipAddressPrefixLength |
Indicates the prefix length of ipAddress.
type=int access=read-only Displayed(tab/group)=IP Address Prefix Length (/IPoE General/IPv4 Information) |
| ipAddressType |
Indicates the address type of ipAddress.
type=rtr.InetAddressType access=read-only default=ipv4 |
| ipOrigin |
Indicates which source provided the IP address.
type=ressubscr.DhcpLseStateInfoOrigin access=read-only Displayed(tab/group)=IP Address Source (/IPoE General/IPv4 Information) |
| ipv6Address |
Indicates the IPv6 Address.
type=InetAddress access=read-only default= Displayed(tab/group)=IPv6 Address (/IPoE General/IPv6 Information) |
| ipv6AddressOrigin |
Indicates the origin of IPv6 Address.
type=ressubscr.DhcpLseStateInfoOrigin access=read-only Displayed(tab/group)=IPv6 Address Source (/IPoE General/IPv6 Information) |
| ipv6AddressPool |
Indicates the DHCP server pool from which
the address, indicated by IPv6 Address, is allocated.
type=string access=read-only Displayed(tab/group)=IPv6 Address Pool (/IPoE General/IPv6 Information) |
| ipv6AddressType |
Indicates the address type of IPv6 Address.
type=rtr.InetAddressType access=read-only default=ipv4 |
| ipv6DelPrefix |
Indicates the IPv6 Delegated Prefix.
type=InetAddress access=read-only default=0.0.0.0 Displayed(tab/group)=IPv6 Delegated Prefix (/IPoE General/IPv6 Information) |
| ipv6DelPrefixLength |
Indicates the prefix length of IPv6 Delegated Prefix.
type=int access=read-only minimum=0 maximum=128 Displayed(tab/group)=IPv6 Delegated Prefix Length (/IPoE General/IPv6 Information) |
| ipv6DelPrefixOrigin |
Indicates which source provided the IPv6 Delegated Prefix.
type=ressubscr.DhcpLseStateInfoOrigin access=read-only Displayed(tab/group)=IPv6 Delegated Prefix Source (/IPoE General/IPv6 Information) |
| ipv6DelPrefixPool |
Indicates the DHCP server pool from which the delegated
prefix, indicated by IPv6 Delegated Prefix, is allocated.
type=string access=read-only Displayed(tab/group)=IPv6 Delegated Prefix Pool (/IPoE General/IPv6 Information) |
| ipv6DelPrefixType |
Indicates the address type of IPv6 Delegated Prefix.
type=rtr.InetAddressType access=read-only default=ipv4 |
| ipv6Dns1 |
Indicates the primary DNS server.
type=InetAddress access=read-only default=0.0.0.0 Displayed(tab/group)=Primary IPv6 DNS IP Address (DNS and NBNS IP Addresses/DNS (IPv6)) |
| ipv6Dns1Type |
Indicates the address type of IPv6 primary DNS server.
type=rtr.InetAddressType access=read-only default=ipv4 |
| ipv6Dns2 |
Indicates the secondary DNS server.
type=InetAddress access=read-only default=0.0.0.0 Displayed(tab/group)=Secondary IPv6 DNS IP Address (DNS and NBNS IP Addresses/DNS (IPv6)) |
| ipv6Dns2Type |
Indicates the address type of secondary DNS server.
type=rtr.InetAddressType access=read-only default=ipv4 |
| ipv6Prefix |
Indicates the IPv6 Prefix.
type=InetAddress access=read-only default=0.0.0.0 Displayed(tab/group)=IPv6 Prefix (/IPoE General/IPv6 Information) |
| ipv6PrefixLength |
Indicates the prefix length of IPv6 Prefix.
type=int access=read-only minimum=0 maximum=128 Displayed(tab/group)=IPv6 Prefix Length (/IPoE General/IPv6 Information) |
| ipv6PrefixOrigin |
Indicates which source provided the IPv6 Prefix.
type=ressubscr.DhcpLseStateInfoOrigin access=read-only Displayed(tab/group)=IPv6 Prefix Source (/IPoE General/IPv6 Information) |
| ipv6PrefixPool |
Indicates the DHCP server pool from which the SLAAC prefix,
indicated by IPv6 Prefix, is allocated.
type=string access=read-only Displayed(tab/group)=IPv6 Prefix Pool (/IPoE General/IPv6 Information) |
| ipv6PrefixType |
Indicates the address type of IPv6 Prefix.
type=rtr.InetAddressType access=read-only default=ipv4 |
| lastAuthTime |
Indicates the sysUpTime at the time of the last
authentication for this session.
type=Date access=read-only Displayed(tab/group)=Last Authentication Time (/IPoE General) |
| macAddress |
Specifies the MAC address to which this session belongs.
type=MacAddress access=read-create default=00-00-00-00-00-00 Displayed(tab/group)=MAC Address (/IPoE General) |
| minAuthIntervalLeft |
Indicates the authentication time left when
a minimum authentication interval is active
for this session. A value of 0 indicates no minimum
authentication interval is active.
type=long access=read-only units=seconds Displayed(tab/group)=Minimum Authentication Interval Left (/IPoE General) |
| outerEncapValue |
The outer Encap value
type=int access=read-create default=0 |
| persistenceKey |
Indicates a key value that can be used to track
this session in the persistence file.
type=long access=read-only Displayed(tab/group)=Persistence Key (/IPoE General) |
| portName |
The name of the SAP's port.
type=string access=read-create default= minimum=0 maximum=32 Mandatory on create |
| primaryDns |
Indicates the primary DNS server.
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) |
| primaryDnsType |
Indicates the address type of primaryDns.
type=rtr.InetAddressType access=read-only default=ipv4 |
| primaryNbns |
Indicates the primary NBNS server.
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 |
Indicates the address type of Primary Nbns.
type=rtr.InetAddressType access=read-only default=ipv4 |
| radiusClassAttr |
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 minimum=0 maximum=253 Displayed(tab/group)=Class (/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 minimum=0 maximum=253 Displayed(tab/group)=User Name (/RADIUS) |
| remoteId |
Indicates the value of the remote-id sub-option.
type=string access=read-only default= Displayed(tab/group)=Remote ID (/DHCP) |
| ressubscr.IPoEBgpEntry-Set |
type=Children-Set |
| ressubscr.IPoEQoSOverride-Set |
type=Children-Set |
| ressubscr.IPoESessionRadiusClassAttribute-Set |
type=Children-Set |
| retailerIf |
Indicates the interface index of the retailer interface to which this session belongs.
type=long access=read-only |
| retailerSvcId |
Indicates the service ID of the retailer service to which this session belongs.
type=long access=read-only |
| 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 IPoE session.
type=Pointer access=read-only Displayed(tab/group)=RIP Policy (/RIP Listener) |
| sapEncapValue |
type=long access=read-only |
| sapPointer |
Reference to the access interface the session belongs to.
type=Pointer access=read-only default= Displayed(tab/group)=SAP (/IPoE General) |
| sapPortId |
type=long access=read-create Mandatory on create |
| sapSessionId |
Indicates the sap session index of the IPoE session.
type=long access=read-only Displayed(tab/group)=SAP Session Index (/IPoE General) |
| secondaryDns |
Indicates the secondary DNS server.
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) |
| secondaryDnsType |
Indicates the address type of secondaryDns.
type=rtr.InetAddressType access=read-only default=ipv4 |
| secondaryNbns |
Indicates the secondary NBNS server.
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) |
| secondaryNbnsType |
Indicates the address type of Secondary Nbns.
type=rtr.InetAddressType access=read-only default=ipv4 |
| serviceId |
type=long access=read-create Mandatory on create |
| sessionIndex |
Indicates the local identifier of the session.
type=long access=read-create default=0 Displayed(tab/group)=Session ID (/IPoE General) |
| sessionKey |
Specifies the session key to be used for IPoE sessions.
type=ressubscr.SessionKeyType access=read-only Displayed(tab/group)=Session Key (/IPoE General) |
| sessionTimeout |
Indicates the session timeout received from the RADIUS server (if applicable).
type=long access=read-only minimum=0 maximum=65535 Displayed(tab/group)=Session Timeout (/RADIUS) |
| slaProfileString |
Indicates the SLA profile string applicable for this session.
type=string access=read-only Displayed(tab/group)=SLA Profile String (/Residential Subscriber) |
| 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 (/IPoE General) |
| subProfileString |
Indicates the subscriber profile string
applicable for this session.
type=string access=read-only Displayed(tab/group)=Subscriber Profile String (/Residential Subscriber) |
| subscriberId |
Indicates the subscriber applicable for this session.
type=string access=read-only Displayed(tab/group)=Subscriber (/Residential Subscriber) |
| 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 (/IPoE General) |
| subscriberInterfaceId |
Indicates the interface index of the subscriber-interface
to which this session belongs.
type=long access=read-only |
| terminationType |
The value of this attribute the indicates the termination type of this session.
type=pppoe.SessionTerminationType access=read-only Displayed(tab/group)=Termination Type (/IPoE General) |
| timeLeft |
Indicates the session time left when a session timeout is active for this session.
A value of 0 indicates no session timeout is active;
4294967295 means N/A with Minimum Authentication Interval configured on Group Interface as Infinite.
type=long access=read-only units=seconds Displayed(tab/group)=Session Time Left (/IPoE General) |
| timeStamp |
Indicates the time that this association was made.
type=Time access=read-only |
| upTime |
Indicates how long (in hundredths of a second) that the
session already exists in this table.
type=Time access=read-only Displayed(tab/group)=Up Time (/IPoE General) |
| Properties inherited from ManagedObject |
|---|
| actionMask, children-Set, deploymentState, isFaultSquelched, name, objectFullName, selfAlarmed |
| Methods |
|---|
deployer
: Deployer - the deployment state
synchronousDeploy
: boolean - (Optional) Specify whether to block until the changes have been fully deployed to the network. A value of "true" means to block. A value of "false" means to return immediately. Default: false (asynchronous)
clearOnDeployFailure
: boolean - (Optional) Specify whether to clear any failed deployers. A value of "true" means to clear. A value of "false" means to leave the failed deployer. Default: false
deployRetries
: int - (Optional) The number of times to attempt re-deployment during synchronous deployment. This parameter is meaningless in the asynchronous case. Default: 0
deployRetryInterval
: long - (Optional) The number of milliseconds to wait between deployment retries. This parameter is meaningless in the asynchronous case. Default: 0
taskDescription
: string - (Optional) A user friendly description of what the operation does. This information will be used by the task manager.
clearIpoeSessionConfig
: ressubscr.ClearIpoeSessionStruct - clearIPoESessionConfig of IPoE sessions with desired serviceId and IP address
whose values are used to be cleared.
The configuration objects must have set siteId and serviceId.
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
aOutResult
: clear.RequestHandleStruct - A request handle which allows the retrieval of the
request (and its result when it becomes available)
through the ClearCommandManager's retrieveClearRequest
method.
ressubscr.IPoESession.requestClearIpoeSessionsException
retrievingIpoeSessionStruct
: ressubscr.RetrievingIpoeSessionStruct - retrievingSessionStruct of retrieving IPoE sessions request
with desired siteId, serviceId, sapId, sapEncapValue, macAddress, sessionId
whose values are used to retrieve IPoE sessions.
The retrievingSessionStruct must have set siteId and serviceId.
If sapId is specified, sapEncapValue must be specified based on the encapsulation type.
If sapEncapValue is not specified, all subscribers for the sapId will be fetched
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.
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.
retrieveBgpPeerInfo
: boolean - (Optional) Specifies if BGP Peer Info should be retrieved,the default is "true".
The Managed Routes won't be retrieved if Service preferences "retrieveManagedRoutes" is
false.
aInCircuitId
: string - (Optional) Specifies Circuit ID value of IPoE Session(s) to be retrieved.
aInRemoteId
: string - (Optional) Specifies Remote ID value of IPoE 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
result
: List (generic.CommonManagedEntityInformation) -
ressubscr.IPoESession.retrieveIPoESessionsException
| Supported Network Elements | |
|---|---|
| 7750 SR | Supported from 13.0.R1 |
| 7450 ESS | Supported from 13.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 | |
| 7750 SR 20.0 | |
| 7750 SR 21.0 | |
| 7750 SR 22.0 | |
| 7750 SR 23.0 | |
| 7750 SR 24.0 | |
| 7750 SR 25.0 | |