RsvpIngressTunnelParams Object

Description:

RSVP ingress tunnel parameters object.

Writable Attributes
Read-Only Attributes

Parents: RsvpRouterConfig

Children: RsvpDetourSubObject, RsvpGmplsParams, RsvpIpv4EroObject, RsvpIpv4ExplicitRouteParams, RsvpP2MpSubGroupParams, RsvpReverseObject

Automatically-created children: RsvpTspecProfile

Relations:

Side name (Type)	Relative	Description
JoinedMulticastGroup (MemberGroup)	Ipv4Group, Ipv6Group	RSVP ingress Joined Multicast IPv4 Group.
(ResolvesInterface)	Aal5If, EthIIIf, FcIf, GreIf, GroupIf, HdlcIf, Ipv4If, Ipv6If, Ipv6SrhIf, ItagIf, L2tpv2If, L2tpv3If, LispIf, MacsecIf, MplsIf, PppIf, PppoeIf, RsvpCustomObject, RsvpCustomObject, TrillIf, VbrasIf, VlanIf, VxlanGpeIf, VxlanIf	Use this to link the traffic binding interfaces and traffic binding resolver.

RsvpIngressTunnelParams Writable Attributes

Attribute

Description

Common Writable Attributes

Active, Name

Affinities

Disables or enables the three (resource class) affinities in tunnel messages.

Type: bool

Default: FALSE

Possible Values:

Value	Description
TRUE	Affinities enabled.
FALSE	Affinities disabled.

AssocId

The Association ID field is carried in the IPv4 and IPv6 ASSOCIATION objects. A value assigned by the LSP head-end. When combined with the Association Type and Association Source, this value uniquely identifies an association.

Type: u16

Default: 1

AssocIdStep

Association ID Step to increment

Type: u16

Default: 1

AssocType

Rsvp Association Type

Type: enum

Default: DOUBLE

Possible Values:

Value	Description
DOUBLE	Rsvp Association Type is Double
SINGLE	Rsvp Association Type is Single

BfdDiscriminatorStep

Bfd My Discriminator Step

Type: u32

Default: 1

Range: 0 - 49151

BfdMessageFormat

BFD message format.

Type: enum

Default: BFD_CC

Possible Values:

Value	Description
BFD_CC	BFD CC.
BFD_CV	BFD CV.

BfdMyDiscriminator

BFD My Discriminator.

Type: u32

Default: 10

BfdMyDiscriminatorStep

NOTE: This attribute is deprecated. It will be removed in subsequent releases, so it is recommended that you do not use it.

BFD My Discriminator Step.

Type: u32

Default: null

Range: 1 - 49151

DstIpAddr

Destination IP address of the RSVP PATH message. This parameter applies to both ingress and egress. The default is the SUT IP address.

Type: ip

Default: 192.85.1.1

DstIpAddrStep

Destination IP address step. This parameter is used to support incremental destination IP address in the same tunnel block.

Type: ip

Default: 0.0.0.0

DstIpv4Address

Destination IPv4 address.

Type: ip

Default: 127.0.0.1

EnableBfd

Enable Bfd.

Type: bool

Default: FALSE

Possible Values:

Value	Description
TRUE	Enable Bfd.
FALSE	Disable BFD.

EnableEroCompression

Enable explicit route object compression.

Type: bool

Default: TRUE

Possible Values:

Value	Description
TRUE	Enable explicit route object compression.
FALSE	Disable explicit route object compression.

EnableGeneralizedLabelRequest

Enable generalized label request.

Type: bool

Default: FALSE

Possible Values:

Value	Description
TRUE	Enable generalized label request.
FALSE	Disable generalized label request.

EnableGenericAssociatedChannel

Enable GenericAssociated Channel (G-ACh).

Type: bool

Default: FALSE

Possible Values:

Value	Description
TRUE	Enable GenericAssociated Channel.
FALSE	Disable GenericAssociated Channel.

