svt
Tunnel

Represents a tunnel (or SDP) object.



public class Tunnel

Stats:
svt.TunnelKeepAliveStats

Properties
accountingOn The Collect Accounting Statistics parameter specifies whether the collection of accounting statistics on the SDP is enabled.

type=boolean
default=true
Displayed(tab/group)=Collect Accounting Statistics (Accounting)

accountingPolicyId

type=long
access=read-only
default=0

accountingPolicyName

type=string
access=read-only
default=
maximum=252

accountingPolicyPointer

type=Pointer
default=
Displayed(tab/group)=Accounting Policy (Accounting)

advertisedMtuOverride The Advertised MTU Override parameter specifies whether you override the advertised VC-type MTU.

type=generic.TruthValue
default=false
Displayed(tab/group)=Advertised MTU Override (/MTU)

allowFragmentation

type=boolean
default=false
Displayed(tab/group)=Allow Fragmentation (/Allow Fragmentation)

associatedServicePointer

type=Pointer
default=
Displayed(tab/group)=Associated Service (Associated Service/Associated Service)

autoSdp Indicates whether this is an Auto generated SDP from auto-discovery.

type=svt.DiscoveryState
access=read-only
default=notAuto

autoselectionPreference

type=long
default=0

availableBandwidth The value of sdpAvailableBandwidth indicates the Bandwidth that is still free for booking by the SDP bindings on the SDP.

type=int
access=read-only
default=0
minimum=0
maximum=100000000
units=kbps
Displayed(tab/group)=SDP Available Bandwidth (SDP Bandwidth/Bandwidth)

bandwidthReserved

type=int
access=read-only
default=no
enums=
    1: no - False
    2: full - Full
    3: partial - Partial

bgpTunnelEnabled The Enable BGP-Tunnel parameter specifies whether the transport tunnel uses BGP, as opposed to LDP or RSVP-signaled LSPs. This parameter cannot be set to true if either the Ldp Enabled or Mixed Lsp Mode parameters are set to true, or if there is at least one RSVP or static LSP provisioned. You can have an operational BGP tunnel only when the source and destination NEs belong to different AS.

type=generic.TruthValue
default=false
Displayed(tab/group)=Enable BGP-Tunnel (/MPLS Signaling)

bookingFactor BookingFactor is used to calculate the max SDP available bandwidth. The value of sdpBandwidthBookingFactor specifies the percentage of the SDP max available bandwidth for VLL call admission. When the value of sdpBandwidthBookingFactor is set to zero (0) no new VLL spoke-sdp bindings with non-zero bandwidth are permitted with this SDP. Overbooking, >100% is allowed.

type=int
default=100
minimum=0
maximum=1000
units=%
Displayed(tab/group)=SDP Bandwidth Booking Factor (SDP Bandwidth/Booking Factor)

classForwardingAdminState Specifies the admin state of class-based forwarding on this SDP

type=int
default=down
Displayed(tab/group)=Administrative State (/Class Forwarding)
enums=
    1: up - Up
    2: down - Down

classForwardingDefaultLspId Specifies the LSP ID that is used as a default when class-base forwarding is enabled on this SDP.

type=long
access=read-only
default=0

classForwardingDefaultLspPointer Specifies the LSP that is used as a default when class-based forwarding is enabled on this SDP.

type=Pointer
default=

classForwardingEnabled Enables or disables the forwarding of a service packet over the SDP based on the class of service of the packet.

type=int
default=false
Displayed(tab/group)=Class Forwarding Capability (/Class Forwarding)
enums=
    1: true - On
    2: false - Off

classForwardingMcLspId Specifies the LSP ID that all multicast traffic will be forwarded on when class-based forwarding is enabled on this SDP.

type=long
access=read-only
default=0

classForwardingMcLspPointer Specifies the LSP that all multicast traffic will be forwarded on when class-based forwarding is enabled on this SDP.

type=Pointer
default=

controlPwIsActive

type=boolean
access=read-only
default=false
Displayed(tab/group)=Control PW Active (/Source B-Mac LSB)

controlPwVcId

type=long
default=0
minimum=0
maximum=4294967295
Displayed(tab/group)=Control PW VC ID (/Source B-Mac LSB)

creationOrigin Indicates indicates the protocol or mechanism which created this SDP.

type=svt.L2RouteOriginType
access=read-only
default=manual
Displayed(tab/group)=Creation Mode (/Auto-Discovery)

egressPortEncapType

type=equipment.PortEncapType
access=read-only
default=unknown

egressPortName

type=string
access=read-only
default=
minimum=0
maximum=252

egressPortPointer

