Interface tunnel-te

Configure MPLS Traffic Engineering (TE) tunnel interfaces on IOS XR devices. Tunnel-TE interfaces provide MPLS Label Switched Paths (LSPs) with explicit routing, bandwidth guarantees, and path protection capabilities.

Diagram

Classes

interfaces (iosxr.devices.configuration)

Name	Type	Constraint	Mandatory	Default Value
tunnel_tes	List	`[tunnel_tes]`	No

tunnel_tes (iosxr.devices.configuration.interfaces)

Name	Type	Constraint	Mandatory
id	Any	Integer[min: `0`] or String[Regex: `^[0-9][0-9]$`] or String[Regex: `^.[\$\%]\{.*$`]	Yes
interface_groups	List	String	No
affinity_mask	String		No
affinity_value	String		No
auto_bw	Class	`[auto_bw]`	No
autoroute_announce	Boolean	`true`, `false`	No
autoroute_announce_exclude_traffic_segment_routing	Boolean	`true`, `false`	No
autoroute_announce_include_ipv6	Boolean	`true`, `false`	No
autoroute_announce_metric	Integer		No
autoroute_announce_metric_absolute	Integer		No
autoroute_announce_metric_relative	Integer		No
autoroute_destinations	List	`[autoroute_destinations]`	No
backup_bw_class_type	Any	Choice[`any`] or Integer[min: `0`, max: `1`] or String[Regex: `^.[\$\%]\{.$`]	No
backup_bw_pool_type	String		No
backup_bw_unlimited	Boolean	`true`, `false`	No
backup_bw_value	Integer		No
bandwidth	Integer	min: `0`, max: `9223372036854775807`	No
bfd_bringup_timeout	Integer	min: `10`, max: `3600`	No
bfd_dampening_initial_wait	Integer	min: `1`, max: `518400000`	No
bfd_dampening_maximum_wait	Integer	min: `1`, max: `518400000`	No
bfd_dampening_secondary_wait	Integer	min: `1`, max: `518400000`	No
bfd_encap_gal	Boolean	`true`, `false`	No
bfd_fast_detect	Boolean	`true`, `false`	No
bfd_lsp_ping	Any	Integer or Choice[`disable`] or String[Regex: `^.[\$\%]\{.$`]	No
bfd_minimum_interval	Integer	min: `3`, max: `30000`	No
bfd_multiplier	Integer	min: `3`, max: `10`	No
bfd_sbfd	Boolean	`true`, `false`	No
bidirectional	Class	`[bidirectional]`	No
binding_sid_mpls_label	Integer		No
description	String		No
destination	IP		No
fast_reroute	Boolean	`true`, `false`	No
fast_reroute_protect_bandwidth	Boolean	`true`, `false`	No
fast_reroute_protect_node	Boolean	`true`, `false`	No
forward_class	Integer		No
forwarding_adjacency	Boolean	`true`, `false`	No
forwarding_adjacency_holdtime	Integer		No
forwarding_adjacency_include_ipv6	Boolean	`true`, `false`	No
ipv4	Class	`[ipv4]`	No
ipv6	Class	`[ipv6]`	No
load_interval	Integer	min: `30`, max: `600`	No
load_share	Integer		No
logging_events_all	Boolean	`true`, `false`	No
logging_events_bfd_status	Boolean	`true`, `false`	No
logging_events_link_status	Boolean	`true`, `false`	No
logging_events_lsp_bw_change	Boolean	`true`, `false`	No
logging_events_lsp_insufficient_bw	Boolean	`true`, `false`	No
logging_events_lsp_record_route	Boolean	`true`, `false`	No
logging_events_lsp_reoptimize	Boolean	`true`, `false`	No
logging_events_lsp_reoptimize_attempts	Boolean	`true`, `false`	No
logging_events_lsp_reroute	Boolean	`true`, `false`	No
logging_events_lsp_state	Boolean	`true`, `false`	No
logging_events_lsp_switchover	Boolean	`true`, `false`	No
logging_events_pcalc_failure	Boolean	`true`, `false`	No
mpls_mtu	Integer	min: `68`, max: `65535`	No
path_options	List	`[path_options]`	No
path_protection	Boolean	`true`, `false`	No
path_protection_non_revertive	Boolean	`true`, `false`	No
path_protection_srlg_diverse	Boolean	`true`, `false`	No
path_selection	Class	`[path_selection]`	No
policy_classes	List	Any[Choice[`default`] or Integer[min: `1`, max: `7`]]	No
priority_hold	Integer		No
priority_setup	Integer		No
record_route	Boolean	`true`, `false`	No
shutdown	Boolean	`true`, `false`	No
signalled_bandwidth	Integer		No
signalled_bandwidth_class_type	Integer		No
signalled_bandwidth_sub_pool	Boolean	`true`, `false`	No
signalled_name	String		No
soft_preemption	Boolean	`true`, `false`	No

auto_bw (iosxr.devices.configuration.interfaces.tunnel_tes)

Name	Type	Constraint	Mandatory
adjustment_threshold_min	Integer		No
adjustment_threshold_percent	Integer		No
collect_only	Boolean	`true`, `false`	No
limit_max	Integer		No
limit_min	Integer		No
overflow_limit	Integer		No
overflow_min	Integer		No
overflow_threshold	Integer		No
resignal_last_bandwidth_timeout	Integer		No
underflow_limit	Integer		No
underflow_min	Integer		No
underflow_threshold	Integer		No

autoroute_destinations (iosxr.devices.configuration.interfaces.tunnel_tes)

Name	Type	Constraint	Mandatory	Default Value
address	IP		Yes

bidirectional (iosxr.devices.configuration.interfaces.tunnel_tes)

