pppoe
PPPoESession

Defines the PPPoE session objects. It is possible to retrieve PPPoE sessions and perform mid-session changes on them.

• Relative Name=[[session-${serviceId}][-${sapPortId}][-${outerEncapValue}][-${innerEncapValue}][-${macAddress}][-${sessionId}]]
• Displayed Name=PPPoE Session

Input Parameters:

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.
configInfo : generic.CommonManagedContainmentEntityConfigurationInformation - Desired values to configure object to. The configuration objects must have the site Id, service ID, SAP ID, MAC address, sessions ID been set.
timeout : long - The number of milliseconds to wait before receiving the results. If no results are received in the given time, the method returns.
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:

configInfo : generic.CommonManagedEntityInformation - Resulting object.

Exceptions:

pppoe.PPPoESession.modifyPPPoESessionException

Input Parameters:

retrievingSessionStruct : pppoe.RetrievingSessionStruct - retrievingSessionStruct of retrieving PPPoE sessions request with desired siteID, serviceId, sapId, innerEncap, outerEncap, sessionsMac, sessionsId whose values are used to be retrieve PPPoE sessions. If value of innerEncap and outerEncap are not provided, PPPoE Session with null Encap will be fetched. If there is no session with null Encap on selected port, no results will be returned. The retrievingSessionStruct must have set siteID, serviceId, sapId.
shallowRetrieval : boolean - (Optional) If it is true, not all of the properties are retrieved for quick response
retrieveL2tpPeerAddress : boolean - (Optional) Specifies if l2tpPeerAddress should be retrieved,the default 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.
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 PPPoE Session(s) to be retrieved.
aInRemoteId : string - (Optional) Specifies Remote ID value of PPPoE 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.PPPoESession.retrievePPPoESessionsException