| Overview | Package | Class | Deprecated | Help |
| Properties | |
|---|---|
| administrativeState |
Administrative state of this tunnel profile.
type=netw.AdministrativeState default=l2tpDown Displayed(tab/group)=Administrative State |
| autoEstablished |
Specifies whether the tunnel is to be set-up automatically by the system.
type=boolean default=false Displayed(tab/group)=Auto Established |
| avpHiding |
Specifies when avpHiding is to be used for the authentication of L2TP tunnels.
type=l2tp.AVPHidingMode default=default Displayed(tab/group)=AVP Hiding |
| challenge |
Specifies when challenge-response is to be used
for the authentication of this L2TP tunnel.
type=l2tp.AlwaysNeverDefault default=default Displayed(tab/group)=Challenge |
| creationOrigin |
type=svt.L2RouteOriginType access=read-create default=manual |
| description |
The description of this tunnel profile.
type=string default= minimum=0 maximum=80 Displayed(tab/group)=Description (/Identification) |
| destructTimeOut |
The period of time that the data of a disconnected tunnel
will persist before being removed.
type=int default=-2 minimum=-2 maximum=86400 units=seconds Displayed(tab/group)=Destruct Timeout |
| 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 '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.
The value 'default' specifies the value of the DF bit from the Group Profile.
type=l2tp.AlwaysNeverDefault default=default Displayed(tab/group)=Do Not Fragment Bit LAC |
| groupName |
The name of the group profile to which this tunnel profile belongs.
type=string access=read-only minimum=0 maximum=63 |
| helloInterval |
The time interval between two consecutive tunnel Hello messages.
type=int default=-2 minimum=-2 maximum=3600 units=seconds Displayed(tab/group)=Hello Interval |
| idleTimeOut |
The period of time that an established tunnel
with no active sessions will persist before being disconnected.
type=int default=-2 minimum=-2 maximum=3600 units=seconds Displayed(tab/group)=Idle Timeout |
| l2tp.MLPPPTunnelProfile-Set |
type=Children-Set |
| l2tp.PPPTunnelProfile-Set |
type=Children-Set |
| l2tp.TunnelStart-Set |
type=Children-Set |
| l2tpRadiusAccPlcyPointer |
Specifies the RADIUS accounting policy to use in this L2TP protocol instance.
type=Pointer default= Displayed(tab/group)=L2TP RADIUS Accounting Policy |
| lnsGroup |
Specifies the L2TP Integrated Service Adaptor group for this L2TP tunnel.
type=int default=0 minimum=0 maximum=4 Displayed(tab/group)=LNS Group ID |
| loadBalanceMethod |
Specifies the method to be used for load-balancing sessions across ISA MDA in this L2TP Tunnel.
Note : load balance method can be either per session or per tunnel based or No load balance method.
type=l2tp.LoadBalanceMethodType default=noLoadBalanceMethod Displayed(tab/group)=Load Balance Method |
| localAddress |
Specifies the local IP address of this L2TP tunnel.
type=InetAddress default=0.0.0.0 Displayed(tab/group)=Local IP Address |
| localAddressType |
Specifies the address type of 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 |
| maxRetriesEstablished |
The number of retries allowed for this tunnel,
when established, before its control connection goes down.
type=int default=-2 minimum=-2 maximum=7 Displayed(tab/group)=Max Retries Established |
| maxRetriesNotEstablished |
The number of retries allowed for this tunnel when not established before
its control connection goes down.
type=int default=-2 minimum=-2 maximum=7 Displayed(tab/group)=Max Retries Not Established |
| 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 |
| peerAddress |
Specifies the IP address for the peer.
type=InetAddress default=0.0.0.0 Displayed(tab/group)= Peer IP Address |
| peerAddressType |
Specifies the address type for the IP address for the peer.
type=rtr.InetAddressType default=ipv4 |
| preference |
The preference for this L2TP tunnel.
type=long default=50 minimum=0 maximum=16777215 Displayed(tab/group)=Preference |
| privateTcpMssAdjust |
Specifies the Maximum Segment Size (MSS) for the TCP traffic in an L2TP tunnel of
this group which is sent from the private network to the public network. The
system may use this value to adjust or insert the MSS option in the TCP SYN packet packet.
Valid values (-2|-1|512..9000).
A value of '-1' specifies that the TCP MSS adjustment functionality on the private side
is disabled.
A value of '-2' specifies that the TCP MSS must be derived from the MSS of the associated
L2TPv3 tunnel group.
type=long default=-2 minimum=-2 maximum=9000 Displayed(tab/group)=Private (/TCP MSS Adjust) |
| publicTcpMssAdjust |
Specifies the Maximum Segment Size (MSS) for the TCP traffic in an L2TP tunnel of this
group which is sent from the public network to the private network. The system may use
this value to adjust or insert the MSS option in the TCP SYN packet packet.
Valid values (-2|-1|512..9000).
A value of '-1' specifies that the TCP MSS adjustment functionality on
the private side is disabled.
A value of '-2' specifies that the TCP MSS must be derived from the MSS of the associated
L2TPv3 tunnel group.
type=long default=-2 minimum=-2 maximum=9000 Displayed(tab/group)=Public (/TCP MSS Adjust) |
| receiveWindowSize |
Specifies the Receive Window Size of the tunnels using this L2TP Tunnel Profile.
type=int default=0 minimum=0 maximum=1024 Displayed(tab/group)=Receive Window Size |
| recoveryMethod |
Specifies the method to be used for the recovery of stateful information about L2TP tunnels and sessions
associated with this tunnel between this system (performing the LAC role) and its failover peer.
type=l2tp.FailoverRecoveryMethod default=default 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=-2 minimum=-2 maximum=900 units=seconds Displayed(tab/group)=Recovery Time (/Failover Information) |
| remoteName |
The host name used by this L2TP tunnel peer during the
authentication phase of tunnel establishment.
This object is related to the RADIUS attribute Tunnel-Server-Auth-ID.
type=string default= minimum=0 maximum=64 Displayed(tab/group)=Remote Name |
| routerId |
Router Identifier of the routing protocol site where the tunnel profile resides.
type=int access=read-only default=1 minimum=1 maximum=10240 |
| routingInstancePointer |
FDN of the routing instance object where the configuration is applicable.
type=Pointer access=read-only default= Displayed(tab/group)=Routing Instance (/Identification) |
| sessionLimit |
The maximum number of sessions in this L2TP tunnel.
The default session limit is -2 from 11.0 R1.
type=long default=65535 minimum=1 maximum=65535 Displayed(tab/group)=Session Limit |
| siteId |
NE ID where the tunnel profile is created.
type=string access=read-only default= minimum=0 maximum=64 Displayed(tab/group)=Site ID (/Identification) |
| tunnelName |
The Name for the tunnel template.
type=string access=read-create minimum=1 maximum=32 Mandatory on create Displayed(tab/group)=Tunnel Name (/Identification) |
| 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.
aInRouterId
: int - Router Identifier of the routing protocol site where the Tunnel resides.
aInGroupName
: string - The Name of the Group Profile
aInTunnelNameList
: List (string) - The name list of the Tunnel Profiles.
aInSiteId
: string -
aInAction
: int - Indicates the action, either drain(0) or stop drain(1).
continueOnFailure
: continueOnFailure - (Optional) Continue processing requests in this stream if an exception occurs, unless the request is invalid. Default: false
l2tp.TunnelProfile.drainException
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
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.
aInRouterId
: int - Router Identifier of the routing protocol site where the Tunnel resides.
aInGroupName
: string - The Name of the Group Profile
aInTunnelNameList
: List (string) - The name list of the Tunnel Profiles.
aInSiteId
: string -
continueOnFailure
: continueOnFailure - (Optional) Continue processing requests in this stream if an exception occurs, unless the request is invalid. Default: false
l2tp.TunnelProfile.stopTunnelsException
| Supported Network Elements | |
|---|---|
| 7750 SR | |
| 7450 ESS |
Supported from 8.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 | |