Name	Type	Constraint	Mandatory
association_id	Integer		No
corouted_fault_oam	Boolean	`true`, `false`	No
corouted_signaling_protection_object_disable	Boolean	`true`, `false`	No
corouted_wrap_protection	Boolean	`true`, `false`	No
global_id	Integer		No
source_address	IP		No
type	Choice	`corouted`	No

ipv4 (iosxr.devices.configuration.interfaces.tunnel_tes)

Name	Type	Constraint	Mandatory
address	IP		No
forwarding_enable	Boolean	`true`, `false`	No
mask	IP		No
ttl_propagate_disable	Boolean	`true`, `false`	No
unnumbered	String		No

ipv6 (iosxr.devices.configuration.interfaces.tunnel_tes)

Name	Type	Constraint	Mandatory	Default Value
enable	Boolean	`true`, `false`	No
ttl_propagate_disable	Boolean	`true`, `false`	No

path_options (iosxr.devices.configuration.interfaces.tunnel_tes)

Name	Type	Constraint	Mandatory
preference	Integer		Yes
attribute_set	String		No
dynamic	Boolean	`true`, `false`	No
explicit_path_id	Integer		No
explicit_path_name	String		No
explicit_path_verbatim	Boolean	`true`, `false`	No
isis_level	Integer		No
isis_process	String		No
lockdown	Boolean	`true`, `false`	No
lockdown_sticky	Boolean	`true`, `false`	No
ospf_area	Any	Integer or String or String[Regex: `^.[\$\%]\{.$`]	No
ospf_process	String		No
protected_by_index	Integer		No
protected_by_index_secondary	Integer		No

path_selection (iosxr.devices.configuration.interfaces.tunnel_tes)

Name	Type	Constraint	Mandatory
cost_limit	Integer		No
delay_limit	Integer		No
hop_limit	Integer		No
metric	Choice	`te`, `igp`, `delay`	No
tiebreaker	Choice	`min-fill`, `max-fill`, `random`	No

Examples

Example 1: Basic MPLS-TE Tunnel

iosxr:
  devices:
    - name: router-1
      host: 10.10.10.1:57400
      configuration:
        hostname: router-1
        interfaces:
          tunnel_tes:
            - id: 100
              description: "MPLS-TE Tunnel to Remote Site"
              shutdown: false
              bandwidth: 1000000
              load_interval: 30
              ipv4:
                unnumbered: Loopback0
              path_options:
                - preference: 1
                  dynamic: true

Example 2: MPLS-TE Tunnel with Explicit Path and Bandwidth

iosxr:
  devices:
    - name: router-1
      host: 10.10.10.1:57400
      configuration:
        hostname: router-1
        interfaces:
          tunnel_tes:
            - id: 101
              description: "TE tunnel with bandwidth reservation"
              destination: 192.168.1.2
              bandwidth: 1000000
              priority_setup: 7
              priority_hold: 7
              path_options:
                - preference: 1
                  explicit_name: PRIMARY_PATH
                - preference: 2
                  explicit_name: BACKUP_PATH
              autoroute_announce: true
              shutdown: false

Example 3: MPLS-TE Tunnel with Fast Reroute (FRR)

iosxr:
  devices:
    - name: router-1
      host: 10.10.10.1:57400
      configuration:
        hostname: router-1
        interfaces:
          tunnel_tes:
            - id: 102
              description: "TE tunnel with FRR protection"
              destination: 192.168.1.2
              bandwidth: 1000000
              path_options:
                - preference: 1
                  dynamic: true
              ipv4:
                unnumbered: Loopback0
              fast_reroute: true
              fast_reroute_protect_node: true
              fast_reroute_protect_bandwidth: true

Example 4: MPLS-TE Tunnel with Path Protection

iosxr:
  devices:
    - name: router-1
      host: 10.10.10.1:57400
      configuration:
        hostname: router-1
        interfaces:
          tunnel_tes:
            - id: 103
              description: "TE tunnel with path protection"
              destination: 192.168.1.2
              path_protection: true
              path_protection_non_revertive: true
              path_options:
                - preference: 1
                  explicit_name: PRIMARY
                - preference: 2
                  explicit_name: SECONDARY
              bandwidth: 1000000
              autoroute_announce: true

Example 5: MPLS-TE Tunnel with Affinity

iosxr:
  devices:
    - name: router-1
      host: 10.10.10.1:57400
      configuration:
        hostname: router-1
        interfaces:
          tunnel_tes:
            - id: 104
              description: "TE tunnel with affinity"
              destination: 192.168.1.2
              affinity_value: "11"
              affinity_mask: "ff"
              bandwidth: 1000000
              path_options:
                - preference: 1
                  dynamic: true

Example 6: MPLS-TE Tunnel with Auto-bandwidth

iosxr:
  devices:
    - name: router-1
      host: 10.10.10.1:57400
      configuration:
        hostname: router-1
        interfaces:
          tunnel_tes:
            - id: 105
              description: "TE tunnel with auto-bandwidth"
              destination: 192.168.1.2
              auto_bw:
                adjustment_threshold_percent: 10
                limit_min: 1000
                limit_max: 100000
              path_options:
                - preference: 1
                  dynamic: true

Example 7: MPLS-TE Tunnel with Explicit Autoroute Destinations

iosxr:
  devices:
    - name: router-1
      host: 10.10.10.1:57400
      configuration:
        hostname: router-1
        interfaces:
          tunnel_tes:
            - id: 800
              description: "TE tunnel with explicit autoroute"
              destination: 192.168.1.2
              autoroute_destinations:
                - address: 172.16.1.1
                - address: 172.16.1.2
                - address: 172.16.1.3
              bandwidth: 1000000
              path_options:
                - preference: 1
                  dynamic: true