| Overview | Package | Class | Deprecated | Help |
| Properties | |
|---|---|
| avpCiscoNasPortAtm |
Specifies what string to put in the Cisco-NAS-Port AVP, for L2TP control messages
related to a PPPoA session in this L2TP protocol instance.
An empty string specifies that the Extended NAS-Port AVP must not be transmitted.
type=string default= minimum=0 maximum=255 Displayed(tab/group)=Cisco NAS-Port ATM (/L2TP General Configuration) |
| avpCiscoNasPortEth |
Specifies what string to put in the Cisco-NAS-Port AVP, for L2TP control messages
related to a PPPoE session in this L2TP protocol instance.
An empty string specifies that the Extended NAS-Port AVP must not be transmitted.
type=string default= minimum=0 maximum=255 Displayed(tab/group)=Cisco NAS-Port Ethernet (/L2TP General Configuration) |
| avpHiding |
Specifies when avpHiding is to be used for the authentication of L2TP tunnels.
type=l2tp.AVPHidingMode default=never Displayed(tab/group)=AVP Hiding (/L2TP General Configuration) |
| callingNumFmt |
Specifies what string to put in the Calling Number AVP, for L2TP control messages
related to a session in this L2TP protocol instance.
type=string default=%S %s minimum=1 maximum=255 Displayed(tab/group)=Calling Number Format (/L2TP General Configuration) |
| challenge |
Specifies when challenge-response is to be used
for the authentication of this L2TP tunnel.
type=l2tp.AlwaysNeverDefault default=never Displayed(tab/group)=Challenge (/L2TP General Configuration) |
| destructTimeOut |
The period of time that the data of a disconnected tunnel
will persist before being removed.
type=int default=60 minimum=60 maximum=86400 units=seconds Displayed(tab/group)=Destruct Timeout (/L2TP General Configuration) |
| dontFragmentBitLac |
Specifies if this system sets the DF (Don't Fragment) bit in the IP header of the data traffic sent from
the LAC to the LNS. Setting the value of this object as 'always', the DF bit is set in upstream traffic.
If the value of this object is 'never', the DF bit is cleared in upstream traffic.
type=l2tp.AlwaysNeverDefault default=always Displayed(tab/group)=Do Not Fragment Bit LAC (/L2TP General Configuration) |
| excludeAvp |
Specifies what AVP's (Attribute Value Pairs) to exclude from L2TP control messages
related to a session in this L2TP protocol instance.
type=l2tp.ExcludeAvpBitMask default=0 Displayed(tab/group)=Excluded AVPs (/L2TP General Configuration) |
| groupSessionLimit |
The maximum number of sessions in this L2TP tunnel.
The default group session limit is -1 from 14.0 R4.
type=long default=131071 minimum=-1 maximum=250000 Displayed(tab/group)=Group Session Limit (/L2TP General Configuration) |
| helloInterval |
The time interval between two consecutive tunnel Hello messages.
type=int default=300 minimum=-1 maximum=3600 units=seconds Displayed(tab/group)=Hello Interval (/L2TP General Configuration) |
| idleTimeOut |
The period of time that an established tunnel
with no active sessions will persist before being disconnected.
type=int default=-1 minimum=-1 maximum=3600 units=seconds Displayed(tab/group)=Idle Timeout (/L2TP General Configuration) |
| l2tp.GroupProfile-Set |
type=Children-Set |
| l2tp.L2TPSession-Set |
type=Children-Set |
| l2tp.L2TPv3VirtualRouterConfig-Set |
type=Children-Set |
| l2tp.L2tpFoSrrpPeer-Set |
type=Children-Set |
| l2tp.LacMlpppBundle-Set |
type=Children-Set |
| l2tp.Peer-Set |
type=Children-Set |
| l2tp.TunnelStatus-Set |
type=Children-Set |
| l2tpRadiusAccPlcyPointer |
Specifies the RADIUS accounting policy to use in this L2TP protocol instance.
type=Pointer default= Displayed(tab/group)=L2TP Accounting Policy (/L2TP General Configuration) |
| length |
Specifies how many tunnels or peers can be in the tunnel-selection-blacklist.
If a tunnel or peer needs to be added to the tunnel-selection-blacklist
and the tunnel-selection-blacklist is full, the system will remove the
tunnel or peer from the blacklist that was in this blacklist for the
longest time.
A value of '-1' specifies there is no limit.
type=int default=-1 minimum=-1 maximum=65535 Displayed(tab/group)=Max List Length (Tunnel Selection Blacklist) |
| localAddress |
Specifies the local IP address of this L2TP tunnel.
type=InetAddress default=0.0.0.0 Displayed(tab/group)=Local IP Address (/L2TP General Configuration) |
| localAddressType |
Specifies the address type for the local IP address of this L2TP tunnel.
type=rtr.InetAddressType default=ipv4 |
| localName |
The host name used by this system for this L2TP tunnel during the
authentication phase of tunnel establishment.
This object is related to the RADIUS attribute Tunnel-Client-Auth-ID.
type=string default= minimum=0 maximum=64 Displayed(tab/group)=Local Name (/L2TP General Configuration) |
| maxRetriesEstablished |
The number of retries allowed for this tunnel,
when established, before its control connection goes down.
type=int default=5 minimum=2 maximum=7 Displayed(tab/group)=Max Retries Established (/L2TP General Configuration) |
| maxRetriesNotEstablished |
The number of retries allowed for this tunnel when not established before
its control connection goes down.
type=int default=5 minimum=2 maximum=7 Displayed(tab/group)=Max Retries Not Established (/L2TP General Configuration) |
| maxTime |
Specifies the maximum time a tunnel or peer may remain in the tunnel-selection-blacklist.
type=int default=5 minimum=1 maximum=60 units=minutes Displayed(tab/group)=Max Time (Tunnel Selection Blacklist) |
| nextAttempt |
Specifies the next tunnel to be used in case the session setup fails.
A value of 'samePreferenceLevel(0)' specifies to try first any
alternative tunnel from the same preference level before falling back to
a lower preference level.
A value of 'nextPreferenceLevel(1)' specifies to try a tunnel with a
lower preference level (higher preference value).
type=int default=1 Displayed(tab/group)=Next Attempt (/L2TP General Configuration) enums= 0: samePreferenceLevel - Same Tunnel Preference Level 1: nextPreferenceLevel - Next Tunnel Preference Level |
| password |
Password to be used for the authentication of the tunnels in the tunnel group.
Note: Because is secure is set to "yes", the password is not visible outside of NFM-P server.
type=string default= minimum=0 maximum=64 Displayed(tab/group)=Password (/L2TP General Configuration) |
| peerAddrChangePlcy |
Specifies the behavior in case the system receives an L2TP response
from another address than the one the request was sent to, for
a tunnel in this L2TP protocol instance.
type=l2tp.PeerAddrChangePlcyState default=reject Displayed(tab/group)=Peer Address Change Policy (/L2TP General Configuration) |
| reason |
Specifies the return codes that determine which tunnels are added to the
tunnel-selection-blacklist. If no value is selected, the tunnel-selection-blacklist
is disabled.
type=long default=unspecified Displayed(tab/group)=Add Tunnel on (Tunnel Selection Blacklist) bits= 0x80: addrChangeTimeout - Address Change Timeout 0x40: cdnErrCode - CDN Error Code 0x20: cdnInvDest - CDN Invalid Destination 0x10: cdnPermNoFacilities - CDN No Facilities (Permanent Condition) 0x8: cdnTmpNoFacilities - CDN No Facilities (Temporary Condition) 0x4: stopCcnErrCode - StopCCN Error Code 0x2: stopCcnOther - StopCCN Other 0x1: txCdnNotEstablishedInTime - CDN Call Not Established In Time |
| receiveWindowSize |
Specifies the receive window size in this L2TP protocol instance.
type=long default=64 minimum=4 maximum=1024 Displayed(tab/group)=Receive Window Size (/L2TP General Configuration) |
| recoveryMaxSeLifeTime |
Specifies the sub-set of sessions that this system attempts to synchronize in the Session State Synchronization
phase. The lifetime taken into account is the lifetime at the moment the system is triggered to start recovery.
type=long default=2 minimum=2 maximum=4294967295 units=minutes Displayed(tab/group)=Recovery Max Session Lifetime (/Failover Information) |
| recoveryMethod |
Specifies the method to be used for the recovery of stateful information about L2TP tunnels and sessions
associated with this virtual router between this system (performing the LAC role) and its failover peer.
type=l2tp.FailoverRecoveryMethod default=mcs Displayed(tab/group)=Recovery Method (/Failover Information) |
| recoveryTime |
Specifies the period of time period of time that an endpoint asks its peer to wait
before assuming the recovery process has failed
type=int default=0 minimum=0 maximum=900 units=seconds Displayed(tab/group)=Recovery Time (/Failover Information) |
| replaceResultCode |
Specifies the return codes that must be replaced by another appropriate result code.
This field is typically used to solve interoperability issues.
type=long default=unspecified Displayed(tab/group)=Replace Result Code (/L2TP General Configuration) bits= 0x80: cdnInvDest - CDN Invalid Destination 0x40: cdnPermNoFacilities - CDN No Facilities (Permanent Condition) 0x20: cdnTmpNoFacilities - CDN No Facilities (Temporary Condition) |
| sessionAssignMethod |
The method to be used for the authentication.
type=l2tp.SessionAssignMethod default=none Displayed(tab/group)=Session Assign Method (/L2TP General Configuration) |
| sessionLimit |
Specifies the maximum number of sessions in this L2TP protocol instance.
The default session limit is -1 from 14.0 R4.
type=int default=131071 minimum=-1 maximum=250000 Displayed(tab/group)=Session Limit (/L2TP General Configuration) |
| templateVersionPointer |
Pointer to the template if this object was created from a template.
type=Pointer default= Displayed(tab/group)=Associated Template (Template/Associated Template) |
| timeoutAction |
Specifies the action to be taken when a tunnel has been in the tunnel-selection-blacklist for
the max time.
A value of 'removeFromBlacklist(0)' specifies the tunnel will be removed
from the tunnel-selection-blacklist.
A value of 'tryOneSession(1)' specifies the tunnel will remain in the
tunnel-selection-blacklist while the system will allow a single session
to be added to the tunnel. Only on success will the tunnel be removed
from the tunnel-selection-blacklist.
type=int default=0 Displayed(tab/group)=Timeout Action (Tunnel Selection Blacklist) enums= 0: removeFromBlackList - Remove From Blacklist 1: tryOneSession - Try One Session |
| tunnelSessionLimit |
The maximum number of sessions in this L2TP tunnel.
The default tunnel session limit is -1 from 14.0 R4.
type=long default=65535 minimum=-1 maximum=65535 Displayed(tab/group)=Tunnel Session Limit (/L2TP General Configuration) |
| Overridden Properties | |
|---|---|
| administrativeState |
Specifies the administrative state of this L2TP protocol instance.
default=l2tpDown |
| displayedName |
default=L2TP |
| Properties inherited from rtr.ProtocolSite |
|---|
| creationOrigin, serviceId, serviceType, subscriberId |
| Properties inherited from rtr.RouterSite |
|---|
| routerId, routerName, routingInstancePointer |
| Properties inherited from netw.NetworkSite |
|---|
| displayedName, siteId, siteName |
| Properties inherited from netw.SubnetworkConnection |
|---|
| domain |
| Properties inherited from netw.Connection |
|---|
| administrativeState, application, connectionId, operationalState |
| 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.
instanceFullName
: string - the full name of the object.
continueOnFailure
: continueOnFailure - (Optional) Continue processing requests in this stream if an exception occurs, unless the request is invalid. Default: false| Methods inherited from rtr.ProtocolSite |
|---|
| shutDown, turnUp |
| Supported Network Elements | |
|---|---|
| 7750 SR | |
| 7450 ESS |
Supported from 10.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 | |