type=string
default=
maximum=252
Displayed(tab/group)=Port (Port Binding/Port)

egressPortportCategory

type=equipment.PortCategory
access=read-only
default=unknown

egressSnmpPortId

type=long
access=read-only
default=503316480

enforceDiffServLspFcMap The Enforce Diff-Serv Lsp-Fc Map parameter specifies whether the FC to LSP mapping must conform to the Diff-Serv FC to Class Type mapping. When this parameter is enabled, NFM-P queries RSVP to determine if the FC is supported by the LSP. RSVP checks if the FC maps to the CT of the LSP. If the FC is already configured on the LSP and the FC does not map to the CT of the LSP, then the NFM-P blocks the enabling of the Enforce Diff-Serv Lsp-Fc Map option. The SDP continues to enforce the mapping of a single LSP per FC. However, when the Enforce Diff-Serv Lsp-Fc Map parameter is enabled, RSVP also enforces the use of a single CT per FC, as per the user-configured mapping in RSVP.

type=int
default=false
Displayed(tab/group)=Enforce Diff-Serv Lsp-Fc Map (/Class Forwarding)
enums=
    1: true - On
    2: false - Off

farEndInetAddressType Specifies the address type for the farEndInetAddress. So far, only IPv6 type is supported.

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

helloMessageLength Specifies the length of the SDP Echo Request messages transmitted on this SDP. Valid range is 0 or 40..9198.

type=int
default=0
minimum=0
maximum=9198
Displayed(tab/group)=Hello Message Length (Maintenance/Keep-alive)

helloRequestTimeout The Hello Request Timeout parameter specifies how long, in seconds, to wait for an acknowledgement of the SDP echo request message before a neighbor is declared down. The range is 1 to 10. The default is 5.

type=int
default=5
minimum=1
maximum=10
Displayed(tab/group)=Hello Request Timeout (Maintenance/Keep-alive)

helloTime The Hello Time parameter specifies how long, in seconds, the SDP echo request messages are transmitted on the SDP. The range is 1 to 3600. The default is 10.

type=int
default=10
minimum=1
maximum=3600
Displayed(tab/group)=Hello Time (Maintenance/Keep-alive)

holdDownTime The Hold Down Time parameter specifies how long, in seconds, the SDP remains in the operationally down state in response to SDP keep-alive monitoring. The range is 1 to 3600. The default is 10.

type=int
default=10
minimum=0
maximum=3600
Displayed(tab/group)=Hold Down Time (Maintenance/Keep-alive)

ipAddressType

type=rtr.InetAddressType
default=ipv4

isAutoselectable

type=boolean
default=true

isLdpActive

type=generic.TruthValue
access=read-only
default=false
Displayed(tab/group)=LDP Active (/MPLS Signaling)

keepAliveOn The Keep-Alive Enabled protocol specifies whether SDP echo request and reply messages are used to monitor service tunnel (SDP) connectivity. The operating state of the SDP is affected by the keep-alive state on the SDP ID. SDP echo request messages are only sent when the SDP ID is configured and administratively up. When the SDP ID is administratively down, keep-alive messages for that SDP ID are disabled.

type=boolean
default=false
Displayed(tab/group)=Keep-Alive Enabled (Maintenance/Keep-alive)

keepAliveStatus

type=svt.KeepAliveStatus
access=read-only
default=unknown
Displayed(tab/group)=Keep-Alive State (Maintenance/Keep-alive)

lateHelloResponses

type=long
access=read-only
default=0

ldpEnabled

type=generic.TruthValue
default=false
Displayed(tab/group)=Enable LDP (/MPLS Signaling)

localEndInetAddress Specifies the source IP Address. Currently, only applicable to tunnel with GRE underlying transport. The IP address should be configured as primary address on a local network interface, and can not be the system or management address. Setting it to default value will clear the setting.

type=InetAddress
default=0.0.0.0
Displayed(tab/group)=Local End IP Address (/Source)

localEndInetAddressType Specifies the address type for the localEndInetAddress. Now only IPv4 type is supported.

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

maxDropCount The Max Drop Count parameter specifies the number of failed responses to an SDP echo request before the SDP changes to a down state. The range is 1 to 5. The default is 3.

type=int
default=3
minimum=1
maximum=5
Displayed(tab/group)=Max Drop Count (Maintenance/Keep-alive)

metric The Metric parameter specifies a value used by a tunnel table manager to determine a route. The parameter value helps identify the preferred route when multiple SDPs with the same destination exist. The preferred route is the route with the lowest parameter value. The range is 1 to 65535. The default is 0.