EnableGenericAssociatedLabel

Enable generic associated label (GAL).

Type: bool

Default: FALSE

Possible Values:

Value	Description
TRUE	Enable generic associated label.
FALSE	Disable generic associated label.

EnableIpv4Assoc

Enable IPv4 Association Object

Type: bool

Default: FALSE

Possible Values:

Value	Description
TRUE	True
FALSE	False

EnableIpv4ExtAssoc

Enable IPv4 Extended Association Object

Type: bool

Default: FALSE

Possible Values:

Value	Description
TRUE	True
FALSE	False

EnableNotifyRequest

Enable notify request.

Type: bool

Default: FALSE

Possible Values:

Value	Description
TRUE	Enable notify request.
FALSE	Disable notify request.

EnablePointToMultiPoint

Enable P2MP RSVP tunnel.

Type: bool

Default: FALSE

Possible Values:

Value	Description
TRUE	Enable P2MP RSVP Tunnel.
FALSE	Disable P2MP RSVP Tunnel.

EnableProtectionObject

Enable protection object.

Type: bool

Default: FALSE

Possible Values:

Value	Description
TRUE	Enable Protection Object.
FALSE	Disable Protection Object.

EnableRecordRoute

Causes the ingress to include a record-route object in the path message.

Type: bool

Default: FALSE

Possible Values:

Value	Description
TRUE	Record route on.
FALSE	Record route off.

EnableUniqueSessionName

Option to enable or disable Unique session name.

Type: bool

Default: FALSE

Possible Values:

Value	Description
TRUE	Enable
FALSE	Disable

EnableUniqueSubGroupSessionName

Enable unique subgroup session name.

Type: bool

Default: FALSE

Possible Values:

Value	Description
TRUE	Enable unique subgroup session name.
FALSE	Disable unique subgroup session name.

EnableUpstreamLabel

Enable upstream label.

Type: bool

Default: FALSE

Possible Values:

Value	Description
TRUE	Enable upstream label.
FALSE	Disable upstream label.

Encapsulation

Encapsulation type.

Type: enum

Default: UDP

Possible Values:

Value	Description
UDP	BFD packet encapsulate over UDP.
RAW	BFD packet encapsulate over RAW.

ExcludeAny

(Optional) Represents a set of attribute filters associated with a backup path, any of which renders a link unacceptable. If any bit in the link bit mask matches the corresponding bit in the exclude any bit mask, the link is excluded from the tunnel.

Type: u32

Default: 0

ExtAssocId

This field contains data that is additional information to support unique identification.

Type: u8

Default: 0

ExtendedTunnelId

Extended 32-bit tunnel identifier, normally set to all zeros.

Type: ip

Default: 0.0.0.0

ExtendedTunnelIdStep

Extended tunnel ID step.

Type: ip

Default: 0.0.0.0

FastRerouteBandwidth

Bandwidth estimate; 32-bit IEEE floating point integer, in bytes per second.

Type: u32

Default: 0

FastRerouteExcludeAny

Represents a set of attribute filters associated with a backup path, any of which renders a link unacceptable.

Type: u32

Default: 0

FastRerouteHoldPriority

Priority of the backup path with respect to holding resources. Used in deciding whether this session can be preempted by another session.

Type: u8

Default: 0

Range: 0 - 7

FastRerouteHopLimit

Maximum number of extra hops that the backup path is allowed to take, from current node (a PLR) to an MP, with PLR and MP excluded the count.

Type: u8

Default: 0

FastRerouteIncludeAll

Represents a set of attribute filters associated with a backup path, all of which must be present for a link to be acceptable (with respect to this test).

Type: u32

Default: 0

FastRerouteIncludeAny

Represents a set of attribute filters associated with a backup path, any of which renders a link acceptable (with respect to this test).

Type: u32

Default: 0

FastRerouteObject