type=long
default=0
minimum=0
maximum=65535
Displayed(tab/group)=Metric (/Metric)

mixedLspMode The Mixed Lsp Mode parameter specifies whether RSVP and LDP LSPs can co-exist in the SDP. When both RSVP and LDP are enabled on an SDP, the SDP can switch from using RSVP LSPs to LDP LSPs in the event that all RSVP LSP paths fail. When the Mixed Lsp Mode parameter is set to true, the Revert Time (seconds) parameter is configurable. If you try to set the Mixed Lsp Mode parameter to false while there is at least one RSVP LSP associated with this SDP, NFM-P will reject your update and an error message will be issued. LDP has an associated timer parameter named Tunnel Down Damp Time (seconds) which is set to 3 seconds by default. This parameter specifies how long an LDP waits before sending a tunnel down event to the route table manager. When the LDP fails, the SDP will revert to the RSVP LSP only after the expiry of this timer. For an immediate switchover, this timer must be set to 0 seconds.

type=generic.TruthValue
default=false
Displayed(tab/group)=Mixed LSP Mode (/MPLS Signaling)

mplstpGlobalId Specifies the MPLS-TP domain number.

type=long
default=0
minimum=0
maximum=4294967295
Displayed(tab/group)=MPLS-TP Global ID (/Destination)

mplstpNodeId Specifies the unique MPLS-TP node identifier for the given global ID.

type=InetAddress
default=0.0.0.0
Displayed(tab/group)=MPLS-TP Node ID (/Destination)

mplstpSitePointer The value specifies an MPLS TP site

type=Pointer
default=
Displayed(tab/group)=MPLS-TP Far End Site (/Destination)

networkDomainPointer

type=Pointer
Displayed(tab/group)=Network Domain (/Network Domain)

numberOfBandwidthReservedTunnels

type=int
access=read-only
default=0

numberOfFunctionalUnderlyingPaths

type=int
access=read-only
default=0

numberOfUnderlyingTransportPaths

type=int
access=read-only
default=0

oamEnabled

type=boolean
default=false

operBandwidth The value of sdpOperBandwidth indicates the operational Bandwidth in kilo-bits per seconds (Kbps) available for this SDP. The value sdpOperBandwidth is determined by the sum of the bandwidth of all the RSVP LSPs used by the SDP.

type=int
access=read-only
default=0
minimum=0
maximum=100000000
units=kbps
Displayed(tab/group)=SDP Operational Bandwidth (SDP Bandwidth/Bandwidth)

operTransportDestAddr The value indicates the operational IP address of the remote end of the transport tunnel for this SDP. If svt.Tunnel.transportDestAddr is not set, it will take the value from destinationNodeId.

type=InetAddress
access=read-only
default=0.0.0.0
Displayed(tab/group)=Operational Transport Destination Address (/Destination)

operTransportDestAddrType

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

pbbEtype The PBB Ethernet Type parameter specifies the addressing space available in the Ethernet frame. The range is 1536 to 65535. The default is 35047.

type=int
default=35047
minimum=1536
maximum=65535
Displayed(tab/group)=PBB Ethernet Type (/Identity)

receivedHelloMessages

type=long
access=read-only
default=0

redundantPathId

type=long
access=read-only
default=0

redundantServiceId

type=long
access=read-only
default=0

redundantVcId

type=long
access=read-only
default=0

revertTime Specifies the time to wait before reverting back from LDP to an associated RSVP LSP when it is available. When the value is -1, the SDP will never revert back (Infinite).

type=int
default=0
minimum=-1
maximum=600
units=seconds
Displayed(tab/group)=Revert Time (/MPLS Signaling)

sas.OneTimeValidationResult-Set type=Children-Set
sdpActiveLspType

type=svt.SdpActiveLspTypes
access=read-only
default=none
Displayed(tab/group)=Active LSP Type (/MPLS Signaling)

sdpEgressIfsNetDomainConsistent

type=svt.SDPEgressIfsNetDomainConsistentTypes
access=read-only
default=notApplicable
Displayed(tab/group)=Egress Interfaces Consistency State (/Network Domain)

sourceBmacLsb

type=long
default=0
minimum=0
maximum=65535
Displayed(tab/group)=B-MAC LSB (/Source B-Mac LSB)

srIsis Specifies whether Segment Routing is enabled for IS-IS on this SDP.

type=boolean
default=false
Displayed(tab/group)=SR-ISIS (/Segment Routing)

srIsisLspId Indicates the Id for the segment routed IS-IS LSP if srIsIs is set to 'enabled' and there is a valid route to the destinationNodeId.