Enables fast re-reroute. Used to control the backup used for the protected LSP. This specifies the setup and hold priorities, session attribute filters, and bandwidth to be used for protection. It also allows a specific local protection method to be requested.

Type: enum

Default: NONE

Possible Values:

Value	Description
NONE	Not enabled.
ONE_TO_ONE_BACKUP	Creates detour LSPs for each protected LSP at each potential point of local repair.
FACILITY_BACKUP	Creates a bypass tunnel to protect a potential failure point; by taking advantage of MPLS label stacking, this bypass tunnel can protect a set of protected LSPs that have similar backup constraints.

FastRerouteSetupPriority

Priority of the backup path with respect to taking resources. The priority assigned to each tunnel is used to determine which tunnel(s) can preempt other tunnels. (Used in tunnel resource allocation.)

Type: u8

Default: 0

Range: 0 - 7

Flag

Opens the RSVP flags dialog.

Type: enum

Default: 7

Possible Values:

Value	Description
RSVP_FLAG_LOCAL_PROTECTION_DESIRED	Local protection is enabled.
RSVP_FLAG_LABLE_RECORD	Label record is enabled.
RSVP_FLAG_SHARED_EXPLICIT	Shared explicit is enabled.
RSVP_FLAG_BANDWIDTH_PROTECTION_DESIRED	Bandwidth protection is enabled.
RSVP_FLAG_NODE_PROTECTION_DESIRED	Node protection is enabled.

GeneralizedPId

Generalized PID (G-PID).

Type: u16

Default: 0

HoldPriority

Priority assigned to each tunnel is used to determine which tunnel(s) can be preempted by other tunnels. (Used to determine resource holding.)

Type: u8

Default: 7

Range: 0 - 7

IncludeAll

(Optional) Represents a set of attribute filters associated with a backup path, all of which must be present for a link to be acceptable (with respect to this test). If the entire link bit mask matches the entire include all bit mask, the link is included in the tunnel. A null set (all bits set to zero) automatically passes.

Type: u32

Default: 0

IncludeAny

(Optional) Represents a set of attribute filters associated with a backup path, any of which renders a link acceptable (with respect to this test). If any bit in the link bit mask matches the corresponding bit in the include any bit mask, the link is included in the tunnel. A null set (all bits set to zero) automatically passes.

Type: u32

Default: 0

Ipv4AssocSrc

An IPv4, respectively, that is associated to the node that originated the association.

Type: ip

Default: null

Ipv4GlobalAssocSrc

This field contains a value that is a unique global identifier or the special value zero (0).

Type: u32

Default: 1

LinkProtectionFlag

Link Protection Flag.

Type: enum

Default: 0

Possible Values:

Value	Description
RSVP_LINK_PROTECTION_FLAG_ENHANCED	Enhanced.
RSVP_LINK_PROTECTION_FLAG_DEDICATED_ONE_PLUS_ONE	Dedicated One Plus One.
RSVP_LINK_PROTECTION_FLAG_DEDICATED_ONE_TO_ONE	Dedicated One to One.
RSVP_LINK_PROTECTION_FLAG_SHARED	Shared.
RSVP_LINK_PROTECTION_FLAG_UNPROTECTED	Unprotected.
RSVP_LINK_PROTECTION_FLAG_EXTRA_TRAFFIC	Extra Traffic.

LspCount

Number of LSPs established within the tunnel.

Type: u16

Default: 1

Range: 1 - 20

LspEncodingType

LSP Encoding Type.

Type: enum

Default: PACKET

Possible Values:

Value	Description
PACKET	Packet.
ETHERNET	Ethernet.
ANSI_ETSI	ANSI ETSI.
RESERVED1	Reserved1.
SIG_SAT	SIG SAT.
RESERVED2	Reserved2.
DIGITAL_WRAPPER	Digital Wrapper.
LAMBDA_PHOTONIC	Lambda Photonic.
FIBER	Fiber.
RESERVED3	Reserved3.
FIBERCHANNEL	Fiber Channel.
USERDEFINED	User Defined.

LspEncodingValue

LSP Encoding Type Value.

Type: u8

Default: 12

LspId

LSP ID.

Type: u16

Default: 1

Range: 1 - 65535

LspIdStep

LSP ID step.

Type: u16

Default: 1

Range: 1 - 65535

MakeBeforeBreak

Enable Make Before Break.

Type: bool

Default: FALSE

Possible Values:

Value	Description
TRUE	Enable Make Before Break.
FALSE	Disable Make Before Break.

MakeBeforeBreakRetryAlgorithm

Retry algorithm for signaling backup LSP.

Type: enum

Default: LOOP_CONTINUOUS

Possible Values:

Value	Description
LOOP_CONTINUOUS	Loop continuously.
LOOP_ONCE	Loop once.

MakeBeforeBreakRetryTime

Make Before Break Retry Time (ms).

Type: u32

Default: null

MaxPktSize

NOTE: This attribute is deprecated. It will be removed in subsequent releases, so it is recommended that you do not use it.

Biggest packet that conforms to the traffic specification. This property is deprecated.

Type: u32

Default: 1500

Range: 0 - 2147483647

MinPolicedUnit

NOTE: This attribute is deprecated. It will be removed in subsequent releases, so it is recommended that you do not use it.

This size includes the application data and all protocol headers at or above the IP level. This property is deprecated.

Type: u32

Default: 20

Range: 0 - 2147483647

P2MpId

P2MP Identifier.

Type: string

Default: 0.0.0.1

PeakDataRate

NOTE: This attribute is deprecated. It will be removed in subsequent releases, so it is recommended that you do not use it.

Maximum rate of IP datagrams. This property is deprecated.

Type: double

Default: 0

Range: 0 - 2147483647

SessionAttribute

Adds a session attribute with Setup Priority, Hold Priority, Flags, and Session Name fields to the PATH message.

Type: bool

Default: FALSE

Possible Values:

Value	Description
TRUE	On
FALSE	Off

SessionName

Optional text name for the session/tunnel.

Type: string

Default: "" (empty string)

SetupPriority

Type: u8

Default: 7

Range: 0 - 7

SrcIpAddr

IP address of the RSVP PATH message sender. This parameter applies to both ingress and egress. The default is the IP address of the emulated RSVP router.

Type: ip

Default: 192.85.1.3

SrcIpAddrStep

Source IP address step. This parameter is used to support incremental source IP address in the same tunnel block.

Type: ip

Default: 0.0.0.0

SwitchingType

Switching Type.

Type: enum

Default: PSC1

Possible Values:

Value	Description
PSC1	PSC1.
PSC2	PSC2.
PSC3	PSC3.
PSC4	PSC4.
L2SC	L2SC.
TDMC	TDMC.
LSC	LSC.
FSC	FSC.
USERDEFINED	User Defined.

SwitchingValue

Switching Value.

Type: u8

Default: 0

TokenBucketRate

NOTE: This attribute is deprecated. It will be removed in subsequent releases, so it is recommended that you do not use it.

Rate of IP datagrams. This property is deprecated.

Type: double

Default: 0

Range: 0 - 2147483647

TokenBucketSize

NOTE: This attribute is deprecated. It will be removed in subsequent releases, so it is recommended that you do not use it.

Token bucket size. This property is deprecated.

Type: double

Default: 0

Range: 0 - 2147483647

TunnelCount

Number of tunnels.

Type: u16

Default: 1

TunnelId

16-bit tunnel identifier. Applies to both ingress and egress.

Type: u16

Default: 1

TunnelIdStep

Tunnel ID step for incrementing Tunnel ID when TunnelCount is greater than one.

Type: u16

Default: 1

RsvpIngressTunnelParams Read-Only Attributes

There are no read-only attributes.