type=int
access=read-only
Displayed(tab/group)=SR-ISIS LSP ID (/Segment Routing)

srOspf Specifies whether Segment Routing is enabled for OSPF on this SDP.

type=boolean
default=false
Displayed(tab/group)=SR-OSPF (/Segment Routing)

srOspfLspId Indicates the Id for the segment routed OSPF LSP if srOspf is set to 'enabled' and there is a valid route to the destinationNodeId.

type=int
access=read-only
Displayed(tab/group)=SR-OSPF LSP ID (/Segment Routing)

srTeLsp Specifies whether Segment Routing is enabled for TE-LSP on this SDP.

type=boolean
access=read-only
default=false
Displayed(tab/group)=SR-TE-LSP (/Segment Routing)

srTeOperInstId Indicates the traffic-engineering (TE) instance identifier in use for this SDP.

type=int
access=read-only
Displayed(tab/group)=TE Instance Id (/Segment Routing)

steerParamInclude A bitmap used to determine which Tunnel Admin Groups are currently included for this service tunnel.

type=long
default=0
units=bitmap
Displayed(tab/group)=Included (/Tunnel Admin Groups)

svt.ForwardingClassMapping-Set type=Children-Set
svt.PWPortBinding-Set type=Children-Set
svt.TransportConnection-Set type=Children-Set
terminatingSiteId Indicates the terminating site IP address for the SDP.

type=InetAddress
access=read-only
default=0.0.0.0
Displayed(tab/group)=Terminating Site ID (/Destination)

terminatingSiteIdAddrType

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

transmittedHelloMessages

type=long
access=read-only
default=0

transportDestAddr The value specifies the IP address of the remote end of the transport tunnel for this SDP. It can only be set while tunnel is LDP enabled. This address must be different from destinationNodeId on SR15.1 and up nodes. The value can only be changed while the admin status of the SDP is 'down'.

type=InetAddress
default=0.0.0.0
Displayed(tab/group)=Transport Destination Address (/Destination)

transportDestAddrType

type=rtr.InetAddressType
default=ipv4

vlanVcEtherType This attribute specifies the Ethertype used in frames sent out this SDP, when the VC type is vlan.

type=long
default=33024
minimum=1536
maximum=65535
Displayed(tab/group)=VLAN VC Ethertype (/VLAN)

weightedEcmp Specifies the packets forwarded to a set of ECMP tunnel next-hops which will be sprayed proportionally to the load balancing weights configured for each LSP.

type=boolean
default=false
Displayed(tab/group)=Weighted ECMP (/Weighted ECMP)

 
Overridden Properties
destinationNodeId

fromNodeId

fromNodeName

pathId

maximum=32767

signallingType The Signaling parameter specifies the signaling protocol that is used to obtain the ingress and egress labels in frames transmitted and received on the service tunnel. When the parameter is set to None (manual), the labels must be configured when the service tunnel is bound to a service. The signaling value can only be changed when the administrative status of the SDP is down. The parameter options are as follows: TLDP (default) - Specifies that the ingress and egress signaling auto labelling is enabled. BGP - Specifies that the ingress and egress pseudowire signaling uses BGP to obtain the ingress/egress PW labels in frames transmitted and received on an SDP. This is the default value when a BGP VPLS automatically instantiates the SDP. None (manual) - Specifies that the ingress and egress signal auto-labeling is not enabled. Each service that uses the specified SDP must use configured VPN labels.

default=tldp

toNodeId

toNodeName

underlyingTransport

access=read-create
default=gre

 
Properties inherited from svt.AbstractTunnel
description, displayedName, flowThruSvcPtrs, isTunnelBeingUsed, operationalFlags, pathId, pathMtu, sasEntityName, sasTestSuiteCount, sourceNodeId, svcConnectionType, svcTunnelType, templateVersionPointer, underlyingTransport
 
Properties inherited from netw.SignalledPath
encapsulationType, signallingType
 
Properties inherited from netw.UnidirectionalPath
actualPathMtu, description, destinationNodeId, destinationNodeIdAddrType, destinationNodeMisconfigured, displayedName, forwardingClasses, loadFactor, pathId, pathMtu, sourceNodeId, sourceNodeIdAddrType, sourceNodeMisconfigured
 
Properties inherited from netw.PointToPointSubnetworkConnection
fromCtp, fromNodeId, fromNodeName, toCtp, toNodeId, toNodeName
 
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

configure

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 -
continueOnFailure : continueOnFailure - (Optional) Continue processing requests in this stream if an exception occurs, unless the request is invalid. Default: false
Output Parameters:
objectFullName : string -
Exceptions:
svt.Tunnel.configureException

find

DEPRECATED - 8.0.R1
Use root find instead.
Input Parameters:
filter : FilterHolder -
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:
infoList : List (generic.CommonManagedEntityInformation) -

findServiceSites

Input Parameters:
instanceFullName : string - the full name of the object.
filter : FilterHolder -
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:
infoList : List (generic.CommonManagedEntityInformation) -
Methods inherited from svt.AbstractTunnel
findCircuits, findServices, findSubscribers, rediscoverTunnelDestination, shutDown, turnUp
 
Supported Network Elements
7450 ESS
Wavence SM
7210 SAS M Supported for all versions
  • Required Capabilities: NetworkMode
7210 SAS T Supported for all versions
  • Required Capabilities: NetworkMode
7210 SAS K Supported for all versions
  • Required Capabilities: NetworkMode
7210 SAS Mxp Supported for all versions
  • Required Capabilities: NetworkMode
7210 SAS S/Sx
7210 SAS X
7210 SAS R
7250 IXR
7750 SR
7705 SAR Gen 2
7705 SAR Hm
7705 SAR
7705 SAR H
OS9700E/9800E
DC VSC
DC 7850
DC 210
DC VSA8
7950 XRS
Generic NE
Product Specifics
7210 SAS K (all versions)
7210 SAS K 20.0
7210 SAS K 21.0
7210 SAS K 22.0
7210 SAS K 23.0
7210 SAS K 24.0
7210 SAS K 25.0
7210 SAS M (all versions)
7210 SAS M 20.0
7210 SAS M 21.0
7210 SAS Mxp (all versions)
7210 SAS Mxp 20.0
7210 SAS Mxp 21.0
7210 SAS Mxp 22.0
7210 SAS Mxp 23.0
7210 SAS Mxp 24.0
7210 SAS Mxp 25.0
7210 SAS R (all versions)
7210 SAS R 20.0
7210 SAS R 21.0
7210 SAS R 22.0
7210 SAS R 23.0
7210 SAS R 24.0
7210 SAS R 25.0
7210 SAS S/Sx (all versions)
7210 SAS S/Sx 20.0
7210 SAS S/Sx 21.0
7210 SAS S/Sx 22.0
7210 SAS S/Sx 23.0
7210 SAS S/Sx 24.0
7210 SAS S/Sx 25.0
7210 SAS T (all versions)
7210 SAS T 20.0
7210 SAS T 21.0
7210 SAS T 22.0
7210 SAS T 23.0
7210 SAS T 24.0
7210 SAS T 25.0
7210 SAS X (all versions)
7250 IXR (all versions)
7250 IXR 20.0
7250 IXR 21.0
7250 IXR 22.0
7250 IXR 23.0
7250 IXR 24.0
7250 IXR 25.0
7450 ESS (all versions)
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 (all versions)
7705 SAR Gen 2 25.0
7705 SAR H (all versions)
7705 SAR H 20.0
7705 SAR H 21.0
7705 SAR H 22.0
7705 SAR H 23.0
7705 SAR H 24.0
7705 SAR H 25.0
7705 SAR H 9.0
7705 SAR Hm 20.0
7705 SAR Hm 21.0
7705 SAR Hm 22.0
7705 SAR Hm 23.0
7705 SAR Hm 24.0
7705 SAR Hm 25.0
7705 SAR (all versions)
7705 SAR 20.0
7705 SAR 21.0
7705 SAR 22.0
7705 SAR 23.0
7705 SAR 24.0
7705 SAR 25.0
7750 SR (all versions)
7750 SR 20.0
7750 SR 21.0
7750 SR 22.0
7750 SR 23.0
7750 SR 24.0
7750 SR 25.0
7950 XRS (all versions)
7950 XRS 20.0
7950 XRS 21.0
7950 XRS 22.0
7950 XRS 23.0
7950 XRS 24.0
7950 XRS 25.0
DC 210 (all versions)
DC 210 20.5
DC 210 5.0
DC 210 6.0
DC 7850 (all versions)
DC 7850 20.0
DC 7850 5.0
DC 7850 6.0
DC VSA8 (all versions)
DC VSA8 5.0
DC VSA8 6.0
DC VSC (all versions)
DC VSC 20.0
DC VSC 5.0
DC VSC 6.0
Generic NE (all versions)
Generic NE 1.0.0
OS9700E/9800E (all versions)
OS9700E/9800E 6.4.3
OS9700E/9800E 6.4.4
OS9700E/9800E 6.4.5
OS9700E/9800E 6.4.6
Wavence SM (all versions)